Dela via

CosmosDBAccountResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.CosmosDB
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.3.2
Package:
Azure.ResourceManager.CosmosDB v1.4.0-beta.11
Source:
CosmosDBAccountResource.cs
Source:
CosmosDBAccountResource.cs

A Class representing a CosmosDBAccount along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a CosmosDBAccountResource from an instance of ArmClient using the GetCosmosDBAccountResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetCosmosDBAccount method.

public class CosmosDBAccountResource : Azure.ResourceManager.ArmResource
public class CosmosDBAccountResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.CosmosDBAccountData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.CosmosDBAccountData>
type CosmosDBAccountResource = class
    inherit ArmResource
type CosmosDBAccountResource = class
    inherit ArmResource
    interface IJsonModel<CosmosDBAccountData>
    interface IPersistableModel<CosmosDBAccountData>
Public Class CosmosDBAccountResource
Inherits ArmResource
Public Class CosmosDBAccountResource
Inherits ArmResource
Implements IJsonModel(Of CosmosDBAccountData), IPersistableModel(Of CosmosDBAccountData)
Inheritance
Object
ArmResource
CosmosDBAccountResource
Implements
IJsonModel<CosmosDBAccountData> IPersistableModel<CosmosDBAccountData> IPersistableModel<T>

Constructors

CosmosDBAccountResource()

Initializes a new instance of the CosmosDBAccountResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.
Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)

Generate the resource identifier of a CosmosDBAccountResource instance.
Delete(WaitUntil, CancellationToken)

Deletes an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Delete
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
DeleteAsync(WaitUntil, CancellationToken)

Deletes an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Delete
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
FailoverPriorityChange(WaitUntil, CosmosDBFailoverPolicies, CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange
  • Operation Id: DatabaseAccounts_FailoverPriorityChange
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
FailoverPriorityChangeAsync(WaitUntil, CosmosDBFailoverPolicies, CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange
  • Operation Id: DatabaseAccounts_FailoverPriorityChange
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
Get(CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetAsync(CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetCassandraKeyspace(String, CancellationToken)

Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
  • Operation Id: CassandraResources_GetCassandraKeyspace
  • Default Api Version: 2024-09-01-preview
  • Resource: CassandraKeyspaceResource
GetCassandraKeyspaceAsync(String, CancellationToken)

Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}
  • Operation Id: CassandraResources_GetCassandraKeyspace
  • Default Api Version: 2024-09-01-preview
  • Resource: CassandraKeyspaceResource
GetCassandraKeyspaces()

Gets a collection of CassandraKeyspaceResources in the CosmosDBAccount.
GetConnectionStrings(CancellationToken)

Lists the connection strings for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings
  • Operation Id: DatabaseAccounts_ListConnectionStrings
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetConnectionStringsAsync(CancellationToken)

Lists the connection strings for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings
  • Operation Id: DatabaseAccounts_ListConnectionStrings
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetCosmosDBChaosFaultResource(String, CancellationToken)

Get Chaos Fault for a CosmosdB account for a particular Chaos Fault.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults/{chaosFault}
  • Operation Id: ChaosFault_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBChaosFaultResource
GetCosmosDBChaosFaultResourceAsync(String, CancellationToken)

Get Chaos Fault for a CosmosdB account for a particular Chaos Fault.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults/{chaosFault}
  • Operation Id: ChaosFault_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBChaosFaultResource
GetCosmosDBChaosFaultResources()

Gets a collection of CosmosDBChaosFaultResources in the CosmosDBAccount.
GetCosmosDBPrivateEndpointConnection(String, CancellationToken)

Gets a private endpoint connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBPrivateEndpointConnectionResource
GetCosmosDBPrivateEndpointConnectionAsync(String, CancellationToken)

Gets a private endpoint connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBPrivateEndpointConnectionResource
GetCosmosDBPrivateEndpointConnections()

Gets a collection of CosmosDBPrivateEndpointConnectionResources in the CosmosDBAccount.
GetCosmosDBPrivateLinkResource(String, CancellationToken)

Gets the private link resources that need to be created for a Cosmos DB account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}
  • Operation Id: PrivateLinkResources_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBPrivateLinkResource
GetCosmosDBPrivateLinkResourceAsync(String, CancellationToken)

Gets the private link resources that need to be created for a Cosmos DB account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}
  • Operation Id: PrivateLinkResources_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBPrivateLinkResource
GetCosmosDBPrivateLinkResources()

Gets a collection of CosmosDBPrivateLinkResources in the CosmosDBAccount.
GetCosmosDBService(String, CancellationToken)

Gets the status of service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}
  • Operation Id: Service_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBServiceResource
GetCosmosDBServiceAsync(String, CancellationToken)

Gets the status of service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}
  • Operation Id: Service_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBServiceResource
GetCosmosDBServices()

Gets a collection of CosmosDBServiceResources in the CosmosDBAccount.
GetCosmosDBSqlDatabase(String, CancellationToken)

Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
  • Operation Id: SqlResources_GetSqlDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlDatabaseResource
GetCosmosDBSqlDatabaseAsync(String, CancellationToken)

Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}
  • Operation Id: SqlResources_GetSqlDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlDatabaseResource
GetCosmosDBSqlDatabases()

Gets a collection of CosmosDBSqlDatabaseResources in the CosmosDBAccount.
GetCosmosDBSqlRoleAssignment(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}
  • Operation Id: SqlResources_GetSqlRoleAssignment
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlRoleAssignmentResource
GetCosmosDBSqlRoleAssignmentAsync(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}
  • Operation Id: SqlResources_GetSqlRoleAssignment
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlRoleAssignmentResource
GetCosmosDBSqlRoleAssignments()

Gets a collection of CosmosDBSqlRoleAssignmentResources in the CosmosDBAccount.
GetCosmosDBSqlRoleDefinition(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}
  • Operation Id: SqlResources_GetSqlRoleDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlRoleDefinitionResource
GetCosmosDBSqlRoleDefinitionAsync(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}
  • Operation Id: SqlResources_GetSqlRoleDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlRoleDefinitionResource
GetCosmosDBSqlRoleDefinitions()

Gets a collection of CosmosDBSqlRoleDefinitionResources in the CosmosDBAccount.
GetCosmosDBTable(String, CancellationToken)

Gets the Tables under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
  • Operation Id: TableResources_GetTable
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBTableResource
GetCosmosDBTableAsync(String, CancellationToken)

Gets the Tables under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
  • Operation Id: TableResources_GetTable
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBTableResource
GetCosmosDBTables()

Gets a collection of CosmosDBTableResources in the CosmosDBAccount.
GetDataTransferJobGetResult(String, CancellationToken)

Get a Data Transfer Job.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}
  • Operation Id: DataTransferJobs_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: DataTransferJobGetResultResource
GetDataTransferJobGetResultAsync(String, CancellationToken)

Get a Data Transfer Job.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}
  • Operation Id: DataTransferJobs_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: DataTransferJobGetResultResource
GetDataTransferJobGetResults()

Gets a collection of DataTransferJobGetResultResources in the CosmosDBAccount.
GetGraphResourceGetResult(String, CancellationToken)

Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs/{graphName}
  • Operation Id: GraphResources_GetGraph
  • Default Api Version: 2024-09-01-preview
  • Resource: GraphResourceGetResultResource
GetGraphResourceGetResultAsync(String, CancellationToken)

Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs/{graphName}
  • Operation Id: GraphResources_GetGraph
  • Default Api Version: 2024-09-01-preview
  • Resource: GraphResourceGetResultResource
GetGraphResourceGetResults()

Gets a collection of GraphResourceGetResultResources in the CosmosDBAccount.
GetGremlinDatabase(String, CancellationToken)

Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
  • Operation Id: GremlinResources_GetGremlinDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
GetGremlinDatabaseAsync(String, CancellationToken)

Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
  • Operation Id: GremlinResources_GetGremlinDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
GetGremlinDatabases()

Gets a collection of GremlinDatabaseResources in the CosmosDBAccount.
GetKeys(CancellationToken)

Lists the access keys for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys
  • Operation Id: DatabaseAccounts_ListKeys
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetKeysAsync(CancellationToken)

Lists the access keys for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys
  • Operation Id: DatabaseAccounts_ListKeys
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetMetricDefinitions(CancellationToken)

Retrieves metric definitions for the given database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions
  • Operation Id: DatabaseAccounts_ListMetricDefinitions
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetMetricDefinitionsAsync(CancellationToken)

Retrieves metric definitions for the given database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions
  • Operation Id: DatabaseAccounts_ListMetricDefinitions
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetMetricDefinitionsCollections(String, String, CancellationToken)

Retrieves metric definitions for the given collection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions
  • Operation Id: Collection_ListMetricDefinitions
  • Default Api Version: 2024-09-01-preview
GetMetricDefinitionsCollectionsAsync(String, String, CancellationToken)

Retrieves metric definitions for the given collection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions
  • Operation Id: Collection_ListMetricDefinitions
  • Default Api Version: 2024-09-01-preview
GetMetricDefinitionsDatabases(String, CancellationToken)

Retrieves metric definitions for the given database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions
  • Operation Id: Database_ListMetricDefinitions
  • Default Api Version: 2024-09-01-preview
GetMetricDefinitionsDatabasesAsync(String, CancellationToken)

Retrieves metric definitions for the given database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions
  • Operation Id: Database_ListMetricDefinitions
  • Default Api Version: 2024-09-01-preview
GetMetrics(String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics
  • Operation Id: DatabaseAccounts_ListMetrics
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetMetricsAsync(String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics
  • Operation Id: DatabaseAccounts_ListMetrics
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetMetricsCollectionPartitionRegions(String, String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given collection and region, split by partition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
  • Operation Id: CollectionPartitionRegion_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsCollectionPartitionRegionsAsync(String, String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given collection and region, split by partition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
  • Operation Id: CollectionPartitionRegion_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsCollectionPartitions(String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given collection, split by partition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
  • Operation Id: CollectionPartition_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsCollectionPartitionsAsync(String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given collection, split by partition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics
  • Operation Id: CollectionPartition_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsCollectionRegions(String, String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account, collection and region.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics
  • Operation Id: CollectionRegion_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsCollectionRegionsAsync(String, String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account, collection and region.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics
  • Operation Id: CollectionRegion_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsCollections(String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account and collection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics
  • Operation Id: Collection_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsCollectionsAsync(String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account and collection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics
  • Operation Id: Collection_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsDatabaseAccountRegions(String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account and region.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics
  • Operation Id: DatabaseAccountRegion_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsDatabaseAccountRegionsAsync(String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account and region.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics
  • Operation Id: DatabaseAccountRegion_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsDatabases(String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account and database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics
  • Operation Id: Database_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsDatabasesAsync(String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account and database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics
  • Operation Id: Database_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsPartitionKeyRangeIdRegions(String, String, String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given partition key range id and region.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
  • Operation Id: PartitionKeyRangeIdRegion_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsPartitionKeyRangeIdRegionsAsync(String, String, String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given partition key range id and region.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
  • Operation Id: PartitionKeyRangeIdRegion_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsPartitionKeyRangeIds(String, String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given partition key range id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
  • Operation Id: PartitionKeyRangeId_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsPartitionKeyRangeIdsAsync(String, String, String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given partition key range id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
  • Operation Id: PartitionKeyRangeId_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsPercentiles(String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics
  • Operation Id: Percentile_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsPercentilesAsync(String, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics
  • Operation Id: Percentile_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsPercentileSourceTargets(String, String, String, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics
  • Operation Id: PercentileSourceTarget_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsPercentileSourceTargetsAsync(String, String, String, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics
  • Operation Id: PercentileSourceTarget_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsPercentileTargets(String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics
  • Operation Id: PercentileTarget_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMetricsPercentileTargetsAsync(String, String, CancellationToken)

Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics
  • Operation Id: PercentileTarget_ListMetrics
  • Default Api Version: 2024-09-01-preview
GetMongoDBDatabase(String, CancellationToken)

Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
  • Operation Id: MongoDBResources_GetMongoDBDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBDatabaseResource
GetMongoDBDatabaseAsync(String, CancellationToken)

Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
  • Operation Id: MongoDBResources_GetMongoDBDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBDatabaseResource
GetMongoDBDatabases()

Gets a collection of MongoDBDatabaseResources in the CosmosDBAccount.
GetMongoDBRoleDefinition(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}
  • Operation Id: MongoDBResources_GetMongoRoleDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBRoleDefinitionResource
GetMongoDBRoleDefinitionAsync(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}
  • Operation Id: MongoDBResources_GetMongoRoleDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBRoleDefinitionResource
GetMongoDBRoleDefinitions()

Gets a collection of MongoDBRoleDefinitionResources in the CosmosDBAccount.
GetMongoDBUserDefinition(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_GetMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
GetMongoDBUserDefinitionAsync(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_GetMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
GetMongoDBUserDefinitions()

Gets a collection of MongoDBUserDefinitionResources in the CosmosDBAccount.
GetNetworkSecurityPerimeterConfiguration(String, CancellationToken)

Gets effective Network Security Perimeter Configuration for association

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}
  • Operation Id: NetworkSecurityPerimeterConfigurations_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: NetworkSecurityPerimeterConfigurationResource
GetNetworkSecurityPerimeterConfigurationAsync(String, CancellationToken)

Gets effective Network Security Perimeter Configuration for association

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}
  • Operation Id: NetworkSecurityPerimeterConfigurations_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: NetworkSecurityPerimeterConfigurationResource
GetNetworkSecurityPerimeterConfigurations()

Gets a collection of NetworkSecurityPerimeterConfigurationResources in the CosmosDBAccount.
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetReadOnlyKeys(CancellationToken)

Lists the read-only access keys for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys
  • Operation Id: DatabaseAccounts_ListReadOnlyKeys
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetReadOnlyKeysAsync(CancellationToken)

Lists the read-only access keys for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys
  • Operation Id: DatabaseAccounts_ListReadOnlyKeys
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetUsages(String, CancellationToken)

Retrieves the usages (most recent data) for the given database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages
  • Operation Id: DatabaseAccounts_ListUsages
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetUsagesAsync(String, CancellationToken)

Retrieves the usages (most recent data) for the given database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages
  • Operation Id: DatabaseAccounts_ListUsages
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
GetUsagesCollectionPartitions(String, String, String, CancellationToken)

Retrieves the usages (most recent storage data) for the given collection, split by partition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages
  • Operation Id: CollectionPartition_ListUsages
  • Default Api Version: 2024-09-01-preview
GetUsagesCollectionPartitionsAsync(String, String, String, CancellationToken)

Retrieves the usages (most recent storage data) for the given collection, split by partition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages
  • Operation Id: CollectionPartition_ListUsages
  • Default Api Version: 2024-09-01-preview
GetUsagesCollections(String, String, String, CancellationToken)

Retrieves the usages (most recent storage data) for the given collection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages
  • Operation Id: Collection_ListUsages
  • Default Api Version: 2024-09-01-preview
GetUsagesCollectionsAsync(String, String, String, CancellationToken)

Retrieves the usages (most recent storage data) for the given collection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages
  • Operation Id: Collection_ListUsages
  • Default Api Version: 2024-09-01-preview
GetUsagesDatabases(String, String, CancellationToken)

Retrieves the usages (most recent data) for the given database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages
  • Operation Id: Database_ListUsages
  • Default Api Version: 2024-09-01-preview
GetUsagesDatabasesAsync(String, String, CancellationToken)

Retrieves the usages (most recent data) for the given database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages
  • Operation Id: Database_ListUsages
  • Default Api Version: 2024-09-01-preview
OfflineRegion(WaitUntil, RegionForOnlineOffline, CancellationToken)

Offline the specified region for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion
  • Operation Id: DatabaseAccounts_OfflineRegion
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
OfflineRegionAsync(WaitUntil, RegionForOnlineOffline, CancellationToken)

Offline the specified region for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion
  • Operation Id: DatabaseAccounts_OfflineRegion
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
OnlineRegion(WaitUntil, RegionForOnlineOffline, CancellationToken)

Online the specified region for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion
  • Operation Id: DatabaseAccounts_OnlineRegion
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
OnlineRegionAsync(WaitUntil, RegionForOnlineOffline, CancellationToken)

Online the specified region for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion
  • Operation Id: DatabaseAccounts_OnlineRegion
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
RegenerateKey(WaitUntil, CosmosDBAccountRegenerateKeyContent, CancellationToken)

Regenerates an access key for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey
  • Operation Id: DatabaseAccounts_RegenerateKey
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
RegenerateKeyAsync(WaitUntil, CosmosDBAccountRegenerateKeyContent, CancellationToken)

Regenerates an access key for the specified Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey
  • Operation Id: DatabaseAccounts_RegenerateKey
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, CosmosDBAccountPatch, CancellationToken)

Updates the properties of an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Update
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource
UpdateAsync(WaitUntil, CosmosDBAccountPatch, CancellationToken)

Updates the properties of an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
  • Operation Id: DatabaseAccounts_Update
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBAccountResource

Explicit Interface Implementations

IJsonModel<CosmosDBAccountData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CosmosDBAccountData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<CosmosDBAccountData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<CosmosDBAccountData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosDBAccountData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to