Edit

Update-AzSqlVMGroup

  • Reference
Module:
Az.SqlVirtualMachine

Updates SQL virtual machine group.

Syntax

Update-AzSqlVMGroup
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-ClusterBootstrapAccount <String>]
      [-ClusterOperatorAccount <String>]
      [-ClusterSubnetType <ClusterSubnetType>]
      [-DomainFqdn <String>]
      [-FileShareWitnessPath <String>]
      [-OuPath <String>]
      [-SqlServiceAccount <String>]
      [-StorageAccountPrimaryKey <SecureString>]
      [-StorageAccountUrl <String>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzSqlVMGroup
      -InputObject <ISqlVirtualMachineIdentity>
      [-ClusterBootstrapAccount <String>]
      [-ClusterOperatorAccount <String>]
      [-ClusterSubnetType <ClusterSubnetType>]
      [-DomainFqdn <String>]
      [-FileShareWitnessPath <String>]
      [-OuPath <String>]
      [-SqlServiceAccount <String>]
      [-StorageAccountPrimaryKey <SecureString>]
      [-StorageAccountUrl <String>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates SQL virtual machine group.

Examples

Example 1

Update-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01' -ClusterBootstrapAccount 'newbootstrapuser@yourdomain.com' -ClusterOperatorAccount 'newoperatoruser@yourdomain.com' -Tag @{'newkey'='newvalue'}

Location Name           ResourceGroupName
-------- ----           -----------------
eastus   sqlvmgroup01	ResourceGroup01

Example 2

$group = Get-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01'
$group | Update-AzSqlVMGroup -ClusterBootstrapAccount 'newbootstrapuser@yourdomain.com' -ClusterOperatorAccount 'newoperatoruser@yourdomain.com' -Tag @{'newkey'='newvalue'}

Location Name           ResourceGroupName
-------- ----           -----------------
eastus   sqlvmgroup01	ResourceGroup01

Parameters

-AsJob

Run the command as a job

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

-ClusterBootstrapAccount

Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).

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

-ClusterOperatorAccount

Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.

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

-ClusterSubnetType

Cluster subnet type.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DomainFqdn

Fully qualified name of the domain.

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

-FileShareWitnessPath

Optional path for fileshare witness.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

Name of the SQL virtual machine group.

Type:String
Aliases:SqlVirtualMachineGroupName, SqlVMGroupName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

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

-OuPath

Organizational Unit path in which the nodes and cluster will be present.

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

-ResourceGroupName

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

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

-SqlServiceAccount

Account name under which SQL service will run on all participating SQL virtual machines in the cluster.

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

-StorageAccountPrimaryKey

Primary key of the witness storage account.

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

-StorageAccountUrl

Fully qualified ARM resource id of the witness storage account.

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

-SubscriptionId

Subscription ID that identifies an Azure subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Resource tags.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

ISqlVirtualMachineIdentity

Outputs

ISqlVirtualMachineGroup

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <ISqlVirtualMachineIdentity>: Identity Parameter

  • [AvailabilityGroupListenerName <String>]: Name of the availability group listener.
  • [Id <String>]: Resource identity path
  • [ResourceGroupName <String>]: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • [SqlVirtualMachineGroupName <String>]: Name of the SQL virtual machine group.
  • [SqlVirtualMachineName <String>]: Name of the SQL virtual machine.
  • [SubscriptionId <String>]: Subscription ID that identifies an Azure subscription.