Server Azure AD Administrators - Create Or Update

參考

服務:: SQL Database

API 版本:: 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 參數

名稱	位於	必要	類型	Description
administratorName	path	True	AdministratorName	伺服器 Active Directory 管理員的名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。

要求本文

名稱	必要	類型	Description
properties.administratorType	True	AdministratorType	伺服器管理員的類型。
properties.login	True	string	伺服器管理員的登入名稱。
properties.sid	True	string	伺服器管理員) SID (物件識別碼。
properties.tenantId		string	系統管理員的租用戶標識碼。

回應

名稱	類型	Description
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 - 標識符為的作業不存在。 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.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")),
            com.azure.core.util.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

範例回覆

狀態碼:: 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
  }
}

狀態碼:: 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
  }
}

狀態碼:: 202

定義

名稱	Description
AdministratorName	伺服器 Active Directory 管理員的名稱。
AdministratorType	伺服器管理員的類型。
ServerAzureADAdministrator	Azure Active Directory 系統管理員。

AdministratorName

伺服器 Active Directory 管理員的名稱。

名稱	類型	Description
ActiveDirectory	string

AdministratorType

伺服器管理員的類型。

名稱	類型	Description
ActiveDirectory	string

ServerAzureADAdministrator

Azure Active Directory 系統管理員。

名稱	類型	Description
id	string	資源識別碼。
name	string	資源名稱。
properties.administratorType	AdministratorType	伺服器管理員的類型。
properties.azureADOnlyAuthentication	boolean	僅啟用 Azure Active Directory 驗證。
properties.login	string	伺服器管理員的登入名稱。
properties.sid	string	伺服器管理員) SID (物件識別碼。
properties.tenantId	string	系統管理員的租用戶標識碼。
type	string	資源類型。

共用方式為