Server Azure AD Administrators - List By Server

服務:

SQL Database

API 版本:

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 參數

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

回應

名稱	類型	Description
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.

範例要求

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

/**
 * 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", 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

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

定義

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

AdministratorListResult

Object

Active Directory 系統管理員的清單。

名稱	類型	Description
nextLink	string	連結以擷取下一頁的結果。
value	ServerAzureADAdministrator[]	結果陣列。

AdministratorType

Enumeration

伺服器管理員的類型。

值	Description
ActiveDirectory

ServerAzureADAdministrator

Object

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	資源類型。