Managed Instance Administrators - Create Or Update

  • リファレンス
Service:
SQL Database
API Version:
2021-11-01

マネージド インスタンス管理者を作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/administrators/ActiveDirectory?api-version=2021-11-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

マネージド インスタンス管理者の SID (オブジェクト ID)。
properties.tenantId

string

マネージド インスタンス管理者のテナント ID。

応答

名前 型 説明
200 OK

ManagedInstanceAdministrator

マネージド インスタンス管理者が正常に更新されました。
201 Created

ManagedInstanceAdministrator

マネージド インスタンス管理者が正常に作成されました。
202 Accepted

同意
Other Status Codes

エラー応答: ***

  • 400 InvalidManagedServerAdministratorType - プロパティで指定された管理者の種類が無効です。

  • 400 InvalidResourceRequestBody - 要求本文のリソースまたはリソースのプロパティが空または無効です。

  • 400 InvalidManagedServerAzureADAdminDeleteOperation - AzureADOnlyAuthentication が設定されているときに、ユーザーがマネージド サーバー Azure Active Azure 管理者を削除しようとしました。最初に azureADOnlyAuthentications API を使用してください。

  • 400 InvalidManagedServerAADOnlyAuthTypePropertyName - Managed Server Azure Active Directory のみの認証の種類を既定にする必要がある

  • 400 InvalidParameterValue - パラメーターに無効な値が指定されました。

  • 400 InvalidLoginName - 指定されたログイン名が無効です。

  • 400 PrincipalNotFoundInTenant - AzureAD Lookup は、この名前の結果を返さなかった。

  • 400 ServerPrincipalHasDuplicateDisplayNameInAad - AzureAD Lookup は、この名前に対して複数の結果を返しました。

  • 400 ManagedInstanceIsBusy - Managed Instanceは別の要求でビジー状態です。

  • 400 InvalidPrincipalType - このプリンシパルの種類は、Windows Azure SQL Database ではサポートされていません。

  • 400 ServerPrincipalCreateLoginBadSyntax - Azure AD 管理者のログインの作成ステートメントを実行するときに構文エラーが発生しました。

  • 400 ServicePrincipalLookupInAadFailed - サービス インフラストラクチャ エラーが原因で AzureAD 参照が失敗しました。

  • 400 TenantNotFoundInActiveDirectory - テナントは Active Directory では使用できません。

  • 400 InvalidUsername - 指定されたユーザー名に無効な文字が含まれています。

  • 400 ManagedInstanceHasNoPermissionsToAccessAad - 実行中のプリンシパルにアクセス許可がない既存のログインまたはログインを含む操作の実行を試みます。

  • 403 ServicePrincipalLookupInAadFailedIdentityForbidden - MSI に AAD の読み取りアクセス許可が付与されていないため、AzureAD 参照に失敗しました。

  • 404 ServerNotInSubscription - 指定されたサブスクリプションに指定されたサーバーが存在しません。

  • 404 ManagedInstanceNotInSubscriptionResourceGroup - 指定されたマネージド インスタンスが、指定されたリソース グループとサブスクリプションに存在しません。

  • 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。

  • 404 OperationIdNotFound - Id を持つ操作が存在しません。

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

  • 409 OperationCancelled - 操作がユーザーによって取り消されました。

  • 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。

  • 409 ServerPrincipalAlreadyExists - 一意でない名前のサーバー プリンシパルの作成を試みます。

  • 409 ServerPrincipalCurrentlyLoggedIn - 自己説明。

  • 409 ServerPrincipalOwnsJobs - アクティブなジョブがある場合にログインの削除を試みます。

  • 409 ServerPrincipalIsGrantorOfPermissions - アクセス許可の付与者であるサーバー プリンシパルの削除を試みます。

  • 409 ServerPrincipalOwnsDatabase - ログインを削除する前に、データベースの所有者を変更します。

  • 409 ServerPrincipalUsedInTriggerOrEventNotification - トリガーまたはイベント通知の実行コンテキストとして使用されるログインの削除を試みます。

  • 409 ServerPrincipalOwnsObjects - オブジェクトを所有するログインの削除を試みます。

  • 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

Sample Request

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

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

Sample Response

Status code:
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"
}
Status code:
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"
}
Status code:
202

Update administrator of managed instance

Sample Request

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

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

Sample Response

Status code:
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"
}
Status code:
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"
}
Status code:
202

定義

名前 説明
AdministratorName
ManagedInstanceAdministrator

マネージド インスタンス管理者Azure SQL。
ManagedInstanceAdministratorType

マネージド インスタンス管理者の種類。

AdministratorName

名前 型 説明
ActiveDirectory

string

ManagedInstanceAdministrator

マネージド インスタンス管理者Azure SQL。

名前 型 説明
id

string

リソースの ID
name

string

リソース名。
properties.administratorType

ManagedInstanceAdministratorType

マネージド インスタンス管理者の種類。
properties.login

string

マネージド インスタンス管理者のログイン名。
properties.sid

string

マネージド インスタンス管理者の SID (オブジェクト ID)。
properties.tenantId

string

マネージド インスタンス管理者のテナント ID。
type

string

リソースの種類。

ManagedInstanceAdministratorType

マネージド インスタンス管理者の種類。

名前 型 説明
ActiveDirectory

string