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 Resource Manager 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 Managed Instance に委任されません。 400 InvalidManagedServerAdministratorType - プロパティで指定された管理者の種類が無効です。 400 InvalidResourceRequestBody - 要求本文のリソースまたはリソースのプロパティが空または無効です。 400 InvalidManagedServerAzureADAdminDeleteOperation - AzureADOnlyAuthentication が設定されているときにマネージドサーバー Azure Active Azure 管理者を削除しようとしましたが、最初に azureADOnlyAuthentications API を使用してください。 400 InvalidManagedServerAADOnlyAuthTypePropertyName - Managed Server Azure Active Directory のみの認証の種類を既定にする必要があります 400 ServerPrincipalCreateLoginBadSyntax - Azure AD 管理者のログインの作成ステートメントを実行するときに構文エラーが発生しました。 400 ManagedInstanceIsBusy - Managed Instance は別の要求でビジー状態です。 400 InvalidLoginName - 指定されたログイン名が無効です。 400 ServicePrincipalLookupInAadFailedIdentityForbidden - MSI に AAD に対する読み取りアクセス許可が付与されていないため、AzureAD Lookup が失敗しました。 400 PrincipalNotFoundInTenant - AzureAD Lookup はこの名前の結果を返しません。 400 ServerPrincipalHasDuplicateDisplayNameInAad - AzureAD Lookup は、この名前に対して複数の結果を返しました。 400 InvalidPrincipalType - このプリンシパルの種類は、Windows Azure SQL Database ではサポートされていません。 400 InvalidParameterValue - パラメーターに無効な値が指定されました。 400 ServicePrincipalLookupInAadFailed - サービスインフラストラクチャエラーが原因で AzureAD Lookup が失敗しました。 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://learn.microsoft.com/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://learn.microsoft.com/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