az sql server ad-admin

Reference

Manage a server's Active Directory administrator.

Commands

Name	Description	Type	Status
az sql server ad-admin create	Create a new server Active Directory administrator.	Core	GA
az sql server ad-admin delete	Sets a server's AD admin.	Core	GA
az sql server ad-admin list	Gets a list of Azure Active Directory administrators in a server.	Core	GA
az sql server ad-admin update	Update an existing server Active Directory administrator.	Core	GA

az sql server ad-admin create

Edit

Create a new server Active Directory administrator.

az sql server ad-admin create --display-name
                              --object-id
                              --resource-group
                              --server

Required Parameters

--display-name -u

Display name of the Azure AD administrator user or group.

--object-id -i

The unique ID of the Azure AD administrator.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server --server-name -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

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 ad-admin delete

Edit

Sets a server's AD admin.

az sql server ad-admin delete [--ids]
                              [--resource-group]
                              [--server]
                              [--subscription]

Optional Parameters

--ids

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.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server --server-name -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

--subscription

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

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 ad-admin list

Edit

Gets a list of Azure Active Directory administrators in a server.

az sql server ad-admin list [--ids]
                            [--resource-group]
                            [--server]
                            [--subscription]

Optional Parameters

--ids

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server --server-name -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

--subscription

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

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 ad-admin update

Edit

Update an existing server Active Directory administrator.

az sql server ad-admin update --display-name
                              --object-id
                              [--add]
                              [--force-string]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--set]
                              [--subscription]

Required Parameters

--display-name -u

Display name of the Azure AD administrator user or group.

--object-id -i

The unique ID of the Azure AD administrator.

Optional Parameters

--add

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>.

Default value: []

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False

--ids

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server --server-name -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []

--subscription

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

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.

Share via

az sql server ad-admin

Commands

az sql server ad-admin create

Required Parameters

az sql server ad-admin delete

Optional Parameters

az sql server ad-admin list

Optional Parameters

az sql server ad-admin update

Required Parameters

Optional Parameters

Additional resources