C# Class Microsoft.Azure.Commands.AzureBackup.ClientAdapter.AzureBackupClientAdapter

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

Private Properties

Property	Type	Description
GetCustomRequestHeaders	Microsoft.Azure.Management.BackupServices.Models.CustomRequestHeaders

Public Methods

Method	Description
AddProtectionPolicy ( string resourceGroupName, string resourceName, string policyName, Microsoft.Azure.Management.BackupServices.Models.CSMAddProtectionPolicyRequest request ) : void	Add protection policy
AzureBackupClientAdapter ( SubscriptionCloudCredentials creds, Uri baseUri ) : Microsoft.Azure.Commands.Common.Authentication
CheckProtectionPolicyNameAvailability ( string resourceGroupName, string resourceName, string name ) : void	Check protection policy name availability
CreateOrUpdateAzureBackupVault ( string resourceGroupName, string vaultName, string location ) : Microsoft.Azure.Management.BackupServices.Models.AzureBackupVault	Creates or updates the vault identified by client
DeleteProtectionPolicy ( string resourceGroupName, string resourceName, string policyName ) : void	Delete protection policy
DeleteVault ( string resourceGroupName, string vaultName ) : bool	Deletes the specified backup vault
DisableProtection ( string resourceGroupName, string resourceName, string containerName, string itemName ) : System.Guid	Dsiable protection
EnableMachineContainerReregistration ( string resourceGroupName, string resourceName, long containerId ) : void	Enable container reregistration
EnableProtection ( string resourceGroupName, string resourceName, string containerName, string itemName, Microsoft.Azure.Management.BackupServices.Models.CSMSetProtectionRequest request ) : System.Guid	Enable Protection
GetClientRequestId ( ) : string
GetJobDetails ( string resourceGroupName, string resourceName, string jobId ) : Microsoft.Azure.Management.BackupServices.Models.CSMJobDetailsResponse
GetOperationStatus ( string resourceGroupName, string resourceName, string operationId ) : CSMOperationResult
GetProtectionPolicyByName ( string resourceGroupName, string resourceName, string name ) : Microsoft.Azure.Management.BackupServices.Models.CSMProtectionPolicyResponse	Gets protection policies of matching name
GetRecoveryPoint ( string resourceGroupName, string resourceName, string containerName, string itemName, string recoveryPointName ) : Microsoft.Azure.Management.BackupServices.Models.CSMRecoveryPointResponse	Lists recovery points for specified item
GetStorageTypeDetails ( string resourceGroupName, string vaultName ) : string	Gets storage type details of the specified resource
GetVault ( string resourceGroupName, string vaultName ) : Microsoft.Azure.Management.BackupServices.Models.AzureBackupVault	Gets the vault identified by the client
GetVaults ( ) : IEnumerable	Gets backup vaults in current subscription
GetVaultsInResourceGroup ( string resourceGroupName ) : IEnumerable	Gets backup vaults in given resource group
ListContainers ( string resourceGroupName, string resourceName, Microsoft.Azure.Management.BackupServices.Models.ContainerQueryParameters parameters ) : IEnumerable	Gets all IaaSVM containers in the vault by friendly name
ListDataSources ( string resourceGroupName, string resourceName, Microsoft.Azure.Management.BackupServices.Models.CSMProtectedItemQueryObject query ) : IList	Lists datasources in the vault
ListJobs ( string resourceGroupName, string resourceName, Microsoft.Azure.Management.BackupServices.Models.CSMJobQueryObject queryParams ) : IEnumerable
ListMachineContainers ( string resourceGroupName, string resourceName ) : IEnumerable	Gets all MARS containers in the vault
ListMachineContainers ( string resourceGroupName, string resourceName, string friendlyName ) : IEnumerable	Gets all MARS containers in the vault which match the friendly name
ListProtectableObjects ( string resourceGroupName, string resourceName, Microsoft.Azure.Management.BackupServices.Models.CSMItemQueryObject query ) : IList	Lists protectable objects in the vault
ListProtectionPolicies ( string resourceGroupName, string resourceName ) : IList	Gets all policies in the vault
ListRecoveryPoints ( string resourceGroupName, string resourceName, string containerName, string itemName ) : IEnumerable	Lists recovery points for specified item
RefreshClientRequestId ( ) : void
RefreshContainers ( string resourceGroupName, string resourceName ) : System.Guid	Refresh container list in service
RegisterContainer ( string resourceGroupName, string resourceName, string containerName ) : System.Guid	Register container
TriggerBackup ( string resourceGroupName, string resourceName, string containerName, string itemName ) : System.Guid	Trigger backup on a DS
TriggerCancelJob ( string resourceGroupName, string resourceName, string jobId ) : System.Guid
TriggerRestore ( string resourceGroupName, string resourceName, string containerName, string itemName, string recoveryPointName, Microsoft.Azure.Management.BackupServices.Models.CSMRestoreRequest csmRestoreRequest ) : System.Guid	Lists recovery points for specified item
UnRegisterContainer ( string resourceGroupName, string resourceName, string containerName ) : System.Guid	UnRegister container
UnregisterMachineContainer ( string resourceGroupName, string resourceName, long containerId ) : void	UnRegister container
UpdateProtection ( string resourceGroupName, string resourceName, string containerName, string itemName, Microsoft.Azure.Management.BackupServices.Models.CSMUpdateProtectionRequest request ) : System.Guid	Update Protection
UpdateProtectionPolicy ( string resourceGroupName, string resourceName, string policyName, Microsoft.Azure.Management.BackupServices.Models.CSMUpdateProtectionPolicyRequest request ) : System.Guid	Update specified protection policy
UpdateStorageType ( string resourceGroupName, string resourceName, string storageType ) : void	Updates storage type of the vault identified by client
UploadCertificate ( string resourceGroupName, string resourceName, string certName, Microsoft.Azure.Management.BackupServices.Models.VaultCredUploadCertRequest request ) : Microsoft.Azure.Management.BackupServices.Models.VaultCredUploadCertResponse

Private Methods

Method	Description
GetCustomRequestHeaders ( ) : Microsoft.Azure.Management.BackupServices.Models.CustomRequestHeaders

Method Details

AddProtectionPolicy() public method

Add protection policy

public AddProtectionPolicy ( string resourceGroupName, string resourceName, string policyName, Microsoft.Azure.Management.BackupServices.Models.CSMAddProtectionPolicyRequest request ) : void
resourceGroupName	string
resourceName	string
policyName	string
request	Microsoft.Azure.Management.BackupServices.Models.CSMAddProtectionPolicyRequest
return	void

AzureBackupClientAdapter() public method

public AzureBackupClientAdapter ( SubscriptionCloudCredentials creds, Uri baseUri ) : Microsoft.Azure.Commands.Common.Authentication
creds	SubscriptionCloudCredentials
baseUri	System.Uri
return	Microsoft.Azure.Commands.Common.Authentication

CheckProtectionPolicyNameAvailability() public method

Check protection policy name availability

public CheckProtectionPolicyNameAvailability ( string resourceGroupName, string resourceName, string name ) : void
resourceGroupName	string
resourceName	string
name	string
return	void

CreateOrUpdateAzureBackupVault() public method

Creates or updates the vault identified by client

public CreateOrUpdateAzureBackupVault ( string resourceGroupName, string vaultName, string location ) : Microsoft.Azure.Management.BackupServices.Models.AzureBackupVault
resourceGroupName	string
vaultName	string
location	string
return	Microsoft.Azure.Management.BackupServices.Models.AzureBackupVault

DeleteProtectionPolicy() public method

Delete protection policy

public DeleteProtectionPolicy ( string resourceGroupName, string resourceName, string policyName ) : void
resourceGroupName	string
resourceName	string
policyName	string
return	void

DeleteVault() public method

Deletes the specified backup vault

public DeleteVault ( string resourceGroupName, string vaultName ) : bool
resourceGroupName	string
vaultName	string
return	bool

DisableProtection() public method

Dsiable protection

public DisableProtection ( string resourceGroupName, string resourceName, string containerName, string itemName ) : System.Guid
resourceGroupName	string
resourceName	string
containerName	string
itemName	string
return	System.Guid

EnableMachineContainerReregistration() public method

Enable container reregistration

public EnableMachineContainerReregistration ( string resourceGroupName, string resourceName, long containerId ) : void
resourceGroupName	string
resourceName	string
containerId	long
return	void

EnableProtection() public method

Enable Protection

public EnableProtection ( string resourceGroupName, string resourceName, string containerName, string itemName, Microsoft.Azure.Management.BackupServices.Models.CSMSetProtectionRequest request ) : System.Guid
resourceGroupName	string
resourceName	string
containerName	string
itemName	string
request	Microsoft.Azure.Management.BackupServices.Models.CSMSetProtectionRequest
return	System.Guid

GetClientRequestId() public method

public GetClientRequestId ( ) : string
return	string

GetJobDetails() public method

public GetJobDetails ( string resourceGroupName, string resourceName, string jobId ) : Microsoft.Azure.Management.BackupServices.Models.CSMJobDetailsResponse
resourceGroupName	string
resourceName	string
jobId	string
return	Microsoft.Azure.Management.BackupServices.Models.CSMJobDetailsResponse

GetOperationStatus() public method

public GetOperationStatus ( string resourceGroupName, string resourceName, string operationId ) : CSMOperationResult
resourceGroupName	string
resourceName	string
operationId	string
return	CSMOperationResult

GetProtectionPolicyByName() public method

Gets protection policies of matching name

public GetProtectionPolicyByName ( string resourceGroupName, string resourceName, string name ) : Microsoft.Azure.Management.BackupServices.Models.CSMProtectionPolicyResponse
resourceGroupName	string
resourceName	string
name	string
return	Microsoft.Azure.Management.BackupServices.Models.CSMProtectionPolicyResponse

GetRecoveryPoint() public method

Lists recovery points for specified item

public GetRecoveryPoint ( string resourceGroupName, string resourceName, string containerName, string itemName, string recoveryPointName ) : Microsoft.Azure.Management.BackupServices.Models.CSMRecoveryPointResponse
resourceGroupName	string
resourceName	string
containerName	string
itemName	string
recoveryPointName	string
return	Microsoft.Azure.Management.BackupServices.Models.CSMRecoveryPointResponse

GetStorageTypeDetails() public method

Gets storage type details of the specified resource

public GetStorageTypeDetails ( string resourceGroupName, string vaultName ) : string
resourceGroupName	string
vaultName	string
return	string

GetVault() public method

Gets the vault identified by the client

public GetVault ( string resourceGroupName, string vaultName ) : Microsoft.Azure.Management.BackupServices.Models.AzureBackupVault
resourceGroupName	string
vaultName	string
return	Microsoft.Azure.Management.BackupServices.Models.AzureBackupVault

GetVaults() public method

Gets backup vaults in current subscription

public GetVaults ( ) : IEnumerable
return	IEnumerable

GetVaultsInResourceGroup() public method

Gets backup vaults in given resource group

public GetVaultsInResourceGroup ( string resourceGroupName ) : IEnumerable
resourceGroupName	string
return	IEnumerable

ListContainers() public method

Gets all IaaSVM containers in the vault by friendly name

public ListContainers ( string resourceGroupName, string resourceName, Microsoft.Azure.Management.BackupServices.Models.ContainerQueryParameters parameters ) : IEnumerable
resourceGroupName	string
resourceName	string
parameters	Microsoft.Azure.Management.BackupServices.Models.ContainerQueryParameters
return	IEnumerable

ListDataSources() public method

Lists datasources in the vault

public ListDataSources ( string resourceGroupName, string resourceName, Microsoft.Azure.Management.BackupServices.Models.CSMProtectedItemQueryObject query ) : IList
resourceGroupName	string
resourceName	string
query	Microsoft.Azure.Management.BackupServices.Models.CSMProtectedItemQueryObject
return	IList

ListJobs() public method

public ListJobs ( string resourceGroupName, string resourceName, Microsoft.Azure.Management.BackupServices.Models.CSMJobQueryObject queryParams ) : IEnumerable
resourceGroupName	string
resourceName	string
queryParams	Microsoft.Azure.Management.BackupServices.Models.CSMJobQueryObject
return	IEnumerable

ListMachineContainers() public method

Gets all MARS containers in the vault

public ListMachineContainers ( string resourceGroupName, string resourceName ) : IEnumerable
resourceGroupName	string
resourceName	string
return	IEnumerable

ListMachineContainers() public method

Gets all MARS containers in the vault which match the friendly name

public ListMachineContainers ( string resourceGroupName, string resourceName, string friendlyName ) : IEnumerable
resourceGroupName	string
resourceName	string
friendlyName	string	The friendly name of the container
return	IEnumerable

ListProtectableObjects() public method

Lists protectable objects in the vault

public ListProtectableObjects ( string resourceGroupName, string resourceName, Microsoft.Azure.Management.BackupServices.Models.CSMItemQueryObject query ) : IList
resourceGroupName	string
resourceName	string
query	Microsoft.Azure.Management.BackupServices.Models.CSMItemQueryObject
return	IList

ListProtectionPolicies() public method

Gets all policies in the vault

public ListProtectionPolicies ( string resourceGroupName, string resourceName ) : IList
resourceGroupName	string
resourceName	string
return	IList

ListRecoveryPoints() public method

Lists recovery points for specified item

public ListRecoveryPoints ( string resourceGroupName, string resourceName, string containerName, string itemName ) : IEnumerable
resourceGroupName	string
resourceName	string
containerName	string
itemName	string
return	IEnumerable

RefreshClientRequestId() public method

public RefreshClientRequestId ( ) : void
return	void

RefreshContainers() public method

Refresh container list in service

public RefreshContainers ( string resourceGroupName, string resourceName ) : System.Guid
resourceGroupName	string
resourceName	string
return	System.Guid

RegisterContainer() public method

public RegisterContainer ( string resourceGroupName, string resourceName, string containerName ) : System.Guid
resourceGroupName	string
resourceName	string
containerName	string
return	System.Guid

TriggerBackup() public method

Trigger backup on a DS

public TriggerBackup ( string resourceGroupName, string resourceName, string containerName, string itemName ) : System.Guid
resourceGroupName	string
resourceName	string
containerName	string
itemName	string
return	System.Guid

TriggerCancelJob() public method

public TriggerCancelJob ( string resourceGroupName, string resourceName, string jobId ) : System.Guid
resourceGroupName	string
resourceName	string
jobId	string
return	System.Guid

TriggerRestore() public method

Lists recovery points for specified item

public TriggerRestore ( string resourceGroupName, string resourceName, string containerName, string itemName, string recoveryPointName, Microsoft.Azure.Management.BackupServices.Models.CSMRestoreRequest csmRestoreRequest ) : System.Guid
resourceGroupName	string
resourceName	string
containerName	string
itemName	string
recoveryPointName	string
csmRestoreRequest	Microsoft.Azure.Management.BackupServices.Models.CSMRestoreRequest
return	System.Guid

UnRegisterContainer() public method

UnRegister container

public UnRegisterContainer ( string resourceGroupName, string resourceName, string containerName ) : System.Guid
resourceGroupName	string
resourceName	string
containerName	string
return	System.Guid

UnregisterMachineContainer() public method

UnRegister container

public UnregisterMachineContainer ( string resourceGroupName, string resourceName, long containerId ) : void
resourceGroupName	string
resourceName	string
containerId	long
return	void

UpdateProtection() public method

Update Protection

public UpdateProtection ( string resourceGroupName, string resourceName, string containerName, string itemName, Microsoft.Azure.Management.BackupServices.Models.CSMUpdateProtectionRequest request ) : System.Guid
resourceGroupName	string
resourceName	string
containerName	string
itemName	string
request	Microsoft.Azure.Management.BackupServices.Models.CSMUpdateProtectionRequest
return	System.Guid

UpdateProtectionPolicy() public method

Update specified protection policy

public UpdateProtectionPolicy ( string resourceGroupName, string resourceName, string policyName, Microsoft.Azure.Management.BackupServices.Models.CSMUpdateProtectionPolicyRequest request ) : System.Guid
resourceGroupName	string
resourceName	string
policyName	string
request	Microsoft.Azure.Management.BackupServices.Models.CSMUpdateProtectionPolicyRequest
return	System.Guid

UpdateStorageType() public method

Updates storage type of the vault identified by client

public UpdateStorageType ( string resourceGroupName, string resourceName, string storageType ) : void
resourceGroupName	string
resourceName	string
storageType	string
return	void

UploadCertificate() public method

public UploadCertificate ( string resourceGroupName, string resourceName, string certName, Microsoft.Azure.Management.BackupServices.Models.VaultCredUploadCertRequest request ) : Microsoft.Azure.Management.BackupServices.Models.VaultCredUploadCertResponse
resourceGroupName	string
resourceName	string
certName	string
request	Microsoft.Azure.Management.BackupServices.Models.VaultCredUploadCertRequest
return	Microsoft.Azure.Management.BackupServices.Models.VaultCredUploadCertResponse