Managed Instances - Get

Service:

SQL Database

API Version:

2021-11-01

Získá spravovanou instanci.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
managedInstanceName	path	True	string	Název spravované instance.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API azure Resource Manager nebo z portálu.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.
$expand	query		string	Podřízené prostředky, které se mají zahrnout do odpovědi.

Odpovědi

Name	Typ	Description
200 OK	ManagedInstance	Zadaná spravovaná instance se úspěšně načetla.
Other Status Codes		Chybové odpovědi: *** 400 MiGeoRestoreWithWrongBackupStorageRedundancy – Geo-Restore není povolen pro spravované instance s redundancí úložiště zálohování LRS/ZRS. 400 UpdatingInstanceAndBackupRedundancy – Redundanci zóny instance a redundanci úložiště zálohování nelze aktualizovat ve stejném požadavku. 400 ProvisioningDisabled – zobrazí chybovou zprávu z operace prostředků authorizer tak, jak je, beze změn. 400 AadOnlyAuthenticationIsEnabled – Je povolené pouze ověřování Azure Active Directory. Obraťte se na správce systému. 400 ManagementServiceFeatureDisabled – Uživatel se pokusil použít funkci, která je zakázaná. 404 SubscriptionNotFound –Požadované předplatné nebylo nalezeno. 404 ServerNotInSubscription – zadaný server v zadaném předplatném neexistuje. 404 ManagedInstanceNotInSubscriptionResourceGroup – Zadaná spravovaná instance v zadané skupině prostředků a předplatném neexistuje. 404 SubscriptionNotFound –Požadované předplatné nebylo nalezeno. 404 ResourceNotFound – požadovaný prostředek nebyl nalezen. 409 ConflictingManagedInstanceOperation – aktuálně probíhá operace pro spravovanou instanci. 409 BackupRedundancyUpdateAndInstanceRedundancyConflict – instance je multi-az, ale úložiště zálohování se aktualizuje ze zónově redundantního na zónově redundantní. 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress – redundanci instance nelze aktualizovat, protože probíhá aktualizace redundance úložiště zálohování. 409 InstanceRedundancyUpdateAndBackupRedundancyConflict – úložiště zálohování není zónově redundantní, ale redundance instance se aktualizuje na zónově redundantní. 409 BackupRedundancyUpdateConflict – Redundanci úložiště zálohování nelze aktualizovat, protože už probíhá aktualizace redundance úložiště zálohování. 409 MiDropFailedOnAuthLocks – Uživatel se pokusil vypustit poslední spravovanou instanci v podsíti, která má u prostředků použitý zámek. 409 MiCreateFailedNonDelegatedSubnet – uživatel se pokusil nasadit spravovanou instanci nebo fond spravovaných instancí v podsíti, která není delegovaná na Microsoft.Sql/managedInstances. 412 InstanceNotReadyForBackupRedundancyUpdate – Nejde aktualizovat redundanci úložiště zálohování, protože instance není připravená. 429 SubscriptionTooManyCreateUpdateRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyCreateUpdateRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky. 429 ConflictingSubscriptionOperation – aktuálně probíhá operace pro předplatné. 503 TooManyRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky. 503 TooManyRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky. 504 RequestTimeout – Žádost o službu překročila povolený časový limit. 504 RequestTimeout – Žádost o službu překročila povolený časový limit.

Příklady

Get managed instance

Get managed instance with $expand=administrators/activedirectory

Get managed instance

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2021-11-01

Java

import com.azure.core.util.Context;

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

{
  "sku": {
    "name": "GP_Gen4",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen4"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.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",
    "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "servicePrincipal": {
      "principalId": "00000011-1111-2222-2222-123456789111",
      "clientId": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "type": "SystemAssigned"
    }
  },
  "location": "japaneast",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

Get managed instance with $expand=administrators/activedirectory

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2021-11-01

Java

import com.azure.core.util.Context;

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

{
  "sku": {
    "name": "GP_Gen4",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen4"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.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",
    "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "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",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

Definice

Name	Description
AdministratorType	Typ správce serveru.
BackupStorageRedundancy	Typ účtu úložiště, který se používá k ukládání záloh pro tuto instanci. Možnosti jsou Místní (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) a GeoZone(GeoZoneRedundantStorage).
IdentityType	Typ identity. Tuto možnost nastavte na SystemAssigned, aby se k prostředku automaticky vytvořil a přiřadil objekt zabezpečení Azure Active Directory.
ManagedInstance	Spravovaná instance Azure SQL.
ManagedInstanceExternalAdministrator	Vlastnosti správce služby Active Directory.
ManagedInstanceLicenseType	Typ licence. Možné hodnoty jsou LicenseIncluded (běžná cena včetně nové licence SQL) a BasePrice (zvýhodněná cena AHB za používání vlastních licencí SQL).
ManagedInstancePecProperty	Připojení privátního koncového bodu ve spravované instanci
ManagedInstancePrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	Typ připojení použitý pro připojení k instanci.
ManagedServerCreateMode	Určuje režim vytváření databáze. Výchozí: Pravidelné vytváření instancí. Obnovení: Vytvoří instanci obnovením sady záloh do konkrétního bodu v čase. Musí být zadány RestorePointInTime a SourceManagedInstanceId.
PrincipalType	Typ objektu zabezpečení správce serveru.
ResourceIdentity	Konfigurace identity Azure Active Directory pro prostředek
ServicePrincipal	Konfigurace instančního objektu spravované instance pro prostředek
ServicePrincipalType	Typ instančního objektu.
Sku	Skladová položka prostředku ARM.
UserIdentity	Konfigurace identity Azure Active Directory pro prostředek

AdministratorType

Typ správce serveru.

Name	Typ	Description
ActiveDirectory	string

BackupStorageRedundancy

Typ účtu úložiště, který se používá k ukládání záloh pro tuto instanci. Možnosti jsou Místní (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) a GeoZone(GeoZoneRedundantStorage).

Name	Typ	Description
Geo	string
GeoZone	string
Local	string
Zone	string

IdentityType

Typ identity. Tuto možnost nastavte na SystemAssigned, aby se k prostředku automaticky vytvořil a přiřadil objekt zabezpečení Azure Active Directory.

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManagedInstance

Spravovaná instance Azure SQL.

Name	Typ	Description
id	string	ID prostředku.
identity	ResourceIdentity	Identita Azure Active Directory spravované instance.
location	string	Umístění prostředku.
name	string	Název prostředku.
properties.administratorLogin	string	Uživatelské jméno správce pro spravovanou instanci Lze zadat pouze v případě, že se spravovaná instance vytváří (a vyžaduje se k vytvoření).
properties.administratorLoginPassword	string	Přihlašovací heslo správce (vyžadované pro vytvoření spravované instance)
properties.administrators	ManagedInstanceExternalAdministrator	Správce azure Active Directory serveru.
properties.collation	string	Kolace spravované instance.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Typ účtu úložiště, který se používá k ukládání záloh pro tuto instanci. Možnosti jsou Místní (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) a GeoZone(GeoZoneRedundantStorage).
properties.dnsZone	string	Zóna DNS, ve které se spravovaná instance nachází.
properties.dnsZonePartner	string	ID prostředku jiné spravované instance, jejíž zónu DNS bude tato spravovaná instance po vytvoření sdílet.
properties.fullyQualifiedDomainName	string	Plně kvalifikovaný název domény spravované instance.
properties.instancePoolId	string	ID fondu instancí, do který tento spravovaný server patří.
properties.keyId	string	Identifikátor URI CMK klíče, který se má použít k šifrování.
properties.licenseType	ManagedInstanceLicenseType	Typ licence. Možné hodnoty jsou LicenseIncluded (běžná cena včetně nové licence SQL) a BasePrice (zvýhodněná cena AHB za používání vlastních licencí SQL).
properties.maintenanceConfigurationId	string	Určuje ID konfigurace údržby, které se má použít pro tuto spravovanou instanci.
properties.managedInstanceCreateMode	ManagedServerCreateMode	Určuje režim vytváření databáze. Výchozí: Pravidelné vytváření instancí. Obnovení: Vytvoří instanci obnovením sady záloh do konkrétního bodu v čase. Musí být zadány RestorePointInTime a SourceManagedInstanceId.
properties.minimalTlsVersion	string	Minimální verze protokolu TLS. Povolené hodnoty: 'None', '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	ID prostředku identity přiřazené uživatelem, které se má použít ve výchozím nastavení.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	Seznam připojení privátních koncových bodů ve spravované instanci
properties.provisioningState	enum: Accepted Canceled Created Creating Deleted Deleting Failed NotSpecified Registering Running Succeeded TimedOut Unknown Unrecognized Updating
properties.proxyOverride	ManagedInstanceProxyOverride	Typ připojení použitý pro připojení k instanci.
properties.publicDataEndpointEnabled	boolean	Určuje, jestli je povolený veřejný datový koncový bod.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Typ účtu úložiště, který se má použít k ukládání záloh pro tuto instanci. Možnosti jsou Místní (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) a GeoZone(GeoZoneRedundantStorage).
properties.restorePointInTime	string	Určuje bod v čase (ISO8601 formát) zdrojové databáze, která se obnoví za účelem vytvoření nové databáze.
properties.servicePrincipal	ServicePrincipal	Instanční objekt spravované instance.
properties.sourceManagedInstanceId	string	Identifikátor prostředku zdrojové spravované instance přidružené k operaci vytvoření této instance.
properties.state	string	Stav spravované instance.
properties.storageSizeInGB	integer	Velikost úložiště v GB. Minimální hodnota: 32. Maximální hodnota: 16384. Jsou povoleny pouze přírůstky o velikosti 32 GB. Maximální hodnota závisí na vybrané řadě hardwaru a počtu virtuálních jader.
properties.subnetId	string	ID prostředku podsítě pro spravovanou instanci
properties.timezoneId	string	ID časového pásma. Povolené hodnoty jsou časová pásma podporovaná systémem Windows. Systém Windows uchovává podrobnosti o podporovaných časových pásmech, včetně ID, v registru v KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\systém Windows NT\CurrentVersion\Time Zones. Tyto hodnoty registru můžete získat prostřednictvím SQL Server dotazem na název SELECT AS timezone_id FROM sys.time_zone_info. Seznam ID můžete také získat spuštěním příkazu [System.TimeZoneInfo]::GetSystemTimeZones() v PowerShellu. Příkladem platného ID časového pásma je "Tichomoří (běžný čas) nebo "W". Evropa (běžný čas).
properties.vCores	integer	Počet virtuálních jader. Povolené hodnoty: 8, 16, 24, 32, 40, 64, 80.
properties.zoneRedundant	boolean	Určuje, jestli je povolený multi-az.
sku	Sku	Skladová položka spravované instance. Povolené hodnoty pro sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
tags	object	Značky prostředků.
type	string	Typ prostředku.

ManagedInstanceExternalAdministrator

Vlastnosti správce služby Active Directory.

Name	Typ	Description
administratorType	AdministratorType	Typ správce serveru.
azureADOnlyAuthentication	boolean	Povoleno pouze ověřování v Azure Active Directory.
login	string	Přihlašovací jméno správce serveru.
principalType	PrincipalType	Typ objektu zabezpečení správce serveru.
sid	string	IDENTIFIKÁTOR SID (ID objektu) správce serveru.
tenantId	string	ID tenanta správce.

ManagedInstanceLicenseType

Typ licence. Možné hodnoty jsou LicenseIncluded (běžná cena včetně nové licence SQL) a BasePrice (zvýhodněná cena AHB za používání vlastních licencí SQL).

Name	Typ	Description
BasePrice	string
LicenseIncluded	string

ManagedInstancePecProperty

Připojení privátního koncového bodu ve spravované instanci

Name	Typ	Description
id	string	ID prostředku.
properties	ManagedInstancePrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu

ManagedInstancePrivateEndpointConnectionProperties

Vlastnosti připojení privátního koncového bodu.

Name	Typ	Description
privateEndpoint	ManagedInstancePrivateEndpointProperty	Privátní koncový bod, ke kterému připojení patří.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	Stav připojení privátního koncového bodu.
provisioningState	string	Stav připojení privátního koncového bodu.

ManagedInstancePrivateEndpointProperty

Name	Typ	Description
id	string	ID prostředku privátního koncového bodu

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name	Typ	Description
actionsRequired	string	Popis připojení služby private link.
description	string	Popis připojení služby private link.
status	string	Stav připojení služby private link.

ManagedInstanceProxyOverride

Typ připojení použitý pro připojení k instanci.

Name	Typ	Description
Default	string
Proxy	string
Redirect	string

ManagedServerCreateMode

Určuje režim vytváření databáze.

Výchozí: Pravidelné vytváření instancí.

Obnovení: Vytvoří instanci obnovením sady záloh do konkrétního bodu v čase. Musí být zadány RestorePointInTime a SourceManagedInstanceId.

Name	Typ	Description
Default	string
PointInTimeRestore	string

PrincipalType

Typ objektu zabezpečení správce serveru.

Name	Typ	Description
Application	string
Group	string
User	string

ResourceIdentity

Konfigurace identity Azure Active Directory pro prostředek

Name	Typ	Description
principalId	string	ID objektu zabezpečení Služby Azure Active Directory.
tenantId	string	ID tenanta Azure Active Directory
type	IdentityType	Typ identity. Tuto možnost nastavte na SystemAssigned, aby se k prostředku automaticky vytvořil a přiřadil objekt zabezpečení Azure Active Directory.
userAssignedIdentities	<string,  UserIdentity>	ID prostředků identit přiřazených uživatelem, které se mají použít

ServicePrincipal

Konfigurace instančního objektu spravované instance pro prostředek

Name	Typ	Description
clientId	string	ID klienta aplikace Azure Active Directory.
principalId	string	ID objektu aplikace Azure Active Directory.
tenantId	string	ID tenanta Azure Active Directory
type	ServicePrincipalType	Typ instančního objektu.

ServicePrincipalType

Typ instančního objektu.

Name	Typ	Description
None	string
SystemAssigned	string

Sku

Skladová položka prostředku ARM.

Name	Typ	Description
capacity	integer	Kapacita konkrétní skladové položky.
family	string	Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete to tady zaznamenat.
name	string	Název skladové položky, obvykle písmeno + číselný kód, např. P3.
size	string	Velikost konkrétní skladové položky
tier	string	Úroveň nebo edice konkrétní skladové položky, například Basic, Premium.

UserIdentity

Konfigurace identity Azure Active Directory pro prostředek

Name	Typ	Description
clientId	string	ID klienta Azure Active Directory.
principalId	string	ID objektu zabezpečení Služby Azure Active Directory.