Managed Instance Administrators - Create Or Update

Layanan:

SQL Database

Versi API:

2025-01-01

Membuat atau memperbarui administrator instans terkelola.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
administratorName	path	True	AdministratorName
managedInstanceName	path	True	string	Nama instans terkelola.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties.administratorType	True	ManagedInstanceAdministratorType	Jenis administrator instans terkelola.
properties.login	True	string	Nama masuk administrator instans terkelola.
properties.sid	True	string (uuid)	SID (ID objek) administrator instans terkelola.
properties.tenantId		string (uuid)	ID penyewa administrator instans terkelola.

Respons

Nama	Jenis	Deskripsi
200 OK	ManagedInstanceAdministrator	Operasi pembaruan 'ManagedInstanceAdministrator' sumber daya berhasil
201 Created	ManagedInstanceAdministrator	Operasi pembuatan sumber daya 'ManagedInstanceAdministrator' berhasil Header Location: string Retry-After: integer
202 Accepted		Operasi sumber daya diterima. Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Create administrator of managed instance

Update administrator of managed instance

Create administrator of managed instance

Permintaan sampel

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

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

Respon sampel

Kode status:

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

Kode status:

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

Kode status:

202

Update administrator of managed instance

Permintaan sampel

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

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

Respon sampel

Kode status:

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

Kode status:

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

Kode status:

202

Definisi

Nama	Deskripsi
AdministratorName
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
ManagedInstanceAdministrator	Administrator instans terkelola Azure SQL.
ManagedInstanceAdministratorType	Jenis administrator instans terkelola.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AdministratorName

Enumerasi

Nilai	Deskripsi
ActiveDirectory	Direktori Aktif

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Sasaran kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ManagedInstanceAdministrator

Objek

Administrator instans terkelola Azure SQL.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties.administratorType	ManagedInstanceAdministratorType	Jenis administrator instans terkelola.
properties.login	string	Nama masuk administrator instans terkelola.
properties.sid	string (uuid)	SID (ID objek) administrator instans terkelola.
properties.tenantId	string (uuid)	ID penyewa administrator instans terkelola.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya "Microsoft. Komputasi/virtualMachines" atau "Microsoft. Akun penyimpanan/penyimpanan"

ManagedInstanceAdministratorType

Enumerasi

Jenis administrator instans terkelola.

Nilai	Deskripsi
ActiveDirectory	Direktori Aktif

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.