az sql vm group
Manage SQL virtual machine groups.
Commands
Name | Description | Type | Status |
---|---|---|---|
az sql vm group ag-listener |
Manage SQL availability group listeners. |
Core | GA |
az sql vm group ag-listener create |
Creates an availability group listener. |
Core | GA |
az sql vm group ag-listener delete |
Deletes an availability group listener. |
Core | GA |
az sql vm group ag-listener list |
Lists all availability group listeners in a SQL virtual machine group. |
Core | GA |
az sql vm group ag-listener show |
Gets an availability group listener. |
Core | GA |
az sql vm group ag-listener update |
Updates an availability group listener. |
Core | GA |
az sql vm group create |
Creates a SQL virtual machine group. |
Core | GA |
az sql vm group delete |
Deletes a SQL virtual machine group. |
Core | GA |
az sql vm group list |
Lists all SQL virtual machine groups in a resource group or subscription. |
Core | GA |
az sql vm group show |
Gets a SQL virtual machine group. |
Core | GA |
az sql vm group update |
Updates a SQL virtual machine group if there are not SQL virtual machines attached to the group. |
Core | GA |
az sql vm group create
Creates a SQL virtual machine group.
az sql vm group create --domain-fqdn
--image-offer
--image-sku {Developer, Enterprise}
--name
--operator-acc
--resource-group
--service-acc
--storage-account
[--bootstrap-acc]
[--cluster-subnet-type {MultiSubnet, SingleSubnet}]
[--fsw-path]
[--location]
[--ou-path]
[--sa-key]
[--tags]
Examples
Create a SQL virtual machine group for SQL2016-WS2016 Enterprise virtual machines.
az sql vm group create -n sqlvmgroup -l eastus -g myresourcegroup --image-offer SQL2016-WS2016 --image-sku Enterprise --domain-fqdn Domain.com --operator-acc testop --service-acc testservice --sa-key {PublicKey} --storage-account 'https://storacc.blob.core.windows.net/'
Create a SQL virtual machine group for SQL2019-WS2022 Enterprise virtual machines with MultiSubnet.
az sql vm group create -n sqlvmgroup -l eastus -g myresourcegroup --image-offer SQL2019-WS2022 --image-sku Enterprise --cluster-subnet-type MultiSubnet --domain-fqdn Domain.com --operator-acc testop --service-acc testservice --sa-key {PublicKey} --storage-account 'https://storacc.blob.core.windows.net/'
Required Parameters
Fully qualified name of the domain.
SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
SQL image sku.
Name of the SQL virtual machine group.
Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Account name under which SQL service will run on all participating SQL virtual machines in the cluster.
Storage account url of the witness storage account.
Optional Parameters
Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).
Cluster subnet type.
Optional path for fileshare witness.
Location. If not provided, group will be created in the same reosurce group location.You can configure the default location using az configure --defaults location=<location>
.
Organizational Unit path in which the nodes and cluster will be present. Example: OU=WSCluster,DC=testdomain,DC=com.
Primary key of the witness storage account.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az sql vm group delete
Deletes a SQL virtual machine group.
az sql vm group delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the SQL virtual machine group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az sql vm group list
Lists all SQL virtual machine groups in a resource group or subscription.
az sql vm group list [--resource-group]
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az sql vm group show
Gets a SQL virtual machine group.
az sql vm group show [--ids]
[--name]
[--resource-group]
[--subscription]
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the SQL virtual machine group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az sql vm group update
Updates a SQL virtual machine group if there are not SQL virtual machines attached to the group.
az sql vm group update [--add]
[--bootstrap-acc]
[--cluster-subnet-type {MultiSubnet, SingleSubnet}]
[--domain-fqdn]
[--force-string]
[--fsw-path]
[--ids]
[--name]
[--operator-acc]
[--ou-path]
[--remove]
[--resource-group]
[--sa-key]
[--service-acc]
[--set]
[--storage-account]
[--subscription]
[--tags]
Examples
Update an empty SQL virtual machine group operator account.
az sql vm group update -n sqlvmgroup -g myresourcegroup --operator-acc testop
Update an empty SQL virtual machine group storage account and key.
az sql vm group update -n sqlvmgroup -g myresourcegroup --sa-key {PublicKey} --storage-account 'https://newstoracc.blob.core.windows.net/'
Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>
.
Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).
Cluster subnet type.
Fully qualified name of the domain.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Optional path for fileshare witness.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the SQL virtual machine group.
Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.
Organizational Unit path in which the nodes and cluster will be present. Example: OU=WSCluster,DC=testdomain,DC=com.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Primary key of the witness storage account.
Account name under which SQL service will run on all participating SQL virtual machines in the cluster.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Storage account url of the witness storage account.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.