Managed Instances - List

Referensi

Service:: SQL Database

API Version:: 2021-11-01

Mendapatkan daftar semua instans terkelola dalam langganan.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/managedInstances?api-version=2021-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/managedInstances?$expand={$expand}&api-version=2021-11-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang digunakan untuk permintaan.
$expand	query		string	Sumber daya anak yang akan disertakan dalam respons.

Respons

Nama	Jenis	Deskripsi
200 OK	ManagedInstanceListResult	Berhasil mengambil daftar instans terkelola.
Other Status Codes		Respons Kesalahan: ***

Contoh

List managed instances

List managed instances with $expand=administrators/activedirectory

List managed instances

GET https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Sql/managedInstances?api-version=2021-11-01


import com.azure.core.util.Context;

/** Samples for ManagedInstances List. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceList.json
     */
    /**
     * Sample code: List managed instances.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedInstances(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().list(null, 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

Sample Response

Status code:: 200

{
  "value": [
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance1",
      "name": "testinstance1",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "GP_Gen4",
        "tier": "GeneralPurpose",
        "capacity": 8,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance1.1b4e2caff2530.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 8,
        "storageSizeInGB": 1024,
        "licenseType": "LicenseIncluded",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "1b4e2caff2530",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo"
      }
    },
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance2",
      "name": "testinstance2",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "BC_Gen5",
        "tier": "BusinessCritical",
        "capacity": 16,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance2.2c3d1bdae3412.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 16,
        "storageSizeInGB": 1024,
        "licenseType": "Full",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "2c3d1bdae3412",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo"
      }
    }
  ]
}

List managed instances with $expand=administrators/activedirectory

Sample Request

HTTP
Java

GET https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Sql/managedInstances?api-version=2021-11-01


import com.azure.core.util.Context;

/** Samples for ManagedInstances List. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceListWithExpandEqualsAdministrators.json
     */
    /**
     * Sample code: List managed instances with $expand=administrators/activedirectory.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedInstancesWithExpandAdministratorsActivedirectory(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().list(null, 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

Sample Response

Status code:: 200

{
  "value": [
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance1",
      "name": "testinstance1",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "GP_Gen4",
        "tier": "GeneralPurpose",
        "capacity": 8,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance1.1b4e2caff2530.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 8,
        "storageSizeInGB": 1024,
        "licenseType": "LicenseIncluded",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "1b4e2caff2530",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo",
        "administrators": {
          "principalType": "User",
          "login": "bob@contoso.com",
          "sid": "00000011-1111-2222-2222-123456789111",
          "tenantId": "00000011-1111-2222-2222-123456789111",
          "azureADOnlyAuthentication": true
        }
      }
    },
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance2",
      "name": "testinstance2",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "BC_Gen5",
        "tier": "BusinessCritical",
        "capacity": 16,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance2.2c3d1bdae3412.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 16,
        "storageSizeInGB": 1024,
        "licenseType": "Full",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "2c3d1bdae3412",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_2",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo",
        "administrators": {
          "principalType": "User",
          "login": "bob@contoso.com",
          "sid": "00000011-1111-2222-2222-123456789111",
          "tenantId": "00000011-1111-2222-2222-123456789111",
          "azureADOnlyAuthentication": true
        }
      }
    }
  ]
}

Definisi

Nama	Deskripsi
AdministratorType	Jenis administrator server.
BackupStorageRedundancy	Jenis akun penyimpanan yang digunakan untuk menyimpan cadangan untuk instans ini. Opsinya adalah Lokal (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) dan GeoZone(GeoZoneRedundantStorage)
IdentityType	Jenis identitas. Atur ini ke 'SystemAssigned' untuk membuat dan menetapkan prinsipal Azure Active Directory secara otomatis untuk sumber daya.
ManagedInstance	Instans terkelola Azure SQL.
ManagedInstanceExternalAdministrator	Properti administrator direktori aktif.
ManagedInstanceLicenseType	Jenis lisensi. Nilai yang mungkin adalah 'LicenseIncluded' (harga reguler termasuk lisensi SQL baru) dan 'BasePrice' (diskon harga AHB untuk membawa lisensi SQL Anda sendiri).
ManagedInstanceListResult	Daftar instans terkelola.
ManagedInstancePecProperty	Koneksi titik akhir privat di bawah instans terkelola
ManagedInstancePrivateEndpointConnectionProperties	Properti koneksi titik akhir privat.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	Jenis koneksi yang digunakan untuk menyambungkan ke instans.
ManagedServerCreateMode	Menentukan mode pembuatan database. Default: Pembuatan instans reguler. Pemulihan: Membuat instans dengan memulihkan sekumpulan cadangan ke titik waktu tertentu. RestorePointInTime dan SourceManagedInstanceId harus ditentukan.
PrincipalType	Jenis Utama administrator server.
ResourceIdentity	Konfigurasi identitas Azure Active Directory untuk sumber daya.
ServicePrincipal	Konfigurasi perwakilan layanan instans terkelola untuk sumber daya.
ServicePrincipalType	Jenis perwakilan layanan.
Sku	SKU Sumber Daya ARM.
UserIdentity	Konfigurasi identitas Azure Active Directory untuk sumber daya.

AdministratorType

Jenis administrator server.

Nama	Jenis	Deskripsi
ActiveDirectory	string

BackupStorageRedundancy

Jenis akun penyimpanan yang digunakan untuk menyimpan cadangan untuk instans ini. Opsinya adalah Lokal (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) dan GeoZone(GeoZoneRedundantStorage)

Nama	Jenis	Deskripsi
Geo	string
GeoZone	string
Local	string
Zone	string

IdentityType

Jenis identitas. Atur ini ke 'SystemAssigned' untuk membuat dan menetapkan prinsipal Azure Active Directory secara otomatis untuk sumber daya.

Nama	Jenis	Deskripsi
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManagedInstance

Instans terkelola Azure SQL.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
identity	ResourceIdentity	Identitas Azure Active Directory dari instans terkelola.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.administratorLogin	string	Nama pengguna administrator untuk instans terkelola. Hanya dapat ditentukan ketika instans terkelola sedang dibuat (dan diperlukan untuk pembuatan).
properties.administratorLoginPassword	string	Kata sandi masuk administrator (diperlukan untuk pembuatan instans terkelola).
properties.administrators	ManagedInstanceExternalAdministrator	Administrator Azure Active Directory server.
properties.collation	string	Kolas instans terkelola.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Jenis akun penyimpanan yang digunakan untuk menyimpan cadangan untuk instans ini. Opsinya adalah Lokal (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) dan GeoZone(GeoZoneRedundantStorage)
properties.dnsZone	string	Zona Dns tempat instans terkelola berada.
properties.dnsZonePartner	string	Id sumber daya instans terkelola lain yang zona DNS-nya akan dibagikan instans terkelola ini setelah pembuatan.
properties.fullyQualifiedDomainName	string	Nama domain yang sepenuhnya memenuhi syarat dari instans terkelola.
properties.instancePoolId	string	Id kumpulan instans tempat server terkelola ini berada.
properties.keyId	string	URI CMK kunci yang digunakan untuk enkripsi.
properties.licenseType	ManagedInstanceLicenseType	Jenis lisensi. Nilai yang mungkin adalah 'LicenseIncluded' (harga reguler termasuk lisensi SQL baru) dan 'BasePrice' (diskon harga AHB untuk membawa lisensi SQL Anda sendiri).
properties.maintenanceConfigurationId	string	Menentukan id konfigurasi pemeliharaan untuk diterapkan ke instans terkelola ini.
properties.managedInstanceCreateMode	ManagedServerCreateMode	Menentukan mode pembuatan database. Default: Pembuatan instans reguler. Pemulihan: Membuat instans dengan memulihkan sekumpulan cadangan ke titik waktu tertentu. RestorePointInTime dan SourceManagedInstanceId harus ditentukan.
properties.minimalTlsVersion	string	Versi TLS minimal. Nilai yang diizinkan: 'None', '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	Id sumber daya identitas yang ditetapkan pengguna yang akan digunakan secara default.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	Daftar koneksi titik akhir privat pada instans terkelola.
properties.provisioningState	enum: Accepted Canceled Created Creating Deleted Deleting Failed NotSpecified Registering Running Succeeded TimedOut Unknown Unrecognized Updating
properties.proxyOverride	ManagedInstanceProxyOverride	Jenis koneksi yang digunakan untuk menyambungkan ke instans.
properties.publicDataEndpointEnabled	boolean	Apakah titik akhir data publik diaktifkan atau tidak.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Jenis akun penyimpanan yang akan digunakan untuk menyimpan cadangan untuk instans ini. Opsinya adalah Lokal (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) dan GeoZone(GeoZoneRedundantStorage)
properties.restorePointInTime	string	Menentukan titik waktu (format ISO8601) database sumber yang akan dipulihkan untuk membuat database baru.
properties.servicePrincipal	ServicePrincipal	Perwakilan layanan instans terkelola.
properties.sourceManagedInstanceId	string	Pengidentifikasi sumber daya instans terkelola sumber yang terkait dengan operasi pembuatan instans ini.
properties.state	string	Status instans terkelola.
properties.storageSizeInGB	integer	Ukuran penyimpanan dalam GB. Nilai minimum: 32. Nilai maksimum: 16384. Kenaikan 32 GB hanya diperbolehkan. Nilai maksimum tergantung pada keluarga perangkat keras yang dipilih dan jumlah vCore.
properties.subnetId	string	ID sumber daya subnet untuk instans terkelola.
properties.timezoneId	string	Id zona waktu. Nilai yang diizinkan adalah zona waktu yang didukung oleh Windows. Windows menyimpan detail tentang zona waktu yang didukung, termasuk id, dalam registri di KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. Anda bisa mendapatkan nilai registri tersebut melalui SQL Server dengan mengkueri nama SELECT AS timezone_id FROM sys.time_zone_info. Daftar Id juga dapat diperoleh dengan mengeksekusi [System.TimeZoneInfo]::GetSystemTimeZones() di PowerShell. Contoh id zona waktu yang valid adalah "Waktu Standar Pasifik" atau "W. Waktu Standar Eropa".
properties.vCores	integer	Jumlah vCore. Nilai yang diizinkan: 8, 16, 24, 32, 40, 64, 80.
properties.zoneRedundant	boolean	Apakah multi-az diaktifkan atau tidak.
sku	Sku	SKU instans terkelola. Nilai yang diizinkan untuk sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

ManagedInstanceExternalAdministrator

Properti administrator direktori aktif.

Nama	Jenis	Deskripsi
administratorType	AdministratorType	Jenis administrator sever.
azureADOnlyAuthentication	boolean	Azure Active Directory hanya Autentikasi yang diaktifkan.
login	string	Nama masuk administrator server.
principalType	PrincipalType	Jenis Utama administrator sever.
sid	string	SID (ID objek) administrator server.
tenantId	string	ID penyewa administrator.

ManagedInstanceLicenseType

Jenis lisensi. Nilai yang mungkin adalah 'LicenseIncluded' (harga reguler termasuk lisensi SQL baru) dan 'BasePrice' (diskon harga AHB untuk membawa lisensi SQL Anda sendiri).

Nama	Jenis	Deskripsi
BasePrice	string
LicenseIncluded	string

ManagedInstanceListResult

Daftar instans terkelola.

Nama	Jenis	Deskripsi
nextLink	string	Tautan untuk mengambil halaman hasil berikutnya.
value	ManagedInstance[]	Array hasil.

ManagedInstancePecProperty

Koneksi titik akhir privat di bawah instans terkelola

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
properties	ManagedInstancePrivateEndpointConnectionProperties	Properti koneksi titik akhir privat

ManagedInstancePrivateEndpointConnectionProperties

Properti koneksi titik akhir privat.

Nama	Jenis	Deskripsi
privateEndpoint	ManagedInstancePrivateEndpointProperty	Titik akhir privat tempat koneksi berada.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	Status Koneksi Koneksi Titik Akhir Privat.
provisioningState	string	Status Koneksi Titik Akhir Privat.

ManagedInstancePrivateEndpointProperty

Nama	Jenis	Deskripsi
id	string	Id sumber daya titik akhir privat.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Nama	Jenis	Deskripsi
actionsRequired	string	Deskripsi koneksi layanan tautan privat.
description	string	Deskripsi koneksi layanan tautan privat.
status	string	Status koneksi layanan tautan privat.

ManagedInstanceProxyOverride

Jenis koneksi yang digunakan untuk menyambungkan ke instans.

Nama	Jenis	Deskripsi
Default	string
Proxy	string
Redirect	string

ManagedServerCreateMode

Menentukan mode pembuatan database.

Default: Pembuatan instans reguler.

Pemulihan: Membuat instans dengan memulihkan sekumpulan cadangan ke titik waktu tertentu. RestorePointInTime dan SourceManagedInstanceId harus ditentukan.

Nama	Jenis	Deskripsi
Default	string
PointInTimeRestore	string

PrincipalType

Jenis Utama administrator server.

Nama	Jenis	Deskripsi
Application	string
Group	string
User	string

ResourceIdentity

Konfigurasi identitas Azure Active Directory untuk sumber daya.

Nama	Jenis	Deskripsi
principalId	string	Id utama Azure Active Directory.
tenantId	string	Id penyewa Azure Active Directory.
type	IdentityType	Jenis identitas. Atur ini ke 'SystemAssigned' untuk membuat dan menetapkan prinsipal Azure Active Directory secara otomatis untuk sumber daya.
userAssignedIdentities	<string, UserIdentity>	Id sumber daya dari identitas yang ditetapkan pengguna untuk digunakan

ServicePrincipal

Konfigurasi perwakilan layanan instans terkelola untuk sumber daya.

Nama	Jenis	Deskripsi
clientId	string	Id klien aplikasi Azure Active Directory.
principalId	string	Id objek aplikasi Azure Active Directory.
tenantId	string	Id penyewa Azure Active Directory.
type	ServicePrincipalType	Jenis perwakilan layanan.

ServicePrincipalType

Jenis perwakilan layanan.

Nama	Jenis	Deskripsi
None	string
SystemAssigned	string

Sku

SKU Sumber Daya ARM.

Nama	Jenis	Deskripsi
capacity	integer	Kapasitas SKU tertentu.
family	string	Jika layanan memiliki generasi perangkat keras yang berbeda, untuk SKU yang sama, maka itu dapat ditangkap di sini.
name	string	Nama SKU, biasanya, kode huruf + Angka, misalnya P3.
size	string	Ukuran SKU tertentu
tier	string	Tingkat atau edisi SKU tertentu, misalnya Dasar, Premium.

UserIdentity

Konfigurasi identitas Azure Active Directory untuk sumber daya.

Nama	Jenis	Deskripsi
clientId	string	Id klien Azure Active Directory.
principalId	string	Id utama Azure Active Directory.

Managed Instances - List

Parameter URI

Respons

Contoh

List managed instances

Sample Request

Sample Response

List managed instances with $expand=administrators/activedirectory

Sample Request

Sample Response

Definisi

AdministratorType

BackupStorageRedundancy

IdentityType

ManagedInstance

ManagedInstanceExternalAdministrator

ManagedInstanceLicenseType

ManagedInstanceListResult

ManagedInstancePecProperty

ManagedInstancePrivateEndpointConnectionProperties

ManagedInstancePrivateEndpointProperty

ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstanceProxyOverride

ManagedServerCreateMode

PrincipalType

ResourceIdentity

ServicePrincipal

ServicePrincipalType

Sku

UserIdentity

Sumber Daya Tambahan: