Share via

az sql stg

  • Preview

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

Manage Server Trust Groups.

Commands

Name Description Type Status
az sql stg create

Create a Server Trust Group.

 Core Preview
az sql stg delete

Delete a Server Trust Group.

 Core Preview
az sql stg list

Retrieve a list of Server Trust Groups.

 Core Preview
az sql stg show

Retrieve a Server Trust Group.

 Core Preview

az sql stg create

Edit
Preview

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

Create a Server Trust Group.

az sql stg create --group-member
                  --location
                  --name
                  --resource-group
                  --trust-scope
                  [--no-wait]

Examples

Create a Server Trust Group with specified resource ids of its members.

az sql stg create -g resourcegroup -l location -n stg-name --trust-scope GlobalTransactions -m $mi1-id $mi2-id

Required Parameters

--group-member -m

Managed Instance that is to be a member of the group. Specify resource group, subscription id and the name of the instance.

--location -l

The location name of the Server Trust Group.

--name -n

The name of the Server Trust Group.

--resource-group -g

The resource group name.

--trust-scope

The trust scope of the Server Trust Group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az sql stg delete

Edit
Preview

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

Delete a Server Trust Group.

az sql stg delete --location
                  --name
                  --resource-group
                  [--no-wait]
                  [--yes]

Examples

Delete a Server Trust Group.

az sql stg delete -g resourcegroup -l location -n stg-name

Required Parameters

--location -l

The location of the Server Trust Group.

--name -n

The name of the Server Trust Group.

--resource-group -g

The resource group name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az sql stg list

Edit
Preview

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

Retrieve a list of Server Trust Groups.

az sql stg list --resource-group
                [--instance-name]
                [--location]

Examples

Retrieve a list of Server Trust Groups by instance.

az sql stg list -g resourcegroup --instance-name mi1-name

Retrieve a list of Server Trust Groups by location.

az sql stg list -g resourcegroup -l location

Required Parameters

--resource-group -g

The resource group name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--instance-name

Managed Instance name.

Property Value
Parameter group: List By Instance Arguments
--location -l

The location of the Server Trust Group.

Property Value
Parameter group: List By Location Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az sql stg show

Edit
Preview

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

Retrieve a Server Trust Group.

az sql stg show --location
                --name
                --resource-group

Examples

Retrieve a Server Trust Group.

az sql stg show -g resourcegroup -l location -n stg-name

Required Parameters

--location -l

The location of the Server Trust Group.

--name -n

The name of the Server Trust Group.

--resource-group -g

The resource group name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False