azure-native.servicebus.PrivateEndpointConnection
Explore with Pulumi AI
Properties of the PrivateEndpointConnection. Azure REST API version: 2022-01-01-preview. Prior API version in Azure Native 1.x: 2018-01-01-preview.
Other available API versions: 2022-10-01-preview, 2023-01-01-preview, 2024-01-01.
Create PrivateEndpointConnection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointConnection(resource_name: str,
args: PrivateEndpointConnectionInitArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PrivateEndpointConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
namespace_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
private_endpoint: Optional[PrivateEndpointArgs] = None,
private_endpoint_connection_name: Optional[str] = None,
private_link_service_connection_state: Optional[ConnectionStateArgs] = None,
provisioning_state: Optional[Union[str, EndPointProvisioningState]] = None)
func NewPrivateEndpointConnection(ctx *Context, name string, args PrivateEndpointConnectionArgs, opts ...ResourceOption) (*PrivateEndpointConnection, error)
public PrivateEndpointConnection(string name, PrivateEndpointConnectionArgs args, CustomResourceOptions? opts = null)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args, CustomResourceOptions options)
type: azure-native:servicebus:PrivateEndpointConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. PrivateEndpointConnectionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. PrivateEndpointConnectionInitArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. PrivateEndpointConnectionArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. PrivateEndpointConnectionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. PrivateEndpointConnectionArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleprivateEndpointConnectionResourceResourceFromServicebus = new AzureNative.ServiceBus.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromServicebus", new()
{
NamespaceName = "string",
ResourceGroupName = "string",
PrivateEndpoint = new AzureNative.ServiceBus.Inputs.PrivateEndpointArgs
{
Id = "string",
},
PrivateEndpointConnectionName = "string",
PrivateLinkServiceConnectionState = new AzureNative.ServiceBus.Inputs.ConnectionStateArgs
{
Description = "string",
Status = "string",
},
ProvisioningState = "string",
});
example, err := servicebus.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromServicebus", &servicebus.PrivateEndpointConnectionArgs{
NamespaceName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
PrivateEndpoint: &servicebus.PrivateEndpointArgs{
Id: pulumi.String("string"),
},
PrivateEndpointConnectionName: pulumi.String("string"),
PrivateLinkServiceConnectionState: &servicebus.ConnectionStateArgs{
Description: pulumi.String("string"),
Status: pulumi.String("string"),
},
ProvisioningState: pulumi.String("string"),
})
var exampleprivateEndpointConnectionResourceResourceFromServicebus = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromServicebus", PrivateEndpointConnectionArgs.builder()
.namespaceName("string")
.resourceGroupName("string")
.privateEndpoint(PrivateEndpointArgs.builder()
.id("string")
.build())
.privateEndpointConnectionName("string")
.privateLinkServiceConnectionState(ConnectionStateArgs.builder()
.description("string")
.status("string")
.build())
.provisioningState("string")
.build());
exampleprivate_endpoint_connection_resource_resource_from_servicebus = azure_native.servicebus.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromServicebus",
namespace_name="string",
resource_group_name="string",
private_endpoint={
"id": "string",
},
private_endpoint_connection_name="string",
private_link_service_connection_state={
"description": "string",
"status": "string",
},
provisioning_state="string")
const exampleprivateEndpointConnectionResourceResourceFromServicebus = new azure_native.servicebus.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromServicebus", {
namespaceName: "string",
resourceGroupName: "string",
privateEndpoint: {
id: "string",
},
privateEndpointConnectionName: "string",
privateLinkServiceConnectionState: {
description: "string",
status: "string",
},
provisioningState: "string",
});
type: azure-native:servicebus:PrivateEndpointConnection
properties:
namespaceName: string
privateEndpoint:
id: string
privateEndpointConnectionName: string
privateLinkServiceConnectionState:
description: string
status: string
provisioningState: string
resourceGroupName: string
PrivateEndpointConnection Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PrivateEndpointConnection resource accepts the following input properties:
- Namespace
Name This property is required. Changes to this property will trigger replacement.
- The namespace name
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- Private
Endpoint Pulumi.Azure Native. Service Bus. Inputs. Private Endpoint - The Private Endpoint resource for this Connection.
- Private
Endpoint Connection Name Changes to this property will trigger replacement.
- The PrivateEndpointConnection name
- Private
Link Pulumi.Service Connection State Azure Native. Service Bus. Inputs. Connection State - Details about the state of the connection.
- Provisioning
State string | Pulumi.Azure Native. Service Bus. End Point Provisioning State - Provisioning state of the Private Endpoint Connection.
- Namespace
Name This property is required. Changes to this property will trigger replacement.
- The namespace name
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- Private
Endpoint PrivateEndpoint Args - The Private Endpoint resource for this Connection.
- Private
Endpoint Connection Name Changes to this property will trigger replacement.
- The PrivateEndpointConnection name
- Private
Link ConnectionService Connection State State Args - Details about the state of the connection.
- Provisioning
State string | EndPoint Provisioning State - Provisioning state of the Private Endpoint Connection.
- namespace
Name This property is required. Changes to this property will trigger replacement.
- The namespace name
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- private
Endpoint PrivateEndpoint - The Private Endpoint resource for this Connection.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The PrivateEndpointConnection name
- private
Link ConnectionService Connection State State - Details about the state of the connection.
- provisioning
State String | EndPoint Provisioning State - Provisioning state of the Private Endpoint Connection.
- namespace
Name This property is required. Changes to this property will trigger replacement.
- The namespace name
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- private
Endpoint PrivateEndpoint - The Private Endpoint resource for this Connection.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The PrivateEndpointConnection name
- private
Link ConnectionService Connection State State - Details about the state of the connection.
- provisioning
State string | EndPoint Provisioning State - Provisioning state of the Private Endpoint Connection.
- namespace_
name This property is required. Changes to this property will trigger replacement.
- The namespace name
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- private_
endpoint PrivateEndpoint Args - The Private Endpoint resource for this Connection.
- private_
endpoint_ connection_ name Changes to this property will trigger replacement.
- The PrivateEndpointConnection name
- private_
link_ Connectionservice_ connection_ state State Args - Details about the state of the connection.
- provisioning_
state str | EndPoint Provisioning State - Provisioning state of the Private Endpoint Connection.
- namespace
Name This property is required. Changes to this property will trigger replacement.
- The namespace name
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- private
Endpoint Property Map - The Private Endpoint resource for this Connection.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The PrivateEndpointConnection name
- private
Link Property MapService Connection State - Details about the state of the connection.
- provisioning
State String | "Creating" | "Updating" | "Deleting" | "Succeeded" | "Canceled" | "Failed" - Provisioning state of the Private Endpoint Connection.
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateEndpointConnection resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Service Bus. Outputs. System Data Response - The system meta data relating to this resource.
- Type string
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- System
Data SystemData Response - The system meta data relating to this resource.
- Type string
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- system
Data SystemData Response - The system meta data relating to this resource.
- type String
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- id string
- The provider-assigned unique ID for this managed resource.
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- system
Data SystemData Response - The system meta data relating to this resource.
- type string
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- id str
- The provider-assigned unique ID for this managed resource.
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- system_
data SystemData Response - The system meta data relating to this resource.
- type str
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- system
Data Property Map - The system meta data relating to this resource.
- type String
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
Supporting Types
ConnectionState, ConnectionStateArgs
- Description string
- Description of the connection state.
- Status
string | Pulumi.
Azure Native. Service Bus. Private Link Connection Status - Status of the connection.
- Description string
- Description of the connection state.
- Status
string | Private
Link Connection Status - Status of the connection.
- description String
- Description of the connection state.
- status
String | Private
Link Connection Status - Status of the connection.
- description string
- Description of the connection state.
- status
string | Private
Link Connection Status - Status of the connection.
- description str
- Description of the connection state.
- status
str | Private
Link Connection Status - Status of the connection.
- description String
- Description of the connection state.
- status String | "Pending" | "Approved" | "Rejected" | "Disconnected"
- Status of the connection.
ConnectionStateResponse, ConnectionStateResponseArgs
- Description string
- Description of the connection state.
- Status string
- Status of the connection.
- Description string
- Description of the connection state.
- Status string
- Status of the connection.
- description String
- Description of the connection state.
- status String
- Status of the connection.
- description string
- Description of the connection state.
- status string
- Status of the connection.
- description str
- Description of the connection state.
- status str
- Status of the connection.
- description String
- Description of the connection state.
- status String
- Status of the connection.
EndPointProvisioningState, EndPointProvisioningStateArgs
- Creating
- Creating
- Updating
- Updating
- Deleting
- Deleting
- Succeeded
- Succeeded
- Canceled
- Canceled
- Failed
- Failed
- End
Point Provisioning State Creating - Creating
- End
Point Provisioning State Updating - Updating
- End
Point Provisioning State Deleting - Deleting
- End
Point Provisioning State Succeeded - Succeeded
- End
Point Provisioning State Canceled - Canceled
- End
Point Provisioning State Failed - Failed
- Creating
- Creating
- Updating
- Updating
- Deleting
- Deleting
- Succeeded
- Succeeded
- Canceled
- Canceled
- Failed
- Failed
- Creating
- Creating
- Updating
- Updating
- Deleting
- Deleting
- Succeeded
- Succeeded
- Canceled
- Canceled
- Failed
- Failed
- CREATING
- Creating
- UPDATING
- Updating
- DELETING
- Deleting
- SUCCEEDED
- Succeeded
- CANCELED
- Canceled
- FAILED
- Failed
- "Creating"
- Creating
- "Updating"
- Updating
- "Deleting"
- Deleting
- "Succeeded"
- Succeeded
- "Canceled"
- Canceled
- "Failed"
- Failed
PrivateEndpoint, PrivateEndpointArgs
- Id string
- The ARM identifier for Private Endpoint.
- Id string
- The ARM identifier for Private Endpoint.
- id String
- The ARM identifier for Private Endpoint.
- id string
- The ARM identifier for Private Endpoint.
- id str
- The ARM identifier for Private Endpoint.
- id String
- The ARM identifier for Private Endpoint.
PrivateEndpointResponse, PrivateEndpointResponseArgs
- Id string
- The ARM identifier for Private Endpoint.
- Id string
- The ARM identifier for Private Endpoint.
- id String
- The ARM identifier for Private Endpoint.
- id string
- The ARM identifier for Private Endpoint.
- id str
- The ARM identifier for Private Endpoint.
- id String
- The ARM identifier for Private Endpoint.
PrivateLinkConnectionStatus, PrivateLinkConnectionStatusArgs
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Disconnected
- Disconnected
- Private
Link Connection Status Pending - Pending
- Private
Link Connection Status Approved - Approved
- Private
Link Connection Status Rejected - Rejected
- Private
Link Connection Status Disconnected - Disconnected
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Disconnected
- Disconnected
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Disconnected
- Disconnected
- PENDING
- Pending
- APPROVED
- Approved
- REJECTED
- Rejected
- DISCONNECTED
- Disconnected
- "Pending"
- Pending
- "Approved"
- Approved
- "Rejected"
- Rejected
- "Disconnected"
- Disconnected
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The type of identity that last modified the resource.
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The type of identity that last modified the resource.
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:servicebus:PrivateEndpointConnection 928c44d5-b7c6-423b-b6fa-811e0c27b3e0 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0