az sql mi ad-admin

  • Reference

Manage a managed instance's Active Directory administrator.

Commands

Name Description Type Status
az sql mi ad-admin create

Creates a new managed instance Active Directory administrator.

 Core GA
az sql mi ad-admin delete

Deletes an existing managed instance Active Directory Administrator.

 Core GA
az sql mi ad-admin list

Returns a list of managed instance Active Directory Administrators.

 Core GA
az sql mi ad-admin update

Updates an existing managed instance Active Directory administrator.

 Core GA

az sql mi ad-admin create

Edit

Creates a new managed instance Active Directory administrator.

az sql mi ad-admin create --display-name
                          --managed-instance
                          --object-id
                          --resource-group

Required Parameters

--display-name -u

Display name of the Azure AD administrator user or group.

--managed-instance --mi

Name of the Azure SQL Managed Instance.

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

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

Edit

Deletes an existing managed instance Active Directory Administrator.

az sql mi ad-admin delete [--ids]
                          [--managed-instance]
                          [--resource-group]
                          [--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.

--managed-instance --mi

Name of the Azure SQL Managed Instance.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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 mi ad-admin list

Edit

Returns a list of managed instance Active Directory Administrators.

az sql mi ad-admin list [--ids]
                        [--managed-instance]
                        [--resource-group]
                        [--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.

--managed-instance --mi

Name of the Azure SQL Managed Instance.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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 mi ad-admin update

Edit

Updates an existing managed instance Active Directory administrator.

az sql mi ad-admin update --display-name
                          --object-id
                          [--ids]
                          [--managed-instance]
                          [--resource-group]
                          [--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

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

--managed-instance --mi

Name of the Azure SQL Managed Instance.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.