Managed Instances - List

Referencia

Service:: SQL Database

API Version:: 2021-11-01

Lekéri az előfizetésben található összes felügyelt példány listáját.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	Az Azure-előfizetést azonosító előfizetés-azonosító.
api-version	query	True	string	A kéréshez használandó API-verzió.
$expand	query		string	A válaszban szerepeltetni kívánt gyermekerőforrások.

Válaszok

Name	Típus	Description
200 OK	ManagedInstanceListResult	Sikerült lekérni a felügyelt példányok listáját.
Other Status Codes		Hibaválaszok: ***

Példák

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

Definíciók

Name	Description
AdministratorType	A rendszergazda típusa.
BackupStorageRedundancy	A példány biztonsági másolatainak tárolására használt tárfióktípus. A beállítások a következők: Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) és GeoZone(GeoZoneRedundantStorage)
IdentityType	Az identitás típusa. Állítsa ezt "SystemAssigned" értékre, hogy automatikusan létrehozhasson és hozzárendelhessen egy Azure Active Directory-tagot az erőforráshoz.
ManagedInstance	Egy Azure SQL felügyelt példány.
ManagedInstanceExternalAdministrator	Egy Active Directory-rendszergazda tulajdonságai.
ManagedInstanceLicenseType	A licenc típusa. Lehetséges értékek a "LicenseIncluded" (az új SQL-licenceket tartalmazó normál ár) és a "BasePrice" (kedvezményes AHB-ár a saját SQL-licencek létrehozásához).
ManagedInstanceListResult	Felügyelt példányok listája.
ManagedInstancePecProperty	Privát végpontkapcsolat felügyelt példány alatt
ManagedInstancePrivateEndpointConnectionProperties	Privát végponti kapcsolat tulajdonságai.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	A példányhoz való csatlakozáshoz használt kapcsolattípus.
ManagedServerCreateMode	Az adatbázis létrehozásának módját határozza meg. Alapértelmezett: Normál példánylétrehozás. Visszaállítás: Létrehoz egy példányt a biztonsági másolatok adott időpontra történő visszaállításával. Meg kell adni a RestorePointInTime és a SourceManagedInstanceId értéket.
PrincipalType	A rendszergazda egyszerű típusa.
ResourceIdentity	Azure Active Directory-identitáskonfiguráció egy erőforráshoz.
ServicePrincipal	A felügyelt példány szolgáltatásnév-konfigurációja egy erőforráshoz.
ServicePrincipalType	Szolgáltatásnév típusa.
Sku	ARM-erőforrás termékváltozata.
UserIdentity	Azure Active Directory-identitáskonfiguráció egy erőforráshoz.

AdministratorType

A rendszergazda típusa.

Name	Típus	Description
ActiveDirectory	string

BackupStorageRedundancy

A példány biztonsági másolatainak tárolására használt tárfióktípus. A beállítások a következők: Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) és GeoZone(GeoZoneRedundantStorage)

Name	Típus	Description
Geo	string
GeoZone	string
Local	string
Zone	string

IdentityType

Az identitás típusa. Állítsa ezt "SystemAssigned" értékre, hogy automatikusan létrehozhasson és hozzárendelhessen egy Azure Active Directory-tagot az erőforráshoz.

Name	Típus	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManagedInstance

Egy Azure SQL felügyelt példány.

Name	Típus	Description
id	string	Erőforrás-azonosító.
identity	ResourceIdentity	A felügyelt példány Azure Active Directory-identitása.
location	string	Erőforrás helye.
name	string	Erőforrás neve.
properties.administratorLogin	string	A felügyelt példány rendszergazdai felhasználóneve. Csak a felügyelt példány létrehozásakor adható meg (és a létrehozáshoz szükséges).
properties.administratorLoginPassword	string	A rendszergazda bejelentkezési jelszava (a felügyelt példány létrehozásához szükséges).
properties.administrators	ManagedInstanceExternalAdministrator	A kiszolgáló Azure Active Directory-rendszergazdája.
properties.collation	string	A felügyelt példány rendezése.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	A példány biztonsági másolatainak tárolására használt tárfióktípus. A beállítások a következők: Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) és GeoZone(GeoZoneRedundantStorage)
properties.dnsZone	string	A felügyelt példány dns-zónája.
properties.dnsZonePartner	string	Egy másik felügyelt példány erőforrás-azonosítója, amelynek DNS-zónáját a felügyelt példány a létrehozás után megosztja.
properties.fullyQualifiedDomainName	string	A felügyelt példány teljes tartományneve.
properties.instancePoolId	string	Annak a példánykészletnek az azonosítója, amelyhez a felügyelt kiszolgáló tartozik.
properties.keyId	string	A titkosításhoz használandó kulcs CMK URI-ja.
properties.licenseType	ManagedInstanceLicenseType	A licenc típusa. Lehetséges értékek a "LicenseIncluded" (az új SQL-licenceket tartalmazó normál ár) és a "BasePrice" (kedvezményes AHB-ár a saját SQL-licencek létrehozásához).
properties.maintenanceConfigurationId	string	Meghatározza a felügyelt példányra alkalmazandó karbantartási konfiguráció azonosítóját.
properties.managedInstanceCreateMode	ManagedServerCreateMode	Az adatbázis létrehozásának módját határozza meg. Alapértelmezett: Normál példánylétrehozás. Visszaállítás: Létrehoz egy példányt a biztonsági másolatok adott időpontra történő visszaállításával. Meg kell adni a RestorePointInTime és a SourceManagedInstanceId értéket.
properties.minimalTlsVersion	string	Minimális TLS-verzió. Engedélyezett értékek: "Nincs", "1.0", "1.1", "1.2"
properties.primaryUserAssignedIdentityId	string	Egy felhasználó által hozzárendelt identitás erőforrás-azonosítója, amelyet alapértelmezés szerint használni szeretne.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	Felügyelt példány privát végpontkapcsolatainak listája.
properties.provisioningState	enum: Accepted Canceled Created Creating Deleted Deleting Failed NotSpecified Registering Running Succeeded TimedOut Unknown Unrecognized Updating
properties.proxyOverride	ManagedInstanceProxyOverride	A példányhoz való csatlakozáshoz használt kapcsolattípus.
properties.publicDataEndpointEnabled	boolean	Azt jelzi, hogy a nyilvános adatvégpont engedélyezve van-e.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	A példány biztonsági mentéseinek tárolására használt tárfiók típusa. A beállítások a következők: Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) és GeoZone(GeoZoneRedundantStorage)
properties.restorePointInTime	string	Megadja annak a forrásadatbázisnak az időpontját (ISO8601 formátumát), amely az új adatbázis létrehozásához lesz visszaállítva.
properties.servicePrincipal	ServicePrincipal	A felügyelt példány szolgáltatásnév.
properties.sourceManagedInstanceId	string	A példány létrehozási műveletéhez társított felügyelt forráspéldány erőforrás-azonosítója.
properties.state	string	A felügyelt példány állapota.
properties.storageSizeInGB	integer	Tárterület mérete GB-ban. Minimális érték: 32. Maximális érték: 16384. A 32 GB-os növekmények csak engedélyezettek. A maximális érték a kiválasztott hardvercsaládtól és a virtuális magok számától függ.
properties.subnetId	string	A felügyelt példány alhálózati erőforrás-azonosítója.
properties.timezoneId	string	Az időzón azonosítója. Az engedélyezett értékek a Windows által támogatott időzónák. A Windows a KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones területen tárolja a támogatott időzónák adatait, beleértve az azonosítót is. Ezeket a beállításjegyzék-értékeket SQL Server keresztül is lekérheti a SELECT name AS timezone_id FROM sys.time_zone_info lekérdezésével. Az azonosítók listája a [System.TimeZoneInfo]::GetSystemTimeZones() PowerShellben történő végrehajtásával is lekérhető. Az érvényes időzón-azonosítóra példa a "Csendes-óceáni téli idő" vagy a "W". Európai téli idő".
properties.vCores	integer	A virtuális magok száma. Engedélyezett értékek: 8, 16, 24, 32, 40, 64, 80.
properties.zoneRedundant	boolean	Azt jelzi, hogy a multi-az engedélyezve van-e.
sku	Sku	Felügyelt példány termékváltozata. A sku.name engedélyezett értékei: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
tags	object	Erőforráscímkék.
type	string	Erőforrástípus.

ManagedInstanceExternalAdministrator

Egy Active Directory-rendszergazda tulajdonságai.

Name	Típus	Description
administratorType	AdministratorType	A rendszergazda típusa.
azureADOnlyAuthentication	boolean	Csak az Azure Active Directory-hitelesítés engedélyezve van.
login	string	A kiszolgálóadminisztrátor bejelentkezési neve.
principalType	PrincipalType	A rendszergazda egyszerű típusa.
sid	string	A kiszolgálóadminisztrátor SID-azonosítója (objektumazonosítója).
tenantId	string	A rendszergazda bérlőazonosítója.

ManagedInstanceLicenseType

A licenc típusa. Lehetséges értékek a "LicenseIncluded" (az új SQL-licenceket tartalmazó normál ár) és a "BasePrice" (kedvezményes AHB-ár a saját SQL-licencek létrehozásához).

Name	Típus	Description
BasePrice	string
LicenseIncluded	string

ManagedInstanceListResult

Felügyelt példányok listája.

Name	Típus	Description
nextLink	string	Hivatkozás az eredmények következő oldalának lekéréséhez.
value	ManagedInstance[]	Eredmények tömbje.

ManagedInstancePecProperty

Privát végpontkapcsolat felügyelt példány alatt

Name	Típus	Description
id	string	Erőforrás-azonosító.
properties	ManagedInstancePrivateEndpointConnectionProperties	Privát végpont kapcsolati tulajdonságai

ManagedInstancePrivateEndpointConnectionProperties

Privát végponti kapcsolat tulajdonságai.

Name	Típus	Description
privateEndpoint	ManagedInstancePrivateEndpointProperty	Privát végpont, amelyhez a kapcsolat tartozik.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	A privát végponti kapcsolat kapcsolati állapota.
provisioningState	string	A privát végponti kapcsolat állapota.

ManagedInstancePrivateEndpointProperty

Name	Típus	Description
id	string	A privát végpont erőforrás-azonosítója.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name	Típus	Description
actionsRequired	string	A private link szolgáltatás kapcsolatának leírása.
description	string	A private link szolgáltatás kapcsolatának leírása.
status	string	A private link szolgáltatás kapcsolati állapota.

ManagedInstanceProxyOverride

A példányhoz való csatlakozáshoz használt kapcsolattípus.

Name	Típus	Description
Default	string
Proxy	string
Redirect	string

ManagedServerCreateMode

Az adatbázis létrehozásának módját határozza meg.

Alapértelmezett: Normál példánylétrehozás.

Visszaállítás: Létrehoz egy példányt a biztonsági másolatok adott időpontra történő visszaállításával. Meg kell adni a RestorePointInTime és a SourceManagedInstanceId értéket.

Name	Típus	Description
Default	string
PointInTimeRestore	string

PrincipalType

A rendszergazda egyszerű típusa.

Name	Típus	Description
Application	string
Group	string
User	string

ResourceIdentity

Azure Active Directory-identitáskonfiguráció egy erőforráshoz.

Name	Típus	Description
principalId	string	Az Azure Active Directory egyszerű azonosítója.
tenantId	string	Az Azure Active Directory-bérlő azonosítója.
type	IdentityType	Az identitás típusa. Állítsa ezt a "SystemAssigned" értékre, hogy automatikusan létrehozhasson és hozzárendelhessen egy Azure Active Directory-tagot az erőforráshoz.
userAssignedIdentities	<string, UserIdentity>	A felhasználó által hozzárendelt identitások használandó erőforrás-azonosítói

ServicePrincipal

A felügyelt példány szolgáltatásnév-konfigurációja egy erőforráshoz.

Name	Típus	Description
clientId	string	Az Azure Active Directory alkalmazásügyfél-azonosítója.
principalId	string	Az Azure Active Directory alkalmazásobjektum-azonosítója.
tenantId	string	Az Azure Active Directory-bérlő azonosítója.
type	ServicePrincipalType	Szolgáltatásnév típusa.

ServicePrincipalType

Szolgáltatásnév típusa.

Name	Típus	Description
None	string
SystemAssigned	string

Sku

ARM-erőforrás termékváltozata.

Name	Típus	Description
capacity	integer	Az adott termékváltozat kapacitása.
family	string	Ha a szolgáltatás különböző hardvergenerációkkal rendelkezik ugyanahhoz a termékváltozathoz, akkor az itt rögzíthető.
name	string	A termékváltozat neve, általában betű + Szám kód, pl. P3.
size	string	Az adott termékváltozat mérete
tier	string	Az adott termékváltozat (pl. Alapszintű, Prémium) szintje vagy kiadása.

UserIdentity

Azure Active Directory-identitáskonfiguráció egy erőforráshoz.

Name	Típus	Description
clientId	string	Az Azure Active Directory ügyfélazonosítója.
principalId	string	Az Azure Active Directory egyszerű azonosítója.

Managed Instances - List

URI-paraméterek

Válaszok

Példák

List managed instances

Sample Request

Sample Response

List managed instances with $expand=administrators/activedirectory

Sample Request

Sample Response

Definíciók

AdministratorType

BackupStorageRedundancy

IdentityType

ManagedInstance

ManagedInstanceExternalAdministrator

ManagedInstanceLicenseType

ManagedInstanceListResult

ManagedInstancePecProperty

ManagedInstancePrivateEndpointConnectionProperties

ManagedInstancePrivateEndpointProperty

ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstanceProxyOverride

ManagedServerCreateMode

PrincipalType

ResourceIdentity

ServicePrincipal

ServicePrincipalType

Sku

UserIdentity

További források