Microsoft.DocumentDB mongoClusters/privateEndpointConnections
Bicep resource definition
The mongoClusters/privateEndpointConnections resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/mongoClusters/privateEndpointConnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters/privateEndpointConnections@2024-10-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
Property values
Microsoft.DocumentDB/mongoClusters/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: mongoClusters |
| properties | The resource-specific properties for this resource. | PrivateEndpointConnectionProperties |
PrivateEndpoint
| Name | Description | Value |
|---|
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateEndpoint | The private endpoint resource. | PrivateEndpoint |
| privateLinkServiceConnectionState | A collection of information about the state of the connection between service consumer and provider. | PrivateLinkServiceConnectionState (required) |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionsRequired | A message indicating if changes on the service provider require any updates on the consumer. | string |
| description | The reason for approval/rejection of the connection. | string |
| status | Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. | 'Approved' 'Pending' 'Rejected' |
ARM template resource definition
The mongoClusters/privateEndpointConnections resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/mongoClusters/privateEndpointConnections resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/mongoClusters/privateEndpointConnections",
"apiVersion": "2024-10-01-preview",
"name": "string",
"properties": {
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
Property values
Microsoft.DocumentDB/mongoClusters/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-10-01-preview' |
| name | The resource name | string (required) |
| properties | The resource-specific properties for this resource. | PrivateEndpointConnectionProperties |
| type | The resource type | 'Microsoft.DocumentDB/mongoClusters/privateEndpointConnections' |
PrivateEndpoint
| Name | Description | Value |
|---|
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateEndpoint | The private endpoint resource. | PrivateEndpoint |
| privateLinkServiceConnectionState | A collection of information about the state of the connection between service consumer and provider. | PrivateLinkServiceConnectionState (required) |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionsRequired | A message indicating if changes on the service provider require any updates on the consumer. | string |
| description | The reason for approval/rejection of the connection. | string |
| status | Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. | 'Approved' 'Pending' 'Rejected' |
Terraform (AzAPI provider) resource definition
The mongoClusters/privateEndpointConnections resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/mongoClusters/privateEndpointConnections resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters/privateEndpointConnections@2024-10-01-preview"
name = "string"
body = jsonencode({
properties = {
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
})
}
Property values
Microsoft.DocumentDB/mongoClusters/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: mongoClusters |
| properties | The resource-specific properties for this resource. | PrivateEndpointConnectionProperties |
| type | The resource type | "Microsoft.DocumentDB/mongoClusters/privateEndpointConnections@2024-10-01-preview" |
PrivateEndpoint
| Name | Description | Value |
|---|
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateEndpoint | The private endpoint resource. | PrivateEndpoint |
| privateLinkServiceConnectionState | A collection of information about the state of the connection between service consumer and provider. | PrivateLinkServiceConnectionState (required) |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionsRequired | A message indicating if changes on the service provider require any updates on the consumer. | string |
| description | The reason for approval/rejection of the connection. | string |
| status | Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. | 'Approved' 'Pending' 'Rejected' |