Edit

Share via

New-AzureSiteRecoveryProtectionProfileObject

Module:
Azure Module

Creates a Site Recovery protection profile object.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

EnterpriseToAzure (Default) 

New-AzureSiteRecoveryProtectionProfileObject
    -ReplicationProvider <String>
    -RecoveryAzureSubscription <String>
    -RecoveryAzureStorageAccount <String>
    -ReplicationFrequencyInSeconds <String>
    [-Name <String>]
    [-RecoveryPoints <Int32>]
    [-ApplicationConsistentSnapshotFrequencyInHours <Int32>]
    [-ReplicationStartTime <TimeSpan>]
    [-Force]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

EnterpriseToEnterprise 

New-AzureSiteRecoveryProtectionProfileObject
    -ReplicationProvider <String>
    -ReplicationFrequencyInSeconds <String>
    -ReplicationPort <UInt16>
    [-Name <String>]
    [-ReplicationMethod <String>]
    [-RecoveryPoints <Int32>]
    [-ApplicationConsistentSnapshotFrequencyInHours <Int32>]
    [-CompressionEnabled]
    [-Authentication <String>]
    [-ReplicationStartTime <TimeSpan>]
    [-AllowReplicaDeletion]
    [-Force]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The New-AzureSiteRecoveryProtectionProfileObject cmdlet creates an Azure Site Recovery protection profile object. This cmdlet creates an ASRProtectionProfile object to use with other cmdlets.

Examples

Example 1: Create a protection profile

PS C:\> New-AzureSiteRecoveryProtectionProfileObject -ReplicationProvider "HyperVReplica" -AllowReplicaDeletion -ApplicationConsistentSnapshotFrequencyInHours 1 -CompressionEnabled -RecoveryPoints 2 -ReplicationFrequencyInSeconds 30 -ReplicationMethod "Online" -ReplicationPort 8085 -ReplicationStartTime 1
Name                                     :
ID                                       :
ReplicationProvider                      : HyperVReplica
HyperVReplicaProviderSettingsObject      : Microsoft.Azure.Portal.RecoveryServices.Models.Common.HyperVReplicaProviderSettings
HyperVReplicaAzureProviderSettingsObject :

This command creates a protection profile object.

Example 2: Create a protection profile for HyperVReplicaAzure provider

PS C:\> New-AzureSiteRecoveryProtectionProfileObject -Name "ProtectionProfile" -ReplicationProvider "HyperVReplicaAzure" -RecoveryAzureSubscription "cb53d0c3-bd59-4721-89bc-06916a9147ef" -RecoveryAzureStorageAccount "Contoso01" -ReplicationFrequencyInSeconds 30 -RecoveryPoints 1 -Force
Name                                     : ProtectionProfile
ID                                       :
ReplicationProvider                      : HyperVReplicaAzure
HyperVReplicaProviderSettingsObject      :
HyperVReplicaAzureProviderSettingsObject : Microsoft.Azure.Portal.RecoveryServices.Models.Common.HyperVReplicaAzureProviderSettings

This command creates a protection profile for a HyperVReplicaAzure provider.

Parameters

-AllowReplicaDeletion

Indicates that the protection profile enables deletion of replica entities.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnterpriseToEnterprise
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ApplicationConsistentSnapshotFrequencyInHours

Specifies the frequency, in hours, for application consistent snapshots.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Authentication

Specifies the type of authentication to use. The acceptable values for this parameter are: Certificate and Kerberos.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnterpriseToEnterprise
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CompressionEnabled

Indicates that the protection profile enables compression.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnterpriseToEnterprise
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies a name for the protection profile.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Parameter properties

Type:AzureSMProfile
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RecoveryAzureStorageAccount

Specifies the name of an Azure Storage account on which to store the Azure replica entity.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnterpriseToAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RecoveryAzureSubscription

Specifies the ID for an Azure Subscription for a storage account. This parameter refers to the account on which to store the Azure replica entity.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnterpriseToAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RecoveryPoints

Specifies the number of hours to retain recovery points.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReplicationFrequencyInSeconds

Specifies the frequency interval, in seconds, for replication. The acceptable values for this parameter are:

  • 30
  • 300
  • 900

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReplicationMethod

Specifies the replication method. The acceptable values for this parameter are:

  • Online. Replication over the network.
  • Offline.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnterpriseToEnterprise
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReplicationPort

Specifies the number of the port on which the replication occurs.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnterpriseToEnterprise
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReplicationProvider

Specifies the type of replication provider. The acceptable values for this parameter are: HyperVReplica and HyperVReplicaAzure.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReplicationStartTime

Specifies the start time of the replication. Specify a time within 24 hours after you start the job.

Parameter properties

Type:TimeSpan
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.