C# Class Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.ServiceClientAdapterNS.ServiceClientAdapter

Show file Open project: Azure/azure-powershell Class Usage Examples

Public Methods

Method	Description
CancelJob ( string jobId ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse	Cancels a job
CreateOrUpdateProtectedItem ( string containerName, string protectedItemName, Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemCreateOrUpdateRequest request ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse	Creates a new protected item or updates an already existing protected item
CreateOrUpdateProtectionPolicy ( string policyName, Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyRequest request ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyResponse	Creates a new policy or updates an already existing policy
DeleteProtectedItem ( string containerName, string protectedItemName ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse	Deletes a protected item
GetJob ( string jobId ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.JobResponse	Gets a job
GetJobOperationStatus ( string jobId, string operationId ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.JobResponse	Gets the job operation status
GetJobs ( string jobId, string status, string operation, System.DateTime startTime, System.DateTime endTime, string backupManagementType, int top = null, string skipToken = null ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.JobListResponse	Lists jobs according to the parameters
GetProtectedItem ( string containerName, string protectedItemName, Microsoft.Azure.Management.RecoveryServices.Backup.Models.GetProtectedItemQueryParam queryFilter ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemResponse	Gets a protected item
GetProtectedItemOperationStatusByURL ( string operationResultLink ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackUpOperationStatusResponse	Gets result of a generic operation on the protected item using the operation tracking URL
GetProtectionPolicy ( string policyName ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyResponse	Gets a protection policy given the name
GetProtectionPolicyOperationStatusByURL ( string url ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackUpOperationStatusResponse	Gets protection policy operation status using the operation tracking URL
GetQueryObject ( string backupManagementType, System.DateTime startTime, System.DateTime endTime, string jobId, string status, string operation ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.CommonJobQueryFilters	Constructs the query object based on the input parameters
GetRecoveryPointDetails ( string containerName, string protectedItemName, string recoveryPointId ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.RecoveryPointResponse	Gets detail about the recovery point identified by the input parameters
GetRecoveryPoints ( string containerName, string protectedItemName, Microsoft.Azure.Management.RecoveryServices.Backup.Models.RecoveryPointQueryParameters queryFilter ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.RecoveryPointListResponse	Lists recovery points according to the input parameters
GetRefreshContainerOperationResultByURL ( string operationResultLink ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse	Gets result of the refresh container operation using the operation tracking URL
ListBackupEngines ( Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackupEngineListQueryParams queryParams ) : IEnumerable	Fetches backup engines in the vault according to the query params
ListContainers ( Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionContainerListQueryParams queryParams ) : IEnumerable	Fetches protection containers in the vault according to the query params
ListProtectableItem ( Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectableObjectListQueryParameters queryFilter, Microsoft.Azure.Management.RecoveryServices.Backup.Models.PaginationRequest paginationRequest = null ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectableObjectListResponse	Lists protectable items according to the query filter and the pagination params
ListProtectedItem ( Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemListQueryParam queryFilter, Microsoft.Azure.Management.RecoveryServices.Backup.Models.PaginationRequest paginationParams = null ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemListResponse	List protected items protected by the Recovery Services vault according to the query params and pagination params.
ListProtectionPolicy ( Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyQueryParameters queryFilter ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyListResponse	Lists protection policies according to the input query filter
RefreshContainers ( ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse	Triggers refresh of container catalog in service
RemoveProtectionPolicy ( string policyName ) : AzureOperationResponse	Deletes protection policy from the vault specified by the name
RestoreDisk ( AzureVmRecoveryPoint rp, string storageAccountId, string storageAccountLocation, string storageAccountType ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse	Restores the disk based on the recovery point and other input parameters
ServiceClientAdapter ( SubscriptionCloudCredentials creds, Uri baseUri ) : System
TriggerBackup ( string containerName, string itemName, System.DateTime expiryDateTimeUtc ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse	Triggers backup on the specified item
UnregisterContainers ( string containerName ) : AzureOperationResponse	Triggers unregister of a container in service

Method Details

CancelJob() public method

Cancels a job

public CancelJob ( string jobId ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse
jobId	string	ID of the job to cancel
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse

CreateOrUpdateProtectedItem() public method

Creates a new protected item or updates an already existing protected item

public CreateOrUpdateProtectedItem ( string containerName, string protectedItemName, Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemCreateOrUpdateRequest request ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse
containerName	string	Name of the container which this item belongs to
protectedItemName	string	Name of the item
request	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemCreateOrUpdateRequest	Protected item create or update request
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse

CreateOrUpdateProtectionPolicy() public method

Creates a new policy or updates an already existing policy

public CreateOrUpdateProtectionPolicy ( string policyName, Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyRequest request ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyResponse
policyName	string	Name of the policy
request	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyRequest	Policy create or update request
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyResponse

DeleteProtectedItem() public method

Deletes a protected item

public DeleteProtectedItem ( string containerName, string protectedItemName ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse
containerName	string	Name of the container which this item belongs to
protectedItemName	string	Name of the item
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse

GetJob() public method

Gets a job

public GetJob ( string jobId ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.JobResponse
jobId	string	ID of the job
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.JobResponse

GetJobOperationStatus() public method

Gets the job operation status

public GetJobOperationStatus ( string jobId, string operationId ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.JobResponse
jobId	string	ID of the job
operationId	string	ID of the operation associated with the job
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.JobResponse

GetJobs() public method

Lists jobs according to the parameters

public GetJobs ( string jobId, string status, string operation, System.DateTime startTime, System.DateTime endTime, string backupManagementType, int top = null, string skipToken = null ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.JobListResponse
jobId	string	ID of the job
status	string	Status of the job
operation	string	Operation represented by the job
startTime	System.DateTime	Time when the job started
endTime	System.DateTime	Time when the job finished
backupManagementType	string	Backup management type of the item represented by the job
top	int	Top pagination param
skipToken	string	Skip token pagination param
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.JobListResponse

GetProtectedItem() public method

Gets a protected item

public GetProtectedItem ( string containerName, string protectedItemName, Microsoft.Azure.Management.RecoveryServices.Backup.Models.GetProtectedItemQueryParam queryFilter ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemResponse
containerName	string	Name of the container which this item belongs to
protectedItemName	string	Name of the item
queryFilter	Microsoft.Azure.Management.RecoveryServices.Backup.Models.GetProtectedItemQueryParam	Query filter
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemResponse

GetProtectedItemOperationStatusByURL() public method

Gets result of a generic operation on the protected item using the operation tracking URL

public GetProtectedItemOperationStatusByURL ( string operationResultLink ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackUpOperationStatusResponse
operationResultLink	string	Operation tracking URL
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackUpOperationStatusResponse

GetProtectionPolicy() public method

Gets a protection policy given the name

public GetProtectionPolicy ( string policyName ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyResponse
policyName	string	Name of the policy
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyResponse

GetProtectionPolicyOperationStatusByURL() public method

Gets protection policy operation status using the operation tracking URL

public GetProtectionPolicyOperationStatusByURL ( string url ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackUpOperationStatusResponse
url	string	Operation tracking URL
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackUpOperationStatusResponse

GetQueryObject() public method

Constructs the query object based on the input parameters

public GetQueryObject ( string backupManagementType, System.DateTime startTime, System.DateTime endTime, string jobId, string status, string operation ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.CommonJobQueryFilters
backupManagementType	string	Backup management type of the item associated with the job
startTime	System.DateTime	Time when the job started
endTime	System.DateTime	Time when the job ended
jobId	string	ID of the job
status	string	Status of the job
operation	string	ID of operation associated with the job
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.CommonJobQueryFilters

GetRecoveryPointDetails() public method

Gets detail about the recovery point identified by the input parameters

public GetRecoveryPointDetails ( string containerName, string protectedItemName, string recoveryPointId ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.RecoveryPointResponse
containerName	string	Name of the container which the item belongs to
protectedItemName	string	Name of the item
recoveryPointId	string	ID of the recovery point
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.RecoveryPointResponse

GetRecoveryPoints() public method

Lists recovery points according to the input parameters

public GetRecoveryPoints ( string containerName, string protectedItemName, Microsoft.Azure.Management.RecoveryServices.Backup.Models.RecoveryPointQueryParameters queryFilter ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.RecoveryPointListResponse
containerName	string	Name of the container which the item belongs to
protectedItemName	string	Name of the item
queryFilter	Microsoft.Azure.Management.RecoveryServices.Backup.Models.RecoveryPointQueryParameters	Query filter
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.RecoveryPointListResponse

GetRefreshContainerOperationResultByURL() public method

Gets result of the refresh container operation using the operation tracking URL

public GetRefreshContainerOperationResultByURL ( string operationResultLink ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse
operationResultLink	string	Operation tracking URL
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse

ListBackupEngines() public method

Fetches backup engines in the vault according to the query params

public ListBackupEngines ( Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackupEngineListQueryParams queryParams ) : IEnumerable
queryParams	Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackupEngineListQueryParams
return	IEnumerable

ListContainers() public method

Fetches protection containers in the vault according to the query params

public ListContainers ( Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionContainerListQueryParams queryParams ) : IEnumerable
queryParams	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionContainerListQueryParams
return	IEnumerable

ListProtectableItem() public method

Lists protectable items according to the query filter and the pagination params

public ListProtectableItem ( Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectableObjectListQueryParameters queryFilter, Microsoft.Azure.Management.RecoveryServices.Backup.Models.PaginationRequest paginationRequest = null ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectableObjectListResponse
queryFilter	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectableObjectListQueryParameters	Query filter
paginationRequest	Microsoft.Azure.Management.RecoveryServices.Backup.Models.PaginationRequest	Pagination parameters
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectableObjectListResponse

ListProtectedItem() public method

List protected items protected by the Recovery Services vault according to the query params and pagination params.

public ListProtectedItem ( Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemListQueryParam queryFilter, Microsoft.Azure.Management.RecoveryServices.Backup.Models.PaginationRequest paginationParams = null ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemListResponse
queryFilter	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemListQueryParam	Query params
paginationParams	Microsoft.Azure.Management.RecoveryServices.Backup.Models.PaginationRequest	Pagination params
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectedItemListResponse

ListProtectionPolicy() public method

Lists protection policies according to the input query filter

public ListProtectionPolicy ( Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyQueryParameters queryFilter ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyListResponse
queryFilter	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyQueryParameters	Query filter
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.ProtectionPolicyListResponse

RefreshContainers() public method

Triggers refresh of container catalog in service

public RefreshContainers ( ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse

RemoveProtectionPolicy() public method

Deletes protection policy from the vault specified by the name

public RemoveProtectionPolicy ( string policyName ) : AzureOperationResponse
policyName	string	Name of the policy to be deleted
return	AzureOperationResponse

RestoreDisk() public method

Restores the disk based on the recovery point and other input parameters

public RestoreDisk ( AzureVmRecoveryPoint rp, string storageAccountId, string storageAccountLocation, string storageAccountType ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse
rp	Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.AzureVmRecoveryPoint	Recovery point to restore the disk to
storageAccountId	string	ID of the storage account where to restore the disk
storageAccountLocation	string	Location of the storage account where to restore the disk
storageAccountType	string	Type of the storage account where to restore the disk
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse

ServiceClientAdapter() public method

public ServiceClientAdapter ( SubscriptionCloudCredentials creds, Uri baseUri ) : System
creds	SubscriptionCloudCredentials
baseUri	System.Uri
return	System

TriggerBackup() public method

Triggers backup on the specified item

public TriggerBackup ( string containerName, string itemName, System.DateTime expiryDateTimeUtc ) : Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse
containerName	string	Name of the container which this item belongs to
itemName	string	Name of the item
expiryDateTimeUtc	System.DateTime
return	Microsoft.Azure.Management.RecoveryServices.Backup.Models.BaseRecoveryServicesJobResponse

UnregisterContainers() public method

Triggers unregister of a container in service

public UnregisterContainers ( string containerName ) : AzureOperationResponse
containerName	string
return	AzureOperationResponse