Server Azure AD Administrators - List By Server

服務:

SQL Database

API 版本:

2023-08-01

取得伺服器中的 Azure Active Directory 系統管理員清單。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	包含資源的資源群組名稱。 您可以從 Azure Resource Manager 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	ErrorResponse	錯誤回應： *** 400 ManagedInstanceStoppingOrStopped - 實例處於停止/停止狀態時提交的衝突作業 400 ManagedInstanceStarting - 實例處於啟動狀態時提交的衝突作業 400 InvalidServerAdministratorTypePropertyName - 伺服器 Active Directory 系統管理員類型應該是 ActiveDirectory 400 InvalidResourceRequestBody - 要求主體中的資源或資源屬性是空的或無效的。 400 InvalidServerAzureADOnlyAuthenticationParameter - 使用者嘗試將 AzureADOnlyAuthentication 參數設定為不允許的 false，請改用 azureADOnlyAuthentications API。 400 InvalidServerAzureADAdminDeleteOperation - 使用者嘗試在設定 AzureADOnlyAuthentication 時刪除伺服器 Azure Active Azure 系統管理員，請先使用 azureADOnlyAuthentications API。 404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 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=2023-08-01

範例回覆

狀態碼:

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	伺服器管理員的類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ServerAzureADAdministrator	Azure Active Directory 系統管理員。

AdministratorListResult

Object

Active Directory 系統管理員的清單。

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

AdministratorType

列舉型別

伺服器管理員的類型。

值	Description
ActiveDirectory

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

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 (uuid)	伺服器管理員的 SID （物件識別符）。
properties.tenantId	string (uuid)	系統管理員的租用戶標識碼。
type	string	資源類型。