azure-native.digitaltwins.PrivateEndpointConnection
Explore with Pulumi AI
The private endpoint connection of a Digital Twin.
Uses Azure REST API version 2023-01-31. In version 2.x of the Azure Native provider, it used API version 2023-01-31.
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,
properties: Optional[ConnectionPropertiesArgs] = None,
resource_group_name: Optional[str] = None,
resource_name_: Optional[str] = None,
private_endpoint_connection_name: Optional[str] = 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:digitaltwins: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 exampleprivateEndpointConnectionResourceResourceFromDigitaltwins = new AzureNative.DigitalTwins.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDigitaltwins", new()
{
Properties = new AzureNative.DigitalTwins.Inputs.ConnectionPropertiesArgs
{
GroupIds = new[]
{
"string",
},
PrivateLinkServiceConnectionState = new AzureNative.DigitalTwins.Inputs.ConnectionPropertiesPrivateLinkServiceConnectionStateArgs
{
Description = "string",
Status = "string",
ActionsRequired = "string",
},
},
ResourceGroupName = "string",
ResourceName = "string",
PrivateEndpointConnectionName = "string",
});
example, err := digitaltwins.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromDigitaltwins", &digitaltwins.PrivateEndpointConnectionArgs{
Properties: &digitaltwins.ConnectionPropertiesArgs{
GroupIds: pulumi.StringArray{
pulumi.String("string"),
},
PrivateLinkServiceConnectionState: &digitaltwins.ConnectionPropertiesPrivateLinkServiceConnectionStateArgs{
Description: pulumi.String("string"),
Status: pulumi.String("string"),
ActionsRequired: pulumi.String("string"),
},
},
ResourceGroupName: pulumi.String("string"),
ResourceName: pulumi.String("string"),
PrivateEndpointConnectionName: pulumi.String("string"),
})
var exampleprivateEndpointConnectionResourceResourceFromDigitaltwins = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDigitaltwins", PrivateEndpointConnectionArgs.builder()
.properties(ConnectionPropertiesArgs.builder()
.groupIds("string")
.privateLinkServiceConnectionState(ConnectionPropertiesPrivateLinkServiceConnectionStateArgs.builder()
.description("string")
.status("string")
.actionsRequired("string")
.build())
.build())
.resourceGroupName("string")
.resourceName("string")
.privateEndpointConnectionName("string")
.build());
exampleprivate_endpoint_connection_resource_resource_from_digitaltwins = azure_native.digitaltwins.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDigitaltwins",
properties={
"group_ids": ["string"],
"private_link_service_connection_state": {
"description": "string",
"status": "string",
"actions_required": "string",
},
},
resource_group_name="string",
resource_name_="string",
private_endpoint_connection_name="string")
const exampleprivateEndpointConnectionResourceResourceFromDigitaltwins = new azure_native.digitaltwins.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDigitaltwins", {
properties: {
groupIds: ["string"],
privateLinkServiceConnectionState: {
description: "string",
status: "string",
actionsRequired: "string",
},
},
resourceGroupName: "string",
resourceName: "string",
privateEndpointConnectionName: "string",
});
type: azure-native:digitaltwins:PrivateEndpointConnection
properties:
privateEndpointConnectionName: string
properties:
groupIds:
- string
privateLinkServiceConnectionState:
actionsRequired: string
description: string
status: string
resourceGroupName: string
resourceName: 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:
- Properties
This property is required. Pulumi.Azure Native. Digital Twins. Inputs. Connection Properties - The connection properties.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the DigitalTwinsInstance.
- Resource
Name This property is required. Changes to this property will trigger replacement.
- The name of the DigitalTwinsInstance.
- Private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection.
- Properties
This property is required. ConnectionProperties Args - The connection properties.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the DigitalTwinsInstance.
- Resource
Name This property is required. Changes to this property will trigger replacement.
- The name of the DigitalTwinsInstance.
- Private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection.
- properties
This property is required. ConnectionProperties - The connection properties.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the DigitalTwinsInstance.
- resource
Name This property is required. Changes to this property will trigger replacement.
- The name of the DigitalTwinsInstance.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection.
- properties
This property is required. ConnectionProperties - The connection properties.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the DigitalTwinsInstance.
- resource
Name This property is required. Changes to this property will trigger replacement.
- The name of the DigitalTwinsInstance.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection.
- properties
This property is required. ConnectionProperties Args - The connection properties.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the DigitalTwinsInstance.
- resource_
name This property is required. Changes to this property will trigger replacement.
- The name of the DigitalTwinsInstance.
- private_
endpoint_ connection_ name Changes to this property will trigger replacement.
- The name of the private endpoint connection.
- properties
This property is required. Property Map - The connection properties.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the DigitalTwinsInstance.
- resource
Name This property is required. Changes to this property will trigger replacement.
- The name of the DigitalTwinsInstance.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection.
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateEndpointConnection resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The resource name.
- System
Data Pulumi.Azure Native. Digital Twins. Outputs. System Data Response - Metadata pertaining to creation and last modification of the private endpoint connection.
- Type string
- The resource type.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The resource name.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the private endpoint connection.
- Type string
- The resource type.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The resource name.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the private endpoint connection.
- type String
- The resource type.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The resource name.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the private endpoint connection.
- type string
- The resource type.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The resource name.
- system_
data SystemData Response - Metadata pertaining to creation and last modification of the private endpoint connection.
- type str
- The resource type.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The resource name.
- system
Data Property Map - Metadata pertaining to creation and last modification of the private endpoint connection.
- type String
- The resource type.
Supporting Types
ConnectionProperties, ConnectionPropertiesArgs
- Group
Ids List<string> - The list of group ids for the private endpoint connection.
- Private
Link Pulumi.Service Connection State Azure Native. Digital Twins. Inputs. Connection Properties Private Link Service Connection State - The connection state.
- Group
Ids []string - The list of group ids for the private endpoint connection.
- Private
Link ConnectionService Connection State Properties Private Link Service Connection State - The connection state.
- group
Ids List<String> - The list of group ids for the private endpoint connection.
- private
Link ConnectionService Connection State Properties Private Link Service Connection State - The connection state.
- group
Ids string[] - The list of group ids for the private endpoint connection.
- private
Link ConnectionService Connection State Properties Private Link Service Connection State - The connection state.
- group_
ids Sequence[str] - The list of group ids for the private endpoint connection.
- private_
link_ Connectionservice_ connection_ state Properties Private Link Service Connection State - The connection state.
- group
Ids List<String> - The list of group ids for the private endpoint connection.
- private
Link Property MapService Connection State - The connection state.
ConnectionPropertiesPrivateLinkServiceConnectionState, ConnectionPropertiesPrivateLinkServiceConnectionStateArgs
- Description
This property is required. string - The description for the current state of a private endpoint connection.
- Status
This property is required. string | Pulumi.Azure Native. Digital Twins. Private Link Service Connection Status - The status of a private endpoint connection.
- Actions
Required string - Actions required for a private endpoint connection.
- Description
This property is required. string - The description for the current state of a private endpoint connection.
- Status
This property is required. string | PrivateLink Service Connection Status - The status of a private endpoint connection.
- Actions
Required string - Actions required for a private endpoint connection.
- description
This property is required. String - The description for the current state of a private endpoint connection.
- status
This property is required. String | PrivateLink Service Connection Status - The status of a private endpoint connection.
- actions
Required String - Actions required for a private endpoint connection.
- description
This property is required. string - The description for the current state of a private endpoint connection.
- status
This property is required. string | PrivateLink Service Connection Status - The status of a private endpoint connection.
- actions
Required string - Actions required for a private endpoint connection.
- description
This property is required. str - The description for the current state of a private endpoint connection.
- status
This property is required. str | PrivateLink Service Connection Status - The status of a private endpoint connection.
- actions_
required str - Actions required for a private endpoint connection.
- description
This property is required. String - The description for the current state of a private endpoint connection.
- status
This property is required. String | "Pending" | "Approved" | "Rejected" | "Disconnected" - The status of a private endpoint connection.
- actions
Required String - Actions required for a private endpoint connection.
ConnectionPropertiesResponse, ConnectionPropertiesResponseArgs
- Provisioning
State This property is required. string - The provisioning state.
- Group
Ids List<string> - The list of group ids for the private endpoint connection.
- Private
Endpoint Pulumi.Azure Native. Digital Twins. Inputs. Private Endpoint Response - The private endpoint.
- Private
Link Pulumi.Service Connection State Azure Native. Digital Twins. Inputs. Connection Properties Response Private Link Service Connection State - The connection state.
- Provisioning
State This property is required. string - The provisioning state.
- Group
Ids []string - The list of group ids for the private endpoint connection.
- Private
Endpoint PrivateEndpoint Response - The private endpoint.
- Private
Link ConnectionService Connection State Properties Response Private Link Service Connection State - The connection state.
- provisioning
State This property is required. String - The provisioning state.
- group
Ids List<String> - The list of group ids for the private endpoint connection.
- private
Endpoint PrivateEndpoint Response - The private endpoint.
- private
Link ConnectionService Connection State Properties Response Private Link Service Connection State - The connection state.
- provisioning
State This property is required. string - The provisioning state.
- group
Ids string[] - The list of group ids for the private endpoint connection.
- private
Endpoint PrivateEndpoint Response - The private endpoint.
- private
Link ConnectionService Connection State Properties Response Private Link Service Connection State - The connection state.
- provisioning_
state This property is required. str - The provisioning state.
- group_
ids Sequence[str] - The list of group ids for the private endpoint connection.
- private_
endpoint PrivateEndpoint Response - The private endpoint.
- private_
link_ Connectionservice_ connection_ state Properties Response Private Link Service Connection State - The connection state.
- provisioning
State This property is required. String - The provisioning state.
- group
Ids List<String> - The list of group ids for the private endpoint connection.
- private
Endpoint Property Map - The private endpoint.
- private
Link Property MapService Connection State - The connection state.
ConnectionPropertiesResponsePrivateLinkServiceConnectionState, ConnectionPropertiesResponsePrivateLinkServiceConnectionStateArgs
- Description
This property is required. string - The description for the current state of a private endpoint connection.
- Status
This property is required. string - The status of a private endpoint connection.
- Actions
Required string - Actions required for a private endpoint connection.
- Description
This property is required. string - The description for the current state of a private endpoint connection.
- Status
This property is required. string - The status of a private endpoint connection.
- Actions
Required string - Actions required for a private endpoint connection.
- description
This property is required. String - The description for the current state of a private endpoint connection.
- status
This property is required. String - The status of a private endpoint connection.
- actions
Required String - Actions required for a private endpoint connection.
- description
This property is required. string - The description for the current state of a private endpoint connection.
- status
This property is required. string - The status of a private endpoint connection.
- actions
Required string - Actions required for a private endpoint connection.
- description
This property is required. str - The description for the current state of a private endpoint connection.
- status
This property is required. str - The status of a private endpoint connection.
- actions_
required str - Actions required for a private endpoint connection.
- description
This property is required. String - The description for the current state of a private endpoint connection.
- status
This property is required. String - The status of a private endpoint connection.
- actions
Required String - Actions required for a private endpoint connection.
PrivateEndpointResponse, PrivateEndpointResponseArgs
- Id
This property is required. string - The resource identifier.
- Id
This property is required. string - The resource identifier.
- id
This property is required. String - The resource identifier.
- id
This property is required. string - The resource identifier.
- id
This property is required. str - The resource identifier.
- id
This property is required. String - The resource identifier.
PrivateLinkServiceConnectionStatus, PrivateLinkServiceConnectionStatusArgs
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Disconnected
- Disconnected
- Private
Link Service Connection Status Pending - Pending
- Private
Link Service Connection Status Approved - Approved
- Private
Link Service Connection Status Rejected - Rejected
- Private
Link Service 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 timestamp of resource last modification (UTC)
- 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 timestamp of resource last modification (UTC)
- 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 timestamp of resource last modification (UTC)
- 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 timestamp of resource last modification (UTC)
- 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 timestamp of resource last modification (UTC)
- 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 timestamp of resource last modification (UTC)
- 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:digitaltwins:PrivateEndpointConnection myPrivateConnection /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/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