az sql server-arc extension

  • Preview
  • Reference

Note

This reference is part of the arcdata extension for the Azure CLI (version 2.3.1 or higher). The extension will automatically install the first time you run an az sql server-arc extension command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage extension level properties.

Commands

Name Description Type Status
az sql server-arc extension feature-flag

Manage extension level feature flags.

 Extension Preview
az sql server-arc extension feature-flag delete

Delete feature flag.

 Extension Preview
az sql server-arc extension feature-flag set

Set feature flag.

 Extension Preview
az sql server-arc extension feature-flag show

Show feature flag.

 Extension Preview
az sql server-arc extension set

Update common host properties.

 Extension Preview
az sql server-arc extension show

Show host properties.

 Extension Preview

az sql server-arc extension set

Preview

Command group 'sql server-arc extension' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update common host properties.

az sql server-arc extension set --resource-group
                                [--esu-enabled]
                                [--license-type]
                                [--machine-name]
                                [--skip-instances]
                                [--sql-server-arc-name]

Examples

Ex 1 - Updating LicenseType value

az sql server-arc extension set --resource-group MyResourceGroup --machine-name MyArcServerName --license-type LicenseTypeValue

Ex 2 - Updating status of extended security updates

az sql server-arc extension set --resource-group MyResourceGroup --machine-name MyArcServerName --esu-enabled True

Ex 2 - Updating list of excluded sql instances

az sql server-arc extension set --resource-group MyResourceGroup --machine-name MyArcServerName --skip-instances "InstanceName1, InstanceName2"

Required Parameters

--resource-group -g

Name of the resource group where the connected machine is located.

Optional Parameters

--esu-enabled

Status of extended security updates.

--license-type

License type of the arc server.

--machine-name -m

Name of the connected machine.

--skip-instances

Comma separated string of instances that are excluded from arc onboarding operations.

--sql-server-arc-name

Name of the sql server instance.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sql server-arc extension show

Preview

Command group 'sql server-arc extension' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show host properties.

az sql server-arc extension show --resource-group
                                 [--machine-name]
                                 [--sql-server-arc-name]

Examples

Ex 1 - Displaying host level properties

az sql server-arc extension show --resource-group MyResourceGroup --machine-name MyArcServerName

Ex 2 - Displaying host level properties using Arc Sql instance resource name

az sql server-arc extension show --resource-group MyResourceGroup --sql-server-arc-name MyArcSqlInstanceName

Required Parameters

--resource-group -g

Name of the resource group where the connected machine is located.

Optional Parameters

--machine-name -m

Name of the connected machine.

--sql-server-arc-name

Name of the sql server instance.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.