Managed Instances - List

Odwołanie

Service:: SQL Database

API Version:: 2021-11-01

Pobiera listę wszystkich wystąpień zarządzanych w subskrypcji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.
$expand	query		string	Zasoby podrzędne do uwzględnienia w odpowiedzi.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ManagedInstanceListResult	Pomyślnie pobrano listę wystąpień zarządzanych.
Other Status Codes		Odpowiedzi na błędy: ***

Przykłady

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

Definicje

Nazwa	Opis
AdministratorType	Typ administratora serwera.
BackupStorageRedundancy	Typ konta magazynu używany do przechowywania kopii zapasowych dla tego wystąpienia. Opcje to Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) i GeoZone(GeoZoneRedundantStorage)
IdentityType	Typ tożsamości. Ustaw tę wartość na "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.
ManagedInstance	Wystąpienie zarządzane Azure SQL.
ManagedInstanceExternalAdministrator	Właściwości administratora usługi Active Directory.
ManagedInstanceLicenseType	Typ licencji. Możliwe wartości to "LicenseIncluded" (zwykła cena włącznie z nową licencją SQL) i "BasePrice" (obniżona cena AHB za wprowadzenie własnych licencji SQL).
ManagedInstanceListResult	Lista wystąpień zarządzanych.
ManagedInstancePecProperty	Połączenie prywatnego punktu końcowego w ramach wystąpienia zarządzanego
ManagedInstancePrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	Typ połączenia używany do nawiązywania połączenia z wystąpieniem.
ManagedServerCreateMode	Określa tryb tworzenia bazy danych. Ustawienie domyślne: regularne tworzenie wystąpienia. Przywracanie: tworzy wystąpienie, przywracając zestaw kopii zapasowych do określonego punktu w czasie. Należy określić wartości RestorePointInTime i SourceManagedInstanceId.
PrincipalType	Typ podmiotu zabezpieczeń administratora serwera.
ResourceIdentity	Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.
ServicePrincipal	Konfiguracja jednostki usługi wystąpienia zarządzanego dla zasobu.
ServicePrincipalType	Typ jednostki usługi.
Sku	Jednostka SKU zasobu usługi ARM.
UserIdentity	Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

AdministratorType

Typ administratora serwera.

Nazwa	Typ	Opis
ActiveDirectory	string

BackupStorageRedundancy

Typ konta magazynu używany do przechowywania kopii zapasowych dla tego wystąpienia. Opcje to Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) i GeoZone(GeoZoneRedundantStorage)

Nazwa	Typ	Opis
Geo	string
GeoZone	string
Local	string
Zone	string

IdentityType

Typ tożsamości. Ustaw tę wartość na "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.

Nazwa	Typ	Opis
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManagedInstance

Wystąpienie zarządzane Azure SQL.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
identity	ResourceIdentity	Tożsamość usługi Azure Active Directory wystąpienia zarządzanego.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.administratorLogin	string	Nazwa użytkownika administratora dla wystąpienia zarządzanego. Można określić tylko wtedy, gdy wystąpienie zarządzane jest tworzone (i jest wymagane do utworzenia).
properties.administratorLoginPassword	string	Hasło logowania administratora (wymagane do utworzenia wystąpienia zarządzanego).
properties.administrators	ManagedInstanceExternalAdministrator	Administrator usługi Azure Active Directory serwera.
properties.collation	string	Sortowanie wystąpienia zarządzanego.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Typ konta magazynu używany do przechowywania kopii zapasowych dla tego wystąpienia. Opcje to Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) i GeoZone(GeoZoneRedundantStorage)
properties.dnsZone	string	Strefa DNS, w którą znajduje się wystąpienie zarządzane.
properties.dnsZonePartner	string	Identyfikator zasobu innego wystąpienia zarządzanego, którego strefa DNS będzie współużytkowała to wystąpienie zarządzane po utworzeniu.
properties.fullyQualifiedDomainName	string	W pełni kwalifikowana nazwa domeny wystąpienia zarządzanego.
properties.instancePoolId	string	Identyfikator puli wystąpień, do którego należy ten serwer zarządzany.
properties.keyId	string	Identyfikator URI klucza do użycia na potrzeby szyfrowania.
properties.licenseType	ManagedInstanceLicenseType	Typ licencji. Możliwe wartości to "LicenseIncluded" (zwykła cena włącznie z nową licencją SQL) i "BasePrice" (obniżona cena AHB za wprowadzenie własnych licencji SQL).
properties.maintenanceConfigurationId	string	Określa identyfikator konfiguracji konserwacji, który ma być stosowany do tego wystąpienia zarządzanego.
properties.managedInstanceCreateMode	ManagedServerCreateMode	Określa tryb tworzenia bazy danych. Ustawienie domyślne: regularne tworzenie wystąpienia. Przywracanie: tworzy wystąpienie, przywracając zestaw kopii zapasowych do określonego punktu w czasie. Należy określić wartości RestorePointInTime i SourceManagedInstanceId.
properties.minimalTlsVersion	string	Minimalna wersja protokołu TLS. Dozwolone wartości: "None", "1.0", "1.1", "1.2"
properties.primaryUserAssignedIdentityId	string	Identyfikator zasobu tożsamości przypisanej przez użytkownika domyślnie używany.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	Lista połączeń prywatnego punktu końcowego w wystąpieniu zarządzanym.
properties.provisioningState	enum: Accepted Canceled Created Creating Deleted Deleting Failed NotSpecified Registering Running Succeeded TimedOut Unknown Unrecognized Updating
properties.proxyOverride	ManagedInstanceProxyOverride	Typ połączenia używany do nawiązywania połączenia z wystąpieniem.
properties.publicDataEndpointEnabled	boolean	Określa, czy publiczny punkt końcowy danych jest włączony.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Typ konta magazynu, który ma być używany do przechowywania kopii zapasowych dla tego wystąpienia. Opcje to Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) i GeoZone(GeoZoneRedundantStorage)
properties.restorePointInTime	string	Określa punkt w czasie (format ISO8601) źródłowej bazy danych, która zostanie przywrócona w celu utworzenia nowej bazy danych.
properties.servicePrincipal	ServicePrincipal	Jednostka usługi wystąpienia zarządzanego.
properties.sourceManagedInstanceId	string	Identyfikator zasobu źródłowego wystąpienia zarządzanego skojarzonego z operacją tworzenia tego wystąpienia.
properties.state	string	Stan wystąpienia zarządzanego.
properties.storageSizeInGB	integer	Rozmiar magazynu w GB. Wartość minimalna: 32. Wartość maksymalna: 16384. Dozwolone są tylko przyrosty o rozmiarze 32 GB. Maksymalna wartość zależy od wybranej rodziny sprzętu i liczby rdzeni wirtualnych.
properties.subnetId	string	Identyfikator zasobu podsieci dla wystąpienia zarządzanego.
properties.timezoneId	string	Identyfikator strefy czasowej. Dozwolone wartości to strefy czasowe obsługiwane przez system Windows. System Windows przechowuje szczegółowe informacje na temat obsługiwanych stref czasowych, w tym identyfikatora, w rejestrze w obszarze KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. Te wartości rejestru można uzyskać za pośrednictwem SQL Server, wysyłając zapytanie o nazwę SELECT AS timezone_id FROM sys.time_zone_info. Listę identyfikatorów można również uzyskać, wykonując polecenie [System.TimeZoneInfo]::GetSystemTimeZones() w programie PowerShell. Przykładem prawidłowego identyfikatora strefy czasowej jest "Pacyficzny czas standardowy" lub "W. Europa (czas standardowy).
properties.vCores	integer	Liczba rdzeni wirtualnych. Dozwolone wartości: 8, 16, 24, 32, 40, 64, 80.
properties.zoneRedundant	boolean	Bez względu na to, czy włączono funkcję multi-az.
sku	Sku	Jednostka SKU wystąpienia zarządzanego. Dozwolone wartości sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
tags	object	Tagi zasobów.
type	string	Typ zasobu.

ManagedInstanceExternalAdministrator

Właściwości administratora usługi Active Directory.

Nazwa	Typ	Opis
administratorType	AdministratorType	Typ administratora serwera.
azureADOnlyAuthentication	boolean	Włączono tylko uwierzytelnianie usługi Azure Active Directory.
login	string	Nazwa logowania administratora serwera.
principalType	PrincipalType	Typ podmiotu zabezpieczeń administratora serwera.
sid	string	Identyfikator SID (identyfikator obiektu) administratora serwera.
tenantId	string	Identyfikator dzierżawy administratora.

ManagedInstanceLicenseType

Typ licencji. Możliwe wartości to "LicenseIncluded" (zwykła cena włącznie z nową licencją SQL) i "BasePrice" (obniżona cena AHB za wprowadzenie własnych licencji SQL).

Nazwa	Typ	Opis
BasePrice	string
LicenseIncluded	string

ManagedInstanceListResult

Lista wystąpień zarządzanych.

Nazwa	Typ	Opis
nextLink	string	Link, aby pobrać następną stronę wyników.
value	ManagedInstance[]	Tablica wyników.

ManagedInstancePecProperty

Połączenie prywatnego punktu końcowego w ramach wystąpienia zarządzanego

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
properties	ManagedInstancePrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego

ManagedInstancePrivateEndpointConnectionProperties

Właściwości połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
privateEndpoint	ManagedInstancePrivateEndpointProperty	Prywatny punkt końcowy, do którego należy połączenie.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	Stan połączenia prywatnego punktu końcowego.
provisioningState	string	Stan połączenia prywatnego punktu końcowego.

ManagedInstancePrivateEndpointProperty

Nazwa	Typ	Opis
id	string	Identyfikator zasobu prywatnego punktu końcowego.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Nazwa	Typ	Opis
actionsRequired	string	Opis połączenia usługi private link.
description	string	Opis połączenia usługi private link.
status	string	Stan połączenia usługi private link.

ManagedInstanceProxyOverride

Typ połączenia używany do nawiązywania połączenia z wystąpieniem.

Nazwa	Typ	Opis
Default	string
Proxy	string
Redirect	string

ManagedServerCreateMode

Określa tryb tworzenia bazy danych.

Ustawienie domyślne: regularne tworzenie wystąpienia.

Przywracanie: tworzy wystąpienie, przywracając zestaw kopii zapasowych do określonego punktu w czasie. Należy określić wartości RestorePointInTime i SourceManagedInstanceId.

Nazwa	Typ	Opis
Default	string
PointInTimeRestore	string

PrincipalType

Typ podmiotu zabezpieczeń administratora serwera.

Nazwa	Typ	Opis
Application	string
Group	string
User	string

ResourceIdentity

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory.
tenantId	string	Identyfikator dzierżawy usługi Azure Active Directory.
type	IdentityType	Typ tożsamości. Ustaw tę wartość na wartość "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.
userAssignedIdentities	<string, UserIdentity>	Identyfikatory zasobów tożsamości przypisanych przez użytkownika do użycia

ServicePrincipal

Konfiguracja jednostki usługi wystąpienia zarządzanego dla zasobu.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta aplikacji usługi Azure Active Directory.
principalId	string	Identyfikator obiektu aplikacji usługi Azure Active Directory.
tenantId	string	Identyfikator dzierżawy usługi Azure Active Directory.
type	ServicePrincipalType	Typ jednostki usługi.

ServicePrincipalType

Typ jednostki usługi.

Nazwa	Typ	Opis
None	string
SystemAssigned	string

Sku

Jednostka SKU zasobu usługi ARM.

Nazwa	Typ	Opis
capacity	integer	Pojemność określonej jednostki SKU.
family	string	Jeśli usługa ma różne generacje sprzętu, dla tej samej jednostki SKU, można je przechwycić tutaj.
name	string	Nazwa jednostki SKU, zazwyczaj litera + kod liczbowy, np. P3.
size	string	Rozmiar określonej jednostki SKU
tier	string	Warstwa lub wersja określonej jednostki SKU, np. Podstawowa, Premium.

UserIdentity

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta usługi Azure Active Directory.
principalId	string	Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory.

Managed Instances - List

Parametry identyfikatora URI

Odpowiedzi

Przykłady

List managed instances

Sample Request

Sample Response

List managed instances with $expand=administrators/activedirectory

Sample Request

Sample Response

Definicje

AdministratorType

BackupStorageRedundancy

IdentityType

ManagedInstance

ManagedInstanceExternalAdministrator

ManagedInstanceLicenseType

ManagedInstanceListResult

ManagedInstancePecProperty

ManagedInstancePrivateEndpointConnectionProperties

ManagedInstancePrivateEndpointProperty

ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstanceProxyOverride

ManagedServerCreateMode

PrincipalType

ResourceIdentity

ServicePrincipal

ServicePrincipalType

Sku

UserIdentity

Dodatkowe zasoby