Поделиться через

CosmosDBForPostgreSqlClusterResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.CosmosDBForPostgreSql
Assembly:
Azure.ResourceManager.CosmosDBForPostgreSql.dll
Package:
Azure.ResourceManager.CosmosDBForPostgreSql v1.0.0
Package:
Azure.ResourceManager.CosmosDBForPostgreSql v1.1.0-beta.2
Source:
CosmosDBForPostgreSqlClusterResource.cs
Source:
CosmosDBForPostgreSqlClusterResource.cs

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

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

Constructors

CosmosDBForPostgreSqlClusterResource()

Initializes a new instance of the CosmosDBForPostgreSqlClusterResource 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.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
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 CosmosDBForPostgreSqlClusterResource instance.
Delete(WaitUntil, CancellationToken)

Deletes a cluster together with servers in it.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Delete
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
DeleteAsync(WaitUntil, CancellationToken)

Deletes a cluster together with servers in it.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Delete
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
Get(CancellationToken)

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
GetAsync(CancellationToken)

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetCosmosDBForPostgreSqlClusterServer(String, CancellationToken)

Gets information about a server in cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers/{serverName}
  • Operation Id: Servers_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterServerResource
GetCosmosDBForPostgreSqlClusterServerAsync(String, CancellationToken)

Gets information about a server in cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers/{serverName}
  • Operation Id: Servers_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterServerResource
GetCosmosDBForPostgreSqlClusterServers()

Gets a collection of CosmosDBForPostgreSqlClusterServerResources in the CosmosDBForPostgreSqlCluster.
GetCosmosDBForPostgreSqlConfiguration(String, CancellationToken)

Gets information of a configuration for coordinator and nodes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/configurations/{configurationName}
  • Operation Id: Configurations_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlConfigurationResource
GetCosmosDBForPostgreSqlConfigurationAsync(String, CancellationToken)

Gets information of a configuration for coordinator and nodes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/configurations/{configurationName}
  • Operation Id: Configurations_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlConfigurationResource
GetCosmosDBForPostgreSqlConfigurations()

Gets a collection of CosmosDBForPostgreSqlConfigurationResources in the CosmosDBForPostgreSqlCluster.
GetCosmosDBForPostgreSqlCoordinatorConfiguration(String, CancellationToken)

Gets information of a configuration for coordinator.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/coordinatorConfigurations/{configurationName}
  • Operation Id: Configurations_GetCoordinator
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlCoordinatorConfigurationResource
GetCosmosDBForPostgreSqlCoordinatorConfigurationAsync(String, CancellationToken)

Gets information of a configuration for coordinator.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/coordinatorConfigurations/{configurationName}
  • Operation Id: Configurations_GetCoordinator
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlCoordinatorConfigurationResource
GetCosmosDBForPostgreSqlCoordinatorConfigurations()

Gets a collection of CosmosDBForPostgreSqlCoordinatorConfigurationResources in the CosmosDBForPostgreSqlCluster.
GetCosmosDBForPostgreSqlFirewallRule(String, CancellationToken)

Gets information about a cluster firewall rule.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/firewallRules/{firewallRuleName}
  • Operation Id: FirewallRules_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlFirewallRuleResource
GetCosmosDBForPostgreSqlFirewallRuleAsync(String, CancellationToken)

Gets information about a cluster firewall rule.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/firewallRules/{firewallRuleName}
  • Operation Id: FirewallRules_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlFirewallRuleResource
GetCosmosDBForPostgreSqlFirewallRules()

Gets a collection of CosmosDBForPostgreSqlFirewallRuleResources in the CosmosDBForPostgreSqlCluster.
GetCosmosDBForPostgreSqlNodeConfiguration(String, CancellationToken)

Gets information of a configuration for worker nodes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/nodeConfigurations/{configurationName}
  • Operation Id: Configurations_GetNode
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlNodeConfigurationResource
GetCosmosDBForPostgreSqlNodeConfigurationAsync(String, CancellationToken)

Gets information of a configuration for worker nodes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/nodeConfigurations/{configurationName}
  • Operation Id: Configurations_GetNode
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlNodeConfigurationResource
GetCosmosDBForPostgreSqlNodeConfigurations()

Gets a collection of CosmosDBForPostgreSqlNodeConfigurationResources in the CosmosDBForPostgreSqlCluster.
GetCosmosDBForPostgreSqlPrivateEndpointConnection(String, CancellationToken)

Gets private endpoint connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlPrivateEndpointConnectionResource
GetCosmosDBForPostgreSqlPrivateEndpointConnectionAsync(String, CancellationToken)

Gets private endpoint connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlPrivateEndpointConnectionResource
GetCosmosDBForPostgreSqlPrivateEndpointConnections()

Gets a collection of CosmosDBForPostgreSqlPrivateEndpointConnectionResources in the CosmosDBForPostgreSqlCluster.
GetCosmosDBForPostgreSqlPrivateLinkResource(String, CancellationToken)

Gets a private link resource for cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateLinkResources/{privateLinkResourceName}
  • Operation Id: PrivateLinkResources_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlPrivateLinkResource
GetCosmosDBForPostgreSqlPrivateLinkResourceAsync(String, CancellationToken)

Gets a private link resource for cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateLinkResources/{privateLinkResourceName}
  • Operation Id: PrivateLinkResources_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlPrivateLinkResource
GetCosmosDBForPostgreSqlPrivateLinkResources()

Gets a collection of CosmosDBForPostgreSqlPrivateLinkResources in the CosmosDBForPostgreSqlCluster.
GetCosmosDBForPostgreSqlRole(String, CancellationToken)

Gets information about a cluster role.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}
  • Operation Id: Roles_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlRoleResource
GetCosmosDBForPostgreSqlRoleAsync(String, CancellationToken)

Gets information about a cluster role.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}
  • Operation Id: Roles_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlRoleResource
GetCosmosDBForPostgreSqlRoles()

Gets a collection of CosmosDBForPostgreSqlRoleResources in the CosmosDBForPostgreSqlCluster.
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)
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)
GetTagResource()

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

(Inherited from ArmResource)
PromoteReadReplica(WaitUntil, CancellationToken)

Promotes read replica cluster to an independent read-write cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/promote
  • Operation Id: Clusters_PromoteReadReplica
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
PromoteReadReplicaAsync(WaitUntil, CancellationToken)

Promotes read replica cluster to an independent read-write cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/promote
  • Operation Id: Clusters_PromoteReadReplica
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
Restart(WaitUntil, CancellationToken)

Restarts all nodes in the cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/restart
  • Operation Id: Clusters_Restart
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
RestartAsync(WaitUntil, CancellationToken)

Restarts all nodes in the cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/restart
  • Operation Id: Clusters_Restart
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
Start(WaitUntil, CancellationToken)

Starts stopped compute on all cluster nodes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/start
  • Operation Id: Clusters_Start
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
StartAsync(WaitUntil, CancellationToken)

Starts stopped compute on all cluster nodes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/start
  • Operation Id: Clusters_Start
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
Stop(WaitUntil, CancellationToken)

Stops compute on all cluster nodes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/stop
  • Operation Id: Clusters_Stop
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
StopAsync(WaitUntil, CancellationToken)

Stops compute on all cluster nodes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/stop
  • Operation Id: Clusters_Stop
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
TryGetApiVersion(ResourceType, String)

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

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

Updates an existing cluster. The request body can contain one or several properties from the cluster definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Update
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource
UpdateAsync(WaitUntil, CosmosDBForPostgreSqlClusterPatch, CancellationToken)

Updates an existing cluster. The request body can contain one or several properties from the cluster definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Update
  • Default Api Version: 2022-11-08
  • Resource: CosmosDBForPostgreSqlClusterResource

Explicit Interface Implementations

IJsonModel<CosmosDBForPostgreSqlClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

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

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosDBForPostgreSqlClusterData>.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
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
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
GetLinkerResources(ArmResource)

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

Applies to