你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Server Azure AD Administrators - Create Or Update

创建或更新现有的 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 (uuid)

服务器管理员的 SID (对象 ID)。

properties.tenantId

string (uuid)

管理员的租户 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"
  }
}

示例响应

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

定义

名称 说明
AdministratorName

服务器 Active Directory 管理员的名称。

AdministratorType

服务器管理员的类型。

ServerAzureADAdministrator

Azure Active Directory 管理员。

AdministratorName

服务器 Active Directory 管理员的名称。

说明
ActiveDirectory

AdministratorType

服务器管理员的类型。

说明
ActiveDirectory

ServerAzureADAdministrator

Azure Active Directory 管理员。

名称 类型 说明
id

string

资源 ID。

name

string

资源名称。

properties.administratorType

AdministratorType

服务器管理员的类型。

properties.azureADOnlyAuthentication

boolean

仅启用 Azure Active Directory 身份验证。

properties.login

string

服务器管理员的登录名。

properties.sid

string (uuid)

服务器管理员的 SID (对象 ID)。

properties.tenantId

string (uuid)

管理员的租户 ID。

type

string

资源类型。