Share via


Managed Instances - Get

Ruft eine verwaltete Instanz ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
managedInstanceName
path True

string

Der Name der verwalteten Instanz.

resourceGroupName
path True

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

subscriptionId
path True

string

Abonnement-ID für ein Azure-Abonnement.

api-version
query True

string

API-Version, die für die Anforderung verwendet werden soll.

$expand
query

string

Die untergeordneten Ressourcen, die in die Antwort eingeschlossen werden sollen.

Antworten

Name Typ Beschreibung
200 OK

ManagedInstance

Die angegebene verwaltete instance wurde erfolgreich abgerufen.

Other Status Codes

Fehlerantworten: ***

  • 400 MiGeoRestoreWithWrongBackupStorageRedundancy: Geo-Restore ist für verwaltete Instanzen mit LRS/ZRS-Sicherungsspeicherredundanz nicht zulässig.

  • 400 UpdatingInstanceAndBackupRedundancy: Die Redundanz von Instanzzonen und die Sicherungsspeicherredundanz können in derselben Anforderung nicht aktualisiert werden.

  • 400 ProvisioningDisabled: Zeigt die Fehlermeldung des Ressourcenvorgangsautorisierer unverändert ohne Änderungen an.

  • 400 AadOnlyAuthenticationIsEnabled: Die reine Azure Active Directory-Authentifizierung ist aktiviert. Wenden Sie sich an den Systemadministrator.

  • 400 ManagementServiceFeatureDisabled: Der Benutzer hat versucht, ein Feature zu verwenden, das deaktiviert ist.

  • 404 SubscriptionNotFound: Das angeforderte Abonnement wurde nicht gefunden.

  • 404 ServerNotInSubscription: Der angegebene Server ist im angegebenen Abonnement nicht vorhanden.

  • 404 ManagedInstanceNotInSubscriptionResourceGroup: Die angegebene verwaltete instance ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

  • 404 SubscriptionNotFound: Das angeforderte Abonnement wurde nicht gefunden.

  • 404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden.

  • 409 ConflictingManagedInstanceOperation: Für die verwaltete instance wird derzeit ein Vorgang ausgeführt.

  • 409 BackupRedundancyUpdateAndInstanceRedundancyConflict: Die instance ist multi-az, aber der Sicherungsspeicher wird von zonenredundant auf nicht zonenredundant aktualisiert.

  • 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress: Instance Redundanz kann nicht aktualisiert werden, da das Update der Sicherungsspeicherredundanz ausgeführt wird.

  • 409 InstanceRedundancyUpdateAndBackupRedundancyConflict: Der Sicherungsspeicher ist nicht zonenredundant, aber instance Redundanz wird auf zonenredundant aktualisiert.

  • 409 BackupRedundancyUpdateConflict: Die Sicherungsspeicherredundanz kann nicht aktualisiert werden, da bereits ein Update für die Sicherungsspeicherredundanz ausgeführt wird.

  • 409 MiDropFailedOnAuthLocks: Der Benutzer hat versucht, die letzte verwaltete Instanz im Subnetz zu löschen, für das die Sperre auf Ressourcen angewendet wurde.

  • 409 MiCreateFailedNonDelegatedSubnet: Der Benutzer hat versucht, verwaltete Instanz oder verwaltete Instanz Pool im Subnetz bereitzustellen, das nicht an Microsoft.Sql/managedInstances delegiert ist.

  • 412 InstanceNotReadyForBackupRedundancyUpdate: Die Sicherungsspeicherredundanz kann nicht aktualisiert werden, da die instance nicht bereit ist.

  • 429 SubscriptionTooManyCreateUpdateRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

  • 429 SubscriptionTooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

  • 429 SubscriptionTooManyCreateUpdateRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

  • 429 SubscriptionTooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

  • 429 ConflictingSubscriptionOperation: Für das Abonnement wird derzeit ein Vorgang ausgeführt.

  • 503 TooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

  • 503 TooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

  • 504 RequestTimeout: Die Dienstanforderung hat das zulässige Timeout überschritten.

  • 504 RequestTimeout: Die Dienstanforderung hat das zulässige Timeout überschritten.

Beispiele

Get managed instance
Get managed instance with $expand=administrators/activedirectory

Get managed instance

Sample Request

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

Sample Response

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

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

Sample Response

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

Definitionen

Name Beschreibung
AdministratorType

Typ des Serveradministrators.

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese instance verwendet wird. Die Optionen sind Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) und GeoZone(GeoZoneRedundantStorage).

IdentityType

Der Identitätstyp. Legen Sie dies auf "SystemAssigned" fest, um automatisch einen Azure Active Directory-Prinzipal für die Ressource zu erstellen und zuzuweisen.

ManagedInstance

Eine Azure SQL verwaltete instance.

ManagedInstanceExternalAdministrator

Eigenschaften eines Active Directory-Administrators.

ManagedInstanceLicenseType

Der Lizenztyp. Mögliche Werte sind "LicenseIncluded" (regulärer Preis inklusive einer neuen SQL-Lizenz) und "BasePrice" (ermäßigter AHB-Preis für das Mitbringen Eigener SQL-Lizenzen).

ManagedInstancePecProperty

Eine private Endpunktverbindung unter einem verwalteten instance

ManagedInstancePrivateEndpointConnectionProperties

Eigenschaften einer privaten Endpunktverbindung.

ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride

Verbindungstyp, der zum Herstellen einer Verbindung mit dem instance verwendet wird.

ManagedServerCreateMode

Gibt den Modus der Datenbankerstellung an.

Standard: Reguläre instance Erstellung.

Wiederherstellen: Erstellt eine instance, indem eine Reihe von Sicherungen auf einen bestimmten Zeitpunkt wiederhergestellt werden. RestorePointInTime und SourceManagedInstanceId müssen angegeben werden.

PrincipalType

Prinzipaltyp des Serveradministrators.

ResourceIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

ServicePrincipal

Die Dienstprinzipalkonfiguration des verwalteten instance für eine Ressource.

ServicePrincipalType

Dienstprinzipaltyp.

Sku

Eine ARM-Ressourcen-SKU.

UserIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

AdministratorType

Typ des Serveradministrators.

Name Typ Beschreibung
ActiveDirectory

string

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese instance verwendet wird. Die Optionen sind Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) und GeoZone(GeoZoneRedundantStorage).

Name Typ Beschreibung
Geo

string

GeoZone

string

Local

string

Zone

string

IdentityType

Der Identitätstyp. Legen Sie dies auf "SystemAssigned" fest, um automatisch einen Azure Active Directory-Prinzipal für die Ressource zu erstellen und zuzuweisen.

Name Typ Beschreibung
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManagedInstance

Eine Azure SQL verwaltete instance.

Name Typ Beschreibung
id

string

Ressourcen-ID

identity

ResourceIdentity

Die Azure Active Directory-Identität des verwalteten instance.

location

string

Ressourcenspeicherort

name

string

Name der Ressource.

properties.administratorLogin

string

Administratorbenutzername für die verwaltete instance. Kann nur angegeben werden, wenn die verwaltete instance erstellt wird (und für die Erstellung erforderlich ist).

properties.administratorLoginPassword

string

Das Administratoranmeldekennwort (erforderlich für die Erstellung von verwalteten instance).

properties.administrators

ManagedInstanceExternalAdministrator

Der Azure Active Directory-Administrator des Servers.

properties.collation

string

Sortierung der verwalteten instance.

properties.currentBackupStorageRedundancy

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese instance verwendet wird. Die Optionen sind Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) und GeoZone(GeoZoneRedundantStorage).

properties.dnsZone

string

Die Dns-Zone, in der sich die verwaltete instance befindet.

properties.dnsZonePartner

string

Die Ressourcen-ID eines anderen verwalteten instance dessen DNS-Zone von diesem verwalteten instance nach der Erstellung freigegeben wird.

properties.fullyQualifiedDomainName

string

Der vollqualifizierte Domänenname des verwalteten instance.

properties.instancePoolId

string

Die ID des instance Pools, zu dem dieser verwaltete Server gehört.

properties.keyId

string

Ein CMK-URI des Schlüssels, der für die Verschlüsselung verwendet werden soll.

properties.licenseType

ManagedInstanceLicenseType

Der Lizenztyp. Mögliche Werte sind "LicenseIncluded" (regulärer Preis inklusive einer neuen SQL-Lizenz) und "BasePrice" (ermäßigter AHB-Preis für das Mitbringen Eigener SQL-Lizenzen).

properties.maintenanceConfigurationId

string

Gibt die Id der Wartungskonfiguration an, die auf diese verwaltete instance angewendet werden soll.

properties.managedInstanceCreateMode

ManagedServerCreateMode

Gibt den Modus der Datenbankerstellung an.

Standard: Reguläre instance Erstellung.

Wiederherstellen: Erstellt eine instance, indem eine Reihe von Sicherungen auf einen bestimmten Zeitpunkt wiederhergestellt werden. RestorePointInTime und SourceManagedInstanceId müssen angegeben werden.

properties.minimalTlsVersion

string

Minimale TLS-Version. Zulässige Werte: "None", "1.0", "1.1", "1.2"

properties.primaryUserAssignedIdentityId

string

Die Ressourcen-ID einer benutzerseitig zugewiesenen Identität, die standardmäßig verwendet werden soll.

properties.privateEndpointConnections

ManagedInstancePecProperty[]

Liste der Privaten Endpunktverbindungen auf einem verwalteten instance.

properties.provisioningState enum:
  • Accepted
  • Canceled
  • Created
  • Creating
  • Deleted
  • Deleting
  • Failed
  • NotSpecified
  • Registering
  • Running
  • Succeeded
  • TimedOut
  • Unknown
  • Unrecognized
  • Updating
properties.proxyOverride

ManagedInstanceProxyOverride

Verbindungstyp, der zum Herstellen einer Verbindung mit dem instance verwendet wird.

properties.publicDataEndpointEnabled

boolean

Gibt an, ob der öffentliche Datenendpunkt aktiviert ist.

properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese instance verwendet werden soll. Die Optionen sind Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) und GeoZone(GeoZoneRedundantStorage).

properties.restorePointInTime

string

Gibt den Zeitpunkt (ISO8601 Format) der Quelldatenbank an, die zum Erstellen der neuen Datenbank wiederhergestellt wird.

properties.servicePrincipal

ServicePrincipal

Der Dienstprinzipal des verwalteten instance.

properties.sourceManagedInstanceId

string

Der Ressourcenbezeichner der verwalteten quellseitig verwalteten instance, die dem Erstellungsvorgang dieses instance zugeordnet ist.

properties.state

string

Der Status des verwalteten instance.

properties.storageSizeInGB

integer

Speichergröße in GB. Mindestwert: 32. Maximaler Wert: 16384. Nur Inkremente von 32 GB zulässig. Der Maximalwert hängt von der ausgewählten Hardwarefamilie und der Anzahl der virtuellen Kerne ab.

properties.subnetId

string

Subnetzressourcen-ID für die verwaltete instance.

properties.timezoneId

string

ID der Zeitzone. Zulässige Werte sind Zeitzonen, die von Windows unterstützt werden. Windows speichert Details zu unterstützten Zeitzonen, einschließlich der ID, in der Registrierung unter KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. Sie können diese Registrierungswerte über SQL Server abrufen, indem Sie select name AS timezone_id FROM sys.time_zone_info abfragen. Die Liste der IDs kann auch abgerufen werden, indem Sie [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell ausführen. Ein Beispiel für eine gültige Zeitzonen-ID ist "Pacific Standard Time" oder "W. Europa Normalzeit".

properties.vCores

integer

Die Anzahl der virtuellen Kerne. Zulässige Werte: 8, 16, 24, 32, 40, 64, 80.

properties.zoneRedundant

boolean

Gibt an, ob multi-az aktiviert ist.

sku

Sku

Verwaltete instance SKU. Zulässige Werte für sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH

tags

object

Ressourcentags.

type

string

Der Ressourcentyp.

ManagedInstanceExternalAdministrator

Eigenschaften eines Active Directory-Administrators.

Name Typ Beschreibung
administratorType

AdministratorType

Typ des Serveradministrators.

azureADOnlyAuthentication

boolean

Nur Azure Active Directory-Authentifizierung aktiviert.

login

string

Anmeldename des Serveradministrators.

principalType

PrincipalType

Prinzipaltyp des Serveradministrators.

sid

string

SID (Objekt-ID) des Serveradministrators.

tenantId

string

Mandanten-ID des Administrators.

ManagedInstanceLicenseType

Der Lizenztyp. Mögliche Werte sind "LicenseIncluded" (regulärer Preis inklusive einer neuen SQL-Lizenz) und "BasePrice" (ermäßigter AHB-Preis für das Mitbringen Eigener SQL-Lizenzen).

Name Typ Beschreibung
BasePrice

string

LicenseIncluded

string

ManagedInstancePecProperty

Eine private Endpunktverbindung unter einem verwalteten instance

Name Typ Beschreibung
id

string

Ressourcen-ID

properties

ManagedInstancePrivateEndpointConnectionProperties

Verbindungseigenschaften für private Endpunkte

ManagedInstancePrivateEndpointConnectionProperties

Eigenschaften einer privaten Endpunktverbindung.

Name Typ Beschreibung
privateEndpoint

ManagedInstancePrivateEndpointProperty

Privater Endpunkt, zu dem die Verbindung gehört.

privateLinkServiceConnectionState

ManagedInstancePrivateLinkServiceConnectionStateProperty

Verbindungsstatus der Verbindung mit dem privaten Endpunkt.

provisioningState

string

Status der Verbindung mit dem privaten Endpunkt.

ManagedInstancePrivateEndpointProperty

Name Typ Beschreibung
id

string

Ressourcen-ID des privaten Endpunkts.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name Typ Beschreibung
actionsRequired

string

Die Verbindungsbeschreibung des Private Link-Diensts.

description

string

Die Verbindungsbeschreibung des Private Link-Diensts.

status

string

Die Private Link-Dienstverbindung status.

ManagedInstanceProxyOverride

Verbindungstyp, der zum Herstellen einer Verbindung mit dem instance verwendet wird.

Name Typ Beschreibung
Default

string

Proxy

string

Redirect

string

ManagedServerCreateMode

Gibt den Modus der Datenbankerstellung an.

Standard: Reguläre instance Erstellung.

Wiederherstellen: Erstellt eine instance, indem eine Reihe von Sicherungen auf einen bestimmten Zeitpunkt wiederhergestellt werden. RestorePointInTime und SourceManagedInstanceId müssen angegeben werden.

Name Typ Beschreibung
Default

string

PointInTimeRestore

string

PrincipalType

Prinzipaltyp des Serveradministrators.

Name Typ Beschreibung
Application

string

Group

string

User

string

ResourceIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

Name Typ Beschreibung
principalId

string

Die Azure Active Directory-Prinzipal-ID.

tenantId

string

Die Azure Active Directory-Mandanten-ID.

type

IdentityType

Der Identitätstyp. Legen Sie dies auf "SystemAssigned" fest, um automatisch einen Azure Active Directory-Prinzipal für die Ressource zu erstellen und zuzuweisen.

userAssignedIdentities

<string,  UserIdentity>

Die Ressourcen-IDs der vom Benutzer zugewiesenen Identitäten, die verwendet werden sollen

ServicePrincipal

Die Dienstprinzipalkonfiguration des verwalteten instance für eine Ressource.

Name Typ Beschreibung
clientId

string

Die Client-ID der Azure Active Directory-Anwendung.

principalId

string

Die Objekt-ID der Azure Active Directory-Anwendung.

tenantId

string

Die Azure Active Directory-Mandanten-ID.

type

ServicePrincipalType

Dienstprinzipaltyp.

ServicePrincipalType

Dienstprinzipaltyp.

Name Typ Beschreibung
None

string

SystemAssigned

string

Sku

Eine ARM-Ressourcen-SKU.

Name Typ Beschreibung
capacity

integer

Kapazität der jeweiligen SKU.

family

string

Wenn der Dienst über unterschiedliche Hardwaregenerationen für dieselbe SKU verfügt, kann dies hier erfasst werden.

name

string

Der Name der SKU, in der Regel ein Buchstabe + Zahlencode, z. B. P3.

size

string

Größe der jeweiligen SKU

tier

string

Der Tarif oder die Edition der jeweiligen SKU, z. B. Basic, Premium.

UserIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

Name Typ Beschreibung
clientId

string

Die Azure Active Directory-Client-ID.

principalId

string

Die Azure Active Directory-Prinzipal-ID.