Microsoft.DocumentDB (preview:2025-05-01)

2025/04/27 • 300 new methods

CassandraResources_GetCassandraRoleDefinition (new)
Description Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Definition with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CassandraResources_CreateUpdateCassandraRoleDefinition (new)
Description Creates or updates an Azure Cosmos DB Cassandra Role Definition.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
createUpdateCassandraRoleDefinitionParameters:
{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CassandraResources_DeleteCassandraRoleDefinition (new)
Description Deletes an existing Azure Cosmos DB Cassandra Role Definition.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CassandraResources_ListCassandraRoleDefinitions (new)
Description Retrieves the list of all Azure Cosmos DB Cassandra Role Definitions.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleDefinitions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CassandraResources_GetCassandraRoleAssignment (new)
Description Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Assignment with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CassandraResources_CreateUpdateCassandraRoleAssignment (new)
Description Creates or updates an Azure Cosmos DB Cassandra Role Assignment.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
createUpdateCassandraRoleAssignmentParameters:
{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CassandraResources_DeleteCassandraRoleAssignment (new)
Description Deletes an existing Azure Cosmos DB Cassandra Role Assignment.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CassandraResources_ListCassandraRoleAssignments (new)
Description Retrieves the list of all Azure Cosmos DB Cassandra Role Assignments.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraRoleAssignments
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ChaosFault_List (new)
Description List Chaos Faults for CosmosDB account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
action: enum ,
region: string ,
databaseName: string ,
containerName: string ,
provisioningState: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ChaosFault_EnableDisable (new)
Description Enable, disable Chaos Fault in a CosmosDB account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults/{chaosFault}
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
chaosFault: string ,
chaosFaultRequest:
{
properties:
{
action: enum ,
region: string ,
databaseName: string ,
containerName: string ,
provisioningState: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
action: enum ,
region: string ,
databaseName: string ,
containerName: string ,
provisioningState: string ,
}
,
}

⚐ Response (201)

{
properties:
{
action: enum ,
region: string ,
databaseName: string ,
containerName: string ,
provisioningState: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ChaosFault_Get (new)
Description Get Chaos Fault for a CosmosdB account for a particular Chaos Fault.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults/{chaosFault}
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
chaosFault: string ,
}

⚐ Response (200)

{
properties:
{
action: enum ,
region: string ,
databaseName: string ,
containerName: string ,
provisioningState: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CopyJobs_Create (new)
Description Creates a Copy Job.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
jobCreateParameters:
{
properties:
{
jobProperties:
{
jobType: enum ,
}
,
status: enum ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
jobProperties:
{
jobType: enum ,
}
,
status: enum ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (201)

{
properties:
{
jobProperties:
{
jobType: enum ,
}
,
status: enum ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CopyJobs_Get (new)
Description Get a Copy Job.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
jobProperties:
{
jobType: enum ,
}
,
status: enum ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CopyJobs_Pause (new)
Description Pause a Copy Job.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}/pause
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
jobProperties:
{
jobType: enum ,
}
,
status: enum ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CopyJobs_Resume (new)
Description Resumes a Copy Job.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}/resume
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
jobProperties:
{
jobType: enum ,
}
,
status: enum ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CopyJobs_Cancel (new)
Description Cancels a Copy Job.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}/cancel
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
jobProperties:
{
jobType: enum ,
}
,
status: enum ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CopyJobs_Complete (new)
Description Completes an Online Copy Job.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs/{jobName}/complete
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
jobProperties:
{
jobType: enum ,
}
,
status: enum ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CopyJobs_ListByDatabaseAccount (new)
Description Get a list of Copy jobs.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/copyJobs
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
jobProperties:
{
jobType: enum ,
}
,
status: enum ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
DatabaseAccounts_Get (new)
Description Retrieves the properties of an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
kind: enum ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: string ,
documentEndpoint: string ,
databaseAccountOfferType: enum ,
ipRules:
[
{
ipAddressOrRange: string ,
}
,
]
,
isVirtualNetworkFilterEnabled: boolean ,
enableAutomaticFailover: boolean ,
consistencyPolicy:
{
defaultConsistencyLevel: enum ,
maxStalenessPrefix: integer ,
maxIntervalInSeconds: integer ,
}
,
capabilities:
[
{
name: string ,
}
,
]
,
writeLocations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
readLocations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
locations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
failoverPolicies:
[
{
id: string ,
locationName: string ,
failoverPriority: integer ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
ignoreMissingVNetServiceEndpoint: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: string ,
}
,
}
,
]
,
enableMultipleWriteLocations: boolean ,
enableCassandraConnector: boolean ,
connectorOffer: enum ,
disableKeyBasedMetadataWriteAccess: boolean ,
keyVaultKeyUri: string ,
defaultIdentity: string ,
publicNetworkAccess: enum ,
enableFreeTier: boolean ,
apiProperties:
{
serverVersion: enum ,
}
,
enableAnalyticalStorage: boolean ,
analyticalStorageConfiguration:
{
schemaType: enum ,
}
,
instanceId: string ,
createMode: enum ,
restoreParameters:
{
restoreMode: enum ,
restoreSource: string ,
restoreTimestampInUtc: string ,
databasesToRestore:
[
{
databaseName: string ,
collectionNames:
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
[
{
databaseName: string ,
graphNames:
[
string ,
]
,
}
,
]
,
tablesToRestore:
[
string ,
]
,
sourceBackupLocation: string ,
}
,
backupPolicy:
{
type: enum ,
migrationState:
{
status: enum ,
targetType: enum ,
startTime: string ,
}
,
}
,
cors:
[
{
allowedOrigins: string ,
allowedMethods: string ,
allowedHeaders: string ,
exposedHeaders: string ,
maxAgeInSeconds: integer ,
}
,
]
,
networkAclBypass: enum ,
networkAclBypassResourceIds:
[
string ,
]
,
diagnosticLogSettings:
{
enableFullTextQuery: enum ,
}
,
disableLocalAuth: boolean ,
capacity:
{
totalThroughputLimit: integer ,
}
,
capacityMode: enum ,
capacityModeChangeTransitionState:
{
capacityModeTransitionStatus: enum ,
currentCapacityMode: enum ,
previousCapacityMode: enum ,
capacityModeTransitionBeginTimestamp: string ,
capacityModeTransitionEndTimestamp: string ,
capacityModeLastSuccessfulTransitionEndTimestamp: string ,
}
,
enableMaterializedViews: boolean ,
keysMetadata:
{
primaryMasterKey:
{
generationTime: string ,
}
,
secondaryMasterKey:
{
generationTime: string ,
}
,
primaryReadonlyMasterKey:
{
generationTime: string ,
}
,
secondaryReadonlyMasterKey:
{
generationTime: string ,
}
,
}
,
enablePartitionMerge: boolean ,
enableBurstCapacity: boolean ,
minimalTlsVersion: enum ,
customerManagedKeyStatus: string ,
enablePriorityBasedExecution: boolean ,
defaultPriorityLevel: enum ,
enablePerRegionPerPartitionAutoscale: boolean ,
enableAllVersionsAndDeletesChangeFeed: boolean ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
DatabaseAccounts_Update (new)
Description Updates the properties of an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
updateParameters:
{
tags: object ,
location: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
consistencyPolicy:
{
defaultConsistencyLevel: enum ,
maxStalenessPrefix: integer ,
maxIntervalInSeconds: integer ,
}
,
locations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
ipRules:
[
{
ipAddressOrRange: string ,
}
,
]
,
isVirtualNetworkFilterEnabled: boolean ,
enableAutomaticFailover: boolean ,
capabilities:
[
{
name: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
ignoreMissingVNetServiceEndpoint: boolean ,
}
,
]
,
enableMultipleWriteLocations: boolean ,
enableCassandraConnector: boolean ,
connectorOffer: enum ,
disableKeyBasedMetadataWriteAccess: boolean ,
keyVaultKeyUri: string ,
defaultIdentity: string ,
publicNetworkAccess: enum ,
enableFreeTier: boolean ,
apiProperties:
{
serverVersion: enum ,
}
,
enableAnalyticalStorage: boolean ,
analyticalStorageConfiguration:
{
schemaType: enum ,
}
,
backupPolicy:
{
type: enum ,
migrationState:
{
status: enum ,
targetType: enum ,
startTime: string ,
}
,
}
,
cors:
[
{
allowedOrigins: string ,
allowedMethods: string ,
allowedHeaders: string ,
exposedHeaders: string ,
maxAgeInSeconds: integer ,
}
,
]
,
networkAclBypass: enum ,
networkAclBypassResourceIds:
[
string ,
]
,
diagnosticLogSettings:
{
enableFullTextQuery: enum ,
}
,
disableLocalAuth: boolean ,
capacity:
{
totalThroughputLimit: integer ,
}
,
capacityMode: enum ,
enableMaterializedViews: boolean ,
keysMetadata:
{
primaryMasterKey:
{
generationTime: string ,
}
,
secondaryMasterKey:
{
generationTime: string ,
}
,
primaryReadonlyMasterKey:
{
generationTime: string ,
}
,
secondaryReadonlyMasterKey:
{
generationTime: string ,
}
,
}
,
enablePartitionMerge: boolean ,
enableBurstCapacity: boolean ,
minimalTlsVersion: enum ,
customerManagedKeyStatus: string ,
enablePriorityBasedExecution: boolean ,
defaultPriorityLevel: enum ,
enablePerRegionPerPartitionAutoscale: boolean ,
enableAllVersionsAndDeletesChangeFeed: boolean ,
}
,
}
,
}

⚐ Response (200)

{
kind: enum ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: string ,
documentEndpoint: string ,
databaseAccountOfferType: enum ,
ipRules:
[
{
ipAddressOrRange: string ,
}
,
]
,
isVirtualNetworkFilterEnabled: boolean ,
enableAutomaticFailover: boolean ,
consistencyPolicy:
{
defaultConsistencyLevel: enum ,
maxStalenessPrefix: integer ,
maxIntervalInSeconds: integer ,
}
,
capabilities:
[
{
name: string ,
}
,
]
,
writeLocations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
readLocations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
locations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
failoverPolicies:
[
{
id: string ,
locationName: string ,
failoverPriority: integer ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
ignoreMissingVNetServiceEndpoint: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: string ,
}
,
}
,
]
,
enableMultipleWriteLocations: boolean ,
enableCassandraConnector: boolean ,
connectorOffer: enum ,
disableKeyBasedMetadataWriteAccess: boolean ,
keyVaultKeyUri: string ,
defaultIdentity: string ,
publicNetworkAccess: enum ,
enableFreeTier: boolean ,
apiProperties:
{
serverVersion: enum ,
}
,
enableAnalyticalStorage: boolean ,
analyticalStorageConfiguration:
{
schemaType: enum ,
}
,
instanceId: string ,
createMode: enum ,
restoreParameters:
{
restoreMode: enum ,
restoreSource: string ,
restoreTimestampInUtc: string ,
databasesToRestore:
[
{
databaseName: string ,
collectionNames:
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
[
{
databaseName: string ,
graphNames:
[
string ,
]
,
}
,
]
,
tablesToRestore:
[
string ,
]
,
sourceBackupLocation: string ,
}
,
backupPolicy:
{
type: enum ,
migrationState:
{
status: enum ,
targetType: enum ,
startTime: string ,
}
,
}
,
cors:
[
{
allowedOrigins: string ,
allowedMethods: string ,
allowedHeaders: string ,
exposedHeaders: string ,
maxAgeInSeconds: integer ,
}
,
]
,
networkAclBypass: enum ,
networkAclBypassResourceIds:
[
string ,
]
,
diagnosticLogSettings:
{
enableFullTextQuery: enum ,
}
,
disableLocalAuth: boolean ,
capacity:
{
totalThroughputLimit: integer ,
}
,
capacityMode: enum ,
capacityModeChangeTransitionState:
{
capacityModeTransitionStatus: enum ,
currentCapacityMode: enum ,
previousCapacityMode: enum ,
capacityModeTransitionBeginTimestamp: string ,
capacityModeTransitionEndTimestamp: string ,
capacityModeLastSuccessfulTransitionEndTimestamp: string ,
}
,
enableMaterializedViews: boolean ,
keysMetadata:
{
primaryMasterKey:
{
generationTime: string ,
}
,
secondaryMasterKey:
{
generationTime: string ,
}
,
primaryReadonlyMasterKey:
{
generationTime: string ,
}
,
secondaryReadonlyMasterKey:
{
generationTime: string ,
}
,
}
,
enablePartitionMerge: boolean ,
enableBurstCapacity: boolean ,
minimalTlsVersion: enum ,
customerManagedKeyStatus: string ,
enablePriorityBasedExecution: boolean ,
defaultPriorityLevel: enum ,
enablePerRegionPerPartitionAutoscale: boolean ,
enableAllVersionsAndDeletesChangeFeed: boolean ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
DatabaseAccounts_CreateOrUpdate (new)
Description Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
createUpdateParameters:
{
kind: enum ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
consistencyPolicy:
{
defaultConsistencyLevel: enum ,
maxStalenessPrefix: integer ,
maxIntervalInSeconds: integer ,
}
,
locations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
databaseAccountOfferType: enum ,
ipRules:
[
{
ipAddressOrRange: string ,
}
,
]
,
isVirtualNetworkFilterEnabled: boolean ,
enableAutomaticFailover: boolean ,
capabilities:
[
{
name: string ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
ignoreMissingVNetServiceEndpoint: boolean ,
}
,
]
,
enableMultipleWriteLocations: boolean ,
enableCassandraConnector: boolean ,
connectorOffer: enum ,
disableKeyBasedMetadataWriteAccess: boolean ,
keyVaultKeyUri: string ,
defaultIdentity: string ,
publicNetworkAccess: enum ,
enableFreeTier: boolean ,
apiProperties:
{
serverVersion: enum ,
}
,
enableAnalyticalStorage: boolean ,
analyticalStorageConfiguration:
{
schemaType: enum ,
}
,
createMode: enum ,
backupPolicy:
{
type: enum ,
migrationState:
{
status: enum ,
targetType: enum ,
startTime: string ,
}
,
}
,
cors:
[
{
allowedOrigins: string ,
allowedMethods: string ,
allowedHeaders: string ,
exposedHeaders: string ,
maxAgeInSeconds: integer ,
}
,
]
,
networkAclBypass: enum ,
networkAclBypassResourceIds:
[
string ,
]
,
diagnosticLogSettings:
{
enableFullTextQuery: enum ,
}
,
disableLocalAuth: boolean ,
restoreParameters:
{
restoreMode: enum ,
restoreSource: string ,
restoreTimestampInUtc: string ,
databasesToRestore:
[
{
databaseName: string ,
collectionNames:
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
[
{
databaseName: string ,
graphNames:
[
string ,
]
,
}
,
]
,
tablesToRestore:
[
string ,
]
,
sourceBackupLocation: string ,
}
,
capacity:
{
totalThroughputLimit: integer ,
}
,
capacityMode: enum ,
enableMaterializedViews: boolean ,
keysMetadata:
{
primaryMasterKey:
{
generationTime: string ,
}
,
secondaryMasterKey:
{
generationTime: string ,
}
,
primaryReadonlyMasterKey:
{
generationTime: string ,
}
,
secondaryReadonlyMasterKey:
{
generationTime: string ,
}
,
}
,
enablePartitionMerge: boolean ,
enableBurstCapacity: boolean ,
minimalTlsVersion: enum ,
customerManagedKeyStatus: string ,
enablePriorityBasedExecution: boolean ,
defaultPriorityLevel: enum ,
enablePerRegionPerPartitionAutoscale: boolean ,
enableAllVersionsAndDeletesChangeFeed: boolean ,
}
,
}
,
}

⚐ Response (200)

{
kind: enum ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: string ,
documentEndpoint: string ,
databaseAccountOfferType: enum ,
ipRules:
[
{
ipAddressOrRange: string ,
}
,
]
,
isVirtualNetworkFilterEnabled: boolean ,
enableAutomaticFailover: boolean ,
consistencyPolicy:
{
defaultConsistencyLevel: enum ,
maxStalenessPrefix: integer ,
maxIntervalInSeconds: integer ,
}
,
capabilities:
[
{
name: string ,
}
,
]
,
writeLocations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
readLocations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
locations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
failoverPolicies:
[
{
id: string ,
locationName: string ,
failoverPriority: integer ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
ignoreMissingVNetServiceEndpoint: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: string ,
}
,
}
,
]
,
enableMultipleWriteLocations: boolean ,
enableCassandraConnector: boolean ,
connectorOffer: enum ,
disableKeyBasedMetadataWriteAccess: boolean ,
keyVaultKeyUri: string ,
defaultIdentity: string ,
publicNetworkAccess: enum ,
enableFreeTier: boolean ,
apiProperties:
{
serverVersion: enum ,
}
,
enableAnalyticalStorage: boolean ,
analyticalStorageConfiguration:
{
schemaType: enum ,
}
,
instanceId: string ,
createMode: enum ,
restoreParameters:
{
restoreMode: enum ,
restoreSource: string ,
restoreTimestampInUtc: string ,
databasesToRestore:
[
{
databaseName: string ,
collectionNames:
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
[
{
databaseName: string ,
graphNames:
[
string ,
]
,
}
,
]
,
tablesToRestore:
[
string ,
]
,
sourceBackupLocation: string ,
}
,
backupPolicy:
{
type: enum ,
migrationState:
{
status: enum ,
targetType: enum ,
startTime: string ,
}
,
}
,
cors:
[
{
allowedOrigins: string ,
allowedMethods: string ,
allowedHeaders: string ,
exposedHeaders: string ,
maxAgeInSeconds: integer ,
}
,
]
,
networkAclBypass: enum ,
networkAclBypassResourceIds:
[
string ,
]
,
diagnosticLogSettings:
{
enableFullTextQuery: enum ,
}
,
disableLocalAuth: boolean ,
capacity:
{
totalThroughputLimit: integer ,
}
,
capacityMode: enum ,
capacityModeChangeTransitionState:
{
capacityModeTransitionStatus: enum ,
currentCapacityMode: enum ,
previousCapacityMode: enum ,
capacityModeTransitionBeginTimestamp: string ,
capacityModeTransitionEndTimestamp: string ,
capacityModeLastSuccessfulTransitionEndTimestamp: string ,
}
,
enableMaterializedViews: boolean ,
keysMetadata:
{
primaryMasterKey:
{
generationTime: string ,
}
,
secondaryMasterKey:
{
generationTime: string ,
}
,
primaryReadonlyMasterKey:
{
generationTime: string ,
}
,
secondaryReadonlyMasterKey:
{
generationTime: string ,
}
,
}
,
enablePartitionMerge: boolean ,
enableBurstCapacity: boolean ,
minimalTlsVersion: enum ,
customerManagedKeyStatus: string ,
enablePriorityBasedExecution: boolean ,
defaultPriorityLevel: enum ,
enablePerRegionPerPartitionAutoscale: boolean ,
enableAllVersionsAndDeletesChangeFeed: boolean ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
DatabaseAccounts_Delete (new)
Description Deletes an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
DatabaseAccounts_FailoverPriorityChange (new)
Description Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
failoverParameters:
{
failoverPolicies:
[
{
id: string ,
locationName: string ,
failoverPriority: integer ,
}
,
]
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
DatabaseAccounts_List (new)
Description Lists all the Azure Cosmos DB database accounts available under the subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
kind: enum ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: string ,
documentEndpoint: string ,
databaseAccountOfferType: enum ,
ipRules:
[
{
ipAddressOrRange: string ,
}
,
]
,
isVirtualNetworkFilterEnabled: boolean ,
enableAutomaticFailover: boolean ,
consistencyPolicy:
{
defaultConsistencyLevel: enum ,
maxStalenessPrefix: integer ,
maxIntervalInSeconds: integer ,
}
,
capabilities:
[
{
name: string ,
}
,
]
,
writeLocations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
readLocations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
locations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
failoverPolicies:
[
{
id: string ,
locationName: string ,
failoverPriority: integer ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
ignoreMissingVNetServiceEndpoint: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: string ,
}
,
}
,
]
,
enableMultipleWriteLocations: boolean ,
enableCassandraConnector: boolean ,
connectorOffer: enum ,
disableKeyBasedMetadataWriteAccess: boolean ,
keyVaultKeyUri: string ,
defaultIdentity: string ,
publicNetworkAccess: enum ,
enableFreeTier: boolean ,
apiProperties:
{
serverVersion: enum ,
}
,
enableAnalyticalStorage: boolean ,
analyticalStorageConfiguration:
{
schemaType: enum ,
}
,
instanceId: string ,
createMode: enum ,
restoreParameters:
{
restoreMode: enum ,
restoreSource: string ,
restoreTimestampInUtc: string ,
databasesToRestore:
[
{
databaseName: string ,
collectionNames:
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
[
{
databaseName: string ,
graphNames:
[
string ,
]
,
}
,
]
,
tablesToRestore:
[
string ,
]
,
sourceBackupLocation: string ,
}
,
backupPolicy:
{
type: enum ,
migrationState:
{
status: enum ,
targetType: enum ,
startTime: string ,
}
,
}
,
cors:
[
{
allowedOrigins: string ,
allowedMethods: string ,
allowedHeaders: string ,
exposedHeaders: string ,
maxAgeInSeconds: integer ,
}
,
]
,
networkAclBypass: enum ,
networkAclBypassResourceIds:
[
string ,
]
,
diagnosticLogSettings:
{
enableFullTextQuery: enum ,
}
,
disableLocalAuth: boolean ,
capacity:
{
totalThroughputLimit: integer ,
}
,
capacityMode: enum ,
capacityModeChangeTransitionState:
{
capacityModeTransitionStatus: enum ,
currentCapacityMode: enum ,
previousCapacityMode: enum ,
capacityModeTransitionBeginTimestamp: string ,
capacityModeTransitionEndTimestamp: string ,
capacityModeLastSuccessfulTransitionEndTimestamp: string ,
}
,
enableMaterializedViews: boolean ,
keysMetadata:
{
primaryMasterKey:
{
generationTime: string ,
}
,
secondaryMasterKey:
{
generationTime: string ,
}
,
primaryReadonlyMasterKey:
{
generationTime: string ,
}
,
secondaryReadonlyMasterKey:
{
generationTime: string ,
}
,
}
,
enablePartitionMerge: boolean ,
enableBurstCapacity: boolean ,
minimalTlsVersion: enum ,
customerManagedKeyStatus: string ,
enablePriorityBasedExecution: boolean ,
defaultPriorityLevel: enum ,
enablePerRegionPerPartitionAutoscale: boolean ,
enableAllVersionsAndDeletesChangeFeed: boolean ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
,
]
,
}
DatabaseAccounts_ListByResourceGroup (new)
Description Lists all the Azure Cosmos DB database accounts available under the given resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts
{
resourceGroupName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
kind: enum ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: string ,
documentEndpoint: string ,
databaseAccountOfferType: enum ,
ipRules:
[
{
ipAddressOrRange: string ,
}
,
]
,
isVirtualNetworkFilterEnabled: boolean ,
enableAutomaticFailover: boolean ,
consistencyPolicy:
{
defaultConsistencyLevel: enum ,
maxStalenessPrefix: integer ,
maxIntervalInSeconds: integer ,
}
,
capabilities:
[
{
name: string ,
}
,
]
,
writeLocations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
readLocations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
locations:
[
{
id: string ,
locationName: string ,
documentEndpoint: string ,
provisioningState: string ,
failoverPriority: integer ,
isZoneRedundant: boolean ,
}
,
]
,
failoverPolicies:
[
{
id: string ,
locationName: string ,
failoverPriority: integer ,
}
,
]
,
virtualNetworkRules:
[
{
id: string ,
ignoreMissingVNetServiceEndpoint: boolean ,
}
,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: string ,
}
,
}
,
]
,
enableMultipleWriteLocations: boolean ,
enableCassandraConnector: boolean ,
connectorOffer: enum ,
disableKeyBasedMetadataWriteAccess: boolean ,
keyVaultKeyUri: string ,
defaultIdentity: string ,
publicNetworkAccess: enum ,
enableFreeTier: boolean ,
apiProperties:
{
serverVersion: enum ,
}
,
enableAnalyticalStorage: boolean ,
analyticalStorageConfiguration:
{
schemaType: enum ,
}
,
instanceId: string ,
createMode: enum ,
restoreParameters:
{
restoreMode: enum ,
restoreSource: string ,
restoreTimestampInUtc: string ,
databasesToRestore:
[
{
databaseName: string ,
collectionNames:
[
string ,
]
,
}
,
]
,
gremlinDatabasesToRestore:
[
{
databaseName: string ,
graphNames:
[
string ,
]
,
}
,
]
,
tablesToRestore:
[
string ,
]
,
sourceBackupLocation: string ,
}
,
backupPolicy:
{
type: enum ,
migrationState:
{
status: enum ,
targetType: enum ,
startTime: string ,
}
,
}
,
cors:
[
{
allowedOrigins: string ,
allowedMethods: string ,
allowedHeaders: string ,
exposedHeaders: string ,
maxAgeInSeconds: integer ,
}
,
]
,
networkAclBypass: enum ,
networkAclBypassResourceIds:
[
string ,
]
,
diagnosticLogSettings:
{
enableFullTextQuery: enum ,
}
,
disableLocalAuth: boolean ,
capacity:
{
totalThroughputLimit: integer ,
}
,
capacityMode: enum ,
capacityModeChangeTransitionState:
{
capacityModeTransitionStatus: enum ,
currentCapacityMode: enum ,
previousCapacityMode: enum ,
capacityModeTransitionBeginTimestamp: string ,
capacityModeTransitionEndTimestamp: string ,
capacityModeLastSuccessfulTransitionEndTimestamp: string ,
}
,
enableMaterializedViews: boolean ,
keysMetadata:
{
primaryMasterKey:
{
generationTime: string ,
}
,
secondaryMasterKey:
{
generationTime: string ,
}
,
primaryReadonlyMasterKey:
{
generationTime: string ,
}
,
secondaryReadonlyMasterKey:
{
generationTime: string ,
}
,
}
,
enablePartitionMerge: boolean ,
enableBurstCapacity: boolean ,
minimalTlsVersion: enum ,
customerManagedKeyStatus: string ,
enablePriorityBasedExecution: boolean ,
defaultPriorityLevel: enum ,
enablePerRegionPerPartitionAutoscale: boolean ,
enableAllVersionsAndDeletesChangeFeed: boolean ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
,
]
,
}
DatabaseAccounts_ListKeys (new)
Description Lists the access keys for the specified Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
primaryMasterKey: string ,
secondaryMasterKey: string ,
}
DatabaseAccounts_ListConnectionStrings (new)
Description Lists the connection strings for the specified Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
connectionStrings:
[
{
connectionString: string ,
description: string ,
keyKind: enum ,
type: enum ,
}
,
]
,
}
DatabaseAccounts_OfflineRegion (new)
Description Offline the specified region for the specified Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
regionParameterForOffline:
{
region: string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
DatabaseAccounts_OnlineRegion (new)
Description Online the specified region for the specified Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
regionParameterForOnline:
{
region: string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
DatabaseAccounts_GetReadOnlyKeys (new)
Description Lists the read-only access keys for the specified Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
primaryReadonlyMasterKey: string ,
secondaryReadonlyMasterKey: string ,
}
DatabaseAccounts_ListReadOnlyKeys (new)
Description Lists the read-only access keys for the specified Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
primaryReadonlyMasterKey: string ,
secondaryReadonlyMasterKey: string ,
}
DatabaseAccounts_RegenerateKey (new)
Description Regenerates an access key for the specified Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
keyToRegenerate:
{
keyKind: enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}
DatabaseAccounts_CheckNameExists (new)
Description Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.
Reference Link ¶

⚼ Request

HEAD:  /providers/Microsoft.DocumentDB/databaseAccountNames/{accountName}
{
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
Operations_List (new)
Description Lists all of the available Cosmos DB Resource Provider operations.
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.DocumentDB/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
Provider: string ,
Resource: string ,
Operation: string ,
Description: string ,
}
,
}
,
]
,
nextLink: string ,
}
DatabaseAccounts_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
startTime: string ,
endTime: string ,
timeGrain: string ,
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
metricValues:
[
{
_count: number ,
average: number ,
maximum: number ,
minimum: number ,
timestamp: string ,
total: number ,
}
,
]
,
}
,
]
,
}
Database_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given database account and database.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseRid: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
startTime: string ,
endTime: string ,
timeGrain: string ,
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
metricValues:
[
{
_count: number ,
average: number ,
maximum: number ,
minimum: number ,
timestamp: string ,
total: number ,
}
,
]
,
}
,
]
,
}
Collection_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given database account and collection.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseRid: string ,
collectionRid: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
startTime: string ,
endTime: string ,
timeGrain: string ,
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
metricValues:
[
{
_count: number ,
average: number ,
maximum: number ,
minimum: number ,
timestamp: string ,
total: number ,
}
,
]
,
}
,
]
,
}
CollectionRegion_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given database account, collection and region.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
region: string ,
databaseRid: string ,
collectionRid: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
startTime: string ,
endTime: string ,
timeGrain: string ,
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
metricValues:
[
{
_count: number ,
average: number ,
maximum: number ,
minimum: number ,
timestamp: string ,
total: number ,
}
,
]
,
}
,
]
,
}
DatabaseAccountRegion_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given database account and region.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
region: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
startTime: string ,
endTime: string ,
timeGrain: string ,
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
metricValues:
[
{
_count: number ,
average: number ,
maximum: number ,
minimum: number ,
timestamp: string ,
total: number ,
}
,
]
,
}
,
]
,
}
PercentileSourceTarget_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
sourceRegion: string ,
targetRegion: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
startTime: string ,
endTime: string ,
timeGrain: string ,
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
metricValues:
[
{
P10: number ,
P25: number ,
P50: number ,
P75: number ,
P90: number ,
P95: number ,
P99: number ,
}
,
]
,
}
,
]
,
}
PercentileTarget_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
targetRegion: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
startTime: string ,
endTime: string ,
timeGrain: string ,
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
metricValues:
[
{
P10: number ,
P25: number ,
P50: number ,
P75: number ,
P90: number ,
P95: number ,
P99: number ,
}
,
]
,
}
,
]
,
}
Percentile_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
startTime: string ,
endTime: string ,
timeGrain: string ,
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
metricValues:
[
{
P10: number ,
P25: number ,
P50: number ,
P75: number ,
P90: number ,
P95: number ,
P99: number ,
}
,
]
,
}
,
]
,
}
CollectionPartitionRegion_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given collection and region, split by partition.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
region: string ,
databaseRid: string ,
collectionRid: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
partitionId: string ,
partitionKeyRangeId: string ,
}
,
]
,
}
CollectionPartition_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given collection, split by partition.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseRid: string ,
collectionRid: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
partitionId: string ,
partitionKeyRangeId: string ,
}
,
]
,
}
PartitionKeyRangeId_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given partition key range id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseRid: string ,
collectionRid: string ,
partitionKeyRangeId: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
partitionId: string ,
partitionKeyRangeId: string ,
}
,
]
,
}
PartitionKeyRangeIdRegion_ListMetrics (new)
Description Retrieves the metrics determined by the given filter for the given partition key range id and region.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
region: string ,
databaseRid: string ,
collectionRid: string ,
partitionKeyRangeId: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
partitionId: string ,
partitionKeyRangeId: string ,
}
,
]
,
}
DatabaseAccounts_ListUsages (new)
Description Retrieves the usages (most recent data) for the given database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
quotaPeriod: string ,
limit: integer ,
currentValue: integer ,
}
,
]
,
}
Database_ListUsages (new)
Description Retrieves the usages (most recent data) for the given database.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseRid: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
quotaPeriod: string ,
limit: integer ,
currentValue: integer ,
}
,
]
,
}
Collection_ListUsages (new)
Description Retrieves the usages (most recent storage data) for the given collection.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseRid: string ,
collectionRid: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
unit: enum ,
name:
{
value: string ,
localizedValue: string ,
}
,
quotaPeriod: string ,
limit: integer ,
currentValue: integer ,
}
,
]
,
}
CollectionPartition_ListUsages (new)
Description Retrieves the usages (most recent storage data) for the given collection, split by partition.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseRid: string ,
collectionRid: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
partitionId: string ,
partitionKeyRangeId: string ,
}
,
]
,
}
Database_ListMetricDefinitions (new)
Description Retrieves metric definitions for the given database.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseRid: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
metricAvailabilities:
[
{
timeGrain: string ,
retention: string ,
}
,
]
,
primaryAggregationType: enum ,
unit: enum ,
resourceUri: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
}
,
]
,
}
Collection_ListMetricDefinitions (new)
Description Retrieves metric definitions for the given collection.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseRid: string ,
collectionRid: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
metricAvailabilities:
[
{
timeGrain: string ,
retention: string ,
}
,
]
,
primaryAggregationType: enum ,
unit: enum ,
resourceUri: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
}
,
]
,
}
DatabaseAccounts_ListMetricDefinitions (new)
Description Retrieves metric definitions for the given database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
metricAvailabilities:
[
{
timeGrain: string ,
retention: string ,
}
,
]
,
primaryAggregationType: enum ,
unit: enum ,
resourceUri: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
}
,
]
,
}
GraphResources_ListGraphs (new)
Description Lists the graphs under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: object ,
options: string ,
}
,
}
,
]
,
}
GraphResources_GetGraph (new)
Description Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs/{graphName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
graphName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: object ,
options: string ,
}
,
}
GraphResources_CreateUpdateGraph (new)
Description Create or update an Azure Cosmos DB Graph.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs/{graphName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
graphName: string ,
api-version: string ,
createUpdateGraphParameters:
{
properties:
{
resource:
{
id: string ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: object ,
options: string ,
}
,
}
GraphResources_DeleteGraphResource (new)
Description Deletes an existing Azure Cosmos DB Graph Resource.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs/{graphName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
graphName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
SqlResources_ListSqlDatabases (new)
Description Lists the SQL databases under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource:
{
_colls: string ,
_users: string ,
}
,
options: string ,
}
,
}
,
]
,
}
SqlResources_GetSqlDatabase (new)
Description Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource:
{
_colls: string ,
_users: string ,
}
,
options: string ,
}
,
}
SqlResources_CreateUpdateSqlDatabase (new)
Description Create or update an Azure Cosmos DB SQL database
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
createUpdateSqlDatabaseParameters:
{
properties:
{
resource:
{
id: string ,
restoreParameters: object ,
createMode: enum ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource:
{
_colls: string ,
_users: string ,
}
,
options: string ,
}
,
}
SqlResources_DeleteSqlDatabase (new)
Description Deletes an existing Azure Cosmos DB SQL database.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
SqlResources_GetSqlDatabaseThroughput (new)
Description Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_UpdateSqlDatabaseThroughput (new)
Description Update RUs per second of an Azure Cosmos DB SQL database
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
updateThroughputParameters:
{
properties:
{
resource:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
autoUpgradePolicy:
{
throughputPolicy:
{
isEnabled: boolean ,
incrementPercent: integer ,
}
,
}
,
targetMaxThroughput: integer ,
}
,
minimumThroughput: string ,
offerReplacePending: string ,
instantMaximumThroughput: string ,
softAllowedMaximumThroughput: string ,
throughputBuckets:
[
{
id: integer ,
maxThroughputPercentage: integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_MigrateSqlDatabaseToAutoscale (new)
Description Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_MigrateSqlDatabaseToManualThroughput (new)
Description Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_ListClientEncryptionKeys (new)
Description Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
}
,
}
,
]
,
}
SqlResources_GetClientEncryptionKey (new)
Description Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
clientEncryptionKeyName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_CreateUpdateClientEncryptionKey (new)
Description Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
clientEncryptionKeyName: string ,
api-version: string ,
createUpdateClientEncryptionKeyParameters:
{
properties:
{
resource:
{
id: string ,
encryptionAlgorithm: string ,
wrappedDataEncryptionKey: string ,
keyWrapMetadata:
{
name: string ,
type: string ,
value: string ,
algorithm: string ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_ListSqlContainers (new)
Description Lists the SQL container under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
options: string ,
}
,
}
,
]
,
}
SqlResources_GetSqlContainer (new)
Description Gets the SQL container under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
SqlResources_CreateUpdateSqlContainer (new)
Description Create or update an Azure Cosmos DB SQL container
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
createUpdateSqlContainerParameters:
{
properties:
{
resource:
{
id: string ,
indexingPolicy:
{
automatic: boolean ,
indexingMode: enum ,
includedPaths:
[
{
path: string ,
indexes:
[
{
dataType: enum ,
precision: integer ,
kind: enum ,
}
,
]
,
}
,
]
,
excludedPaths:
[
{
path: string ,
}
,
]
,
compositeIndexes:
[
{
path: string ,
order: enum ,
}
,
]
,
spatialIndexes:
[
{
path: string ,
types:
[
string ,
]
,
}
,
]
,
vectorIndexes:
[
{
path: string ,
type: enum ,
}
,
]
,
}
,
partitionKey:
{
paths:
[
string ,
]
,
kind: enum ,
version: integer ,
systemKey: boolean ,
}
,
defaultTtl: integer ,
uniqueKeyPolicy:
{
uniqueKeys:
[
{
paths:
[
string ,
]
,
}
,
]
,
}
,
conflictResolutionPolicy:
{
mode: enum ,
conflictResolutionPath: string ,
conflictResolutionProcedure: string ,
}
,
clientEncryptionPolicy:
{
includedPaths:
[
{
path: string ,
clientEncryptionKeyId: string ,
encryptionType: string ,
encryptionAlgorithm: string ,
}
,
]
,
policyFormatVersion: integer ,
}
,
analyticalStorageTtl: integer ,
restoreParameters: object ,
createMode: enum ,
materializedViewDefinition:
{
sourceCollectionRid: string ,
sourceCollectionId: string ,
definition: string ,
}
,
materializedViews:
[
{
id: string ,
_rid: string ,
}
,
]
,
computedProperties:
[
{
name: string ,
query: string ,
}
,
]
,
vectorEmbeddingPolicy:
{
vectorEmbeddings:
[
{
path: string ,
dataType: enum ,
distanceFunction: enum ,
dimensions: integer ,
}
,
]
,
}
,
fullTextPolicy:
{
defaultLanguage: string ,
fullTextPaths:
[
{
path: string ,
language: string ,
}
,
]
,
}
,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
SqlResources_DeleteSqlContainer (new)
Description Deletes an existing Azure Cosmos DB SQL container.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
SqlResources_SqlDatabasePartitionMerge (new)
Description Merges the partitions of a SQL database
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/partitionMerge
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
mergeParameters:
{
isDryRun: boolean ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
physicalPartitionStorageInfoCollection:
[
{
id: string ,
storageInKB: number ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_ListSqlContainerPartitionMerge (new)
Description Merges the partitions of a SQL Container
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/partitionMerge
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
mergeParameters:
{
isDryRun: boolean ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
physicalPartitionStorageInfoCollection:
[
{
id: string ,
storageInKB: number ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_GetSqlContainerThroughput (new)
Description Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_UpdateSqlContainerThroughput (new)
Description Update RUs per second of an Azure Cosmos DB SQL container
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
updateThroughputParameters:
{
properties:
{
resource:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
autoUpgradePolicy:
{
throughputPolicy:
{
isEnabled: boolean ,
incrementPercent: integer ,
}
,
}
,
targetMaxThroughput: integer ,
}
,
minimumThroughput: string ,
offerReplacePending: string ,
instantMaximumThroughput: string ,
softAllowedMaximumThroughput: string ,
throughputBuckets:
[
{
id: integer ,
maxThroughputPercentage: integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_MigrateSqlContainerToAutoscale (new)
Description Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_MigrateSqlContainerToManualThroughput (new)
Description Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_SqlDatabaseRetrieveThroughputDistribution (new)
Description Retrieve throughput distribution for an Azure Cosmos DB SQL database
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
retrieveThroughputParameters:
{
properties:
{
resource:
{
physicalPartitionIds:
[
{
id: string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_SqlDatabaseRedistributeThroughput (new)
Description Redistribute throughput for an Azure Cosmos DB SQL database
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/redistributeThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
redistributeThroughputParameters:
{
properties:
{
resource:
{
throughputPolicy: enum ,
targetPhysicalPartitionThroughputInfo:
[
{
id: string ,
throughput: number ,
targetThroughput: number ,
}
,
]
,
sourcePhysicalPartitionThroughputInfo:
[
{
id: string ,
throughput: number ,
targetThroughput: number ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_SqlContainerRetrieveThroughputDistribution (new)
Description Retrieve throughput distribution for an Azure Cosmos DB SQL container
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/retrieveThroughputDistribution
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
retrieveThroughputParameters:
{
properties:
{
resource:
{
physicalPartitionIds:
[
{
id: string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_SqlContainerRedistributeThroughput (new)
Description Redistribute throughput for an Azure Cosmos DB SQL container
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/redistributeThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
redistributeThroughputParameters:
{
properties:
{
resource:
{
throughputPolicy: enum ,
targetPhysicalPartitionThroughputInfo:
[
{
id: string ,
throughput: number ,
targetThroughput: number ,
}
,
]
,
sourcePhysicalPartitionThroughputInfo:
[
{
id: string ,
throughput: number ,
targetThroughput: number ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_ListSqlStoredProcedures (new)
Description Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_GetSqlStoredProcedure (new)
Description Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
storedProcedureName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_CreateUpdateSqlStoredProcedure (new)
Description Create or update an Azure Cosmos DB SQL storedProcedure
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
storedProcedureName: string ,
api-version: string ,
createUpdateSqlStoredProcedureParameters:
{
properties:
{
resource:
{
id: string ,
body: string ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_DeleteSqlStoredProcedure (new)
Description Deletes an existing Azure Cosmos DB SQL storedProcedure.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
storedProcedureName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
SqlResources_ListSqlUserDefinedFunctions (new)
Description Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
}
,
}
,
]
,
}
SqlResources_GetSqlUserDefinedFunction (new)
Description Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
userDefinedFunctionName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_CreateUpdateSqlUserDefinedFunction (new)
Description Create or update an Azure Cosmos DB SQL userDefinedFunction
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
userDefinedFunctionName: string ,
api-version: string ,
createUpdateSqlUserDefinedFunctionParameters:
{
properties:
{
resource:
{
id: string ,
body: string ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_DeleteSqlUserDefinedFunction (new)
Description Deletes an existing Azure Cosmos DB SQL userDefinedFunction.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
userDefinedFunctionName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
SqlResources_ListSqlTriggers (new)
Description Lists the SQL trigger under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
}
,
}
,
]
,
}
SqlResources_GetSqlTrigger (new)
Description Gets the SQL trigger under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
triggerName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_CreateUpdateSqlTrigger (new)
Description Create or update an Azure Cosmos DB SQL trigger
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
triggerName: string ,
api-version: string ,
createUpdateSqlTriggerParameters:
{
properties:
{
resource:
{
id: string ,
body: string ,
triggerType: enum ,
triggerOperation: enum ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
SqlResources_DeleteSqlTrigger (new)
Description Deletes an existing Azure Cosmos DB SQL trigger.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
triggerName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
MongoDBResources_ListMongoDBDatabases (new)
Description Lists the MongoDB databases under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
options: string ,
}
,
}
,
]
,
}
MongoDBResources_GetMongoDBDatabase (new)
Description Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
MongoDBResources_CreateUpdateMongoDBDatabase (new)
Description Create or updates Azure Cosmos DB MongoDB database
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
createUpdateMongoDBDatabaseParameters:
{
properties:
{
resource:
{
id: string ,
restoreParameters: object ,
createMode: enum ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
MongoDBResources_DeleteMongoDBDatabase (new)
Description Deletes an existing Azure Cosmos DB MongoDB database.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
MongoDBResources_GetMongoDBDatabaseThroughput (new)
Description Gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
MongoDBResources_UpdateMongoDBDatabaseThroughput (new)
Description Update RUs per second of the an Azure Cosmos DB MongoDB database
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
updateThroughputParameters:
{
properties:
{
resource:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
autoUpgradePolicy:
{
throughputPolicy:
{
isEnabled: boolean ,
incrementPercent: integer ,
}
,
}
,
targetMaxThroughput: integer ,
}
,
minimumThroughput: string ,
offerReplacePending: string ,
instantMaximumThroughput: string ,
softAllowedMaximumThroughput: string ,
throughputBuckets:
[
{
id: integer ,
maxThroughputPercentage: integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_MigrateMongoDBDatabaseToAutoscale (new)
Description Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_MigrateMongoDBDatabaseToManualThroughput (new)
Description Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_MongoDBDatabaseRetrieveThroughputDistribution (new)
Description Retrieve throughput distribution for an Azure Cosmos DB MongoDB database
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
retrieveThroughputParameters:
{
properties:
{
resource:
{
physicalPartitionIds:
[
{
id: string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_MongoDBDatabaseRedistributeThroughput (new)
Description Redistribute throughput for an Azure Cosmos DB MongoDB database
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/redistributeThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
redistributeThroughputParameters:
{
properties:
{
resource:
{
throughputPolicy: enum ,
targetPhysicalPartitionThroughputInfo:
[
{
id: string ,
throughput: number ,
targetThroughput: number ,
}
,
]
,
sourcePhysicalPartitionThroughputInfo:
[
{
id: string ,
throughput: number ,
targetThroughput: number ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_MongoDBContainerRetrieveThroughputDistribution (new)
Description Retrieve throughput distribution for an Azure Cosmos DB MongoDB container
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/retrieveThroughputDistribution
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
retrieveThroughputParameters:
{
properties:
{
resource:
{
physicalPartitionIds:
[
{
id: string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_MongoDBContainerRedistributeThroughput (new)
Description Redistribute throughput for an Azure Cosmos DB MongoDB container
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/redistributeThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
redistributeThroughputParameters:
{
properties:
{
resource:
{
throughputPolicy: enum ,
targetPhysicalPartitionThroughputInfo:
[
{
id: string ,
throughput: number ,
targetThroughput: number ,
}
,
]
,
sourcePhysicalPartitionThroughputInfo:
[
{
id: string ,
throughput: number ,
targetThroughput: number ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_ListMongoDBCollections (new)
Description Lists the MongoDB collection under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
options: string ,
}
,
}
,
]
,
}
MongoDBResources_GetMongoDBCollection (new)
Description Gets the MongoDB collection under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
MongoDBResources_CreateUpdateMongoDBCollection (new)
Description Create or update an Azure Cosmos DB MongoDB Collection
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
createUpdateMongoDBCollectionParameters:
{
properties:
{
resource:
{
id: string ,
shardKey: object ,
indexes:
[
{
key:
{
keys:
[
string ,
]
,
}
,
options:
{
expireAfterSeconds: integer ,
unique: boolean ,
}
,
}
,
]
,
analyticalStorageTtl: integer ,
restoreParameters: object ,
createMode: enum ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
MongoDBResources_DeleteMongoDBCollection (new)
Description Deletes an existing Azure Cosmos DB MongoDB Collection.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
MongoDBResources_MongoDBDatabasePartitionMerge (new)
Description Merges the partitions of a MongoDB database
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/partitionMerge
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
mergeParameters:
{
isDryRun: boolean ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
physicalPartitionStorageInfoCollection:
[
{
id: string ,
storageInKB: number ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_ListMongoDBCollectionPartitionMerge (new)
Description Merges the partitions of a MongoDB Collection
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/partitionMerge
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
mergeParameters:
{
isDryRun: boolean ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
physicalPartitionStorageInfoCollection:
[
{
id: string ,
storageInKB: number ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_GetMongoDBCollectionThroughput (new)
Description Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
MongoDBResources_UpdateMongoDBCollectionThroughput (new)
Description Update the RUs per second of an Azure Cosmos DB MongoDB collection
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
updateThroughputParameters:
{
properties:
{
resource:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
autoUpgradePolicy:
{
throughputPolicy:
{
isEnabled: boolean ,
incrementPercent: integer ,
}
,
}
,
targetMaxThroughput: integer ,
}
,
minimumThroughput: string ,
offerReplacePending: string ,
instantMaximumThroughput: string ,
softAllowedMaximumThroughput: string ,
throughputBuckets:
[
{
id: integer ,
maxThroughputPercentage: integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
MongoDBResources_MigrateMongoDBCollectionToAutoscale (new)
Description Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_MigrateMongoDBCollectionToManualThroughput (new)
Description Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
TableResources_ListTables (new)
Description Lists the Tables under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
options: string ,
}
,
}
,
]
,
}
TableResources_GetTable (new)
Description Gets the Tables under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
tableName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
TableResources_CreateUpdateTable (new)
Description Create or update an Azure Cosmos DB Table
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
tableName: string ,
api-version: string ,
createUpdateTableParameters:
{
properties:
{
resource:
{
id: string ,
restoreParameters: object ,
createMode: enum ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
TableResources_DeleteTable (new)
Description Deletes an existing Azure Cosmos DB Table.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
tableName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
TableResources_GetTableThroughput (new)
Description Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
tableName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
TableResources_UpdateTableThroughput (new)
Description Update RUs per second of an Azure Cosmos DB Table
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
tableName: string ,
api-version: string ,
updateThroughputParameters:
{
properties:
{
resource:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
autoUpgradePolicy:
{
throughputPolicy:
{
isEnabled: boolean ,
incrementPercent: integer ,
}
,
}
,
targetMaxThroughput: integer ,
}
,
minimumThroughput: string ,
offerReplacePending: string ,
instantMaximumThroughput: string ,
softAllowedMaximumThroughput: string ,
throughputBuckets:
[
{
id: integer ,
maxThroughputPercentage: integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
TableResources_MigrateTableToAutoscale (new)
Description Migrate an Azure Cosmos DB Table from manual throughput to autoscale
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
tableName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
TableResources_MigrateTableToManualThroughput (new)
Description Migrate an Azure Cosmos DB Table from autoscale to manual throughput
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
tableName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraResources_ListCassandraKeyspaces (new)
Description Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
options: string ,
}
,
}
,
]
,
}
CassandraResources_GetCassandraKeyspace (new)
Description Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
CassandraResources_CreateUpdateCassandraKeyspace (new)
Description Create or update an Azure Cosmos DB Cassandra keyspace
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
api-version: string ,
createUpdateCassandraKeyspaceParameters:
{
properties:
{
resource:
{
id: string ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
CassandraResources_DeleteCassandraKeyspace (new)
Description Deletes an existing Azure Cosmos DB Cassandra keyspace.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
CassandraResources_GetCassandraKeyspaceThroughput (new)
Description Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
CassandraResources_UpdateCassandraKeyspaceThroughput (new)
Description Update RUs per second of an Azure Cosmos DB Cassandra Keyspace
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
api-version: string ,
updateThroughputParameters:
{
properties:
{
resource:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
autoUpgradePolicy:
{
throughputPolicy:
{
isEnabled: boolean ,
incrementPercent: integer ,
}
,
}
,
targetMaxThroughput: integer ,
}
,
minimumThroughput: string ,
offerReplacePending: string ,
instantMaximumThroughput: string ,
softAllowedMaximumThroughput: string ,
throughputBuckets:
[
{
id: integer ,
maxThroughputPercentage: integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
CassandraResources_MigrateCassandraKeyspaceToAutoscale (new)
Description Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraResources_MigrateCassandraKeyspaceToManualThroughput (new)
Description Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraResources_ListCassandraTables (new)
Description Lists the Cassandra table under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
options: string ,
}
,
}
,
]
,
}
CassandraResources_GetCassandraTable (new)
Description Gets the Cassandra table under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
tableName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
CassandraResources_CreateUpdateCassandraTable (new)
Description Create or update an Azure Cosmos DB Cassandra Table
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
tableName: string ,
api-version: string ,
createUpdateCassandraTableParameters:
{
properties:
{
resource:
{
id: string ,
defaultTtl: integer ,
schema:
{
columns:
[
{
name: string ,
type: string ,
}
,
]
,
partitionKeys:
[
{
name: string ,
}
,
]
,
clusterKeys:
[
{
name: string ,
orderBy: string ,
}
,
]
,
}
,
analyticalStorageTtl: integer ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
CassandraResources_DeleteCassandraTable (new)
Description Deletes an existing Azure Cosmos DB Cassandra table.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
tableName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
CassandraResources_GetCassandraTableThroughput (new)
Description Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
tableName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
CassandraResources_UpdateCassandraTableThroughput (new)
Description Update RUs per second of an Azure Cosmos DB Cassandra table
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
tableName: string ,
api-version: string ,
updateThroughputParameters:
{
properties:
{
resource:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
autoUpgradePolicy:
{
throughputPolicy:
{
isEnabled: boolean ,
incrementPercent: integer ,
}
,
}
,
targetMaxThroughput: integer ,
}
,
minimumThroughput: string ,
offerReplacePending: string ,
instantMaximumThroughput: string ,
softAllowedMaximumThroughput: string ,
throughputBuckets:
[
{
id: integer ,
maxThroughputPercentage: integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
CassandraResources_MigrateCassandraTableToAutoscale (new)
Description Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
tableName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraResources_MigrateCassandraTableToManualThroughput (new)
Description Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
tableName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
GremlinResources_ListGremlinDatabases (new)
Description Lists the Gremlin databases under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
options: string ,
}
,
}
,
]
,
}
GremlinResources_GetGremlinDatabase (new)
Description Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
GremlinResources_CreateUpdateGremlinDatabase (new)
Description Create or update an Azure Cosmos DB Gremlin database
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
createUpdateGremlinDatabaseParameters:
{
properties:
{
resource:
{
id: string ,
restoreParameters: object ,
createMode: enum ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
GremlinResources_DeleteGremlinDatabase (new)
Description Deletes an existing Azure Cosmos DB Gremlin database.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
GremlinResources_GetGremlinDatabaseThroughput (new)
Description Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
GremlinResources_UpdateGremlinDatabaseThroughput (new)
Description Update RUs per second of an Azure Cosmos DB Gremlin database
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
updateThroughputParameters:
{
properties:
{
resource:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
autoUpgradePolicy:
{
throughputPolicy:
{
isEnabled: boolean ,
incrementPercent: integer ,
}
,
}
,
targetMaxThroughput: integer ,
}
,
minimumThroughput: string ,
offerReplacePending: string ,
instantMaximumThroughput: string ,
softAllowedMaximumThroughput: string ,
throughputBuckets:
[
{
id: integer ,
maxThroughputPercentage: integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
GremlinResources_MigrateGremlinDatabaseToAutoscale (new)
Description Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
GremlinResources_MigrateGremlinDatabaseToManualThroughput (new)
Description Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
GremlinResources_ListGremlinGraphs (new)
Description Lists the Gremlin graph under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
options: string ,
}
,
}
,
]
,
}
GremlinResources_GetGremlinGraph (new)
Description Gets the Gremlin graph under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
graphName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
GremlinResources_CreateUpdateGremlinGraph (new)
Description Create or update an Azure Cosmos DB Gremlin graph
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
graphName: string ,
api-version: string ,
createUpdateGremlinGraphParameters:
{
properties:
{
resource:
{
id: string ,
indexingPolicy:
{
automatic: boolean ,
indexingMode: enum ,
includedPaths:
[
{
path: string ,
indexes:
[
{
dataType: enum ,
precision: integer ,
kind: enum ,
}
,
]
,
}
,
]
,
excludedPaths:
[
{
path: string ,
}
,
]
,
compositeIndexes:
[
{
path: string ,
order: enum ,
}
,
]
,
spatialIndexes:
[
{
path: string ,
types:
[
string ,
]
,
}
,
]
,
vectorIndexes:
[
{
path: string ,
type: enum ,
}
,
]
,
}
,
partitionKey:
{
paths:
[
string ,
]
,
kind: enum ,
version: integer ,
systemKey: boolean ,
}
,
defaultTtl: integer ,
uniqueKeyPolicy:
{
uniqueKeys:
[
{
paths:
[
string ,
]
,
}
,
]
,
}
,
conflictResolutionPolicy:
{
mode: enum ,
conflictResolutionPath: string ,
conflictResolutionProcedure: string ,
}
,
analyticalStorageTtl: integer ,
restoreParameters: object ,
createMode: enum ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
GremlinResources_DeleteGremlinGraph (new)
Description Deletes an existing Azure Cosmos DB Gremlin graph.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
graphName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
GremlinResources_GetGremlinGraphThroughput (new)
Description Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
graphName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
GremlinResources_UpdateGremlinGraphThroughput (new)
Description Update RUs per second of an Azure Cosmos DB Gremlin graph
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
graphName: string ,
api-version: string ,
updateThroughputParameters:
{
properties:
{
resource:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
autoUpgradePolicy:
{
throughputPolicy:
{
isEnabled: boolean ,
incrementPercent: integer ,
}
,
}
,
targetMaxThroughput: integer ,
}
,
minimumThroughput: string ,
offerReplacePending: string ,
instantMaximumThroughput: string ,
softAllowedMaximumThroughput: string ,
throughputBuckets:
[
{
id: integer ,
maxThroughputPercentage: integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
GremlinResources_MigrateGremlinGraphToAutoscale (new)
Description Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
graphName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
GremlinResources_MigrateGremlinGraphToManualThroughput (new)
Description Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
graphName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
Locations_List (new)
Description List Cosmos DB locations and their properties
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
supportsAvailabilityZone: boolean ,
isResidencyRestricted: boolean ,
backupStorageRedundancies:
[
string ,
]
,
isSubscriptionRegionAccessAllowedForRegular: boolean ,
isSubscriptionRegionAccessAllowedForAz: boolean ,
status: enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
Locations_Get (new)
Description Get the properties of an existing Cosmos DB location
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}
{
api-version: string ,
subscriptionId: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
supportsAvailabilityZone: boolean ,
isResidencyRestricted: boolean ,
backupStorageRedundancies:
[
string ,
]
,
isSubscriptionRegionAccessAllowedForRegular: boolean ,
isSubscriptionRegionAccessAllowedForAz: boolean ,
status: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraResources_ListCassandraViews (new)
Description Lists the Cassandra materialized views under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource: string ,
options: string ,
}
,
}
,
]
,
}
CassandraResources_GetCassandraView (new)
Description Gets the Cassandra view under an existing Azure Cosmos DB database account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
viewName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
CassandraResources_CreateUpdateCassandraView (new)
Description Create or update an Azure Cosmos DB Cassandra View
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
viewName: string ,
api-version: string ,
createUpdateCassandraViewParameters:
{
properties:
{
resource:
{
id: string ,
viewDefinition: string ,
}
,
options:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
options: string ,
}
,
}
CassandraResources_DeleteCassandraView (new)
Description Deletes an existing Azure Cosmos DB Cassandra view.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
viewName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}
CassandraResources_GetCassandraViewThroughput (new)
Description Gets the RUs per second of the Cassandra view under an existing Azure Cosmos DB database account with the provided name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
viewName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
CassandraResources_UpdateCassandraViewThroughput (new)
Description Update RUs per second of an Azure Cosmos DB Cassandra view
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
viewName: string ,
api-version: string ,
updateThroughputParameters:
{
properties:
{
resource:
{
throughput: integer ,
autoscaleSettings:
{
maxThroughput: integer ,
autoUpgradePolicy:
{
throughputPolicy:
{
isEnabled: boolean ,
incrementPercent: integer ,
}
,
}
,
targetMaxThroughput: integer ,
}
,
minimumThroughput: string ,
offerReplacePending: string ,
instantMaximumThroughput: string ,
softAllowedMaximumThroughput: string ,
throughputBuckets:
[
{
id: integer ,
maxThroughputPercentage: integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}
CassandraResources_MigrateCassandraViewToAutoscale (new)
Description Migrate an Azure Cosmos DB Cassandra view from manual throughput to autoscale
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToAutoscale
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
viewName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraResources_MigrateCassandraViewToManualThroughput (new)
Description Migrate an Azure Cosmos DB Cassandra view from autoscale to manual throughput
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToManualThroughput
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
keyspaceName: string ,
viewName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (200)

{
properties:
{
resource: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
DataTransferJobs_Create (new)
Description Creates a Data Transfer Job.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
jobCreateParameters:
{
properties:
{
jobName: string ,
source:
{
component: enum ,
}
,
destination:
{
component: enum ,
}
,
status: string ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
jobName: string ,
source:
{
component: enum ,
}
,
destination:
{
component: enum ,
}
,
status: string ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
DataTransferJobs_Get (new)
Description Get a Data Transfer Job.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
jobName: string ,
source:
{
component: enum ,
}
,
destination:
{
component: enum ,
}
,
status: string ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
DataTransferJobs_Pause (new)
Description Pause a Data Transfer Job.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/pause
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
jobName: string ,
source:
{
component: enum ,
}
,
destination:
{
component: enum ,
}
,
status: string ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
DataTransferJobs_Resume (new)
Description Resumes a Data Transfer Job.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/resume
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
jobName: string ,
source:
{
component: enum ,
}
,
destination:
{
component: enum ,
}
,
status: string ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
DataTransferJobs_Cancel (new)
Description Cancels a Data Transfer Job.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/cancel
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
jobName: string ,
source:
{
component: enum ,
}
,
destination:
{
component: enum ,
}
,
status: string ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
DataTransferJobs_Complete (new)
Description Completes a Data Transfer Online Job.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/complete
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
jobName: string ,
source:
{
component: enum ,
}
,
destination:
{
component: enum ,
}
,
status: string ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
DataTransferJobs_ListByDatabaseAccount (new)
Description Get a list of Data Transfer jobs.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
jobName: string ,
source:
{
component: enum ,
}
,
destination:
{
component: enum ,
}
,
status: string ,
processedCount: integer ,
totalCount: integer ,
lastUpdatedUtcTime: string ,
workerCount: integer ,
error:
{
code: string ,
message: string ,
}
,
duration: string ,
mode: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
Fleet_List (new)
Description Lists all the fleets under the subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/fleets
{
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Fleet_ListByResourceGroup (new)
Description Lists all the fleets under the specified subscription and resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Fleet_Get (new)
Description Retrieves the properties of an existing Azure Cosmos DB fleet under a subscription
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Fleet_Create (new)
Description Creates an Azure Cosmos DB fleet under a subscription.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
}
,
}

⚐ Response (201)

{
properties:
{
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Fleet_Update (new)
Description Updates the properties of an existing Azure Cosmos DB Fleet.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Fleet_Delete (new)
Description Deletes an existing Azure Cosmos DB Fleet.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FleetAnalytics_List (new)
Description Lists all the FleetAnalytics under a fleet.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetAnalytics
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
storageLocationType: enum ,
storageLocationUri: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FleetAnalytics_Get (new)
Description Retrieves the properties of an existing Azure Cosmos DB FleetAnalytics under a fleet
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetAnalytics/{fleetAnalyticsName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetAnalyticsName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
storageLocationType: enum ,
storageLocationUri: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FleetAnalytics_Create (new)
Description Creates an Azure Cosmos DB FleetAnalytics under a fleet.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetAnalytics/{fleetAnalyticsName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetAnalyticsName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
storageLocationType: enum ,
storageLocationUri: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
storageLocationType: enum ,
storageLocationUri: string ,
}
,
}

⚐ Response (201)

{
properties:
{
provisioningState: enum ,
storageLocationType: enum ,
storageLocationUri: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FleetAnalytics_Delete (new)
Description Deletes an existing Azure Cosmos DB FleetAnalytics.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetAnalytics/{fleetAnalyticsName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetAnalyticsName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Fleetspace_List (new)
Description Lists all the fleetspaces under a fleet.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
fleetspaceApiKind: enum ,
throughputPoolConfiguration:
{
minThroughput: integer ,
maxThroughput: integer ,
serviceTier: enum ,
dataRegions:
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Fleetspace_Get (new)
Description Retrieves the properties of an existing Azure Cosmos DB fleetspace under a fleet
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
fleetspaceApiKind: enum ,
throughputPoolConfiguration:
{
minThroughput: integer ,
maxThroughput: integer ,
serviceTier: enum ,
dataRegions:
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Fleetspace_Create (new)
Description Creates an Azure Cosmos DB fleetspace under a fleet.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetspaceName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
fleetspaceApiKind: enum ,
throughputPoolConfiguration:
{
minThroughput: integer ,
maxThroughput: integer ,
serviceTier: enum ,
dataRegions:
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
fleetspaceApiKind: enum ,
throughputPoolConfiguration:
{
minThroughput: integer ,
maxThroughput: integer ,
serviceTier: enum ,
dataRegions:
[
string ,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
provisioningState: enum ,
fleetspaceApiKind: enum ,
throughputPoolConfiguration:
{
minThroughput: integer ,
maxThroughput: integer ,
serviceTier: enum ,
dataRegions:
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Fleetspace_Update (new)
Description Update the properties of an existing Azure Cosmos DB fleetspace under a fleet.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetspaceName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
fleetspaceApiKind: enum ,
throughputPoolConfiguration:
{
minThroughput: integer ,
maxThroughput: integer ,
serviceTier: enum ,
dataRegions:
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
fleetspaceApiKind: enum ,
throughputPoolConfiguration:
{
minThroughput: integer ,
maxThroughput: integer ,
serviceTier: enum ,
dataRegions:
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Fleetspace_Delete (new)
Description Deletes an existing Azure Cosmos DB Fleetspace.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetspaceName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FleetspaceAccount_List (new)
Description Lists all the fleetspaces accounts under a fleetspace.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
accountResourceIdentifier: string ,
accountLocation: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FleetspaceAccount_Get (new)
Description Retrieves the properties of an existing Azure Cosmos DB fleetspace account under a fleetspace
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts/{fleetspaceAccountName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetspaceName: string ,
fleetspaceAccountName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
accountResourceIdentifier: string ,
accountLocation: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FleetspaceAccount_Create (new)
Description Creates an Azure Cosmos DB fleetspace account under a fleetspace.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts/{fleetspaceAccountName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetspaceName: string ,
fleetspaceAccountName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
accountResourceIdentifier: string ,
accountLocation: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
accountResourceIdentifier: string ,
accountLocation: string ,
}
,
}

⚐ Response (201)

{
properties:
{
provisioningState: enum ,
accountResourceIdentifier: string ,
accountLocation: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
FleetspaceAccount_Delete (new)
Description Removes an existing Azure Cosmos DB fleetspace account from a fleetspace.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts/{fleetspaceAccountName}
{
subscriptionId: string ,
resourceGroupName: string ,
fleetName: string ,
fleetspaceName: string ,
fleetspaceAccountName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
GremlinResources_GetGremlinRoleDefinition (new)
Description Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Definition with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
GremlinResources_CreateUpdateGremlinRoleDefinition (new)
Description Creates or updates an Azure Cosmos DB Gremlin Role Definition.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
createUpdateGremlinRoleDefinitionParameters:
{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
GremlinResources_DeleteGremlinRoleDefinition (new)
Description Deletes an existing Azure Cosmos DB Gremlin Role Definition.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
GremlinResources_ListGremlinRoleDefinitions (new)
Description Retrieves the list of all Azure Cosmos DB Gremlin Role Definitions.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleDefinitions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
GremlinResources_GetGremlinRoleAssignment (new)
Description Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Assignment with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
GremlinResources_CreateUpdateGremlinRoleAssignment (new)
Description Creates or updates an Azure Cosmos DB Gremlin Role Assignment.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
createUpdateGremlinRoleAssignmentParameters:
{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
GremlinResources_DeleteGremlinRoleAssignment (new)
Description Deletes an existing Azure Cosmos DB Gremlin Role Assignment.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
GremlinResources_ListGremlinRoleAssignments (new)
Description Retrieves the list of all Azure Cosmos DB Gremlin Role Assignments.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleAssignments
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CassandraClusters_ListBySubscription (new)
Description List all managed Cassandra clusters in this subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/cassandraClusters
{
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
restoreFromBackupId: string ,
delegatedManagementSubnetId: string ,
cassandraVersion: string ,
clusterNameOverride: string ,
authenticationMethod: enum ,
initialCassandraAdminPassword: string ,
prometheusEndpoint:
{
ipAddress: string ,
}
,
repairEnabled: boolean ,
autoReplicate: enum ,
clientCertificates:
[
{
pem: string ,
}
,
]
,
externalGossipCertificates:
[
{
pem: string ,
}
,
]
,
gossipCertificates:
[
{
pem: string ,
}
,
]
,
externalSeedNodes:
[
{
ipAddress: string ,
}
,
]
,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
externalDataCenters:
[
string ,
]
,
hoursBetweenBackups: integer ,
deallocated: boolean ,
cassandraAuditLoggingEnabled: boolean ,
clusterType: enum ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
extensions:
[
string ,
]
,
backupSchedules:
[
{
scheduleName: string ,
cronExpression: string ,
retentionInHours: integer ,
}
,
]
,
scheduledEventStrategy: enum ,
azureConnectionMethod: enum ,
privateLinkResourceId: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_ListByResourceGroup (new)
Description List all managed Cassandra clusters in this resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
restoreFromBackupId: string ,
delegatedManagementSubnetId: string ,
cassandraVersion: string ,
clusterNameOverride: string ,
authenticationMethod: enum ,
initialCassandraAdminPassword: string ,
prometheusEndpoint:
{
ipAddress: string ,
}
,
repairEnabled: boolean ,
autoReplicate: enum ,
clientCertificates:
[
{
pem: string ,
}
,
]
,
externalGossipCertificates:
[
{
pem: string ,
}
,
]
,
gossipCertificates:
[
{
pem: string ,
}
,
]
,
externalSeedNodes:
[
{
ipAddress: string ,
}
,
]
,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
externalDataCenters:
[
string ,
]
,
hoursBetweenBackups: integer ,
deallocated: boolean ,
cassandraAuditLoggingEnabled: boolean ,
clusterType: enum ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
extensions:
[
string ,
]
,
backupSchedules:
[
{
scheduleName: string ,
cronExpression: string ,
retentionInHours: integer ,
}
,
]
,
scheduledEventStrategy: enum ,
azureConnectionMethod: enum ,
privateLinkResourceId: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_Get (new)
Description Get the properties of a managed Cassandra cluster.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
restoreFromBackupId: string ,
delegatedManagementSubnetId: string ,
cassandraVersion: string ,
clusterNameOverride: string ,
authenticationMethod: enum ,
initialCassandraAdminPassword: string ,
prometheusEndpoint:
{
ipAddress: string ,
}
,
repairEnabled: boolean ,
autoReplicate: enum ,
clientCertificates:
[
{
pem: string ,
}
,
]
,
externalGossipCertificates:
[
{
pem: string ,
}
,
]
,
gossipCertificates:
[
{
pem: string ,
}
,
]
,
externalSeedNodes:
[
{
ipAddress: string ,
}
,
]
,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
externalDataCenters:
[
string ,
]
,
hoursBetweenBackups: integer ,
deallocated: boolean ,
cassandraAuditLoggingEnabled: boolean ,
clusterType: enum ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
extensions:
[
string ,
]
,
backupSchedules:
[
{
scheduleName: string ,
cronExpression: string ,
retentionInHours: integer ,
}
,
]
,
scheduledEventStrategy: enum ,
azureConnectionMethod: enum ,
privateLinkResourceId: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_Delete (new)
Description Deletes a managed Cassandra cluster.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_CreateUpdate (new)
Description Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
restoreFromBackupId: string ,
delegatedManagementSubnetId: string ,
cassandraVersion: string ,
clusterNameOverride: string ,
authenticationMethod: enum ,
initialCassandraAdminPassword: string ,
prometheusEndpoint:
{
ipAddress: string ,
}
,
repairEnabled: boolean ,
autoReplicate: enum ,
clientCertificates:
[
{
pem: string ,
}
,
]
,
externalGossipCertificates:
[
{
pem: string ,
}
,
]
,
gossipCertificates:
[
{
pem: string ,
}
,
]
,
externalSeedNodes:
[
{
ipAddress: string ,
}
,
]
,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
externalDataCenters:
[
string ,
]
,
hoursBetweenBackups: integer ,
deallocated: boolean ,
cassandraAuditLoggingEnabled: boolean ,
clusterType: enum ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
extensions:
[
string ,
]
,
backupSchedules:
[
{
scheduleName: string ,
cronExpression: string ,
retentionInHours: integer ,
}
,
]
,
scheduledEventStrategy: enum ,
azureConnectionMethod: enum ,
privateLinkResourceId: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
restoreFromBackupId: string ,
delegatedManagementSubnetId: string ,
cassandraVersion: string ,
clusterNameOverride: string ,
authenticationMethod: enum ,
initialCassandraAdminPassword: string ,
prometheusEndpoint:
{
ipAddress: string ,
}
,
repairEnabled: boolean ,
autoReplicate: enum ,
clientCertificates:
[
{
pem: string ,
}
,
]
,
externalGossipCertificates:
[
{
pem: string ,
}
,
]
,
gossipCertificates:
[
{
pem: string ,
}
,
]
,
externalSeedNodes:
[
{
ipAddress: string ,
}
,
]
,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
externalDataCenters:
[
string ,
]
,
hoursBetweenBackups: integer ,
deallocated: boolean ,
cassandraAuditLoggingEnabled: boolean ,
clusterType: enum ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
extensions:
[
string ,
]
,
backupSchedules:
[
{
scheduleName: string ,
cronExpression: string ,
retentionInHours: integer ,
}
,
]
,
scheduledEventStrategy: enum ,
azureConnectionMethod: enum ,
privateLinkResourceId: string ,
}
,
}

⚐ Response (201)

{
properties:
{
provisioningState: enum ,
restoreFromBackupId: string ,
delegatedManagementSubnetId: string ,
cassandraVersion: string ,
clusterNameOverride: string ,
authenticationMethod: enum ,
initialCassandraAdminPassword: string ,
prometheusEndpoint:
{
ipAddress: string ,
}
,
repairEnabled: boolean ,
autoReplicate: enum ,
clientCertificates:
[
{
pem: string ,
}
,
]
,
externalGossipCertificates:
[
{
pem: string ,
}
,
]
,
gossipCertificates:
[
{
pem: string ,
}
,
]
,
externalSeedNodes:
[
{
ipAddress: string ,
}
,
]
,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
externalDataCenters:
[
string ,
]
,
hoursBetweenBackups: integer ,
deallocated: boolean ,
cassandraAuditLoggingEnabled: boolean ,
clusterType: enum ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
extensions:
[
string ,
]
,
backupSchedules:
[
{
scheduleName: string ,
cronExpression: string ,
retentionInHours: integer ,
}
,
]
,
scheduledEventStrategy: enum ,
azureConnectionMethod: enum ,
privateLinkResourceId: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_Update (new)
Description Updates some of the properties of a managed Cassandra cluster.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
restoreFromBackupId: string ,
delegatedManagementSubnetId: string ,
cassandraVersion: string ,
clusterNameOverride: string ,
authenticationMethod: enum ,
initialCassandraAdminPassword: string ,
prometheusEndpoint:
{
ipAddress: string ,
}
,
repairEnabled: boolean ,
autoReplicate: enum ,
clientCertificates:
[
{
pem: string ,
}
,
]
,
externalGossipCertificates:
[
{
pem: string ,
}
,
]
,
gossipCertificates:
[
{
pem: string ,
}
,
]
,
externalSeedNodes:
[
{
ipAddress: string ,
}
,
]
,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
externalDataCenters:
[
string ,
]
,
hoursBetweenBackups: integer ,
deallocated: boolean ,
cassandraAuditLoggingEnabled: boolean ,
clusterType: enum ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
extensions:
[
string ,
]
,
backupSchedules:
[
{
scheduleName: string ,
cronExpression: string ,
retentionInHours: integer ,
}
,
]
,
scheduledEventStrategy: enum ,
azureConnectionMethod: enum ,
privateLinkResourceId: string ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
provisioningState: enum ,
restoreFromBackupId: string ,
delegatedManagementSubnetId: string ,
cassandraVersion: string ,
clusterNameOverride: string ,
authenticationMethod: enum ,
initialCassandraAdminPassword: string ,
prometheusEndpoint:
{
ipAddress: string ,
}
,
repairEnabled: boolean ,
autoReplicate: enum ,
clientCertificates:
[
{
pem: string ,
}
,
]
,
externalGossipCertificates:
[
{
pem: string ,
}
,
]
,
gossipCertificates:
[
{
pem: string ,
}
,
]
,
externalSeedNodes:
[
{
ipAddress: string ,
}
,
]
,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
externalDataCenters:
[
string ,
]
,
hoursBetweenBackups: integer ,
deallocated: boolean ,
cassandraAuditLoggingEnabled: boolean ,
clusterType: enum ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
extensions:
[
string ,
]
,
backupSchedules:
[
{
scheduleName: string ,
cronExpression: string ,
retentionInHours: integer ,
}
,
]
,
scheduledEventStrategy: enum ,
azureConnectionMethod: enum ,
privateLinkResourceId: string ,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
restoreFromBackupId: string ,
delegatedManagementSubnetId: string ,
cassandraVersion: string ,
clusterNameOverride: string ,
authenticationMethod: enum ,
initialCassandraAdminPassword: string ,
prometheusEndpoint:
{
ipAddress: string ,
}
,
repairEnabled: boolean ,
autoReplicate: enum ,
clientCertificates:
[
{
pem: string ,
}
,
]
,
externalGossipCertificates:
[
{
pem: string ,
}
,
]
,
gossipCertificates:
[
{
pem: string ,
}
,
]
,
externalSeedNodes:
[
{
ipAddress: string ,
}
,
]
,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
externalDataCenters:
[
string ,
]
,
hoursBetweenBackups: integer ,
deallocated: boolean ,
cassandraAuditLoggingEnabled: boolean ,
clusterType: enum ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
extensions:
[
string ,
]
,
backupSchedules:
[
{
scheduleName: string ,
cronExpression: string ,
retentionInHours: integer ,
}
,
]
,
scheduledEventStrategy: enum ,
azureConnectionMethod: enum ,
privateLinkResourceId: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_InvokeCommand (new)
Description Invoke a command like nodetool for cassandra maintenance
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/invokeCommand
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
body:
{
command: string ,
arguments: object ,
host: string ,
cassandra-stop-start: boolean ,
readwrite: boolean ,
}
,
}

⚐ Response (202)

{
commandOutput: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_InvokeCommandAsync (new)
Description Invoke a command like nodetool for cassandra maintenance asynchronously
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/invokeCommandAsync
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
body:
{
command: string ,
arguments: object ,
host: string ,
cassandra-stop-start: boolean ,
readWrite: boolean ,
}
,
}

⚐ Response (200)

{
command: string ,
commandId: string ,
arguments: object ,
host: string ,
isAdmin: boolean ,
cassandraStopStart: boolean ,
readWrite: boolean ,
result: string ,
status: enum ,
outputFile: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CassandraClusters_ListCommand (new)
Description List all commands currently running on ring info
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
command: string ,
commandId: string ,
arguments: object ,
host: string ,
isAdmin: boolean ,
cassandraStopStart: boolean ,
readWrite: boolean ,
result: string ,
status: enum ,
outputFile: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_GetCommandAsync (new)
Description Get details about a specified command that was run asynchronously.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands/{commandId}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
commandId: string ,
api-version: string ,
}

⚐ Response (200)

{
command: string ,
commandId: string ,
arguments: object ,
host: string ,
isAdmin: boolean ,
cassandraStopStart: boolean ,
readWrite: boolean ,
result: string ,
status: enum ,
outputFile: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_ListBackups (new)
Description List the backups of this cluster that are available to restore.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
backupId: string ,
backupState: enum ,
backupStartTimestamp: string ,
backupStopTimestamp: string ,
backupExpiryTimestamp: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_GetBackup (new)
Description Get the properties of an individual backup of this cluster that is available to restore.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups/{backupId}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
backupId: string ,
api-version: string ,
}

⚐ Response (200)

{
backupId: string ,
backupState: enum ,
backupStartTimestamp: string ,
backupStopTimestamp: string ,
backupExpiryTimestamp: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraDataCenters_List (new)
Description List all data centers in a particular managed Cassandra cluster.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
dataCenterLocation: string ,
delegatedSubnetId: string ,
nodeCount: integer ,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
base64EncodedCassandraYamlFragment: string ,
managedDiskCustomerKeyUri: string ,
backupStorageCustomerKeyUri: string ,
sku: string ,
diskSku: string ,
diskCapacity: integer ,
availabilityZone: boolean ,
authenticationMethodLdapProperties:
{
serverHostname: string ,
serverPort: integer ,
serviceUserDistinguishedName: string ,
serviceUserPassword: string ,
searchBaseDistinguishedName: string ,
searchFilterTemplate: string ,
serverCertificates:
[
{
pem: string ,
}
,
]
,
connectionTimeoutInMs: integer ,
}
,
deallocated: boolean ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
privateEndpointIpAddress: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraDataCenters_Get (new)
Description Get the properties of a managed Cassandra data center.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
dataCenterName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
dataCenterLocation: string ,
delegatedSubnetId: string ,
nodeCount: integer ,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
base64EncodedCassandraYamlFragment: string ,
managedDiskCustomerKeyUri: string ,
backupStorageCustomerKeyUri: string ,
sku: string ,
diskSku: string ,
diskCapacity: integer ,
availabilityZone: boolean ,
authenticationMethodLdapProperties:
{
serverHostname: string ,
serverPort: integer ,
serviceUserDistinguishedName: string ,
serviceUserPassword: string ,
searchBaseDistinguishedName: string ,
searchFilterTemplate: string ,
serverCertificates:
[
{
pem: string ,
}
,
]
,
connectionTimeoutInMs: integer ,
}
,
deallocated: boolean ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
privateEndpointIpAddress: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraDataCenters_Delete (new)
Description Delete a managed Cassandra data center.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
dataCenterName: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraDataCenters_CreateUpdate (new)
Description Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
dataCenterName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
dataCenterLocation: string ,
delegatedSubnetId: string ,
nodeCount: integer ,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
base64EncodedCassandraYamlFragment: string ,
managedDiskCustomerKeyUri: string ,
backupStorageCustomerKeyUri: string ,
sku: string ,
diskSku: string ,
diskCapacity: integer ,
availabilityZone: boolean ,
authenticationMethodLdapProperties:
{
serverHostname: string ,
serverPort: integer ,
serviceUserDistinguishedName: string ,
serviceUserPassword: string ,
searchBaseDistinguishedName: string ,
searchFilterTemplate: string ,
serverCertificates:
[
{
pem: string ,
}
,
]
,
connectionTimeoutInMs: integer ,
}
,
deallocated: boolean ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
privateEndpointIpAddress: string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
provisioningState: enum ,
dataCenterLocation: string ,
delegatedSubnetId: string ,
nodeCount: integer ,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
base64EncodedCassandraYamlFragment: string ,
managedDiskCustomerKeyUri: string ,
backupStorageCustomerKeyUri: string ,
sku: string ,
diskSku: string ,
diskCapacity: integer ,
availabilityZone: boolean ,
authenticationMethodLdapProperties:
{
serverHostname: string ,
serverPort: integer ,
serviceUserDistinguishedName: string ,
serviceUserPassword: string ,
searchBaseDistinguishedName: string ,
searchFilterTemplate: string ,
serverCertificates:
[
{
pem: string ,
}
,
]
,
connectionTimeoutInMs: integer ,
}
,
deallocated: boolean ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
privateEndpointIpAddress: string ,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
dataCenterLocation: string ,
delegatedSubnetId: string ,
nodeCount: integer ,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
base64EncodedCassandraYamlFragment: string ,
managedDiskCustomerKeyUri: string ,
backupStorageCustomerKeyUri: string ,
sku: string ,
diskSku: string ,
diskCapacity: integer ,
availabilityZone: boolean ,
authenticationMethodLdapProperties:
{
serverHostname: string ,
serverPort: integer ,
serviceUserDistinguishedName: string ,
serviceUserPassword: string ,
searchBaseDistinguishedName: string ,
searchFilterTemplate: string ,
serverCertificates:
[
{
pem: string ,
}
,
]
,
connectionTimeoutInMs: integer ,
}
,
deallocated: boolean ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
privateEndpointIpAddress: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraDataCenters_Update (new)
Description Update some of the properties of a managed Cassandra data center.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
dataCenterName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
dataCenterLocation: string ,
delegatedSubnetId: string ,
nodeCount: integer ,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
base64EncodedCassandraYamlFragment: string ,
managedDiskCustomerKeyUri: string ,
backupStorageCustomerKeyUri: string ,
sku: string ,
diskSku: string ,
diskCapacity: integer ,
availabilityZone: boolean ,
authenticationMethodLdapProperties:
{
serverHostname: string ,
serverPort: integer ,
serviceUserDistinguishedName: string ,
serviceUserPassword: string ,
searchBaseDistinguishedName: string ,
searchFilterTemplate: string ,
serverCertificates:
[
{
pem: string ,
}
,
]
,
connectionTimeoutInMs: integer ,
}
,
deallocated: boolean ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
privateEndpointIpAddress: string ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
provisioningState: enum ,
dataCenterLocation: string ,
delegatedSubnetId: string ,
nodeCount: integer ,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
base64EncodedCassandraYamlFragment: string ,
managedDiskCustomerKeyUri: string ,
backupStorageCustomerKeyUri: string ,
sku: string ,
diskSku: string ,
diskCapacity: integer ,
availabilityZone: boolean ,
authenticationMethodLdapProperties:
{
serverHostname: string ,
serverPort: integer ,
serviceUserDistinguishedName: string ,
serviceUserPassword: string ,
searchBaseDistinguishedName: string ,
searchFilterTemplate: string ,
serverCertificates:
[
{
pem: string ,
}
,
]
,
connectionTimeoutInMs: integer ,
}
,
deallocated: boolean ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
privateEndpointIpAddress: string ,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
dataCenterLocation: string ,
delegatedSubnetId: string ,
nodeCount: integer ,
seedNodes:
[
{
ipAddress: string ,
}
,
]
,
base64EncodedCassandraYamlFragment: string ,
managedDiskCustomerKeyUri: string ,
backupStorageCustomerKeyUri: string ,
sku: string ,
diskSku: string ,
diskCapacity: integer ,
availabilityZone: boolean ,
authenticationMethodLdapProperties:
{
serverHostname: string ,
serverPort: integer ,
serviceUserDistinguishedName: string ,
serviceUserPassword: string ,
searchBaseDistinguishedName: string ,
searchFilterTemplate: string ,
serverCertificates:
[
{
pem: string ,
}
,
]
,
connectionTimeoutInMs: integer ,
}
,
deallocated: boolean ,
provisionError:
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
privateEndpointIpAddress: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_Deallocate (new)
Description Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/deallocate
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
x-ms-force-deallocate: string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_Start (new)
Description Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won't do anything on an already running cluster. Use Deallocate to deallocate the cluster.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/start
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
CassandraClusters_Status (new)
Description Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/status
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
}

⚐ Response (200)

{
eTag: string ,
reaperStatus:
{
healthy: boolean ,
repairRunIds: object ,
repairSchedules: object ,
}
,
connectionErrors:
[
{
connectionState: enum ,
iPFrom: string ,
iPTo: string ,
port: integer ,
exception: string ,
}
,
]
,
errors:
[
{
code: string ,
message: string ,
target: string ,
additionalErrorInfo: string ,
}
,
]
,
dataCenters:
[
{
name: string ,
seedNodes:
[
string ,
]
,
nodes:
[
{
address: string ,
state: enum ,
status: string ,
cassandraProcessStatus: string ,
load: string ,
tokens:
[
string ,
]
,
size: integer ,
hostID: string ,
rack: string ,
timestamp: string ,
diskUsedKB: integer ,
diskFreeKB: integer ,
memoryUsedKB: integer ,
memoryBuffersAndCachedKB: integer ,
memoryFreeKB: integer ,
memoryTotalKB: integer ,
cpuUsage: number ,
isLatestModel: boolean ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoMIResources_GetMongoMIRoleDefinition (new)
Description Retrieves the properties of an existing Azure Cosmos DB MongoMI Role Definition with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongoMIRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MongoMIResources_CreateUpdateMongoMIRoleDefinition (new)
Description Creates or updates an Azure Cosmos DB MongoMI Role Definition.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongoMIRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
createUpdateMongoMIRoleDefinitionParameters:
{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MongoMIResources_DeleteMongoMIRoleDefinition (new)
Description Deletes an existing Azure Cosmos DB MongoMI Role Definition.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongoMIRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MongoMIResources_ListMongoMIRoleDefinitions (new)
Description Retrieves the list of all Azure Cosmos DB MongoMI Role Definitions.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongoMIRoleDefinitions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MongoMIResources_GetMongoMIRoleAssignment (new)
Description Retrieves the properties of an existing Azure Cosmos DB MongoMI Role Assignment with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongoMIRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MongoMIResources_CreateUpdateMongoMIRoleAssignment (new)
Description Creates or updates an Azure Cosmos DB MongoMI Role Assignment.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongoMIRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
createUpdateMongoMIRoleAssignmentParameters:
{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MongoMIResources_DeleteMongoMIRoleAssignment (new)
Description Deletes an existing Azure Cosmos DB MongoMI Role Assignment.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongoMIRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MongoMIResources_ListMongoMIRoleAssignments (new)
Description Retrieves the list of all Azure Cosmos DB MongoMI Role Assignments.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongoMIRoleAssignments
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MongoDBResources_GetMongoRoleDefinition (new)
Description Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}
{
mongoRoleDefinitionId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
roleName: string ,
type: enum ,
databaseName: string ,
privileges:
[
{
resource:
{
db: string ,
collection: string ,
}
,
actions:
[
string ,
]
,
}
,
]
,
roles:
[
{
db: string ,
role: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_CreateUpdateMongoRoleDefinition (new)
Description Creates or updates an Azure Cosmos DB Mongo Role Definition.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}
{
mongoRoleDefinitionId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
createUpdateMongoRoleDefinitionParameters:
{
properties:
{
roleName: string ,
type: enum ,
databaseName: string ,
privileges:
[
{
resource:
{
db: string ,
collection: string ,
}
,
actions:
[
string ,
]
,
}
,
]
,
roles:
[
{
db: string ,
role: string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
roleName: string ,
type: enum ,
databaseName: string ,
privileges:
[
{
resource:
{
db: string ,
collection: string ,
}
,
actions:
[
string ,
]
,
}
,
]
,
roles:
[
{
db: string ,
role: string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_DeleteMongoRoleDefinition (new)
Description Deletes an existing Azure Cosmos DB Mongo Role Definition.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}
{
mongoRoleDefinitionId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_ListMongoRoleDefinitions (new)
Description Retrieves the list of all Azure Cosmos DB Mongo Role Definitions.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
roleName: string ,
type: enum ,
databaseName: string ,
privileges:
[
{
resource:
{
db: string ,
collection: string ,
}
,
actions:
[
string ,
]
,
}
,
]
,
roles:
[
{
db: string ,
role: string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_GetMongoUserDefinition (new)
Description Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
{
mongoUserDefinitionId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
userName: string ,
password: string ,
databaseName: string ,
customData: string ,
roles:
[
{
db: string ,
role: string ,
}
,
]
,
mechanisms: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_CreateUpdateMongoUserDefinition (new)
Description Creates or updates an Azure Cosmos DB Mongo User Definition.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
{
mongoUserDefinitionId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
createUpdateMongoUserDefinitionParameters:
{
properties:
{
userName: string ,
password: string ,
databaseName: string ,
customData: string ,
roles:
[
{
db: string ,
role: string ,
}
,
]
,
mechanisms: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
userName: string ,
password: string ,
databaseName: string ,
customData: string ,
roles:
[
{
db: string ,
role: string ,
}
,
]
,
mechanisms: string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_DeleteMongoUserDefinition (new)
Description Deletes an existing Azure Cosmos DB Mongo User Definition.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
{
mongoUserDefinitionId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_ListMongoUserDefinitions (new)
Description Retrieves the list of all Azure Cosmos DB Mongo User Definition.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
userName: string ,
password: string ,
databaseName: string ,
customData: string ,
roles:
[
{
db: string ,
role: string ,
}
,
]
,
mechanisms: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
NetworkSecurityPerimeterConfigurations_List (new)
Description Gets list of effective Network Security Perimeter Configuration for cosmos db account
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/networkSecurityPerimeterConfigurations
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
provisioningIssues:
[
{
name: string ,
properties:
{
issueType: enum ,
severity: enum ,
description: string ,
suggestedResourceIds:
[
string ,
]
,
suggestedAccessRules:
[
{
name: string ,
properties:
{
direction: enum ,
addressPrefixes:
[
string ,
]
,
subscriptions:
[
{
id: string ,
}
,
]
,
networkSecurityPerimeters:
[
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
]
,
fullyQualifiedDomainNames:
[
string ,
]
,
emailAddresses:
[
string ,
]
,
phoneNumbers:
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
resourceAssociation:
{
name: string ,
accessMode: enum ,
}
,
profile:
{
name: string ,
accessRulesVersion: integer ,
accessRules:
[
{
name: string ,
properties:
{
direction: enum ,
addressPrefixes:
[
string ,
]
,
subscriptions:
[
{
id: string ,
}
,
]
,
networkSecurityPerimeters:
[
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
]
,
fullyQualifiedDomainNames:
[
string ,
]
,
emailAddresses:
[
string ,
]
,
phoneNumbers:
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion: integer ,
enabledLogCategories:
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_Get (new)
Description Gets effective Network Security Perimeter Configuration for association
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
networkSecurityPerimeterConfigurationName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
provisioningIssues:
[
{
name: string ,
properties:
{
issueType: enum ,
severity: enum ,
description: string ,
suggestedResourceIds:
[
string ,
]
,
suggestedAccessRules:
[
{
name: string ,
properties:
{
direction: enum ,
addressPrefixes:
[
string ,
]
,
subscriptions:
[
{
id: string ,
}
,
]
,
networkSecurityPerimeters:
[
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
]
,
fullyQualifiedDomainNames:
[
string ,
]
,
emailAddresses:
[
string ,
]
,
phoneNumbers:
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
resourceAssociation:
{
name: string ,
accessMode: enum ,
}
,
profile:
{
name: string ,
accessRulesVersion: integer ,
accessRules:
[
{
name: string ,
properties:
{
direction: enum ,
addressPrefixes:
[
string ,
]
,
subscriptions:
[
{
id: string ,
}
,
]
,
networkSecurityPerimeters:
[
{
id: string ,
perimeterGuid: string ,
location: string ,
}
,
]
,
fullyQualifiedDomainNames:
[
string ,
]
,
emailAddresses:
[
string ,
]
,
phoneNumbers:
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion: integer ,
enabledLogCategories:
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_Reconcile (new)
Description Refreshes any information about the association.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
networkSecurityPerimeterConfigurationName: string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NotebookWorkspaces_ListByDatabaseAccount (new)
Description Gets the notebook workspace resources of an existing Cosmos DB account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
notebookServerEndpoint: string ,
status: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
NotebookWorkspaces_Get (new)
Description Gets the notebook workspace for a Cosmos DB account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
notebookWorkspaceName: string ,
}

⚐ Response (200)

{
properties:
{
notebookServerEndpoint: string ,
status: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
NotebookWorkspaces_CreateOrUpdate (new)
Description Creates the notebook workspace for a Cosmos DB account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
notebookWorkspaceName: string ,
notebookCreateUpdateParameters: object ,
}

⚐ Response (200)

{
properties:
{
notebookServerEndpoint: string ,
status: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
NotebookWorkspaces_Delete (new)
Description Deletes the notebook workspace for a Cosmos DB account.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
notebookWorkspaceName: string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code: string ,
message: string ,
}
NotebookWorkspaces_ListConnectionInfo (new)
Description Retrieves the connection info for the notebook workspace
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/listConnectionInfo
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
notebookWorkspaceName: string ,
}

⚐ Response (200)

{
authToken: string ,
notebookServerEndpoint: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
NotebookWorkspaces_RegenerateAuthToken (new)
Description Regenerates the auth token for the notebook workspace
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/regenerateAuthToken
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
notebookWorkspaceName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code: string ,
message: string ,
}
NotebookWorkspaces_Start (new)
Description Starts the notebook workspace
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/start
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
notebookWorkspaceName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code: string ,
message: string ,
}
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: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: 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: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (200)

{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: 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: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
privateEndpointConnectionName: string ,
parameters:
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
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: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
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: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
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: string ,
resourceGroupName: string ,
api-version: string ,
accountName: string ,
groupName: string ,
}

⚐ Response (200)

{
properties:
{
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
string ,
]
,
}
,
}
SqlResources_GetSqlRoleDefinition (new)
Description Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}
{
roleDefinitionId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_CreateUpdateSqlRoleDefinition (new)
Description Creates or updates an Azure Cosmos DB SQL Role Definition.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}
{
roleDefinitionId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
createUpdateSqlRoleDefinitionParameters:
{
properties:
{
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_DeleteSqlRoleDefinition (new)
Description Deletes an existing Azure Cosmos DB SQL Role Definition.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}
{
roleDefinitionId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_ListSqlRoleDefinitions (new)
Description Retrieves the list of all Azure Cosmos DB SQL Role Definitions.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_GetSqlRoleAssignment (new)
Description Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}
{
roleAssignmentId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_CreateUpdateSqlRoleAssignment (new)
Description Creates or updates an Azure Cosmos DB SQL Role Assignment.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}
{
roleAssignmentId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
createUpdateSqlRoleAssignmentParameters:
{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_DeleteSqlRoleAssignment (new)
Description Deletes an existing Azure Cosmos DB SQL Role Assignment.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}
{
roleAssignmentId: string ,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_ListSqlRoleAssignments (new)
Description Retrieves the list of all Azure Cosmos DB SQL Role Assignments.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableDatabaseAccounts_ListByLocation (new)
Description Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts
{
api-version: string ,
subscriptionId: string ,
location: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
accountName: string ,
creationTime: string ,
oldestRestorableTime: string ,
deletionTime: string ,
apiType: enum ,
restorableLocations:
[
{
locationName: string ,
regionalDatabaseAccountInstanceId: string ,
creationTime: string ,
deletionTime: string ,
}
,
]
,
}
,
id: string ,
name: string ,
type: string ,
location: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableDatabaseAccounts_List (new)
Description Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/restorableDatabaseAccounts
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
accountName: string ,
creationTime: string ,
oldestRestorableTime: string ,
deletionTime: string ,
apiType: enum ,
restorableLocations:
[
{
locationName: string ,
regionalDatabaseAccountInstanceId: string ,
creationTime: string ,
deletionTime: string ,
}
,
]
,
}
,
id: string ,
name: string ,
type: string ,
location: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableDatabaseAccounts_GetByLocation (new)
Description Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
}

⚐ Response (200)

{
properties:
{
accountName: string ,
creationTime: string ,
oldestRestorableTime: string ,
deletionTime: string ,
apiType: enum ,
restorableLocations:
[
{
locationName: string ,
regionalDatabaseAccountInstanceId: string ,
creationTime: string ,
deletionTime: string ,
}
,
]
,
}
,
id: string ,
name: string ,
type: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
SqlResources_RetrieveContinuousBackupInformation (new)
Description Retrieves continuous backup information for a container resource.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/retrieveContinuousBackupInformation
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
containerName: string ,
api-version: string ,
location:
{
location: string ,
}
,
}

⚐ Response (200)

{
continuousBackupInformation:
{
latestRestorableTimestamp: string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableSqlDatabases_List (new)
Description Show the event feed of all mutations done on all the Azure Cosmos DB SQL databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlDatabases
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource:
{
_rid: string ,
operationType: enum ,
canUndelete: string ,
canUndeleteReason: string ,
eventTimestamp: string ,
ownerId: string ,
ownerResourceId: string ,
database:
{
_colls: string ,
_users: string ,
_self: string ,
}
,
}
,
}
,
id: string ,
name: string ,
type: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableSqlContainers_List (new)
Description Show the event feed of all mutations done on all the Azure Cosmos DB SQL containers under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
restorableSqlDatabaseRid: string ,
startTime: string ,
endTime: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource:
{
_rid: string ,
operationType: enum ,
canUndelete: string ,
canUndeleteReason: string ,
eventTimestamp: string ,
ownerId: string ,
ownerResourceId: string ,
container:
{
_self: string ,
}
,
}
,
}
,
id: string ,
name: string ,
type: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableSqlResources_List (new)
Description Return a list of database and container combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
restoreLocation: string ,
restoreTimestampInUtc: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name: string ,
type: string ,
databaseName: string ,
collectionNames:
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
MongoDBResources_RetrieveContinuousBackupInformation (new)
Description Retrieves continuous backup information for a Mongodb collection.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/retrieveContinuousBackupInformation
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
collectionName: string ,
api-version: string ,
location:
{
location: string ,
}
,
}

⚐ Response (200)

{
continuousBackupInformation:
{
latestRestorableTimestamp: string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableMongodbDatabases_List (new)
Description Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbDatabases
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource:
{
_rid: string ,
operationType: enum ,
canUndelete: string ,
canUndeleteReason: string ,
eventTimestamp: string ,
ownerId: string ,
ownerResourceId: string ,
}
,
}
,
id: string ,
name: string ,
type: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableMongodbCollections_List (new)
Description Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbCollections
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
restorableMongodbDatabaseRid: string ,
startTime: string ,
endTime: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource:
{
_rid: string ,
operationType: enum ,
canUndelete: string ,
canUndeleteReason: string ,
eventTimestamp: string ,
ownerId: string ,
ownerResourceId: string ,
}
,
}
,
id: string ,
name: string ,
type: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableMongodbResources_List (new)
Description Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbResources
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
restoreLocation: string ,
restoreTimestampInUtc: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name: string ,
type: string ,
databaseName: string ,
collectionNames:
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
GremlinResources_RetrieveContinuousBackupInformation (new)
Description Retrieves continuous backup information for a gremlin graph.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/retrieveContinuousBackupInformation
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
databaseName: string ,
graphName: string ,
api-version: string ,
location:
{
location: string ,
}
,
}

⚐ Response (200)

{
continuousBackupInformation:
{
latestRestorableTimestamp: string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableGremlinDatabases_List (new)
Description Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinDatabases
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource:
{
_rid: string ,
operationType: enum ,
canUndelete: string ,
canUndeleteReason: string ,
eventTimestamp: string ,
ownerId: string ,
ownerResourceId: string ,
}
,
}
,
id: string ,
name: string ,
type: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableGremlinGraphs_List (new)
Description Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin graphs under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGraphs
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
restorableGremlinDatabaseRid: string ,
startTime: string ,
endTime: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource:
{
_rid: string ,
operationType: enum ,
canUndelete: string ,
canUndeleteReason: string ,
eventTimestamp: string ,
ownerId: string ,
ownerResourceId: string ,
}
,
}
,
id: string ,
name: string ,
type: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableGremlinResources_List (new)
Description Return a list of gremlin database and graphs combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinResources
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
restoreLocation: string ,
restoreTimestampInUtc: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name: string ,
type: string ,
databaseName: string ,
graphNames:
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
TableResources_RetrieveContinuousBackupInformation (new)
Description Retrieves continuous backup information for a table.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/retrieveContinuousBackupInformation
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
tableName: string ,
api-version: string ,
location:
{
location: string ,
}
,
}

⚐ Response (200)

{
continuousBackupInformation:
{
latestRestorableTimestamp: string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableTables_List (new)
Description Show the event feed of all mutations done on all the Azure Cosmos DB Tables. This helps in scenario where table was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableTables
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
startTime: string ,
endTime: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resource:
{
_rid: string ,
operationType: enum ,
canUndelete: string ,
canUndeleteReason: string ,
eventTimestamp: string ,
ownerId: string ,
ownerResourceId: string ,
}
,
}
,
id: string ,
name: string ,
type: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
RestorableTableResources_List (new)
Description Return a list of tables that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableTableResources
{
api-version: string ,
subscriptionId: string ,
location: string ,
instanceId: string ,
restoreLocation: string ,
restoreTimestampInUtc: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name: string ,
type: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
Service_List (new)
Description Gets the status of service.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
creationTime: string ,
instanceSize: enum ,
instanceCount: integer ,
serviceType: enum ,
status: enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
Service_Create (new)
Description Creates a service.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
serviceName: string ,
api-version: string ,
createUpdateParameters:
{
properties:
{
instanceSize: enum ,
instanceCount: integer ,
serviceType: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
creationTime: string ,
instanceSize: enum ,
instanceCount: integer ,
serviceType: enum ,
status: enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
Service_Get (new)
Description Gets the status of service.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
serviceName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
creationTime: string ,
instanceSize: enum ,
instanceCount: integer ,
serviceType: enum ,
status: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
Service_Delete (new)
Description Deletes service with the given serviceName.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
serviceName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
}
,
}
TableResources_GetTableRoleDefinition (new)
Description Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tableRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
TableResources_CreateUpdateTableRoleDefinition (new)
Description Creates or updates an Azure Cosmos DB Table Role Definition.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tableRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
createUpdateTableRoleDefinitionParameters:
{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
TableResources_DeleteTableRoleDefinition (new)
Description Deletes an existing Azure Cosmos DB Table Role Definition.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tableRoleDefinitions/{roleDefinitionId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleDefinitionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
TableResources_ListTableRoleDefinitions (new)
Description Retrieves the list of all Azure Cosmos DB Table Role Definitions.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tableRoleDefinitions
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
roleName: string ,
type: enum ,
assignableScopes:
[
string ,
]
,
permissions:
[
{
id: string ,
dataActions:
[
string ,
]
,
notDataActions:
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
TableResources_GetTableRoleAssignment (new)
Description Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given Id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tableRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
TableResources_CreateUpdateTableRoleAssignment (new)
Description Creates or updates an Azure Cosmos DB Table Role Assignment.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tableRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
createUpdateTableRoleAssignmentParameters:
{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
TableResources_DeleteTableRoleAssignment (new)
Description Deletes an existing Azure Cosmos DB Table Role Assignment.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tableRoleAssignments/{roleAssignmentId}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
roleAssignmentId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
TableResources_ListTableRoleAssignments (new)
Description Retrieves the list of all Azure Cosmos DB Table Role Assignments.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tableRoleAssignments
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
roleDefinitionId: string ,
scope: string ,
principalId: string ,
provisioningState: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ThroughputPools_List (new)
Description Lists all the Azure Cosmos DB Throughput Pools available under the subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/throughputPools
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
maxThroughput: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ThroughputPools_ListByResourceGroup (new)
Description List all the ThroughputPools in a given resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
maxThroughput: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ThroughputPool_Get (new)
Description Retrieves the properties of an existing Azure Cosmos DB Throughput Pool
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
{
subscriptionId: string ,
resourceGroupName: string ,
throughputPoolName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
maxThroughput: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ThroughputPool_CreateOrUpdate (new)
Description Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
{
subscriptionId: string ,
resourceGroupName: string ,
throughputPoolName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
maxThroughput: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
maxThroughput: integer ,
}
,
}

⚐ Response (201)

{
properties:
{
provisioningState: enum ,
maxThroughput: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ThroughputPool_Update (new)
Description Updates the properties of an existing Azure Cosmos DB Throughput Pool.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
{
subscriptionId: string ,
resourceGroupName: string ,
throughputPoolName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
maxThroughput: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
maxThroughput: integer ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ThroughputPool_Delete (new)
Description Deletes an existing Azure Cosmos DB Throughput Pool.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
{
subscriptionId: string ,
resourceGroupName: string ,
throughputPoolName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ThroughputPoolAccounts_List (new)
Description Lists all the Azure Cosmos DB accounts available under the subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
throughputPoolName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
accountResourceIdentifier: string ,
accountLocation: string ,
accountInstanceId: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ThroughputPoolAccount_Get (new)
Description Retrieves the properties of an existing Azure Cosmos DB Throughput Pool
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}
{
subscriptionId: string ,
resourceGroupName: string ,
throughputPoolName: string ,
throughputPoolAccountName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
accountResourceIdentifier: string ,
accountLocation: string ,
accountInstanceId: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ThroughputPoolAccount_Create (new)
Description Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}
{
subscriptionId: string ,
resourceGroupName: string ,
throughputPoolName: string ,
throughputPoolAccountName: string ,
api-version: string ,
body:
{
properties:
{
provisioningState: enum ,
accountResourceIdentifier: string ,
accountLocation: string ,
accountInstanceId: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
accountResourceIdentifier: string ,
accountLocation: string ,
accountInstanceId: string ,
}
,
}

⚐ Response (201)

{
properties:
{
provisioningState: enum ,
accountResourceIdentifier: string ,
accountLocation: string ,
accountInstanceId: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ThroughputPoolAccount_Delete (new)
Description Removes an existing Azure Cosmos DB database account from a throughput pool.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}
{
subscriptionId: string ,
resourceGroupName: string ,
throughputPoolName: string ,
throughputPoolAccountName: string ,
api-version: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}