New-AzSqlVirtualMachineAgReplicaObject

  • Reference
Module:
Az.SqlVirtualMachine

Create an in-memory object for AgReplica.

Syntax

New-AzSqlVirtualMachineAgReplicaObject
   [-Commit <Commit>]
   [-Failover <Failover>]
   [-ReadableSecondary <ReadableSecondary>]
   [-Role <Role>]
   [-SqlVirtualMachineInstanceId <String>]
   [<CommonParameters>]

Description

Create an in-memory object for AgReplica.

Examples

Example 1: Create an in-memory object for availability group replica configuration

$AgReplica = New-AzSqlVirtualMachineAgReplicaObject -Commit 'SYNCHRONOUS_COMMIT' -Failover 'MANUAL' -ReadableSecondary 'NO' -Role 'PRIMARY' -SqlVirtualMachineInstanceId $sqlvmResourceId1
$AgReplica

Commit             Failover ReadableSecondary Role    SqlVirtualMachineInstanceId
------             -------- ----------------- ----    ---------------------------
SYNCHRONOUS_COMMIT MANUAL   NO                PRIMARY

New-AzSqlVirtualMachineAgReplicaObject creates an in-memory object of type AgReplica. This object represents an availability group replica configuration and will be used for parameter AvailabilityGroupConfigurationReplica in cmdlet New-AzAvailabilityGroupListener.

Parameters

-Commit

Replica commit mode in availability group.

Type:Commit
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Failover

Replica failover mode in availability group.

Type:Failover
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReadableSecondary

Replica readable secondary mode in availability group.

Type:ReadableSecondary
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Role

Replica Role in availability group.

Type:Role
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SqlVirtualMachineInstanceId

Sql VirtualMachine Instance Id.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

AgReplica