az sql server ad-admin

Manage a server's Active Directory administrator.

Commands

az sql server ad-admin create

Create a new server Active Directory administrator.

az sql server ad-admin delete

Deletes the Azure Active Directory administrator with the given name.

az sql server ad-admin list

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

az sql server ad-admin update

Update an existing server Active Directory administrator.

az sql server ad-admin create

Create a new server Active Directory administrator.

az sql server ad-admin create --display-name
                              --object-id
                              --resource-group
                              --server
                              [--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.

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

Optional Parameters

--subscription

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

az sql server ad-admin delete

Deletes the Azure Active Directory administrator with the given name.

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.

az sql server ad-admin list

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

az sql server ad-admin list [--ids]
                            [--query-examples]
                            [--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.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

az sql server ad-admin update

Update an existing server Active Directory administrator.

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

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

--display-name -u

Display name of the Azure AD administrator user or group.

--force-string

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

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

--object-id -i

The unique ID of the Azure AD administrator.

--remove

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

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

--subscription

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