azure-native.mongocluster.PrivateEndpointConnection
Explore with Pulumi AI
Concrete proxy resource types can be created by aliasing this type using a specific property type.
Uses Azure REST API version 2024-07-01.
Other available API versions: 2024-03-01-preview, 2024-06-01-preview, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native mongocluster [ApiVersion]
. See the version guide for details.
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: PrivateEndpointConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PrivateEndpointConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
mongo_cluster_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
private_endpoint_connection_name: Optional[str] = None,
properties: Optional[PrivateEndpointConnectionPropertiesArgs] = 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:mongocluster: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. PrivateEndpointConnectionArgs - 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 exampleprivateEndpointConnectionResourceResourceFromMongocluster = new AzureNative.MongoCluster.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromMongocluster", new()
{
MongoClusterName = "string",
ResourceGroupName = "string",
PrivateEndpointConnectionName = "string",
Properties = new AzureNative.MongoCluster.Inputs.PrivateEndpointConnectionPropertiesArgs
{
PrivateLinkServiceConnectionState = new AzureNative.MongoCluster.Inputs.PrivateLinkServiceConnectionStateArgs
{
ActionsRequired = "string",
Description = "string",
Status = "string",
},
},
});
example, err := mongocluster.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromMongocluster", &mongocluster.PrivateEndpointConnectionArgs{
MongoClusterName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
PrivateEndpointConnectionName: pulumi.String("string"),
Properties: &mongocluster.PrivateEndpointConnectionPropertiesArgs{
PrivateLinkServiceConnectionState: &mongocluster.PrivateLinkServiceConnectionStateArgs{
ActionsRequired: pulumi.String("string"),
Description: pulumi.String("string"),
Status: pulumi.String("string"),
},
},
})
var exampleprivateEndpointConnectionResourceResourceFromMongocluster = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromMongocluster", PrivateEndpointConnectionArgs.builder()
.mongoClusterName("string")
.resourceGroupName("string")
.privateEndpointConnectionName("string")
.properties(PrivateEndpointConnectionPropertiesArgs.builder()
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
.actionsRequired("string")
.description("string")
.status("string")
.build())
.build())
.build());
exampleprivate_endpoint_connection_resource_resource_from_mongocluster = azure_native.mongocluster.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromMongocluster",
mongo_cluster_name="string",
resource_group_name="string",
private_endpoint_connection_name="string",
properties={
"private_link_service_connection_state": {
"actions_required": "string",
"description": "string",
"status": "string",
},
})
const exampleprivateEndpointConnectionResourceResourceFromMongocluster = new azure_native.mongocluster.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromMongocluster", {
mongoClusterName: "string",
resourceGroupName: "string",
privateEndpointConnectionName: "string",
properties: {
privateLinkServiceConnectionState: {
actionsRequired: "string",
description: "string",
status: "string",
},
},
});
type: azure-native:mongocluster:PrivateEndpointConnection
properties:
mongoClusterName: string
privateEndpointConnectionName: string
properties:
privateLinkServiceConnectionState:
actionsRequired: string
description: string
status: 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:
- Mongo
Cluster Name This property is required. Changes to this property will trigger replacement.
- The name of the mongo cluster.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection associated with the Azure resource.
- Properties
Pulumi.
Azure Native. Mongo Cluster. Inputs. Private Endpoint Connection Properties - The resource-specific properties for this resource.
- Mongo
Cluster Name This property is required. Changes to this property will trigger replacement.
- The name of the mongo cluster.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection associated with the Azure resource.
- Properties
Private
Endpoint Connection Properties Args - The resource-specific properties for this resource.
- mongo
Cluster Name This property is required. Changes to this property will trigger replacement.
- The name of the mongo cluster.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection associated with the Azure resource.
- properties
Private
Endpoint Connection Properties - The resource-specific properties for this resource.
- mongo
Cluster Name This property is required. Changes to this property will trigger replacement.
- The name of the mongo cluster.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection associated with the Azure resource.
- properties
Private
Endpoint Connection Properties - The resource-specific properties for this resource.
- mongo_
cluster_ name This property is required. Changes to this property will trigger replacement.
- The name of the mongo cluster.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- private_
endpoint_ connection_ name Changes to this property will trigger replacement.
- The name of the private endpoint connection associated with the Azure resource.
- properties
Private
Endpoint Connection Properties Args - The resource-specific properties for this resource.
- mongo
Cluster Name This property is required. Changes to this property will trigger replacement.
- The name of the mongo cluster.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- private
Endpoint Connection Name Changes to this property will trigger replacement.
- The name of the private endpoint connection associated with the Azure resource.
- properties Property Map
- The resource-specific properties for this resource.
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 name of the resource
- System
Data Pulumi.Azure Native. Mongo Cluster. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
PrivateEndpointConnectionProperties, PrivateEndpointConnectionPropertiesArgs
- Private
Link Service Connection State This property is required. Pulumi.Azure Native. Mongo Cluster. Inputs. Private Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- Private
Link Service Connection State This property is required. PrivateLink Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- private
Link Service Connection State This property is required. PrivateLink Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- private
Link Service Connection State This property is required. PrivateLink Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- private_
link_ service_ connection_ state This property is required. PrivateLink Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- private
Link Service Connection State This property is required. Property Map - A collection of information about the state of the connection between service consumer and provider.
PrivateEndpointConnectionPropertiesResponse, PrivateEndpointConnectionPropertiesResponseArgs
- Group
Ids This property is required. List<string> - The group ids for the private endpoint resource.
- Private
Link Service Connection State This property is required. Pulumi.Azure Native. Mongo Cluster. Inputs. Private Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State This property is required. string - The provisioning state of the private endpoint connection resource.
- Private
Endpoint Pulumi.Azure Native. Mongo Cluster. Inputs. Private Endpoint Response - The private endpoint resource.
- Group
Ids This property is required. []string - The group ids for the private endpoint resource.
- Private
Link Service Connection State This property is required. PrivateLink Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State This property is required. string - The provisioning state of the private endpoint connection resource.
- Private
Endpoint PrivateEndpoint Response - The private endpoint resource.
- group
Ids This property is required. List<String> - The group ids for the private endpoint resource.
- private
Link Service Connection State This property is required. PrivateLink Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State This property is required. String - The provisioning state of the private endpoint connection resource.
- private
Endpoint PrivateEndpoint Response - The private endpoint resource.
- group
Ids This property is required. string[] - The group ids for the private endpoint resource.
- private
Link Service Connection State This property is required. PrivateLink Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State This property is required. string - The provisioning state of the private endpoint connection resource.
- private
Endpoint PrivateEndpoint Response - The private endpoint resource.
- group_
ids This property is required. Sequence[str] - The group ids for the private endpoint resource.
- private_
link_ service_ connection_ state This property is required. PrivateLink Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning_
state This property is required. str - The provisioning state of the private endpoint connection resource.
- private_
endpoint PrivateEndpoint Response - The private endpoint resource.
- group
Ids This property is required. List<String> - The group ids for the private endpoint resource.
- private
Link Service Connection State This property is required. Property Map - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State This property is required. String - The provisioning state of the private endpoint connection resource.
- private
Endpoint Property Map - The private endpoint resource.
PrivateEndpointResponse, PrivateEndpointResponseArgs
- Id
This property is required. string - The ARM identifier for private endpoint.
- Id
This property is required. string - The ARM identifier for private endpoint.
- id
This property is required. String - The ARM identifier for private endpoint.
- id
This property is required. string - The ARM identifier for private endpoint.
- id
This property is required. str - The ARM identifier for private endpoint.
- id
This property is required. String - The ARM identifier for private endpoint.
PrivateEndpointServiceConnectionStatus, PrivateEndpointServiceConnectionStatusArgs
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Private
Endpoint Service Connection Status Pending - Pending
- Private
Endpoint Service Connection Status Approved - Approved
- Private
Endpoint Service Connection Status Rejected - Rejected
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- PENDING
- Pending
- APPROVED
- Approved
- REJECTED
- Rejected
- "Pending"
- Pending
- "Approved"
- Approved
- "Rejected"
- Rejected
PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status
string | Pulumi.
Azure Native. Mongo Cluster. Private Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status
string | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status
String | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- description string
- The reason for approval/rejection of the connection.
- status
string | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions_
required str - A message indicating if changes on the service provider require any updates on the consumer.
- description str
- The reason for approval/rejection of the connection.
- status
str | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String | "Pending" | "Approved" | "Rejected"
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- description string
- The reason for approval/rejection of the connection.
- status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions_
required str - A message indicating if changes on the service provider require any updates on the consumer.
- description str
- The reason for approval/rejection of the connection.
- status str
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
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:mongocluster:PrivateEndpointConnection pecTest.5d393f64-ef64-46d0-9959-308321c44ac0 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/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