Share via

ArmResource Class

Definition

Namespace:
Azure.ResourceManager
Assembly:
Azure.ResourceManager.dll
Package:
Azure.ResourceManager v1.13.1
Package:
Azure.ResourceManager v1.14.0-beta.1
Source:
ArmResource.cs
Source:
ArmResource.cs

A class representing the operations that can be performed over a specific resource.

public abstract class ArmResource
type ArmResource = class
Public MustInherit Class ArmResource
Inheritance
Object
ArmResource
Derived

Constructors

ArmResource()

Initializes a new instance of the ArmResource class for mocking.
ArmResource(ArmClient, ResourceIdentifier)

Initializes a new instance of the ArmResource class.

Properties

Client

Gets the ArmClient this resource client was created from.
Diagnostics

Gets the diagnostic options for this resource client.
Endpoint

Gets the base uri for this resource client.
Id

Gets the resource identifier.
Pipeline

Gets the pipeline for this resource client.

Methods

CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.
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
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
GetManagementLocks()

Gets a collection of ManagementLockResources in the 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
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
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.
TryGetApiVersion(ResourceType, String)

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

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
<item>MockingTo mock this method, please mock GetAuthorizationRoleDefinition(ResourceIdentifier, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitionAsync(ResourceIdentifier, CancellationToken) instead.</item>
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. <item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.</item>
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
<item>MockingTo mock this method, please mock GetDenyAssignment(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetDenyAssignmentAsync(String, CancellationToken) instead.</item>
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetDenyAssignments() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignment(String, String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentAsync(String, String, CancellationToken) instead.</item>
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignments() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentSchedule(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleAsync(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstance(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstanceAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequest(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequestAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleRequests(ArmResource)

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

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilitySchedule(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleAsync(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstance(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstanceAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequest(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequestAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleRequests(ArmResource)

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

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

Gets a collection of RoleManagementPolicyResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicies() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicy(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignment(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignmentAsync(String, CancellationToken) instead.</item>
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAsync(String, CancellationToken) instead.</item>
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. <item>MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.</item>
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>

Applies to