MockableCosmosDBArmClient Class

Definition

Namespace:: Azure.ResourceManager.CosmosDB.Mocking

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.5.0

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.13

Source:: MockableCosmosDBArmClient.cs

Source:: MockableCosmosDBArmClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A class to add extension methods to ArmClient.

public class MockableCosmosDBArmClient : Azure.ResourceManager.ArmResource

type MockableCosmosDBArmClient = class
    inherit ArmResource

Public Class MockableCosmosDBArmClient
Inherits ArmResource

Inheritance: Object

ArmResource
MockableCosmosDBArmClient

Constructors

Name	Description
MockableCosmosDBArmClient()	Initializes a new instance of MockableCosmosDBArmClient for mocking.

Properties

Name	Description
Client	Gets the ArmClient this resource client was created from. (Inherited from ArmResource)
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmResource)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmResource)
Id	Gets the resource identifier. (Inherited from ArmResource)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmResource)

Methods

Name	Description
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)
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetCassandraClusterResource(ResourceIdentifier)	Gets an object representing a CassandraClusterResource along with the instance operations that can be performed on it but with no data.
GetCassandraDataCenterResource(ResourceIdentifier)	Gets an object representing a CassandraDataCenterResource along with the instance operations that can be performed on it but with no data.
GetCassandraKeyspaceResource(ResourceIdentifier)	Gets an object representing a CassandraKeyspaceResource along with the instance operations that can be performed on it but with no data.
GetCassandraKeyspaceThroughputSettingResource(ResourceIdentifier)	Gets an object representing a CassandraKeyspaceThroughputSettingResource along with the instance operations that can be performed on it but with no data.
GetCassandraRoleAssignmentResource(ResourceIdentifier)	Gets an object representing a CassandraRoleAssignmentResource along with the instance operations that can be performed on it but with no data.
GetCassandraRoleDefinitionResource(ResourceIdentifier)	Gets an object representing a CassandraRoleDefinitionResource along with the instance operations that can be performed on it but with no data.
GetCassandraTableResource(ResourceIdentifier)	Gets an object representing a CassandraTableResource along with the instance operations that can be performed on it but with no data.
GetCassandraTableThroughputSettingResource(ResourceIdentifier)	Gets an object representing a CassandraTableThroughputSettingResource along with the instance operations that can be performed on it but with no data.
GetCassandraViewGetResultResource(ResourceIdentifier)	Gets an object representing a CassandraViewGetResultResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a CassandraViewGetResultResource ResourceIdentifier from its components.
GetCassandraViewThroughputSettingResource(ResourceIdentifier)	Gets an object representing a CassandraViewThroughputSettingResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String, String) to create a CassandraViewThroughputSettingResource ResourceIdentifier from its components.
GetCosmosDBAccountResource(ResourceIdentifier)	Gets an object representing a CosmosDBAccountResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBChaosFaultResource(ResourceIdentifier)	Gets an object representing a CosmosDBChaosFaultResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBChaosFaultResource ResourceIdentifier from its components.
GetCosmosDBFleetResource(ResourceIdentifier)	Gets an object representing a CosmosDBFleetResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBFleetspaceAccountResource(ResourceIdentifier)	Gets an object representing a CosmosDBFleetspaceAccountResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBFleetspaceResource(ResourceIdentifier)	Gets an object representing a CosmosDBFleetspaceResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBLocationResource(ResourceIdentifier)	Gets an object representing a CosmosDBLocationResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBPrivateEndpointConnectionResource(ResourceIdentifier)	Gets an object representing a CosmosDBPrivateEndpointConnectionResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBPrivateLinkResource(ResourceIdentifier)	Gets an object representing a CosmosDBPrivateLinkResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBServiceResource(ResourceIdentifier)	Gets an object representing a CosmosDBServiceResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBSqlClientEncryptionKeyResource(ResourceIdentifier)	Gets an object representing a CosmosDBSqlClientEncryptionKeyResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBSqlContainerResource(ResourceIdentifier)	Gets an object representing a CosmosDBSqlContainerResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBSqlContainerThroughputSettingResource(ResourceIdentifier)	Gets an object representing a CosmosDBSqlContainerThroughputSettingResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBSqlDatabaseResource(ResourceIdentifier)	Gets an object representing a CosmosDBSqlDatabaseResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBSqlDatabaseThroughputSettingResource(ResourceIdentifier)	Gets an object representing a CosmosDBSqlDatabaseThroughputSettingResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBSqlRoleAssignmentResource(ResourceIdentifier)	Gets an object representing a CosmosDBSqlRoleAssignmentResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBSqlRoleDefinitionResource(ResourceIdentifier)	Gets an object representing a CosmosDBSqlRoleDefinitionResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBSqlStoredProcedureResource(ResourceIdentifier)	Gets an object representing a CosmosDBSqlStoredProcedureResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBSqlTriggerResource(ResourceIdentifier)	Gets an object representing a CosmosDBSqlTriggerResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBSqlUserDefinedFunctionResource(ResourceIdentifier)	Gets an object representing a CosmosDBSqlUserDefinedFunctionResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBTableResource(ResourceIdentifier)	Gets an object representing a CosmosDBTableResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBTableRoleAssignmentResource(ResourceIdentifier)	Gets an object representing a CosmosDBTableRoleAssignmentResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBTableRoleDefinitionResource(ResourceIdentifier)	Gets an object representing a CosmosDBTableRoleDefinitionResource along with the instance operations that can be performed on it but with no data.
GetCosmosDBThroughputPoolAccountResource(ResourceIdentifier)	Gets an object representing a CosmosDBThroughputPoolAccountResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a CosmosDBThroughputPoolAccountResource ResourceIdentifier from its components.
GetCosmosDBThroughputPoolResource(ResourceIdentifier)	Gets an object representing a CosmosDBThroughputPoolResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create a CosmosDBThroughputPoolResource ResourceIdentifier from its components.
GetCosmosTableThroughputSettingResource(ResourceIdentifier)	Gets an object representing a CosmosTableThroughputSettingResource along with the instance operations that can be performed on it but with no data.
GetDataTransferJobGetResultResource(ResourceIdentifier)	Gets an object representing a DataTransferJobGetResultResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a DataTransferJobGetResultResource ResourceIdentifier from its components.
GetGraphResourceGetResultResource(ResourceIdentifier)	Gets an object representing a GraphResourceGetResultResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a GraphResourceGetResultResource ResourceIdentifier from its components.
GetGremlinDatabaseResource(ResourceIdentifier)	Gets an object representing a GremlinDatabaseResource along with the instance operations that can be performed on it but with no data.
GetGremlinDatabaseThroughputSettingResource(ResourceIdentifier)	Gets an object representing a GremlinDatabaseThroughputSettingResource along with the instance operations that can be performed on it but with no data.
GetGremlinGraphResource(ResourceIdentifier)	Gets an object representing a GremlinGraphResource along with the instance operations that can be performed on it but with no data.
GetGremlinGraphThroughputSettingResource(ResourceIdentifier)	Gets an object representing a GremlinGraphThroughputSettingResource along with the instance operations that can be performed on it but with no data.
GetGremlinRoleAssignmentResource(ResourceIdentifier)	Gets an object representing a GremlinRoleAssignmentResource along with the instance operations that can be performed on it but with no data.
GetGremlinRoleDefinitionResource(ResourceIdentifier)	Gets an object representing a GremlinRoleDefinitionResource along with the instance operations that can be performed on it but with no data.
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)
GetMongoDBCollectionResource(ResourceIdentifier)	Gets an object representing a MongoDBCollectionResource along with the instance operations that can be performed on it but with no data.
GetMongoDBCollectionThroughputSettingResource(ResourceIdentifier)	Gets an object representing a MongoDBCollectionThroughputSettingResource along with the instance operations that can be performed on it but with no data.
GetMongoDBDatabaseResource(ResourceIdentifier)	Gets an object representing a MongoDBDatabaseResource along with the instance operations that can be performed on it but with no data.
GetMongoDBDatabaseThroughputSettingResource(ResourceIdentifier)	Gets an object representing a MongoDBDatabaseThroughputSettingResource along with the instance operations that can be performed on it but with no data.
GetMongoDBRoleDefinitionResource(ResourceIdentifier)	Gets an object representing a MongoDBRoleDefinitionResource along with the instance operations that can be performed on it but with no data.
GetMongoDBUserDefinitionResource(ResourceIdentifier)	Gets an object representing a MongoDBUserDefinitionResource along with the instance operations that can be performed on it but with no data.
GetMongoMIRoleAssignmentResource(ResourceIdentifier)	Gets an object representing a MongoMIRoleAssignmentResource along with the instance operations that can be performed on it but with no data.
GetMongoMIRoleDefinitionResource(ResourceIdentifier)	Gets an object representing a MongoMIRoleDefinitionResource along with the instance operations that can be performed on it but with no data.
GetNetworkSecurityPerimeterConfigurationResource(ResourceIdentifier)	Gets an object representing a NetworkSecurityPerimeterConfigurationResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a NetworkSecurityPerimeterConfigurationResource ResourceIdentifier from its components.
GetNotebookWorkspaceResource(ResourceIdentifier)	Gets an object representing a NotebookWorkspaceResource along with the instance operations that can be performed on it but with no data.
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)
GetRestorableCosmosDBAccountResource(ResourceIdentifier)	Gets an object representing a RestorableCosmosDBAccountResource along with the instance operations that can be performed on it but with no data.
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)

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

Feedback

Was this page helpful?