Managed Instance Administrators - Create Or Update

サービス:

SQL Database

API バージョン:

2025-01-01

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

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

URI パラメーター

名前	/	必須	型	説明
administratorName	path	True	AdministratorName
managedInstanceName	path	True	string	マネージド インスタンスの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前の大文字と小文字は区別されません。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
properties.administratorType	True	ManagedInstanceAdministratorType	マネージド インスタンス管理者の種類。
properties.login	True	string	マネージド インスタンス管理者のログイン名。
properties.sid	True	string (uuid)	マネージド インスタンス管理者の SID (オブジェクト ID)。
properties.tenantId		string (uuid)	マネージド インスタンス管理者のテナント ID。

応答

名前	型	説明
200 OK	ManagedInstanceAdministrator	リソース「ManagedInstanceAdministrator」の更新操作が成功しました
201 Created	ManagedInstanceAdministrator	リソース「ManagedInstanceAdministrator」の作成操作は成功しました ヘッダー Location: string Retry-After: integer
202 Accepted		リソース操作が受け入れられます。 ヘッダー Location: string Retry-After: integer
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Create administrator of managed instance

Update administrator of managed instance

Create administrator of managed instance

要求のサンプル

HTTP

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

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

Java

import com.azure.resourcemanager.sql.fluent.models.ManagedInstanceAdministratorInner;
import com.azure.resourcemanager.sql.models.AdministratorName;
import com.azure.resourcemanager.sql.models.ManagedInstanceAdministratorType;
import java.util.UUID;

/**
 * Samples for ManagedInstanceAdministrators CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ManagedInstanceAdministratorCreate.json
     */
    /**
     * Sample code: Create administrator of managed instance.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void createAdministratorOfManagedInstance(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getManagedInstanceAdministrators().createOrUpdate("Default-SQL-SouthEastAsia",
            "managedInstance", AdministratorName.ACTIVE_DIRECTORY,
            new ManagedInstanceAdministratorInner()
                .withAdministratorType(ManagedInstanceAdministratorType.ACTIVE_DIRECTORY).withLogin("bob@contoso.com")
                .withSid(UUID.fromString("44444444-3333-2222-1111-000000000000")).withTenantId(
                    UUID.fromString("55555555-4444-3333-2222-111111111111")),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python managed_instance_administrator_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.managed_instance_administrators.begin_create_or_update(
        resource_group_name="Default-SQL-SouthEastAsia",
        managed_instance_name="managedInstance",
        administrator_name="ActiveDirectory",
        parameters={
            "properties": {
                "administratorType": "ActiveDirectory",
                "login": "bob@contoso.com",
                "sid": "44444444-3333-2222-1111-000000000000",
                "tenantId": "55555555-4444-3333-2222-111111111111",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/ManagedInstanceAdministratorCreate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to creates or updates a managed instance administrator.
 *
 * @summary creates or updates a managed instance administrator.
 * x-ms-original-file: 2025-01-01/ManagedInstanceAdministratorCreate.json
 */
async function createAdministratorOfManagedInstance() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.managedInstanceAdministrators.createOrUpdate(
    "Default-SQL-SouthEastAsia",
    "managedInstance",
    "ActiveDirectory",
    {
      administratorType: "ActiveDirectory",
      login: "bob@contoso.com",
      sid: "44444444-3333-2222-1111-000000000000",
      tenantId: "55555555-4444-3333-2222-111111111111",
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

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/SQL/stable/2025-01-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

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

状態コード:

201

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

状態コード:

202

Update administrator of managed instance

要求のサンプル

HTTP

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

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

Java

import com.azure.resourcemanager.sql.fluent.models.ManagedInstanceAdministratorInner;
import com.azure.resourcemanager.sql.models.AdministratorName;
import com.azure.resourcemanager.sql.models.ManagedInstanceAdministratorType;
import java.util.UUID;

/**
 * Samples for ManagedInstanceAdministrators CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ManagedInstanceAdministratorUpdate.json
     */
    /**
     * Sample code: Update administrator of managed instance.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void updateAdministratorOfManagedInstance(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getManagedInstanceAdministrators().createOrUpdate("Default-SQL-SouthEastAsia",
            "managedInstance", AdministratorName.ACTIVE_DIRECTORY,
            new ManagedInstanceAdministratorInner()
                .withAdministratorType(ManagedInstanceAdministratorType.ACTIVE_DIRECTORY).withLogin("bob@contoso.com")
                .withSid(UUID.fromString("44444444-3333-2222-1111-000000000000")).withTenantId(
                    UUID.fromString("55555555-4444-3333-2222-111111111111")),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python managed_instance_administrator_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.managed_instance_administrators.begin_create_or_update(
        resource_group_name="Default-SQL-SouthEastAsia",
        managed_instance_name="managedInstance",
        administrator_name="ActiveDirectory",
        parameters={
            "properties": {
                "administratorType": "ActiveDirectory",
                "login": "bob@contoso.com",
                "sid": "44444444-3333-2222-1111-000000000000",
                "tenantId": "55555555-4444-3333-2222-111111111111",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/ManagedInstanceAdministratorUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to creates or updates a managed instance administrator.
 *
 * @summary creates or updates a managed instance administrator.
 * x-ms-original-file: 2025-01-01/ManagedInstanceAdministratorUpdate.json
 */
async function updateAdministratorOfManagedInstance() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.managedInstanceAdministrators.createOrUpdate(
    "Default-SQL-SouthEastAsia",
    "managedInstance",
    "ActiveDirectory",
    {
      administratorType: "ActiveDirectory",
      login: "bob@contoso.com",
      sid: "44444444-3333-2222-1111-000000000000",
      tenantId: "55555555-4444-3333-2222-111111111111",
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

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/SQL/stable/2025-01-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

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

状態コード:

201

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

状態コード:

202

定義

名前	説明
AdministratorName
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ManagedInstanceAdministrator	An Azure SQL managed instance administrator.
ManagedInstanceAdministratorType	マネージド インスタンス管理者の種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。

AdministratorName

列挙

値	説明
ActiveDirectory	アクティブディレクトリ

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

ManagedInstanceAdministrator

Object

An Azure SQL managed instance administrator.

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.administratorType	ManagedInstanceAdministratorType	マネージド インスタンス管理者の種類。
properties.login	string	マネージド インスタンス管理者のログイン名。
properties.sid	string (uuid)	マネージド インスタンス管理者の SID (オブジェクト ID)。
properties.tenantId	string (uuid)	マネージド インスタンス管理者のテナント ID。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

ManagedInstanceAdministratorType

列挙

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

値	説明
ActiveDirectory	アクティブディレクトリ

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。