Share via


DataProtectionBackupInstanceResource Class

Definition

A Class representing a DataProtectionBackupInstance along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a DataProtectionBackupInstanceResource from an instance of ArmClient using the GetDataProtectionBackupInstanceResource method. Otherwise you can get one from its parent resource DataProtectionBackupVaultResource using the GetDataProtectionBackupInstance method.

public class DataProtectionBackupInstanceResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataProtectionBackup.DataProtectionBackupInstanceData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataProtectionBackup.DataProtectionBackupInstanceData>
public class DataProtectionBackupInstanceResource : Azure.ResourceManager.ArmResource
type DataProtectionBackupInstanceResource = class
    inherit ArmResource
    interface IJsonModel<DataProtectionBackupInstanceData>
    interface IPersistableModel<DataProtectionBackupInstanceData>
type DataProtectionBackupInstanceResource = class
    inherit ArmResource
Public Class DataProtectionBackupInstanceResource
Inherits ArmResource
Implements IJsonModel(Of DataProtectionBackupInstanceData), IPersistableModel(Of DataProtectionBackupInstanceData)
Public Class DataProtectionBackupInstanceResource
Inherits ArmResource
Inheritance
DataProtectionBackupInstanceResource
Implements

Constructors

DataProtectionBackupInstanceResource()

Initializes a new instance of the DataProtectionBackupInstanceResource 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.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_Get
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_Get
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
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, String)

Generate the resource identifier of a DataProtectionBackupInstanceResource instance.

Delete(WaitUntil, String, CancellationToken)

Delete a backup instance in a backup vault

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_Delete
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
DeleteAsync(WaitUntil, String, CancellationToken)

Delete a backup instance in a backup vault

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_Delete
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
FindRestorableTimeRange(BackupFindRestorableTimeRangeContent, CancellationToken)
  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges
  • Operation Id: RestorableTimeRanges_Find
  • Default Api Version: 2024-04-01
FindRestorableTimeRangeAsync(BackupFindRestorableTimeRangeContent, CancellationToken)
  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges
  • Operation Id: RestorableTimeRanges_Find
  • Default Api Version: 2024-04-01
Get(CancellationToken)

Gets a backup instance with name in a backup vault

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_Get
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
GetAsync(CancellationToken)

Gets a backup instance with name in a backup vault

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_Get
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetDataProtectionBackupRecoveryPoint(String, CancellationToken)

Gets a Recovery Point using recoveryPointId for a Datasource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}
  • Operation Id: RecoveryPoints_Get
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupRecoveryPointResource
GetDataProtectionBackupRecoveryPointAsync(String, CancellationToken)

Gets a Recovery Point using recoveryPointId for a Datasource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}
  • Operation Id: RecoveryPoints_Get
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupRecoveryPointResource
GetDataProtectionBackupRecoveryPoints()

Gets a collection of DataProtectionBackupRecoveryPointResources in the DataProtectionBackupInstance.

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)
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_Get
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_Get
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
ResumeBackups(WaitUntil, CancellationToken)

This operation will resume backups for backup instance

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups
  • Operation Id: BackupInstances_ResumeBackups
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
ResumeBackupsAsync(WaitUntil, CancellationToken)

This operation will resume backups for backup instance

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups
  • Operation Id: BackupInstances_ResumeBackups
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
ResumeProtection(WaitUntil, CancellationToken)

This operation will resume protection for a stopped backup instance

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection
  • Operation Id: BackupInstances_ResumeProtection
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
ResumeProtectionAsync(WaitUntil, CancellationToken)

This operation will resume protection for a stopped backup instance

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection
  • Operation Id: BackupInstances_ResumeProtection
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_Get
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_Get
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
StopProtection(WaitUntil, StopProtectionContent, String, CancellationToken)

This operation will stop protection of a backup instance and data will be held forever

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection
  • Operation Id: BackupInstances_StopProtection
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
StopProtectionAsync(WaitUntil, StopProtectionContent, String, CancellationToken)

This operation will stop protection of a backup instance and data will be held forever

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection
  • Operation Id: BackupInstances_StopProtection
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
SuspendBackups(WaitUntil, SuspendBackupContent, String, CancellationToken)

This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups
  • Operation Id: BackupInstances_SuspendBackups
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
SuspendBackupsAsync(WaitUntil, SuspendBackupContent, String, CancellationToken)

This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups
  • Operation Id: BackupInstances_SuspendBackups
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
SyncBackupInstance(WaitUntil, BackupInstanceSyncContent, CancellationToken)

Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync
  • Operation Id: BackupInstances_SyncBackupInstance
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
SyncBackupInstanceAsync(WaitUntil, BackupInstanceSyncContent, CancellationToken)

Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync
  • Operation Id: BackupInstances_SyncBackupInstance
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
TriggerAdhocBackup(WaitUntil, AdhocBackupTriggerContent, CancellationToken)

Trigger adhoc backup

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup
  • Operation Id: BackupInstances_AdhocBackup
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
TriggerAdhocBackupAsync(WaitUntil, AdhocBackupTriggerContent, CancellationToken)

Trigger adhoc backup

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup
  • Operation Id: BackupInstances_AdhocBackup
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
TriggerRehydration(WaitUntil, BackupRehydrationContent, CancellationToken)

rehydrate recovery point for restore for a BackupInstance

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate
  • Operation Id: BackupInstances_TriggerRehydrate
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
TriggerRehydrationAsync(WaitUntil, BackupRehydrationContent, CancellationToken)

rehydrate recovery point for restore for a BackupInstance

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate
  • Operation Id: BackupInstances_TriggerRehydrate
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
TriggerRestore(WaitUntil, BackupRestoreContent, String, CancellationToken)

Triggers restore for a BackupInstance

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore
  • Operation Id: BackupInstances_TriggerRestore
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
TriggerRestoreAsync(WaitUntil, BackupRestoreContent, String, CancellationToken)

Triggers restore for a BackupInstance

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore
  • Operation Id: BackupInstances_TriggerRestore
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
TryGetApiVersion(ResourceType, String)

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

(Inherited from ArmResource)
Update(WaitUntil, DataProtectionBackupInstanceData, String, CancellationToken)

Create or update a backup instance in a backup vault

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_CreateOrUpdate
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
UpdateAsync(WaitUntil, DataProtectionBackupInstanceData, String, CancellationToken)

Create or update a backup instance in a backup vault

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}
  • Operation Id: BackupInstances_CreateOrUpdate
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
ValidateRestore(WaitUntil, BackupValidateRestoreContent, CancellationToken)

Validates if Restore can be triggered for a DataSource

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore
  • Operation Id: BackupInstances_ValidateForRestore
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource
ValidateRestoreAsync(WaitUntil, BackupValidateRestoreContent, CancellationToken)

Validates if Restore can be triggered for a DataSource

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore
  • Operation Id: BackupInstances_ValidateForRestore
  • Default Api Version: 2024-04-01
  • Resource: DataProtectionBackupInstanceResource

Explicit Interface Implementations

IJsonModel<DataProtectionBackupInstanceData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<DataProtectionBackupInstanceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DataProtectionBackupInstanceData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DataProtectionBackupInstanceData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<DataProtectionBackupInstanceData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

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

Get role definition by name (GUID).

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

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

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

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

Get the specified deny assignment.

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

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

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

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

Get a role assignment by scope and name.

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

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

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

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

Get the specified role assignment schedule for a resource scope

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

Gets the specified role assignment schedule instance.

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

Gets the specified role assignment schedule instance.

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

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

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

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

Get the specified role assignment schedule request.

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

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

GetRoleAssignmentSchedules(ArmResource)

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

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

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

Get the specified role eligibility schedule for a resource scope

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

Gets the specified role eligibility schedule instance.

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

Gets the specified role eligibility schedule instance.

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

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

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

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

Get the specified role eligibility schedule request.

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

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

GetRoleEligibilitySchedules(ArmResource)

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

GetRoleManagementPolicies(ArmResource)

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

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

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

Get the specified role management policy assignment for a resource scope

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

Get the specified role management policy assignment for a resource scope

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

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

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

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

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

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

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

Returns Linker resource for a given name.

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

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

Applies to