Server Azure AD Administrators - List By Server

Service:

SQL Database

API Version:

2021-11-01

サーバー内の Azure Active Directory 管理者の一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/administrators?api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

応答

名前	型	説明
200 OK	AdministratorListResult	Azure Active Directory 管理者の一覧が正常に取得されました。
Other Status Codes		エラー応答: *** 400 InvalidServerAdministratorTypePropertyName - サーバーの Active Directory 管理者の種類を ActiveDirectory にする必要がある 400 InvalidResourceRequestBody - 要求本文のリソースまたはリソースのプロパティが空または無効です。 400 InvalidServerAzureADOnlyAuthenticationParameter - ユーザーが AzureADOnlyAuthentication パラメーターを false に設定しようとしましたが、これは許可されていません。代わりに azureADOnlyAuthentications API を使用してください。 400 InvalidServerAzureADAdminDeleteOperation - AzureADOnlyAuthentication が設定されているときにユーザーがサーバー Azure Active Azure 管理者を削除しようとしましたが、最初に azureADOnlyAuthentications API を使用してください。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

例

Gets a list of Azure Active Directory administrator.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/administrators?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for ServerAzureADAdministrators ListByServer. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/AdministratorList.json
     */
    /**
     * Sample code: Gets a list of Azure Active Directory administrator.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getsAListOfAzureActiveDirectoryAdministrator(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAzureADAdministrators().listByServer("sqlcrudtest-4799",
            "sqlcrudtest-6440", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/administrators/ActiveDirectory",
      "name": "ActiveDirectory",
      "type": "Microsoft.Sql/servers/administrators",
      "properties": {
        "administratorType": "ActiveDirectory",
        "login": "bob@contoso.com",
        "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        "azureADOnlyAuthentication": true
      }
    }
  ]
}

定義

名前	説明
AdministratorListResult	Active Directory 管理者の一覧。
AdministratorType	切断管理者の種類。
ServerAzureADAdministrator	Azure Active Directory 管理者。

AdministratorListResult

Active Directory 管理者の一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	ServerAzureADAdministrator[]	結果の配列。

AdministratorType

切断管理者の種類。

名前	型	説明
ActiveDirectory	string

ServerAzureADAdministrator

Azure Active Directory 管理者。

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.administratorType	AdministratorType	切断管理者の種類。
properties.azureADOnlyAuthentication	boolean	Azure Active Directory のみ認証が有効になっています。
properties.login	string	サーバー管理者のログイン名。
properties.sid	string	サーバー管理者の SID (オブジェクト ID)。
properties.tenantId	string	管理者のテナント ID。
type	string	リソースの種類。