Server Azure AD Administrators - Create Or Update

リファレンス

Service:: SQL Database

API Version:: 2021-11-01

既存の Azure Active Directory 管理者を作成または更新します。

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

URI パラメーター

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

要求本文

名前	必須	型	説明
properties.administratorType	True	AdministratorType	管理者の種類。
properties.login	True	string	サーバー管理者のログイン名。
properties.sid	True	string	サーバー管理者の SID (オブジェクト ID)。
properties.tenantId		string	管理者のテナント ID。

応答

名前	型	説明
200 OK	ServerAzureADAdministrator	Azure Active Directory 管理者が正常に更新されました。
201 Created	ServerAzureADAdministrator	Azure Active Directory 管理者が正常に作成されました。
202 Accepted		同意
Other Status Codes		エラー応答: *** 400 InvalidServerAdministratorTypePropertyName - サーバーの Active Directory 管理者の種類を ActiveDirectory にする必要がある 400 InvalidResourceRequestBody - 要求本文のリソースまたはリソースのプロパティが空または無効です。 400 InvalidServerAzureADOnlyAuthenticationParameter - ユーザーが AzureADOnlyAuthentication パラメーターを false に設定しようとしましたが、これは許可されていません。代わりに azureADOnlyAuthentications API を使用してください。 400 InvalidServerAzureADAdminDeleteOperation - AzureADOnlyAuthentication が設定されているときに、ユーザーがサーバー Azure Active Azure 管理者を削除しようとしましたが、最初に azureADOnlyAuthentications API を使用してください。 400 ServerAdministratorNameAlreadyExists - ユーザーが外部管理者を設定しようとしましたが、プリンシパル名は 'master' データベースに既に存在します。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 OperationIdNotFound - Id を持つ操作が存在しません。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作をやり直してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

例

Creates or updates an existing Azure Active Directory administrator.

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

{
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerAzureADAdministratorInner;
import com.azure.resourcemanager.sql.models.AdministratorName;
import com.azure.resourcemanager.sql.models.AdministratorType;
import java.util.UUID;

/** Samples for ServerAzureADAdministrators CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/AdministratorCreateOrUpdate.json
     */
    /**
     * Sample code: Creates or updates an existing Azure Active Directory administrator.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createsOrUpdatesAnExistingAzureActiveDirectoryAdministrator(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAzureADAdministrators().createOrUpdate("sqlcrudtest-4799",
            "sqlcrudtest-6440", AdministratorName.ACTIVE_DIRECTORY,
            new ServerAzureADAdministratorInner().withAdministratorType(AdministratorType.ACTIVE_DIRECTORY)
                .withLogin("bob@contoso.com").withSid(UUID.fromString("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"))
                .withTenantId(UUID.fromString("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c")),
            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

{
  "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
  }
}

Status code:: 201

{
  "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
  }
}

Status code:: 202

定義

名前	説明
AdministratorName	サーバー Active Directory 管理者の名前。
AdministratorType	管理者の種類。
ServerAzureADAdministrator	Azure Active Directory 管理者。

AdministratorName

サーバー Active Directory 管理者の名前。

名前	型	説明
ActiveDirectory	string

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	リソースの種類。