Microsoft.DocumentDB (preview:2019-08-01)

2025/10/23 • 6 new, 6 deleted methods

PrivateEndpointConnections_ListByDatabaseAccount (new)
Description :  List all private endpoint connections on a Cosmos DB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Approve or reject a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateLinkResources_ListByDatabaseAccount (new)
Description :  Gets the private link resources that need to be created for a Cosmos DB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource required zone names. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
PrivateLinkResources_Get (new)
Description :  Gets the private link resources that need to be created for a Cosmos DB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource required zone names. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnections_ListByDatabaseAccount (removed)
Description :  List all private endpoint connections on a Cosmos DB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
PrivateEndpointConnections_Get (removed)
Description :  Gets a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Approve or reject a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
groupId:
{
Description: Group id of the private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the private endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Delete (removed)
Description :  Deletes a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateLinkResources_ListByDatabaseAccount (removed)
Description :  Gets the private link resources that need to be created for a Cosmos DB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource required zone names. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
PrivateLinkResources_Get (removed)
Description :  Gets the private link resources that need to be created for a Cosmos DB account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Cosmos DB database account name. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource required zone names. ,
Required: False ,
}
[
string ,
]
,
}
,
}