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

Managed Instance Administrators - Create Or Update

服务:: SQL Database

API 版本:: 2023-08-01

创建或更新托管实例管理员。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/administrators/ActiveDirectory?api-version=2023-08-01

URI 参数

名称	在	必需	类型	说明
administratorName	path	True	AdministratorName
managedInstanceName	path	True	string	托管实例的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

请求正文

名称	必需	类型	说明
properties.administratorType	True	ManagedInstanceAdministratorType	托管实例管理员的类型。
properties.login	True	string	托管实例管理员的登录名。
properties.sid	True	string (uuid)	托管实例管理员的 SID （对象 ID）。
properties.tenantId		string (uuid)	托管实例管理员的租户 ID。

响应

名称	类型	说明
200 OK	ManagedInstanceAdministrator	已成功更新托管实例管理员。
201 Created	ManagedInstanceAdministrator	已成功创建托管实例管理员。
202 Accepted		接受标头 Location: string
Other Status Codes	ErrorResponse	错误响应： *** 400 SubnetMissingRequiredDelegation - 未为 SQL 托管实例委托所选子网。 400 InvalidManagedServerAdministratorType - 属性中指定的管理员类型无效。 400 InvalidResourceRequestBody - 请求正文中的资源或资源属性为空或无效。 400 InvalidManagedServerAzureADAdminDeleteOperation - 用户尝试在设置 AzureADOnlyAuthentication 时删除托管服务器 Azure Active Azure 管理员，请先使用 azureADOnlyAuthentications API。 400 InvalidManagedServerAADOnlyAuthTypePropertyName - 托管服务器 Azure Active Directory 仅身份验证类型应为默认值 400 ServerPrincipalCreateLoginBadSyntax - 为 Azure AD 管理员执行创建登录语句时出现语法错误。 400 ManagedInstanceIsBusy - 托管实例正忙于另一个请求。 400 InvalidLoginName - 提供的登录名无效。 400 ServicePrincipalLookupInAadFailedIdentityForbidden - AzureAD 查找失败，因为 MSI 未授予对 AAD 的读取权限。 400 PrincipalNotFoundInTenant - AzureAD Lookup 未返回此名称的结果。 400 ServerPrincipalHasDuplicateDisplayNameInAad - AzureAD Lookup 返回了此名称的多个结果。 400 InvalidPrincipalType - Windows Azure SQL 数据库中不支持此主体类型。 400 InvalidParameterValue - 为参数提供无效值。 400 ServicePrincipalLookupInAadFailed - AzureAD 查找因服务基础结构错误而失败。 400 TenantNotFoundInActiveDirectory - 租户在 Active Directory 中不可用。 400 InvalidUsername - 提供的用户名包含无效字符。 400 ManagedInstanceHasNoPermissionsToAccessAad - 尝试执行作，涉及执行主体没有权限的非现有登录名或登录名。 404 ManagedInstanceNotInSubscriptionResourceGroup - 指定的托管实例在指定的资源组和订阅中不存在。 404 SubscriptionNotFound - 找不到请求的订阅。 404 ServerNotInSubscription - 指定的服务器在指定的订阅上不存在。 404 OperationIdNotFound - ID作不存在。 404 ResourceNotFound - 找不到请求的资源。 409 CannotCancelOperation - 管理作处于无法取消的状态。 409 OperationCancelled -作已被用户取消。 409 OperationInterrupted - 无法完成资源上的作，因为它被同一资源上的另一个作中断。 409 ServerPrincipalOwnsJobs - 尝试在具有活动作业时删除登录名。 409 ServerPrincipalOwnsObjects - 尝试删除拥有对象的登录名。 409 ServerPrincipalIsGrantorOfPermissions - 尝试删除服务器主体，这是权限的授权者。 409 ServerPrincipalOwnsDatabase - 在删除登录名之前更改数据库的所有者。 409 ServerPrincipalCurrentlyLoggedIn - 自我解释。 409 ServerPrincipalAlreadyExists - 尝试创建具有非唯一名称的服务器主体。 409 ServerPrincipalUsedInTriggerOrEventNotification - 尝试删除登录，该登录名用作触发器或事件通知的执行上下文。 429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。 429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。 500 OperationTimedOut -作超时并自动回滚。请重试该作。 500 ActiveDirectoryLookupTimedOut - 目前无法完成该作。请稍后重试。 503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。 503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。 504 RequestTimeout - 服务请求超过了允许的超时。

示例

Create administrator of managed instance

Update administrator of managed instance

Create administrator of managed instance

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory?api-version=2023-08-01

{
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ManagedInstanceAdministratorCreate.json
// this example is just showing the usage of "ManagedInstanceAdministrators_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceAdministratorResource created on azure
// for more information of creating ManagedInstanceAdministratorResource, please refer to the document of ManagedInstanceAdministratorResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string managedInstanceName = "managedInstance";
SqlAdministratorName administratorName = SqlAdministratorName.ActiveDirectory;
ResourceIdentifier managedInstanceAdministratorResourceId = ManagedInstanceAdministratorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, administratorName);
ManagedInstanceAdministratorResource managedInstanceAdministrator = client.GetManagedInstanceAdministratorResource(managedInstanceAdministratorResourceId);

// invoke the operation
ManagedInstanceAdministratorData data = new ManagedInstanceAdministratorData
{
    AdministratorType = ManagedInstanceAdministratorType.ActiveDirectory,
    Login = "bob@contoso.com",
    Sid = Guid.Parse("44444444-3333-2222-1111-000000000000"),
    TenantId = Guid.Parse("55555555-4444-3333-2222-111111111111"),
};
ArmOperation<ManagedInstanceAdministratorResource> lro = await managedInstanceAdministrator.UpdateAsync(WaitUntil.Completed, data);
ManagedInstanceAdministratorResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ManagedInstanceAdministratorData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory",
  "name": "ActiveDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  },
  "type": "Microsoft.Sql/managedInstances/administrators"
}

状态代码:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory",
  "name": "ActiveDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  },
  "type": "Microsoft.Sql/managedInstances/administrators"
}

状态代码:: 202

Update administrator of managed instance

示例请求

HTTP
dotnet

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory?api-version=2023-08-01

{
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ManagedInstanceAdministratorUpdate.json
// this example is just showing the usage of "ManagedInstanceAdministrators_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceAdministratorResource created on azure
// for more information of creating ManagedInstanceAdministratorResource, please refer to the document of ManagedInstanceAdministratorResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string managedInstanceName = "managedInstance";
SqlAdministratorName administratorName = SqlAdministratorName.ActiveDirectory;
ResourceIdentifier managedInstanceAdministratorResourceId = ManagedInstanceAdministratorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, administratorName);
ManagedInstanceAdministratorResource managedInstanceAdministrator = client.GetManagedInstanceAdministratorResource(managedInstanceAdministratorResourceId);

// invoke the operation
ManagedInstanceAdministratorData data = new ManagedInstanceAdministratorData
{
    AdministratorType = ManagedInstanceAdministratorType.ActiveDirectory,
    Login = "bob@contoso.com",
    Sid = Guid.Parse("44444444-3333-2222-1111-000000000000"),
    TenantId = Guid.Parse("55555555-4444-3333-2222-111111111111"),
};
ArmOperation<ManagedInstanceAdministratorResource> lro = await managedInstanceAdministrator.UpdateAsync(WaitUntil.Completed, data);
ManagedInstanceAdministratorResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ManagedInstanceAdministratorData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory",
  "name": "ActiveDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  },
  "type": "Microsoft.Sql/managedInstances/administrators"
}

状态代码:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory",
  "name": "ActiveDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  },
  "type": "Microsoft.Sql/managedInstances/administrators"
}

状态代码:: 202

定义

名称	说明
AdministratorName
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ManagedInstanceAdministrator	Azure SQL 托管实例管理员。
ManagedInstanceAdministratorType	托管实例管理员的类型。

AdministratorName

枚举

值	说明
ActiveDirectory

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ManagedInstanceAdministrator

Object

Azure SQL 托管实例管理员。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.administratorType	ManagedInstanceAdministratorType	托管实例管理员的类型。
properties.login	string	托管实例管理员的登录名。
properties.sid	string (uuid)	托管实例管理员的 SID （对象 ID）。
properties.tenantId	string (uuid)	托管实例管理员的租户 ID。
type	string	资源类型。

ManagedInstanceAdministratorType

枚举

托管实例管理员的类型。

值	说明
ActiveDirectory

通过

Managed Instance Administrators - Create Or Update

URI 参数

请求正文

响应

示例

Create administrator of managed instance

示例请求

示例响应

Update administrator of managed instance

示例请求

示例响应

定义

AdministratorName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedInstanceAdministrator

ManagedInstanceAdministratorType