CosmosDBAccountResource Class

Definition

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 GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetCosmosDBAccounts method.

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
    interface IJsonModel<CosmosDBAccountData>
    interface IPersistableModel<CosmosDBAccountData>
Public Class CosmosDBAccountResource
Inherits ArmResource
Implements IJsonModel(Of CosmosDBAccountData), IPersistableModel(Of CosmosDBAccountData)
Inheritance
CosmosDBAccountResource
Implements

Constructors

Name Description
CosmosDBAccountResource()

Initializes a new instance of CosmosDBAccountResource for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
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

Name Description
AddTag(String, String, CancellationToken)

Add a tag to the current resource.

AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

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 for this resource.

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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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.

GetCassandraKeyspaceAsync(String, CancellationToken)

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

GetCassandraKeyspaces()

Gets a collection of CassandraKeyspaces in the CosmosDBAccountResource.

GetCassandraRoleAssignment(String, CancellationToken)

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

GetCassandraRoleAssignmentAsync(String, CancellationToken)

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

GetCassandraRoleAssignments()

Gets a collection of CassandraRoleAssignments in the CosmosDBAccountResource.

GetCassandraRoleDefinition(String, CancellationToken)

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

GetCassandraRoleDefinitionAsync(String, CancellationToken)

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

GetCassandraRoleDefinitions()

Gets a collection of CassandraRoleDefinitions in the CosmosDBAccountResource.

GetConnectionStrings(CancellationToken)

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

GetConnectionStringsAsync(CancellationToken)

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

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-12-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-12-01-preview
  • Resource: CosmosDBChaosFaultResource
GetCosmosDBChaosFaultResources()

Gets a collection of CosmosDBChaosFaultResources in the CosmosDBAccount.

GetCosmosDBPrivateEndpointConnection(String, CancellationToken)

Gets a private endpoint connection.

GetCosmosDBPrivateEndpointConnectionAsync(String, CancellationToken)

Gets a private endpoint connection.

GetCosmosDBPrivateEndpointConnections()

Gets a collection of CosmosDBPrivateEndpointConnections in the CosmosDBAccountResource.

GetCosmosDBPrivateLinkResource(String, CancellationToken)

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

GetCosmosDBPrivateLinkResourceAsync(String, CancellationToken)

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

GetCosmosDBPrivateLinkResources()

Gets a collection of CosmosDBPrivateLinkResources in the CosmosDBAccountResource.

GetCosmosDBService(String, CancellationToken)

Gets the status of service.

GetCosmosDBServiceAsync(String, CancellationToken)

Gets the status of service.

GetCosmosDBServices()

Gets a collection of CosmosDBServices in the CosmosDBAccountResource.

GetCosmosDBSqlDatabase(String, CancellationToken)

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

GetCosmosDBSqlDatabaseAsync(String, CancellationToken)

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

GetCosmosDBSqlDatabases()

Gets a collection of CosmosDBSqlDatabases in the CosmosDBAccountResource.

GetCosmosDBSqlRoleAssignment(String, CancellationToken)

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

GetCosmosDBSqlRoleAssignmentAsync(String, CancellationToken)

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

GetCosmosDBSqlRoleAssignments()

Gets a collection of CosmosDBSqlRoleAssignments in the CosmosDBAccountResource.

GetCosmosDBSqlRoleDefinition(String, CancellationToken)

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

GetCosmosDBSqlRoleDefinitionAsync(String, CancellationToken)

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

GetCosmosDBSqlRoleDefinitions()

Gets a collection of CosmosDBSqlRoleDefinitions in the CosmosDBAccountResource.

GetCosmosDBTable(String, CancellationToken)

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

GetCosmosDBTableAsync(String, CancellationToken)

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

GetCosmosDBTableRoleAssignment(String, CancellationToken)

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

GetCosmosDBTableRoleAssignmentAsync(String, CancellationToken)

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

GetCosmosDBTableRoleAssignments()

Gets a collection of CosmosDBTableRoleAssignments in the CosmosDBAccountResource.

GetCosmosDBTableRoleDefinition(String, CancellationToken)

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

GetCosmosDBTableRoleDefinitionAsync(String, CancellationToken)

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

GetCosmosDBTableRoleDefinitions()

Gets a collection of CosmosDBTableRoleDefinitions in the CosmosDBAccountResource.

GetCosmosDBTables()

Gets a collection of CosmosDBTables in the CosmosDBAccountResource.

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-12-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-12-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-12-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-12-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.

GetGremlinDatabaseAsync(String, CancellationToken)

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

GetGremlinDatabases()

Gets a collection of GremlinDatabases in the CosmosDBAccountResource.

GetGremlinRoleAssignment(String, CancellationToken)

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

GetGremlinRoleAssignmentAsync(String, CancellationToken)

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

GetGremlinRoleAssignments()

Gets a collection of GremlinRoleAssignments in the CosmosDBAccountResource.

GetGremlinRoleDefinition(String, CancellationToken)

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

GetGremlinRoleDefinitionAsync(String, CancellationToken)

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

GetGremlinRoleDefinitions()

Gets a collection of GremlinRoleDefinitions in the CosmosDBAccountResource.

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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : DatabaseAccounts_CollectionListMetricDefinitions.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionListMetricDefinitions.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_DatabaseListMetricDefinitions.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_DatabaseListMetricDefinitions.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : DatabaseAccounts_CollectionPartitionRegionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionPartitionRegionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionPartitionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionPartitionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionRegionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionRegionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_DatabaseAccountRegionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_DatabaseAccountRegionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_DatabaseListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_DatabaseListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_PartitionKeyRangeIdRegionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_PartitionKeyRangeIdRegionListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_PartitionKeyRangeIdListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_PartitionKeyRangeIdListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_PercentileListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_PercentileListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_PercentileSourceTargetListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_PercentileSourceTargetListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_PercentileTargetListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_PercentileTargetListMetrics.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
GetMongoDBDatabase(String, CancellationToken)

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

GetMongoDBDatabaseAsync(String, CancellationToken)

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

GetMongoDBDatabases()

Gets a collection of MongoDBDatabases in the CosmosDBAccountResource.

GetMongoDBRoleDefinition(String, CancellationToken)

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

GetMongoDBRoleDefinitionAsync(String, CancellationToken)

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

GetMongoDBRoleDefinitions()

Gets a collection of MongoDBRoleDefinitions in the CosmosDBAccountResource.

GetMongoDBUserDefinition(String, CancellationToken)

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

GetMongoDBUserDefinitionAsync(String, CancellationToken)

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

GetMongoDBUserDefinitions()

Gets a collection of MongoDBUserDefinitions in the CosmosDBAccountResource.

GetMongoMIRoleAssignment(String, CancellationToken)

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

GetMongoMIRoleAssignmentAsync(String, CancellationToken)

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

GetMongoMIRoleAssignments()

Gets a collection of MongoMIRoleAssignments in the CosmosDBAccountResource.

GetMongoMIRoleDefinition(String, CancellationToken)

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

GetMongoMIRoleDefinitionAsync(String, CancellationToken)

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

GetMongoMIRoleDefinitions()

Gets a collection of MongoMIRoleDefinitions in the CosmosDBAccountResource.

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-12-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-12-01-preview
  • Resource: NetworkSecurityPerimeterConfigurationResource
GetNetworkSecurityPerimeterConfigurations()

Gets a collection of NetworkSecurityPerimeterConfigurationResources in the CosmosDBAccount.

GetNotebookWorkspace(NotebookWorkspaceName, CancellationToken)

Gets the notebook workspace for a Cosmos DB account.

GetNotebookWorkspaceAsync(NotebookWorkspaceName, CancellationToken)

Gets the notebook workspace for a Cosmos DB account.

GetNotebookWorkspaces()

Gets a collection of NotebookWorkspaces in the CosmosDBAccountResource.

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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : DatabaseAccounts_CollectionPartitionListUsages.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionPartitionListUsages.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionListUsages.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_CollectionListUsages.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_DatabaseListUsages.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : DatabaseAccounts_DatabaseListUsages.
  • Default Api Version. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • 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. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

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. : 2026-03-15.
  • 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. : 2026-03-15.
  • Resource. : CosmosDBAccountResource.

Explicit Interface Implementations

Name Description
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

Name Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentCollection objects within the specified scope.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

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

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentCollection objects within the specified scope.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyCollection objects within the specified scope.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetSystemAssignedIdentity(ArmResource)

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

Applies to