From f171b44efb35ba915a29aca08e4fb5dd07ba8da2 Mon Sep 17 00:00:00 2001 From: dragonfly91 Date: Wed, 26 Aug 2015 21:05:28 +0530 Subject: [PATCH] Updating help doc --- ...ft.Azure.Commands.AzureBackup.dll-help.xml | 4545 +++++++++++++++-- 1 file changed, 4027 insertions(+), 518 deletions(-) diff --git a/src/ResourceManager/AzureBackup/Commands.AzureBackup/Microsoft.Azure.Commands.AzureBackup.dll-help.xml b/src/ResourceManager/AzureBackup/Commands.AzureBackup/Microsoft.Azure.Commands.AzureBackup.dll-help.xml index 453be5a0631b..e106e04e5ad7 100644 --- a/src/ResourceManager/AzureBackup/Commands.AzureBackup/Microsoft.Azure.Commands.AzureBackup.dll-help.xml +++ b/src/ResourceManager/AzureBackup/Commands.AzureBackup/Microsoft.Azure.Commands.AzureBackup.dll-help.xml @@ -1,152 +1,32 @@  - - - - Enable-AzureBackupContainerReregistration - - Allow re-registration of the server to connect the server back to the vault and continue the backup points chain. - - - - - Enable - AzureBackupContainerReregistration - - - - When a server is destroyed, all its cloud backup points remain in the Azure Backup vault. If the server is rebuilt and given the same FQDN, it is possible to connect it back to the same vault. This will allow the server to continue taking backups and adding new backup points to the existing set - essentially continuing where it was left off in the backup chain. - To make this connection, the AzureBackupContainer has to be primed for "re-registration". Without this step, you can lose all the existing data as a part of the registration process. The commandlet tells the service that the next time the container is registered, it should continue the backup chain. - - - - Enable-AzureBackupContainerReregistration - - Container - - An object referencing the container for which re-registration is being requested - - AzureBackupContainer - - - Profile - - Non-mandatory AzureProfile input object - - AzureProfile - - - - - - Container - - An object referencing the container for which re-registration is being requested - - AzureBackupContainer - - AzureBackupContainer - - - - - - Profile - - Non-mandatory AzureProfile input object - - AzureProfile - - AzureProfile - - - - - - - - - AzureBackupContainer - - - - - - This section details out the type of the objects that you can pipe to the cmdlet. - - - - - - - - None - - - - - This section details out the type of the objects that the cmdlet emits. - - - - - - - - - None - - - - - - - - Get-AzureBackupContainer + Backup-AzureRMBackupItem - Retrieves one or more Azure Backup containers that match the filter criteria specified. + Trigger backup for a protected item - Get - AzureBackupContainer + Backup + AzureRMBackupItem - An AzureBackupContainer is an object that encapsulates datasources, protected items, and recovery points. An AzureBackupContainer can be one of three: -- a Windows server -- a System Center Data Protection Manager server (SCDPM) -- an Azure IaaS virtual machine - Before a datasource or item can be backed-up, the container holding it must be registered with the Azure Backup service and be authenticated to send backup data to the backup vault. For Windows and SCDPM servers, the registration is held with the FQDN of the server. + Using this commandlet is the equivalent of "Backup Now". It triggers an ad-hoc backup that is not tied to the backup schedule. This is useful in two scenarios: +1. Starting initial backup immediately after enabling protection +2. Triggering ad-hoc backup when a previous scheduled backup has failed - Get-AzureBackupContainer - - Name - - The name of the AzureBackupContainer for which an object reference will be returned. - - String - - - Type - - This determines the Type of the container that has been registered. -- For Windows servers using the Azure Backup agent directly, the type will be "Windows" -- For SCDPM servers using the Azure Backup agent in conjunction with SCDPM, the type will be "DPM" - - AzureBackupContainerType - + Backup-AzureRMBackupItem - Vault + Item - A filter for the vault object, under which the container needs to be found. + The Azure Backup item for which ad-hoc backup is being triggered - AzurePSBackupVault + AzureRMBackupItem Profile @@ -158,40 +38,14 @@ - - Name - - The name of the AzureBackupContainer for which an object reference will be returned. - - String - - String - - - - - - Type - - This determines the Type of the container that has been registered. -- For Windows servers using the Azure Backup agent directly, the type will be "Windows" -- For SCDPM servers using the Azure Backup agent in conjunction with SCDPM, the type will be "DPM" - - AzureBackupContainerType - - AzureBackupContainerType - - - - - Vault + Item - A filter for the vault object, under which the container needs to be found. + The Azure Backup item for which ad-hoc backup is being triggered - AzurePSBackupVault + AzureRMBackupItem - AzurePSBackupVault + AzureRMBackupItem @@ -208,42 +62,30 @@ - - ManagedResourceName - - The name of the container that is specified as a filter. - - string - - string - - - - - AzureBackupVault + AzureRMBackupItem - -This section details out the type of the objects that you can pipe to the cmdlet. + This section details out the type of the objects that you can pipe to the cmdlet. + - AzureBackupContainer + AzureRMBackupJob - -This section details out the type of the objects that the cmdlet emits. + This section details out the type of the objects that the cmdlet emits. + @@ -252,25 +94,23 @@ This section details out the type of the objects that the cmdlet emits. - None + When an existing backup job is running this commandlet will fail. - -------------------------- List of all Windows servers registered to the vault -------------------------- + -------------------------- Trigger backup for a virtual machine -------------------------- PS C:\> - Get-AzureBackupContainer -vault $v -type Windows + Get-AzureRMBackupItem -Container $c | Backup-AzureRMBackupItem - Gets a list of all containers of type "Windows" from the specified vault. - Name Type Status ----- ---- ------ -SERVER1.CONTOSO.COM Windows Registered -SERVER2.CONTOSO.COM Windows Registered - + + WorkloadName Operation Status StartTime EndTime +------------ --------- ------ --------- ------- +test-vm Backup InProgress 26-Aug-15 12:24:01 PM 01-Jan-01 12:00:00 AM @@ -281,19 +121,18 @@ SERVER2.CONTOSO.COM Windows Registered - -------------------------- Retrieve a specific container -------------------------- + -------------------------- Failure to trigger backup when an existing backup is running -------------------------- PS C:\> - Get-AzureBackupContainer -vault $v -type SCDPM -name "DPMSERVER.CONTOSO.COM" + Get-AzureRMBackupItem -Container $c | Backup-AzureRMBackupItem - Gets the container representing a specific DPM server registered to the specified vault. - Name Type Status ----- ---- ------ -DPMSERVER.CONTOSO.COM SCDPM Registered - + + WorkloadName Operation Status StartTime EndTime +------------ --------- ------ --------- ------- +test-vm Backup Failed 26-Aug-15 12:30:30 PM 26-Aug-15 12:30:30 PM @@ -310,36 +149,36 @@ DPMSERVER.CONTOSO.COM SCDPM Registered - Get-AzureBackupVault + Disable-AzureRMBackupProtection - Retrieves one or more vault objects based on the parameters that are specified. + Disable protection for a protected item - Get - AzureBackupVault + Disable + AzureRMBackupProtection - The Get-AzureBackupVault commandlet retrieves existing Azure Backup vaults and returns objects of type AzurePSBackupVault. The vault object is used in some Azure Backup commandlets as a mandatory parameter. + To stop regular scheduled backup of a backup item and to delete existing recovery points associated with the backup item. - Get-AzureBackupVault - - ResourceGroupName + Disable-AzureRMBackupProtection + + RemoveRecoveryPoints - The Azure resource group under which the vault was created. + An optional switch parameter that deletes the recovery points data associated with a backup item. It is possible to disable backup and keep the recovery points data by NOT supplying this parameter. At a later point the same commandlet can be used to delete the data - String + SwitchParameter - - Name + + Item - The name of the specific Azure Backup vault that needs to be retrieved. If no name is specified, then the commandlet returns all the vaults created by the subscription. If there is more than 1 backup vault with the same name then the commandlet returns all the vaults that match the name. Use the -ResourceGroupName parameter to filter results and get a unique vault. + The Azure Backup item for which protection is being disabled. - String + AzureRMBackupItem Profile @@ -351,26 +190,26 @@ DPMSERVER.CONTOSO.COM SCDPM Registered - - ResourceGroupName + + RemoveRecoveryPoints - The Azure resource group under which the vault was created. + An optional switch parameter that deletes the recovery points data associated with a backup item. It is possible to disable backup and keep the recovery points data by NOT supplying this parameter. At a later point the same commandlet can be used to delete the data - String + SwitchParameter - String + SwitchParameter - - Name + + Item - The name of the specific Azure Backup vault that needs to be retrieved. If no name is specified, then the commandlet returns all the vaults created by the subscription. If there is more than 1 backup vault with the same name then the commandlet returns all the vaults that match the name. Use the -ResourceGroupName parameter to filter results and get a unique vault. + The Azure Backup item for which protection is being disabled. - String + AzureRMBackupItem - String + AzureRMBackupItem @@ -387,30 +226,52 @@ DPMSERVER.CONTOSO.COM SCDPM Registered + + Reason + + + + string + + string + + + + + + Comments + + + + string + + string + + + + - Vault name as [String] + AzureRMBackupItem - -This section details out the type of the objects that you can pipe to the cmdlet. + This section details out the type of the objects that you can pipe to the cmdlet. - Microsoft.Azure.Commands.AzureBackup.Models.AzurePSBackupVault + AzureRMBackupJob - -This section details out the type of the objects that the cmdlet emits. + This section details out the type of the objects that the cmdlet emits. @@ -423,149 +284,37 @@ This section details out the type of the objects that the cmdlet emits. - - -------------------------- View all the Azure Backup vaults created -------------------------- - - PS C:\> - - Get-AzureBackupVault - - - - - - - - - - - - - - - - -------------------------- Get a list of all vaults created in West US -------------------------- - - PS C:\> - - Get-AzureBackupVault | Where-Object { $_.Region -eq "westus" } - - - - - - - - - - - - - - - - -------------------------- Get a reference to a specific vault -------------------------- - - PS C:\> - - Get-AzureBackupVault -Name "myvault" - - - - - ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/rg1/providers/Microsoft.Backup - /BackupVault/myvault -Name : myvault -ResourceGroupName : rg1 -Region : westus -Storage : GeoRedundant - - - - - - - - - - - -------------------------- Count the number of vaults having Locally Redundant Storage -------------------------- - - PS C:\> - - Get-AzureBackupVault | Where-Object { $_.Storage –match ‘LocallyRedundant’ } | Measure-Object - - - - - Count : 4 -Average : -Sum : -Maximum : -Minimum : -Property : - - - - - - - - - - - New-AzureBackupVault - - - - Set-AzureBackupVault - - - - Remove-AzureBackupVault - - - - Get-AzureBackupContainer - - - Get-AzureBackupVaultCredentials + Enable-AzureRMBackupContainerReregistration - Downloads the Vault Credentials file to a specified location. + Allow re-registration of the server to connect the server back to the vault and continue the backup points chain. - Get - AzureBackupVaultCredentials + Enable + AzureRMBackupContainerReregistration - To enable hybrid backup scenarios the Vault Credentials file is a critical component. The vault credential file is used to connect a server to the Azure Backup vault and register it. Only after registration can backup data be sent to the vault. The Get-AzureBackupVaultCredentials commandlet downloads and places a vault credential file at the location specified by the user. + When a server is destroyed, all its cloud backup points remain in the Azure Backup vault. If the server is rebuilt and given the same FQDN, it is possible to connect it back to the same vault. This will allow the server to continue taking backups and adding new backup points to the existing set - essentially continuing where it was left off in the backup chain. + To make this connection, the AzureBackupContainer has to be primed for "re-registration". Without this step, you can lose all the existing data as a part of the registration process. The commandlet tells the service that the next time the container is registered, it should continue the backup chain. - Get-AzureBackupVaultCredentials - - TargetLocation - - The destination path where the Vault Credentials file should be placed. - - String - + Enable-AzureRMBackupContainerReregistration - Vault + Container - The specific Azure Backup vault object for which the Vault Credential file is generated. + An object referencing the container for which re-registration is being requested - AzurePSBackupVault + AzureRMBackupContainer Profile @@ -577,26 +326,132 @@ Property : - - TargetLocation + + Container - The destination path where the Vault Credentials file should be placed. + An object referencing the container for which re-registration is being requested - String + AzureRMBackupContainer - String + AzureRMBackupContainer - - Vault + + Profile - The specific Azure Backup vault object for which the Vault Credential file is generated. + Non-mandatory AzureProfile input object - AzurePSBackupVault + AzureProfile + + AzureProfile + + + + + + + + + AzureBackupContainer + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + None + + + + + + + + + + + + + + None + + + + + + + + + + + Enable-AzureRMBackupProtection + + Associate an item with a protection policy + + + + + Enable + AzureRMBackupProtection + + + + Enabling protection involves two key entities - the AzureRMBackupItem and the AzureRMBackupProtectionPolicy. Both need to belong to the same vault. The backup schedule will take care of doing the full initial copy for the item and the incremental copy for the subsequent backups. + + + + Enable-AzureRMBackupProtection + + Policy + + The Azure Backup protection policy that will be associated with the item. + + AzureRMBackupProtectionPolicy + + + Item + + The Azure Backup item object for which protection is being enabled. + + AzureRMBackupContainerContextObject + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + Policy + + The Azure Backup protection policy that will be associated with the item. + + AzureRMBackupProtectionPolicy + + AzureRMBackupProtectionPolicy + + + + + + Item + + The Azure Backup item object for which protection is being enabled. + + AzureRMBackupContainerContextObject - AzurePSBackupVault + AzureRMBackupContainerContextObject @@ -617,7 +472,7 @@ Property : - Microsoft.Azure.Commands.AzureBackup.Models.AzurePSBackupVault + AzureRMBackupItem @@ -629,7 +484,7 @@ Property : - Vault Credentials file name as [String] + AzureRMBackupJob @@ -648,16 +503,18 @@ Property : - -------------------------- Download a Vault Credentials file -------------------------- + -------------------------- Enable protection on an Azure VM -------------------------- PS C:\> - Get-AzureBackupVaultCredentials -Vault $vaultobj -TargetLocation "C:\users\admin\Desktop" + Get-AzureRMBackupContainer -Type AzureVM -Status Registered -Vault $v | Get-AzureRMBackupItem | Enable-AzureRMBackupProtection -Policy $policies[0] - This will place the vault credentials file at the user-specified location. - f5303a0b-fae4-4cdb-b44d-0e4c032dde26_backuprg_backuprn_2015-06-7--06-22-35.VaultCredentials + + WorkloadName Operation Status StartTime EndTime +------------ --------- ------ --------- ------- +test-vm ConfigureBackup Completed 26-Aug-15 12:19:49 PM 26-Aug-15 12:19:54 PM @@ -669,55 +526,78 @@ Property : + + Get-AzureRMBackupItem + + + + Get-AzureRMBackupProtectionPolicy + + + + Backup-AzureRMBackupItem + + - New-AzureBackupVault + Get-AzureRMBackupContainer - Creates a new Azure Backup vault based on the parameters that are specified. A vault is the start point for all backup operations with Azure Backup. + Retrieves one or more Azure Backup containers that match the filter criteria specified. - New - AzureBackupVault + Get + AzureRMBackupContainer - The New-AzureBackupVault commandlet creates and Azure Backup vault and returns an object of type AzurePSBackupVault that acts as a reference to the vault entity. The vault has some important properties that define the scope of backup – the region and the storage type. + An AzureBackupContainer is an object that encapsulates datasources, protected items, and recovery points. An AzureBackupContainer can be one of three: +- a Windows server +- a System Center Data Protection Manager server (SCDPM) +- an Azure IaaS virtual machine + Before a datasource or item can be backed-up, the container holding it must be registered with the Azure Backup service and be authenticated to send backup data to the backup vault. For Windows and SCDPM servers, the registration is held with the FQDN of the server. - New-AzureBackupVault - - ResourceGroupName + Get-AzureRMBackupContainer + + Name - Specifies the name of an existing resource group. In order to create a resource group, use the New-AzureResourceGroup commandlet. There is no requirement that the Azure ResourceGroup and the Azure Backup vault be in the same region. + Name of the container to be retrieved. String - - Name + + Type - Specifies the name of the Azure Backup vault. The combination of ResourceGroupName and Name must be unique. You cannot create two vaults with the same name under the same ResourceGroup, but two vaults with the same name can be placed under two different Resource Groups. + Type of the container. Currently supported types are Windows - String + AzureBackupContainerType - - Region + + ManagedResourceGroupName - The region parameter places the vault object into a specific Azure region. For hybrid backup scenarios, it is advised to create a vault in a region close to the on-premise server to reduce latency. For backup of Azure IaaS virtual machines, the vault becomes the point of discovery for local virtual machines. + The resource group name associated with the container. When registering the container this input would have been provided using the -ServiceName or the -ResourceGroupName parameter. String - - Storage + + Status - Backup storage is billed at Azure Storage rates and users can choose between LocallyRedundant and GeoRedundant as the storage for the backup data. Since this is an optional parameter, if it is not specified then the vault is created with the GeoRedundant Storage option. + The current status of the container object. Supported values are: NotRegistered, Registered, Registering, - AzureBackupVaultStorageType + AzureBackupContainerRegistrationStatus + + + Vault + + The Azure Backup vault from to which the container is associated. + + AzureRMBackupVault Profile @@ -729,10 +609,10 @@ Property : - - ResourceGroupName + + Name - Specifies the name of an existing resource group. In order to create a resource group, use the New-AzureResourceGroup commandlet. There is no requirement that the Azure ResourceGroup and the Azure Backup vault be in the same region. + Name of the container to be retrieved. String @@ -741,22 +621,22 @@ Property : - - Name + + Type - Specifies the name of the Azure Backup vault. The combination of ResourceGroupName and Name must be unique. You cannot create two vaults with the same name under the same ResourceGroup, but two vaults with the same name can be placed under two different Resource Groups. + Type of the container. Currently supported types are Windows - String + AzureBackupContainerType - String + AzureBackupContainerType - - Region + + ManagedResourceGroupName - The region parameter places the vault object into a specific Azure region. For hybrid backup scenarios, it is advised to create a vault in a region close to the on-premise server to reduce latency. For backup of Azure IaaS virtual machines, the vault becomes the point of discovery for local virtual machines. + The resource group name associated with the container. When registering the container this input would have been provided using the -ServiceName or the -ResourceGroupName parameter. String @@ -765,14 +645,26 @@ Property : - - Storage + + Status - Backup storage is billed at Azure Storage rates and users can choose between LocallyRedundant and GeoRedundant as the storage for the backup data. Since this is an optional parameter, if it is not specified then the vault is created with the GeoRedundant Storage option. + The current status of the container object. Supported values are: NotRegistered, Registered, Registering, - AzureBackupVaultStorageType + AzureBackupContainerRegistrationStatus - AzureBackupVaultStorageType + AzureBackupContainerRegistrationStatus + + + + + + Vault + + The Azure Backup vault from to which the container is associated. + + AzureRMBackupVault + + AzureRMBackupVault @@ -793,26 +685,24 @@ Property : - None + AzureBackupVault - -This section details out the type of the objects that you can pipe to the cmdlet. + This section details out the type of the objects that you can pipe to the cmdlet. - Microsoft.Azure.Commands.AzureBackup.Models.AzurePSBackupVault + AzureBackupContainer - -This section details out the type of the objects that the cmdlet emits. + This section details out the type of the objects that the cmdlet emits. @@ -826,21 +716,41 @@ This section details out the type of the objects that the cmdlet emits. - -------------------------- Create a new backup vault -------------------------- + -------------------------- List of all Windows servers registered to the vault -------------------------- PS C:\> - New-AzureBackupVault –ResourceGroupName “rg1” –Name “vault1” –Region “westus” + Get-AzureBackupContainer -vault $v -type Windows + Gets a list of all containers of type "Windows" from the specified vault. + Name Type Status +---- ---- ------ +SERVER1.CONTOSO.COM Windows Registered +SERVER2.CONTOSO.COM Windows Registered + + + + + + + + + + + -------------------------- Retrieve a specific container -------------------------- + + PS C:\> + + Get-AzureBackupContainer -vault $v -type SCDPM -name "DPMSERVER.CONTOSO.COM" + + Gets the container representing a specific DPM server registered to the specified vault. + - ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/rg1/providers/Microsoft.Backup - /BackupVault/vault1 -Name : vault1 -ResourceGroupName : rg1 -Region : westus -Storage : GeoRedundant + Name Type Status +---- ---- ------ +DPMSERVER.CONTOSO.COM SCDPM Registered @@ -851,21 +761,18 @@ Storage : GeoRedundant - -------------------------- Create a new backup vault with Locally Redundant Storage -------------------------- + -------------------------- List all registered Azure VMs -------------------------- PS C:\> - New-AzureBackupVault –ResourceGroupName “rg2” –Name “vault2” –Region “westus” –Storage LocallyRedundant + Get-AzureRMBackupContainer -Type AzureVM -Status Registered -Vault $v - ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/rg2/providers/Microsoft.Backup - /BackupVault/vault2 -Name : vault2 -ResourceGroupName : rg2 -Region : westus -Storage : LocallyRedundant + Name Type Status +---- ---- ------ +test-vm AzureVM Registered @@ -878,19 +785,3451 @@ Storage : LocallyRedundant - New-AzureResourceGroup - https://msdn.microsoft.com/en-us/library/dn654594.aspx - - - Get-AzureBackupVault - - - - Set-AzureBackupVault - - - - Remove-AzureBackupVault + Register-AzureRMBackupContainer + + + + Unregister-AzureRMBackupContainer + + + + + + + + Get-AzureRMBackupItem + + Gets the items under a container + + + + + Get + AzureRMBackupItem + + + + A container registered to the Azure Backup vault can have one or more items that can be protected. These items are enabled for protection using the Enable-AzureRMBackupProtection commandlet. This commandlet gets all the items under the container and their protection status. + + + + Get-AzureRMBackupItem + + ProtectionStatus + + The overall protection status of the item in the container. Supported values are: Protected, Protecting. + + String + + + Status + + The backup status for the item. Supported values are: IRPending, Protected, ProtectionError, ProtectionStopped. This is a sub-status that can be used as a filter for items that have -ProtectionStatus as Protected. + + String + + + Type + + The type of item that is being requested. Supported values: AzureVM + + String + + + Container + + The parent container object for which we are querying the items. Use the Get-AzureRMBackupContainer commandlet to get the list of containers in the vault. + + AzureRMBackupContainer + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + ProtectionStatus + + The overall protection status of the item in the container. Supported values are: Protected, Protecting. + + String + + String + + + + + + Status + + The backup status for the item. Supported values are: IRPending, Protected, ProtectionError, ProtectionStopped. This is a sub-status that can be used as a filter for items that have -ProtectionStatus as Protected. + + String + + String + + + + + + Type + + The type of item that is being requested. Supported values: AzureVM + + String + + String + + + + + + Container + + The parent container object for which we are querying the items. Use the Get-AzureRMBackupContainer commandlet to get the list of containers in the vault. + + AzureRMBackupContainer + + AzureRMBackupContainer + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + + + + AzureRMBackupContainer + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + AzureRMBackupItem + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + For Azure VMs, there is only one item under the registered VM container. + + + + + -------------------------- Get a list of all items in a container -------------------------- + + PS C:\> + + Get-AzureRMBackupContainer -Type AzureVM -Name "test-vm" -Vault $v | Get-AzureRMBackupItem + + + + + Name ProtectionStatus DataSourceStatus RecoveryPointsCount ProtectionPolicyName +---- ---------------- ---------------- ------------------- -------------------- +test-vm NotProtected 0 + + + + + + + + + + + -------------------------- See all the fields for an item -------------------------- + + PS C:\> + + Get-AzureRMBackupItem -Container $c | select * + + + + + Name : test-vm +DataSourceStatus : +ProtectionStatus : NotProtected +Type : AzureVM +ProtectionPolicyName : +ProtectionPolicyId : +RecoveryPointsCount : 0 +ItemName : iaasvmcontainer;test-vm;test-vm +ContainerType : AzureVM +ContainerUniqueName : iaasvmcontainer;test-vm;test-vm +ResourceGroupName : test-rg +ResourceName : test-vault +Location : southeastasia + + + + + + + + + + + + + Restore-AzureRMBackupItem + + + + Get-AzureRMBackupContainer + + + + Enable-AzureRMBackupProtection + + + + Backup-AzureRMBackupItem + + + + Disable-AzureRMBackupProtection + + + + + + + + Get-AzureRMBackupJob + + Retrieves a list of jobs or a specific job + + + + + Get + AzureRMBackupJob + + + + This commandlet gets the Azure Backup jobs that match the filter criteria specified. The jobs returned are restricted to the Azure Backup vault. + + + + Get-AzureRMBackupJob + + Vault + + The specific Azure Backup vault object for which the jobs are being retrieved. The vault is the parent container for an Azure Backup job, and any given job must be a part of a specified vault. Use the Get-AzureRMBackupVault to get a list of vaults. + + AzureRMBackupVault + + + JobId + + The unique identifier for the Azure Backup job. + + String + + + From + + A time range is specified to filter the list of jobs returned from the Azure Backup service. This parameter specifies the start time for the time range. + When this parameter is not specified, the default is _____ + When the -To parameter is used the -From parameter is mandatory. + + Nullable`1[DateTime] + + + To + + A time range is specified to filter the list of jobs returned from the Azure Backup service. This parameter specifies the end time for the time range. + When this parameter is not specified, the default vault is the current system date/time. + + Nullable`1[DateTime] + + + Status + + A filter value to get jobs with the specified status. Typically the status field is used to get InProgress and Failed jobs. + Supported values: +- InProgress +- Failed +- Cancelled +- Cancelling +- Completed +- CompletedWithWarnings + + String + + + Type + + The type of container that is used as a filter. The only supported item currently is AzureVM. + + String + + + Operation + + A filter that describes the specific operation for which the jobs will be retrieved. + Supported values: +- Backup +- ConfigureBackup +- DeleteBackupData +- Register +- Restore +- UnProtect +- Unregister + + String + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + Get-AzureRMBackupJob + + Job + + When you use the -Job parameter, the commandlet fetches the latest status for the job. Identifying the job is done using the details provided in the input object. This input object would also have been returned earlier from Get-AzureRMBackupJob. + + AzureRMBackupJob + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + Vault + + The specific Azure Backup vault object for which the jobs are being retrieved. The vault is the parent container for an Azure Backup job, and any given job must be a part of a specified vault. Use the Get-AzureRMBackupVault to get a list of vaults. + + AzureRMBackupVault + + AzureRMBackupVault + + + + + + JobId + + The unique identifier for the Azure Backup job. + + String + + String + + + + + + From + + A time range is specified to filter the list of jobs returned from the Azure Backup service. This parameter specifies the start time for the time range. + When this parameter is not specified, the default is _____ + When the -To parameter is used the -From parameter is mandatory. + + Nullable`1[DateTime] + + Nullable`1[DateTime] + + + + + + To + + A time range is specified to filter the list of jobs returned from the Azure Backup service. This parameter specifies the end time for the time range. + When this parameter is not specified, the default vault is the current system date/time. + + Nullable`1[DateTime] + + Nullable`1[DateTime] + + + + + + Status + + A filter value to get jobs with the specified status. Typically the status field is used to get InProgress and Failed jobs. + Supported values: +- InProgress +- Failed +- Cancelled +- Cancelling +- Completed +- CompletedWithWarnings + + String + + String + + + + + + Type + + The type of container that is used as a filter. The only supported item currently is AzureVM. + + String + + String + + + + + + Operation + + A filter that describes the specific operation for which the jobs will be retrieved. + Supported values: +- Backup +- ConfigureBackup +- DeleteBackupData +- Register +- Restore +- UnProtect +- Unregister + + String + + String + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + Job + + When you use the -Job parameter, the commandlet fetches the latest status for the job. Identifying the job is done using the details provided in the input object. This input object would also have been returned earlier from Get-AzureRMBackupJob. + + AzureRMBackupJob + + AzureRMBackupJob + + + + + + + + + AzureRMBackupVault + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + AzureRMBackupJob object (or) +Array of AzureRMBackupJob objects + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + None + + + + + -------------------------- Retrieve a list of jobs from the backup vault -------------------------- + + PS C:\> + + Get-AzureRMBackupJob -Vault $v + + + + + WorkloadName Operation Status StartTime EndTime +------------ --------- ------ --------- ------- +test-vm Backup InProgress 26-Aug-15 12:24:01 PM 01-Jan-01 12:00:00 AM +test-vm ConfigureBackup Completed 26-Aug-15 12:19:49 PM 26-Aug-15 12:19:54 PM +test-vm Register Completed 25-Aug-15 3:23:53 PM 25-Aug-15 3:25:00 PM + + + + + + + + + + + -------------------------- Retrieve a list of completed jobs -------------------------- + + PS C:\> + + Get-AzureRMBackupJob -Vault $v -Status Completed + + + + + WorkloadName Operation Status StartTime EndTime +------------ --------- ------ --------- ------- +test-vm Register Completed 25-Aug-15 3:23:53 PM 25-Aug-15 3:25:00 PM + + + + + + + + + + + -------------------------- Retrieve a list of failed jobs for the last 1 week -------------------------- + + PS C:\> + + Get-AzureRMBackupJob -Vault $v -From (Get-Date).AddDays(-7) -Status Failed + + + + + + + + + + + + + + + + -------------------------- Poll the service for a change in the job status -------------------------- + + PS C:\> + + $joblist = Get-AzureRMBackupJob -Vault $v -Status InProgress +$job = $joblist[0] + +while ( $job.Status -ne Completed ) +{ + Write-Host "Waiting for completion..." + Start-Sleep -s 10 + $job = Get-AzureRMBackupJob -Vault $v -Job $job +} +Write-Host "Done!" + + + + + Waiting for completion... +Waiting for completion... +Waiting for completion... +Done! + + + + + + + + + + + + + + + + + Get-AzureRMBackupJobDetails + + Get the details of a job + + + + + Get + AzureRMBackupJobDetails + + + + When a job has failed, the Azure Backup service typically logs more information for debugging purposes. The detailed job information can be retrieved using this commandlet + + + + Get-AzureRMBackupJobDetails + + Job + + The job object for which details are to be retrieved + + AzureRMBackupJob + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + Get-AzureRMBackupJobDetails + + Vault + + The Azure Backup vault under which the job can be found. + + AzureRMBackupVault + + + JobId + + The unique identifier for the job, for which the details are to be retrieved. + + String + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + Job + + The job object for which details are to be retrieved + + AzureRMBackupJob + + AzureRMBackupJob + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + Vault + + The Azure Backup vault under which the job can be found. + + AzureRMBackupVault + + AzureRMBackupVault + + + + + + JobId + + The unique identifier for the job, for which the details are to be retrieved. + + String + + String + + + + + + + + + None + + + + + + + + + + + + + AzureRMBackupJobDetails + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + None + + + + + -------------------------- Get the details of a failed job -------------------------- + + PS C:\> + + $jd = Get-AzureRMBackupJobDetails -Job $j +PS C:\> $jd.ErrorDetails + + + + + + ErrorCode ErrorMessage Recommendations +--------- ------------ --------------- + 400001 Command execution failed. {Another operation is currently in p... + + + + + + + + + + + -------------------------- Get the recommended action for a failed job -------------------------- + + PS C:\> + + $jd.ErrorDetails.Recommendations + + + + + Another operation is currently in progress on this item. Please wait until the previous operation is completed, and then retry. + + + + + + + + + + + + + + + + + Get-AzureRMBackupProtectionPolicy + + Fetches the backup policies in a backup vault + + + + + Get + AzureRMBackupProtectionPolicy + + + + The backup policy is used in the Enable-AzureRMBackupProtection commandlet to enable protection on an item. The policy must be created using the New-AzureRMBackupProtectionPolicy commandlet, or an existing policy can be used. This commandlet gets the list of existing policies in the backup vault. + + + + Get-AzureRMBackupProtectionPolicy + + Name + + The name of the specific policy. Since policy names are unique within a vault, the name is sufficient to identify a policy. + + String + + + Vault + + The Azure Backup vault under which the policy has been created. + + AzureRMBackupVault + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + Name + + The name of the specific policy. Since policy names are unique within a vault, the name is sufficient to identify a policy. + + String + + String + + + + + + Vault + + The Azure Backup vault under which the policy has been created. + + AzureRMBackupVault + + AzureRMBackupVault + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + + + + AzureRMBackupVault + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + AzureRMBackupProtectionPolicy + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + None + + + + + -------------------------- Get the list of policies in a vault -------------------------- + + PS C:\> + + Get-AzureRMBackupProtectionPolicy -Vault $v + + + + + Name Type ScheduleType BackupTime +---- ---- ------------ ---------- +test01 AzureVM Daily 26-Aug-15 3:00:00 PM +DailyBkp AzureVM Daily 26-Aug-15 3:00:00 PM +DefaultPolicy AzureVM Daily 26-Aug-15 12:30:00 AM +WeeklyBkp AzureVM Weekly 26-Aug-15 5:00:00 PM +test2 AzureVM Daily 26-Aug-15 3:00:00 PM + + + + + + + + + + + -------------------------- Get a specific policy from a vault -------------------------- + + PS C:\> + + Get-AzureRMBackupProtectionPolicy -Vault $v -Name DefaultPolicy + + + + + Name Type ScheduleType BackupTime +---- ---- ------------ ---------- +DefaultPolicy AzureVM Daily 26-Aug-15 12:30:00 AM + + + + + + + + + + + + + New-AzureRMBackupProtectionPolicy + + + + Enable-AzureRMBackupProtection + + + + Remove-AzureRMBackupProtectionPolicy + + + + + + + + Get-AzureRMBackupRecoveryPoint + + Get the recovery point(s) for a backed-up item + + + + + Get + AzureRMBackupRecoveryPoint + + + + Once an item has been backed up, it will have one or more recovery points. This commandlet gets a list of the recovery points + + + + Get-AzureRMBackupRecoveryPoint + + RecoveryPointId + + The ID to retrieve a specific recovery point for an item + + String + + + Item + + The item object for which the recovery points are being queried. + + AzureRMBackupItem + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + RecoveryPointId + + The ID to retrieve a specific recovery point for an item + + String + + String + + + + + + Item + + The item object for which the recovery points are being queried. + + AzureRMBackupItem + + AzureRMBackupItem + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + + + + AzureRMBackupItem + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + AzureRMBackupRecoveryPoint + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + + + + + + + -------------------------- Get a list of recovery points for an item -------------------------- + + PS C:\> + + Get-AzureRMBackupRecoveryPoint -Item $backupitem + + + + + RecoveryPointId RecoveryPointType RecoveryPointTime ContainerName +--------------- ----------------- ----------------- ------------- +15273496567119 AppConsistent 26-Aug-15 12:27:38 PM iaasvmcontainer;aashish-vm;aashis... + + + + + + + + + + + + + + + + + Get-AzureRMBackupVault + + Retrieves one or more vault objects based on the parameters that are specified. + + + + + Get + AzureRMBackupVault + + + + The Get-AzureRMBackupVault commandlet retrieves existing Azure Backup vaults and returns objects of type AzurePSBackupVault. The vault object is used in some Azure Backup commandlets as a mandatory parameter. + + + + Get-AzureRMBackupVault + + ResourceGroupName + + The Azure resource group under which the vault was created. + + String + + + Name + + The name of the specific Azure Backup vault that needs to be retrieved. If no name is specified, then the commandlet returns all the vaults created by the subscription. If there is more than 1 backup vault with the same name then the commandlet returns all the vaults that match the name. Use the -ResourceGroupName parameter to filter results and get a unique vault. + + String + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + ResourceGroupName + + The Azure resource group under which the vault was created. + + String + + String + + + + + + Name + + The name of the specific Azure Backup vault that needs to be retrieved. If no name is specified, then the commandlet returns all the vaults created by the subscription. If there is more than 1 backup vault with the same name then the commandlet returns all the vaults that match the name. Use the -ResourceGroupName parameter to filter results and get a unique vault. + + String + + String + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + + + + Vault name as [String] + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + AzureRMBackupVault + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + None + + + + + -------------------------- View all the Azure Backup vaults created -------------------------- + + PS C:\> + + Get-AzureBackupVault + + + + + + + + + + + + + + + + -------------------------- Get a list of all vaults created in West US -------------------------- + + PS C:\> + + Get-AzureBackupVault | Where-Object { $_.Region -eq "westus" } + + + + + + + + + + + + + + + + -------------------------- Get a reference to a specific vault -------------------------- + + PS C:\> + + Get-AzureBackupVault -Name "myvault" + + + + + ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/rg1/providers/Microsoft.Backup + /BackupVault/myvault +Name : myvault +ResourceGroupName : rg1 +Region : westus +Storage : GeoRedundant + + + + + + + + + + + -------------------------- Count the number of vaults having Locally Redundant Storage -------------------------- + + PS C:\> + + Get-AzureBackupVault | Where-Object { $_.Storage –match ‘LocallyRedundant’ } | Measure-Object + + + + + Count : 4 +Average : +Sum : +Maximum : +Minimum : +Property : + + + + + + + + + + + + + New-AzureRMBackupVault + + + + Set-AzureRMBackupVault + + + + Remove-AzureRMBackupVault + + + + Get-AzureRMBackupContainer + + + + + + + + Get-AzureRMBackupVaultCredentials + + Downloads the Vault Credentials file to a specified location. + + + + + Get + AzureRMBackupVaultCredentials + + + + To enable hybrid backup scenarios the Vault Credentials file is a critical component. The vault credential file is used to connect a server to the Azure Backup vault and register it. Only after registration can backup data be sent to the vault. The Get-AzureRMBackupVaultCredentials commandlet downloads and places a vault credential file at the location specified by the user. + + + + Get-AzureRMBackupVaultCredentials + + TargetLocation + + The destination path where the Vault Credentials file should be placed. + + String + + + Vault + + The specific Azure Backup vault object for which the Vault Credential file is generated. Use the Get-AzureRMBackupVault to get a list of vaults. + + AzureRMBackupVault + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + TargetLocation + + The destination path where the Vault Credentials file should be placed. + + String + + String + + + + + + Vault + + The specific Azure Backup vault object for which the Vault Credential file is generated. Use the Get-AzureRMBackupVault to get a list of vaults. + + AzureRMBackupVault + + AzureRMBackupVault + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + + + + AzureRMBackupVault + + + + + +This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + Vault Credentials file name as [String] + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + None + + + + + + + + + + + New-AzureRMBackupProtectionPolicy + + Creates a PowerShell object that holds backup policy information + + + + + New + AzureRMBackupProtectionPolicy + + + + A backup policy defines when and how often the backup of an item is done. This commandlet creates a PowerShell object that holds backup policy information. The backup policy is used as an input to the Enable-AzureRMBackupProtection commandlet. + There are 4 types of retention - Daily, Weekly, Monthly, and Yearly. You need to create one object for each type of retention that you plan to use. + + + + New-AzureRMBackupProtectionPolicy + + Name + + The name of the backup policy. It should be unique within a vault. + + String + + + Type + + The type of backup item on which the policy can be applied. Currently, the only supported value for is AzureVM. + + String + + + BackupTime + + The time of the day when backup should be triggered. + + DateTime + + + DaysOfWeek + + Specifies one or more days of the week when backup will be triggered at the time specified using the -BackupTime option. This parameter needs to be used with the -Weekly flag. + + String[] + + + RetentionPolicy + + A list of one or more retention policies that are associated with this backup policy. Use the New-AzureRMBackupRetentionPolicyObject to create retention policies. + + AzureRMBackupRetentionPolicy[] + + + Vault + + The Azure Backup vault that is the parent for the backup policy. + + AzureRMBackupVault + + + Profile + + Non-mandatory AzureProfile input object. + + AzureProfile + + + + New-AzureRMBackupProtectionPolicy + + Name + + The name of the backup policy. It should be unique within a vault. + + String + + + Type + + The type of backup item on which the policy can be applied. Currently, the only supported value for is AzureVM. + + String + + + Daily + + A flag for indicating that the backup policy will be triggered daily. + + SwitchParameter + + + BackupTime + + The time of the day when backup should be triggered. + + DateTime + + + RetentionPolicy + + A list of one or more retention policies that are associated with this backup policy. Use the New-AzureRMBackupRetentionPolicyObject to create retention policies. + + AzureRMBackupRetentionPolicy[] + + + Vault + + The Azure Backup vault that is the parent for the backup policy. + + AzureRMBackupVault + + + Profile + + Non-mandatory AzureProfile input object. + + AzureProfile + + + + New-AzureRMBackupProtectionPolicy + + Name + + The name of the backup policy. It should be unique within a vault. + + String + + + Type + + The type of backup item on which the policy can be applied. Currently, the only supported value for is AzureVM. + + String + + + Weekly + + A flag for indicating that the backup policy will be triggered on one more days of the week. + + SwitchParameter + + + BackupTime + + The time of the day when backup should be triggered. + + DateTime + + + DaysOfWeek + + Specifies one or more days of the week when backup will be triggered at the time specified using the -BackupTime option. This parameter needs to be used with the -Weekly flag. + + String[] + + + RetentionPolicy + + A list of one or more retention policies that are associated with this backup policy. Use the New-AzureRMBackupRetentionPolicyObject to create retention policies. + + AzureRMBackupRetentionPolicy[] + + + Vault + + The Azure Backup vault that is the parent for the backup policy. + + AzureRMBackupVault + + + Profile + + Non-mandatory AzureProfile input object. + + AzureProfile + + + + + + Name + + The name of the backup policy. It should be unique within a vault. + + String + + String + + + + + + Type + + The type of backup item on which the policy can be applied. Currently, the only supported value for is AzureVM. + + String + + String + + + + + + BackupTime + + The time of the day when backup should be triggered. + + DateTime + + DateTime + + + + + + DaysOfWeek + + Specifies one or more days of the week when backup will be triggered at the time specified using the -BackupTime option. This parameter needs to be used with the -Weekly flag. + + String[] + + String[] + + + + + + RetentionPolicy + + A list of one or more retention policies that are associated with this backup policy. Use the New-AzureRMBackupRetentionPolicyObject to create retention policies. + + AzureRMBackupRetentionPolicy[] + + AzureRMBackupRetentionPolicy[] + + + + + + Vault + + The Azure Backup vault that is the parent for the backup policy. + + AzureRMBackupVault + + AzureRMBackupVault + + + + + + Profile + + Non-mandatory AzureProfile input object. + + AzureProfile + + AzureProfile + + + + + + Daily + + A flag for indicating that the backup policy will be triggered daily. + + SwitchParameter + + SwitchParameter + + + + + + Weekly + + A flag for indicating that the backup policy will be triggered on one more days of the week. + + SwitchParameter + + SwitchParameter + + + + + + + + + None + + + + + + + + + + + + + AzureRMBackupProtectionPolicy + + + + + This section details out the type of the objects that the cmdlet emits + + + + + + + + + None + + + + + -------------------------- Create a daily backup policy with daily and monthly retention -------------------------- + + PS C:\> + + $bp = New-AzureRMBackupProtectionPolicy -Name DailyBackup01 -Type AzureVM -Daily -BackupTime ([datetime]"3:30 PM") -RetentionPolicy ($Daily,$Monthly) -Vault $v + + + The backup policy in this example has a daily backup time of 3:00 PM, and the backup data is stored as per the $Daily and $Monthly retention policies created using the New-AzureRMBackupRetentionPolicyObject commandlet. + + + Name Type ScheduleType BackupTime +---- ---- ------------ ---------- +DailyBkp AzureVM Daily 26-Aug-15 3:00:00 PM + + + + + + + + + + + + + New-AzureRMBackupRetentionPolicyObject + + + + Enable-AzureRMBackupProtection + + + + Get-AzureRMBackupProtectionPolicy + + + + Set-AzureRMBackupProtectionPolicy + + + + Remove-AzureRMBackupProtectionPolicy + + + + + + + + New-AzureRMBackupRetentionPolicyObject + + Creates a PowerShell object that holds retention policy information + + + + + New + AzureRMBackupRetentionPolicyObject + + + + A backup policy is associated with at least one retention policy. The retention policy defines how long a recovery point is kept with Azure Backup. This commandlet creates PowerShell objects that hold retention policy information. These retention policy objects are used as inputs to the New-AzureRMBackupProtectionPolicy commandlet, or directly with the Enable-AzureRMBackupProtection commandlet. + There are 4 types of retention - Daily, Weekly, Monthly, and Yearly. You need to create one object for each type of retention that you plan to use. + + + + New-AzureRMBackupRetentionPolicyObject + + DailyRetention + + Switch parameter that creates an object with Daily retention information. + + SwitchParameter + + + Retention + + The retention period for which the backup point will be stored. This unit depends on the switch option specified in the commandlet. For example, if you are using the -DailyRetention flag then this value specifies the retention in days. Or if you are using the -MonthlyRetentionInDailyFormat flag then this value specifies the retention in months. + + Int32 + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + New-AzureRMBackupRetentionPolicyObject + + WeeklyRetention + + Switch parameter that creates an object with Weekly retention information. + + SwitchParameter + + + DaysOfWeek + + The days of the week used to identify which recovery points will be retained and for how long. This parameter works with the -WeeklyRetention, -MonthlyRetentionInWeeklyFormat, and -YearlyRetentionInWeeklyFormat options. + NOTE: You need to ensure that the days of the week that are picked for backup and for retention are aligned! For example, if backup is set for Saturdays then the weekly/monthly/yearly retention policies also must use Saturday as the -DaysOfWeek option. + + String[] + + + Retention + + The retention period for which the backup point will be stored. This unit depends on the switch option specified in the commandlet. For example, if you are using the -DailyRetention flag then this value specifies the retention in days. Or if you are using the -MonthlyRetentionInDailyFormat flag then this value specifies the retention in months. + + Int32 + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + New-AzureRMBackupRetentionPolicyObject + + MonthlyRetentionInDailyFormat + + Switch parameter that creates an object with Monthly retention information. + + SwitchParameter + + + DaysOfMonth + + The days of the month used to identify which recovery points will be retained and for how long. This parameter works with the -DailyRetention, -MonthlyRetentionInDailyFormat, and -YearlyRetentionInDailyFormat options. + + + List`1[String] + + + Retention + + The retention period for which the backup point will be stored. This unit depends on the switch option specified in the commandlet. For example, if you are using the -DailyRetention flag then this value specifies the retention in days. Or if you are using the -MonthlyRetentionInDailyFormat flag then this value specifies the retention in months. + + Int32 + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + New-AzureRMBackupRetentionPolicyObject + + MonthlyRetentionInWeeklyFormat + + Switch parameter that creates an object with Monthly retention information. + + SwitchParameter + + + DaysOfWeek + + The days of the week used to identify which recovery points will be retained and for how long. This parameter works with the -WeeklyRetention, -MonthlyRetentionInWeeklyFormat, and -YearlyRetentionInWeeklyFormat options. + NOTE: You need to ensure that the days of the week that are picked for backup and for retention are aligned! For example, if backup is set for Saturdays then the weekly/monthly/yearly retention policies also must use Saturday as the -DaysOfWeek option. + + String[] + + + WeekNumber + + When defining monthly retention, this parameter specifies which week of the month has the recovery points that should get monthly retention. + + String[] + + + Retention + + The retention period for which the backup point will be stored. This unit depends on the switch option specified in the commandlet. For example, if you are using the -DailyRetention flag then this value specifies the retention in days. Or if you are using the -MonthlyRetentionInDailyFormat flag then this value specifies the retention in months. + + Int32 + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + New-AzureRMBackupRetentionPolicyObject + + YearlyRetentionInDailyFormat + + Switch parameter that creates an object with Yearly retention information. + + SwitchParameter + + + DaysOfMonth + + The days of the month used to identify which recovery points will be retained and for how long. This parameter works with the -DailyRetention, -MonthlyRetentionInDailyFormat, and -YearlyRetentionInDailyFormat options. + + + List`1[String] + + + MonthsOfYear + + When defining yearly retention, this parameter specifies which months of the year has the recovery points that should get yearly retention. + + String[] + + + Retention + + The retention period for which the backup point will be stored. This unit depends on the switch option specified in the commandlet. For example, if you are using the -DailyRetention flag then this value specifies the retention in days. Or if you are using the -MonthlyRetentionInDailyFormat flag then this value specifies the retention in months. + + Int32 + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + New-AzureRMBackupRetentionPolicyObject + + YearlyRetentionInWeeklyFormat + + Switch parameter that creates an object with Yearly retention information. + + SwitchParameter + + + DaysOfWeek + + The days of the week used to identify which recovery points will be retained and for how long. This parameter works with the -WeeklyRetention, -MonthlyRetentionInWeeklyFormat, and -YearlyRetentionInWeeklyFormat options. + NOTE: You need to ensure that the days of the week that are picked for backup and for retention are aligned! For example, if backup is set for Saturdays then the weekly/monthly/yearly retention policies also must use Saturday as the -DaysOfWeek option. + + String[] + + + WeekNumber + + When defining monthly retention, this parameter specifies which week of the month has the recovery points that should get monthly retention. + + String[] + + + MonthsOfYear + + When defining yearly retention, this parameter specifies which months of the year has the recovery points that should get yearly retention. + + String[] + + + Retention + + The retention period for which the backup point will be stored. This unit depends on the switch option specified in the commandlet. For example, if you are using the -DailyRetention flag then this value specifies the retention in days. Or if you are using the -MonthlyRetentionInDailyFormat flag then this value specifies the retention in months. + + Int32 + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + DailyRetention + + Switch parameter that creates an object with Daily retention information. + + SwitchParameter + + SwitchParameter + + + + + + Retention + + The retention period for which the backup point will be stored. This unit depends on the switch option specified in the commandlet. For example, if you are using the -DailyRetention flag then this value specifies the retention in days. Or if you are using the -MonthlyRetentionInDailyFormat flag then this value specifies the retention in months. + + Int32 + + Int32 + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + WeeklyRetention + + Switch parameter that creates an object with Weekly retention information. + + SwitchParameter + + SwitchParameter + + + + + + DaysOfWeek + + The days of the week used to identify which recovery points will be retained and for how long. This parameter works with the -WeeklyRetention, -MonthlyRetentionInWeeklyFormat, and -YearlyRetentionInWeeklyFormat options. + NOTE: You need to ensure that the days of the week that are picked for backup and for retention are aligned! For example, if backup is set for Saturdays then the weekly/monthly/yearly retention policies also must use Saturday as the -DaysOfWeek option. + + String[] + + String[] + + + + + + MonthlyRetentionInDailyFormat + + Switch parameter that creates an object with Monthly retention information. + + SwitchParameter + + SwitchParameter + + + + + + DaysOfMonth + + The days of the month used to identify which recovery points will be retained and for how long. This parameter works with the -DailyRetention, -MonthlyRetentionInDailyFormat, and -YearlyRetentionInDailyFormat options. + + + List`1[String] + + List`1[String] + + + + + + MonthlyRetentionInWeeklyFormat + + Switch parameter that creates an object with Monthly retention information. + + SwitchParameter + + SwitchParameter + + + + + + WeekNumber + + When defining monthly retention, this parameter specifies which week of the month has the recovery points that should get monthly retention. + + String[] + + String[] + + + + + + YearlyRetentionInDailyFormat + + Switch parameter that creates an object with Yearly retention information. + + SwitchParameter + + SwitchParameter + + + + + + MonthsOfYear + + When defining yearly retention, this parameter specifies which months of the year has the recovery points that should get yearly retention. + + String[] + + String[] + + + + + + YearlyRetentionInWeeklyFormat + + Switch parameter that creates an object with Yearly retention information. + + SwitchParameter + + SwitchParameter + + + + + + + + + None + + + + + + + + + + + + + AzureRMBackupRetentionPolicy + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + None + + + + + -------------------------- Create a retention policy for 30 days of daily retention -------------------------- + + PS C:\> + + $Daily = New-AzureRMBackupRetentionPolicyObject -DailyRetention -Retention 30 +PS C:\> $Daily + + + + + RetentionType Retention RetentionTimes +------------- --------- -------------- +Daily 30 + + + + + + + + + + + -------------------------- Create a monthly retention policy -------------------------- + + PS C:\> + + $Monthly = New-AzureRMBackupRetentionPolicyObject -MonthlyRetentionInDailyFormat -DaysOfMonth (10, 20) -Retention 12 +PS C:\> $Monthly | select * + + This policy keeps the backup on the 10th and the 20th of each month for 12 months + + + RetentionFormat : Daily +DaysOfMonth : {10, 20} +WeekNumber : +DaysOfWeek : +RetentionType : Monthly +Retention : 12 +RetentionTimes : + + + + + + + + + + + + + New-AzureRMBackupProtectionPolicy + + + + + + + + New-AzureRMBackupVault + + Creates a new Azure Backup vault based on the parameters that are specified. A vault is the start point for all backup operations with Azure Backup. + + + + + New + AzureRMBackupVault + + + + The New-AzureRMBackupVault commandlet creates and Azure Backup vault and returns an object of type AzurePSBackupVault that acts as a reference to the vault entity. The vault has some important properties that define the scope of backup – the region and the storage type. + + + + New-AzureRMBackupVault + + ResourceGroupName + + Specifies the name of an existing resource group. In order to create a resource group, use the New-AzureResourceGroup commandlet. There is no requirement that the Azure ResourceGroup and the Azure Backup vault be in the same region. + + String + + + Name + + Specifies the name of the Azure Backup vault. The combination of ResourceGroupName and Name must be unique. You cannot create two vaults with the same name under the same ResourceGroup, but two vaults with the same name can be placed under two different Resource Groups. + + String + + + Region + + The region parameter places the vault object into a specific Azure region. For hybrid backup scenarios, it is advised to create a vault in a region close to the on-premise server to reduce latency. For backup of Azure IaaS virtual machines, the vault becomes the point of discovery for local virtual machines. + + String + + + Storage + + Backup storage is billed at Azure Storage rates and users can choose between LocallyRedundant and GeoRedundant as the storage for the backup data. Since this is an optional parameter, if it is not specified then the vault is created with the GeoRedundant Storage option. + + AzureBackupVaultStorageType + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + ResourceGroupName + + Specifies the name of an existing resource group. In order to create a resource group, use the New-AzureResourceGroup commandlet. There is no requirement that the Azure ResourceGroup and the Azure Backup vault be in the same region. + + String + + String + + + + + + Name + + Specifies the name of the Azure Backup vault. The combination of ResourceGroupName and Name must be unique. You cannot create two vaults with the same name under the same ResourceGroup, but two vaults with the same name can be placed under two different Resource Groups. + + String + + String + + + + + + Region + + The region parameter places the vault object into a specific Azure region. For hybrid backup scenarios, it is advised to create a vault in a region close to the on-premise server to reduce latency. For backup of Azure IaaS virtual machines, the vault becomes the point of discovery for local virtual machines. + + String + + String + + + + + + Storage + + Backup storage is billed at Azure Storage rates and users can choose between LocallyRedundant and GeoRedundant as the storage for the backup data. Since this is an optional parameter, if it is not specified then the vault is created with the GeoRedundant Storage option. + + AzureBackupVaultStorageType + + AzureBackupVaultStorageType + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + + + + None + + + + + + + + + + + + AzureRMBackupVault + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + None + + + + + -------------------------- Create a new backup vault -------------------------- + + PS C:\> + + New-AzureRMBackupVault –ResourceGroupName “rg1” –Name “vault1” –Region “westus” + + + + + ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/rg1/providers/Microsoft.Backup + /BackupVault/vault1 +Name : vault1 +ResourceGroupName : rg1 +Region : westus +Storage : GeoRedundant + + + + + + + + + + + -------------------------- Create a new backup vault with Locally Redundant Storage -------------------------- + + PS C:\> + + New-AzureRMBackupVault –ResourceGroupName “rg2” –Name “vault2” –Region “westus” –Storage LocallyRedundant + + + + + ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/rg2/providers/Microsoft.Backup + /BackupVault/vault2 +Name : vault2 +ResourceGroupName : rg2 +Region : westus +Storage : LocallyRedundant + + + + + + + + + + + + + New-AzureResourceGroup + https://msdn.microsoft.com/en-us/library/dn654594.aspx + + + Get-AzureRMBackupVault + + + + Set-AzureRMBackupVault + + + + Remove-AzureRMBackupVault + + + + + + + + Register-AzureRMBackupContainer + + Register the container with the Azure Backup vault + + + + + Register + AzureRMBackupContainer + + + + The first step towards configuring backup with Azure Backup is to register your machine or VM with an Azure Backup vault. This commandlet takes the input information of an Azure IaaS virtual machine and registers it with the specified vault. The register operation associates the Azure virtual machine with the backup vault and tracks the VM through the backup lifecycle. + + + + Register-AzureRMBackupContainer + + Name + + Name of the Azure VM to be registered. + + String + + + ServiceName + + The cloud service name of the Azure VM to be registered. Typically the cloud service name has a suffix ".cloudapp.net". Do not include the suffix as input to this commandlet! You can use the Get-AzureVM commandlet (in the AzureServiceManagement mode) to get the VM information; the service name is the DeploymentName property in the VM object. + + String + + + Vault + + The Azure Backup vault to which the Azure VM should be registered. + + AzureRMBackupVault + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + Register-AzureRMBackupContainer + + Name + + Name of the Azure VM to be registered. + + String + + + ResourceGroupName + + If your VM is created in the AzureResourceManager mode, then instead of -ServiceName you will need to use this parameter + + String + + + Vault + + The Azure Backup vault to which the Azure VM should be registered. + + AzureRMBackupVault + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + Name + + Name of the Azure VM to be registered. + + String + + String + + + + + + ServiceName + + The cloud service name of the Azure VM to be registered. Typically the cloud service name has a suffix ".cloudapp.net". Do not include the suffix as input to this commandlet! You can use the Get-AzureVM commandlet (in the AzureServiceManagement mode) to get the VM information; the service name is the DeploymentName property in the VM object. + + String + + String + + + + + + Vault + + The Azure Backup vault to which the Azure VM should be registered. + + AzureRMBackupVault + + AzureRMBackupVault + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + ResourceGroupName + + If your VM is created in the AzureResourceManager mode, then instead of -ServiceName you will need to use this parameter + + String + + String + + + + + + + + + AzureRMBackupVault + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + AzureRMBackupJob + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + + None + + + + + -------------------------- Register a virtual machine to an Azure Backup vault -------------------------- + + PS C:\> + + $job = Register-AzureRMBackupContainer -Vault $v -Name "testvm" -ServiceName "testvm" + + + + + None + + + + + + + + + + + + + Get-AzureVM + + + + + + + + Remove-AzureRMBackupProtectionPolicy + + Deletes a backup policy from the vault + + + + + Remove + AzureRMBackupProtectionPolicy + + + + Deletes the specified policy from the backup vault. + + + + Remove-AzureRMBackupProtectionPolicy + + ProtectionPolicy + + The protection policy object that has information about the policy. Use the Get-AzureRMBackupProtectionPolicy commandlet to get a list of protection policy objects. + + AzureRMBackupProtectionPolicy + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + ProtectionPolicy + + The protection policy object that has information about the policy. Use the Get-AzureRMBackupProtectionPolicy commandlet to get a list of protection policy objects. + + AzureRMBackupProtectionPolicy + + AzureRMBackupProtectionPolicy + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + + + + AzureRMBackupProtectionPolicy + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + + None + + + + + + + + + + + + + + + The policy must not have any associated Items that are protected. If you need to delete the policy, ensure that each associated item is protected with some other policy first. To associate another policy with a backup item, use the Enable-AzureRMBackupProtection commandlet. + + + + + -------------------------- Remove a specified policy -------------------------- + + PS C:\> + + Get-AzureRMBackupProtectionPolicy -Vault $v -Name DailyBackup | Remove-AzureRMBackupProtectionPolicy + + In this example, we fetch a policy named "DailyBackup" and pipe the policy object to the Remove commandlet. + + + None + + + + + + + + + + + + + Get-AzureRMBackupProtectionPolicy + + + + New-AzureRMBackupProtectionPolicy + + + + + + + + Remove-AzureRMBackupVault + + Deletes the Azure Backup vault object based on the parameters that are specified. + + + + + Remove + AzureRMBackupVault + + + + The Remove-AzureBackupVault commandlet deletes the backup vault. However, before a vault can be removed, it must first be empty – it must contain no backup data or protected items or registered servers. This ensures that a vault cannot be deleted inadvertently; the deletion of a backup vault is a planned operation. + Use the Remove-AzureBackupContainer commandlet to clear up IaaS VM backup data from the vault, or use the Delete-RegisteredServer commandlet to clear up other registered servers and backup data. + + + + Remove-AzureRMBackupVault + + Vault + + The specific Azure Backup vault object which needs to be removed. Use the Get-AzureRMBackupVault to get a list of vaults. + + AzureRMBackupVault + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + Vault + + The specific Azure Backup vault object which needs to be removed. Use the Get-AzureRMBackupVault to get a list of vaults. + + AzureRMBackupVault + + AzureRMBackupVault + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + + + + AzureRMBackupVault + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + None + + + + + + + + + + + + + + None + + + + + -------------------------- Delete an Azure Backup vault -------------------------- + + PS C:\> + + Get-AzureBackupVault -Name "myvault" | Remove-AzureBackupVault + + + + + + + + + + + + + + + + + + RemoveAzureRMBackupContainer + + + + New-AzureRMBackupVault + + + + Get-AzureRMBackupVault + + + + Set-AzureRMBackupVault + + + + + + + + Restore-AzureRMBackupItem + + Restores the data and config for a point in time + + + + + Restore + AzureRMBackupItem + + + + In order to restore backup data, you need to identify the backed-up item and the recovery point that holds the point-in-time data that needs to be restored. This information is supplied to the Restore-AzureRMBackupItem commandlet to initiate a restore of data from the vault to the customer's account. + + + + Restore-AzureRMBackupItem + + StorageAccountName + + The target storage account name in the customer subscription. As a part of the restore process, the disks and the config information will be placed in this storage account. + + String + + + RecoveryPoint + + The recovery point object that has information about which specific point-in-time needs to be restored. + + AzureRMBackupRecoveryPoint + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + StorageAccountName + + The target storage account name in the customer subscription. As a part of the restore process, the disks and the config information will be placed in this storage account. + + String + + String + + + + + + RecoveryPoint + + The recovery point object that has information about which specific point-in-time needs to be restored. + + AzureRMBackupRecoveryPoint + + AzureRMBackupRecoveryPoint + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + + + + AzureRMBackupRecoveryPoint + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + + AzureRMBackupJob + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + + Triggering a restore operation in PowerShell does not restore the full VM. It restores only the disk data and config information. The user has to additionally create the VM and start it after the restore operation has completed. + + + + + -------------------------- Restore a recovery point -------------------------- + + PS C:\> + + $rp = Get-AzureRMBackupContainer -Type AzureVM -Status Registered -Vault $v | Get-AzureRMBackupItem | Get-AzureRMBackupRecoveryPoint +PS C:\> Restore-AzureRMBackupItem -StorageAccountName "destaccount" -RecoveryPoint $rp + + + + + WorkloadName Operation Status StartTime EndTime +------------ --------- ------ --------- ------- +test-vm Restore InProgress 26-Aug-15 1:14:01 PM 01-Jan-01 12:00:00 AM + + + + + + + + + + + + + + + + + Set-AzureRMBackupProtectionPolicy + + Update an existing protection policy + + + + + Set + AzureRMBackupProtectionPolicy + + + + The protection policy has multiple components: +- Name +- Backup schedule +- Retention policies + This commandlet allows you to update one or more of the components of the policy. The change might affect the backup and retention of the items associated with the policy. + + + + Set-AzureRMBackupProtectionPolicy + + NewName + + An optional parameter that specifies the new name for the policy. As with any policy, this value should be unique within a vault + + String + + + BackupTime + + An optional parameter that specifies the new backup time for the policy. + + DateTime + + + RetentionPolicy + + An optional parameter that specifies one or more new retention policies to be associated with the protection policy. + + AzureRMBackupRetentionPolicy[] + + + ProtectionPolicy + + The protection policy object that refers to the original policy that this commandlet will update. + + AzureRMBackupProtectionPolicy + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + Set-AzureRMBackupProtectionPolicy + + NewName + + An optional parameter that specifies the new name for the policy. As with any policy, this value should be unique within a vault + + String + + + Daily + + An optional parameter that sets the backup operation to run at a Daily schedule. Refer to New-AzureRMBackupProtectionPolicy for examples. + + SwitchParameter + + + BackupTime + + An optional parameter that specifies the new backup time for the policy. + + DateTime + + + RetentionPolicy + + An optional parameter that specifies one or more new retention policies to be associated with the protection policy. + + AzureRMBackupRetentionPolicy[] + + + ProtectionPolicy + + The protection policy object that refers to the original policy that this commandlet will update. + + AzureRMBackupProtectionPolicy + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + Set-AzureRMBackupProtectionPolicy + + NewName + + An optional parameter that specifies the new name for the policy. As with any policy, this value should be unique within a vault + + String + + + Weekly + + An optional parameter that sets the backup operation to run at a Weekly schedule. Refer to New-AzureRMBackupProtectionPolicy for examples. + + SwitchParameter + + + BackupTime + + An optional parameter that specifies the new backup time for the policy. + + DateTime + + + RetentionPolicy + + An optional parameter that specifies one or more new retention policies to be associated with the protection policy. + + AzureRMBackupRetentionPolicy[] + + + DaysOfWeek + + An optional parameter that sets the backup operation to run on specific days of the week. Used in conjunction with the -Weekly parameter. Refer to New-AzureRMBackupProtectionPolicy for examples. + + String[] + + + ProtectionPolicy + + The protection policy object that refers to the original policy that this commandlet will update. + + AzureRMBackupProtectionPolicy + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + NewName + + An optional parameter that specifies the new name for the policy. As with any policy, this value should be unique within a vault + + String + + String + + + + + + BackupTime + + An optional parameter that specifies the new backup time for the policy. + + DateTime + + DateTime + + + + + + RetentionPolicy + + An optional parameter that specifies one or more new retention policies to be associated with the protection policy. + + AzureRMBackupRetentionPolicy[] + + AzureRMBackupRetentionPolicy[] + + + + + + ProtectionPolicy + + The protection policy object that refers to the original policy that this commandlet will update. + + AzureRMBackupProtectionPolicy + + AzureRMBackupProtectionPolicy + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + Daily + + An optional parameter that sets the backup operation to run at a Daily schedule. Refer to New-AzureRMBackupProtectionPolicy for examples. + + SwitchParameter + + SwitchParameter + + + + + + Weekly + + An optional parameter that sets the backup operation to run at a Weekly schedule. Refer to New-AzureRMBackupProtectionPolicy for examples. + + SwitchParameter + + SwitchParameter + + + + + + DaysOfWeek + + An optional parameter that sets the backup operation to run on specific days of the week. Used in conjunction with the -Weekly parameter. Refer to New-AzureRMBackupProtectionPolicy for examples. + + String[] + + String[] + + + + + + + + + AzureRMBackupProtectionPolicy + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + None + + + + + + + + + + + + + + + None + + + + + + + New-AzureRMBackupProtectionPolicy @@ -898,30 +4237,36 @@ Storage : LocallyRedundant - Remove-AzureBackupVault + Set-AzureRMBackupVault - Deletes the Azure Backup vault object based on the parameters that are specified. + Changes the properties of the Azure Backup vault object based on the parameters that are specified. - Remove - AzureBackupVault + Set + AzureRMBackupVault - The Remove-AzureBackupVault commandlet deletes the backup vault. However, before a vault can be removed, it must first be empty – it must contain no backup data or protected items or registered servers. This ensures that a vault cannot be deleted inadvertently; the deletion of a backup vault is a planned operation. - Use the Remove-AzureBackupContainer commandlet to clear up IaaS VM backup data from the vault, or use the Delete-RegisteredServer commandlet to clear up other registered servers and backup data. + The Set-AzureBackupVault commandlet allows you to change the storage type of the backup vault. The other parameters like Region, Name, and ResourceGroupName are not editable. - Remove-AzureBackupVault + Set-AzureRMBackupVault + + Storage + + Users can choose between LocallyRedundant and GeoRedundant as the storage for the backup data. + + AzureBackupVaultStorageType + Vault - The specific Azure Backup vault object which needs to be removed. + The specific Azure Backup vault object for which the properties need to be updated. Use the Get-AzureRMBackupVault to get a list of vaults. - AzurePSBackupVault + AzureRMBackupVault Profile @@ -933,14 +4278,26 @@ Storage : LocallyRedundant + + Storage + + Users can choose between LocallyRedundant and GeoRedundant as the storage for the backup data. + + AzureBackupVaultStorageType + + AzureBackupVaultStorageType + + + + Vault - The specific Azure Backup vault object which needs to be removed. + The specific Azure Backup vault object for which the properties need to be updated. Use the Get-AzureRMBackupVault to get a list of vaults. - AzurePSBackupVault + AzureRMBackupVault - AzurePSBackupVault + AzureRMBackupVault @@ -961,13 +4318,12 @@ Storage : LocallyRedundant - Microsoft.Azure.Commands.AzureBackup.Models.AzurePSBackupVault + AzureRMBackupVault - -This section details out the type of the objects that you can pipe to the cmdlet. + This section details out the type of the objects that you can pipe to the cmdlet. @@ -979,8 +4335,7 @@ This section details out the type of the objects that you can pipe to the cmdlet - -This section details out the type of the objects that the cmdlet emits. + @@ -989,16 +4344,16 @@ This section details out the type of the objects that the cmdlet emits. - None + The storage type is locked on the registration of the first server or virtual machine, and cannot be changed afterwards. - -------------------------- Delete an Azure Backup vault -------------------------- + -------------------------- Change the storage for an existing vault -------------------------- PS C:\> - Get-AzureBackupVault -Name "myvault" | Remove-AzureBackupVault + Get-AzureBackupVault –Name “myvault” | Set-AzureBackupVault –Storage LocallyRedundant @@ -1016,23 +4371,15 @@ This section details out the type of the objects that the cmdlet emits. - Remove-AzureBackupContainer - - - - Delete-RegisteredServer - - - - New-AzureBackupVault + New-AzureRMBackupVault - Get-AzureBackupVault + Get-AzureRMBackupVault - Set-AzureBackupVault + Remove-AzureRMBackupVault @@ -1040,36 +4387,57 @@ This section details out the type of the objects that the cmdlet emits. - Set-AzureBackupVault + Stop-AzureRMBackupJob - Changes the properties of the Azure Backup vault object based on the parameters that are specified. + Cancels an ongoing Azure Backup job - Set - AzureBackupVault + Stop + AzureRMBackupJob - The Set-AzureBackupVault commandlet allows you to change the storage type of the backup vault. The other parameters like Region, Name, and ResourceGroupName are not editable. + This commandlet cancels an existing Azure Backup job. This is particularly helpful if the job is taking too long and is blocking other activities. + The types of jobs that can be stopped are: +- Backup +- Restore + All other job types are not cancellable. - Set-AzureBackupVault - - Storage + Stop-AzureRMBackupJob + + Vault - Users can choose between LocallyRedundant and GeoRedundant as the storage for the backup data. + Use the Get-AzureRMBackupVault to get a list of vaults. - AzureBackupVaultStorageType + AzureRMBackupVault - - Vault + + JobID + + The GUID that uniquely identifies a job in the Azure Backup service. Use the Get-AzureRMBackupJob commandlet to get one or more jobs. From the AzureRMBackupJob object, use the InstanceId field for this value. + + String + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + Stop-AzureRMBackupJob + + Job - The specific Azure Backup vault object for which the properties need to be updated. + The job object that contains information about the job. The commandlet will attempt to stop (or cancel) this job. - AzurePSBackupVault + AzureRMBackupJob Profile @@ -1081,26 +4449,26 @@ This section details out the type of the objects that the cmdlet emits. - - Storage + + Vault - Users can choose between LocallyRedundant and GeoRedundant as the storage for the backup data. + Use the Get-AzureRMBackupVault to get a list of vaults. - AzureBackupVaultStorageType + AzureRMBackupVault - AzureBackupVaultStorageType + AzureRMBackupVault - - Vault + + JobID - The specific Azure Backup vault object for which the properties need to be updated. + The GUID that uniquely identifies a job in the Azure Backup service. Use the Get-AzureRMBackupJob commandlet to get one or more jobs. From the AzureRMBackupJob object, use the InstanceId field for this value. - AzurePSBackupVault + String - AzurePSBackupVault + String @@ -1117,11 +4485,23 @@ This section details out the type of the objects that the cmdlet emits. + + Job + + The job object that contains information about the job. The commandlet will attempt to stop (or cancel) this job. + + AzureRMBackupJob + + AzureRMBackupJob + + + + - Microsoft.Azure.Commands.AzureBackup.Models.AzurePSBackupVault + AzureRMBackupJob @@ -1138,7 +4518,7 @@ This section details out the type of the objects that the cmdlet emits. - This section details out the type of the objects that the cmdlet emits. + @@ -1147,16 +4527,17 @@ This section details out the type of the objects that the cmdlet emits. - The storage type is locked on the registration of the first server or virtual machine, and cannot be changed afterwards. + None - -------------------------- Change the storage for an existing vault -------------------------- + -------------------------- Stop a backup job with a job ID -------------------------- PS C:\> - Get-AzureBackupVault –Name “myvault” | Set-AzureBackupVault –Storage LocallyRedundant + $j = Get-AzureRMBackupJob -Vault $v -Operation Backup +PS C:\> Stop-AzureRMBackupJob -Vault $v -JobID $j.InstanceId @@ -1171,30 +4552,34 @@ This section details out the type of the objects that the cmdlet emits. + + -------------------------- Stop all running Restore operations -------------------------- + + PS C:\> + + Get-AzureRMBackupJob -Vault $v -Operation Restore | Stop-AzureRMBackupJob + + In this example, the AzureRMBackupJob objects returned by the Get-AzureRMBackupJob commandlet are piped to the Stop-AzureRMBackupJob commandlet. + + + + + + + + + + + + - - New-AzureBackupVault - - - - Get-AzureBackupVault - - - - Remove-AzureBackupVault - - - - Set-AzureBackupVaultStorageType - - - Unregister-AzureBackupContainer + Unregister-AzureRMBackupContainer Unregisters the specified Windows Server or Azure virtual machine from the Azure Backup vault. @@ -1202,7 +4587,7 @@ This section details out the type of the objects that the cmdlet emits. Unregister - AzureBackupContainer + AzureRMBackupContainer @@ -1210,7 +4595,7 @@ This section details out the type of the objects that the cmdlet emits. - Unregister-AzureBackupContainer + Unregister-AzureRMBackupContainer Force @@ -1223,7 +4608,7 @@ This section details out the type of the objects that the cmdlet emits. The Windows Server or Azure virtual machine that should be unregistered. - AzureBackupContainer + AzureRMBackupContainer Profile @@ -1252,9 +4637,9 @@ This section details out the type of the objects that the cmdlet emits. The Windows Server or Azure virtual machine that should be unregistered. - AzureBackupContainer + AzureRMBackupContainer - AzureBackupContainer + AzureRMBackupContainer @@ -1288,7 +4673,7 @@ This section details out the type of the objects that the cmdlet emits. AzureBackupJob -- For containers of type Windows, the return value is $null +- For containers of type Windows Server, the return value is $null @@ -1352,7 +4737,131 @@ This operation will delete all data in the backup vault that is associated with - Get-AzureBackupContainer + Get-AzureRMBackupContainer + + + + + + + + Wait-AzureRMBackupJob + + Waits for an Azure Backup job to complete + + + + + Wait + AzureRMBackupJob + + + + Long running operations are tracked in the Azure Backup service using jobs. To script out a workflow sequence that involves such a long running operations, the script has to wait for the operation to finish before starting the next one. This commandlet allows the script to pause until the job completes. + Scripting with this commandlet makes the script code simpler with no need to "poll" for the job status. + + + + Wait-AzureRMBackupJob + + Job + + The job object that contains information about the job. The commandlet will wait for this job to complete. + + Object + + + TimeOut + + The maximum time (in seconds) that the commandlet should wait for the job to complete. It is advised that a timeout value should always be specified to prevent infinite waiting. In order to wait 24 hours, set the timeout value to 86400. + + Nullable`1[Int64] + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + + + + + Job + + The job object that contains information about the job. The commandlet will wait for this job to complete. + + Object + + Object + + + + + + TimeOut + + The maximum time (in seconds) that the commandlet should wait for the job to complete. It is advised that a timeout value should always be specified to prevent infinite waiting. In order to wait 24 hours, set the timeout value to 86400. + + Nullable`1[Int64] + + Nullable`1[Int64] + + + + + + Profile + + Non-mandatory AzureProfile input object + + AzureProfile + + AzureProfile + + + + + + + + + AzureRMBackupJob + + + + + This section details out the type of the objects that you can pipe to the cmdlet. + + + + + + + AzureRMBackupJob object (or) +Array of AzureRMBackupJob objects + + + + + This section details out the type of the objects that the cmdlet emits. + + + + + + + + + + + + + + + + Get-AzureRMBackupJob