Managed Instances - Get

Hämtar en hanterad instans.

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-parametrar

Name In Required Type Description
managedInstanceName
path True
  • string

Namnet på den hanterade instansen.

resourceGroupName
path True
  • string

Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.

subscriptionId
path True
  • string

Det prenumerations-ID som identifierar en Azure-prenumeration.

api-version
query True
  • string

DEN API-version som ska användas för begäran.

$expand
query
  • string

De underordnade resurser som ska ingå i svaret.

Svar

Name Type Description
200 OK

Den angivna hanterade instansen har hämtats.

Other Status Codes

Felsvar: ***

  • 400 MiGeoRestoreWithWrongBackupStorageRedundancy – Geo-Restore tillåts inte för hanterade instanser med redundans för LRS/ZRS-lagring för säkerhetskopiering.

  • 400 UpdatingInstanceAndBackupRedundancy – Redundans för instanszoner och redundans för lagring av säkerhetskopior kan inte uppdateras i samma begäran.

  • 400 ProvisioningDisabled – visar felmeddelandet från resursåtgärden authorizer som den är, utan ändringar

  • 400 AadOnlyAuthenticationIsEnabled – Endast Azure Active Directory-autentisering är aktiverat. Kontakta systemadministratören.

  • 400 ManagementServiceFeatureDisabled – Användaren försökte använda en funktion som är inaktiverad.

  • 404 SubscriptionNotFound – Det gick inte att hitta den begärda prenumerationen.

  • 404 ServerNotInSubscription – Den angivna servern finns inte i den angivna prenumerationen.

  • 404 ManagedInstanceNotInSubscriptionResourceGroup – Den angivna hanterade instansen finns inte i den angivna resursgruppen och prenumerationen.

  • 404 SubscriptionNotFound – Det gick inte att hitta den begärda prenumerationen.

  • 404 ResourceNotFound – Den begärda resursen hittades inte.

  • 409 ConflictingManagedInstanceOperation – en åtgärd pågår för närvarande för den hanterade instansen.

  • 409 BackupRedundancyUpdateAndInstanceRedundancyConflict – Instansen är multi-az men lagringen för säkerhetskopior uppdateras från zonredundant till icke-zonredundant.

  • 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress – Det går inte att uppdatera instansredundans eftersom redundansuppdatering för lagring av säkerhetskopior pågår.

  • 409 InstanceRedundancyUpdateAndBackupRedundancyConflict – Säkerhetskopieringslagringen är icke-zonredundant men instansredundans uppdateras till zonredundant.

  • 409 BackupRedundancyUpdateConflict – Det går inte att uppdatera redundansen för lagring av säkerhetskopior eftersom en redundansuppdatering för säkerhetskopieringslagring redan pågår.

  • 409 MiDropFailedOnAuthLocks – Användaren försökte släppa den senaste hanterade instansen i undernätet som har Lås tillämpat på resurser.

  • 409 MiCreateFailedNonDelegatedSubnet – Användaren försökte distribuera en hanterad instans eller en hanterad instanspool i ett undernät som inte har delegerats till Microsoft.Sql/managedInstances.

  • 412 InstanceNotReadyForBackupRedundancyUpdate – Det går inte att uppdatera redundansen för lagring av säkerhetskopior eftersom instansen inte är klar.

  • 429 SubscriptionTooManyCreateUpdateRequests – begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser.

  • 429 SubscriptionTooManyRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

  • 429 SubscriptionTooManyCreateUpdateRequests – begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser.

  • 429 SubscriptionTooManyRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

  • 429 ConflictingSubscriptionOperation – en åtgärd pågår för närvarande för prenumerationen.

  • 503 TooManyRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

  • 503 TooManyRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

  • 504 RequestTimeout – Tjänstbegäran överskred den tillåtna tidsgränsen.

  • 504 RequestTimeout – Tjänstbegäran överskred den tillåtna tidsgränsen.

Exempel

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

Definitioner

AdministratorType

Typ av serveradministratör.

BackupStorageRedundancy

Den typ av lagringskonto som används för att lagra säkerhetskopior för den här instansen. Alternativen är Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) och GeoZone(GeoZoneRedundantStorage)

IdentityType

Identitetstypen. Ange "SystemAssigned" (SystemAssigned) för att automatiskt skapa och tilldela ett Azure Active Directory-huvudnamn för resursen.

ManagedInstance

En Azure SQL hanterad instans.

ManagedInstanceExternalAdministrator

Egenskaper för en Active Directory-administratör.

ManagedInstanceLicenseType

Licenstypen. Möjliga värden är "LicenseIncluded" (vanligt pris inklusive en ny SQL-licens) och "BasePrice" (rabatterat AHB-pris för att ta med dina egna SQL-licenser).

ManagedInstancePecProperty

En privat slutpunktsanslutning under en hanterad instans

ManagedInstancePrivateEndpointConnectionProperties

Egenskaper för en privat slutpunktsanslutning.

ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride

Anslutningstyp som används för att ansluta till instansen.

ManagedServerCreateMode

Anger läget för att skapa databasen.

Standard: Skapande av vanlig instans.

Återställning: Skapar en instans genom att återställa en uppsättning säkerhetskopior till en viss tidpunkt. RestorePointInTime och SourceManagedInstanceId måste anges.

PrincipalType

Huvudtyp för serveradministratören.

ResourceIdentity

Azure Active Directory-identitetskonfiguration för en resurs.

ServicePrincipal

Den hanterade instansens konfiguration av tjänstens huvudnamn för en resurs.

ServicePrincipalType

Tjänstens huvudnamnstyp.

Sku

En ARM-resurs-SKU.

UserIdentity

Azure Active Directory-identitetskonfiguration för en resurs.

AdministratorType

Typ av serveradministratör.

Name Type Description
ActiveDirectory
  • string

BackupStorageRedundancy

Den typ av lagringskonto som används för att lagra säkerhetskopior för den här instansen. Alternativen är Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) och GeoZone(GeoZoneRedundantStorage)

Name Type Description
Geo
  • string
GeoZone
  • string
Local
  • string
Zone
  • string

IdentityType

Identitetstypen. Ange "SystemAssigned" (SystemAssigned) för att automatiskt skapa och tilldela ett Azure Active Directory-huvudnamn för resursen.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

ManagedInstance

En Azure SQL hanterad instans.

Name Type Description
id
  • string

Resurs-ID.

identity

Azure Active Directory-identiteten för den hanterade instansen.

location
  • string

Resursplats.

name
  • string

Resursnamn.

properties.administratorLogin
  • string

Administratörsanvändarnamn för den hanterade instansen. Kan bara anges när den hanterade instansen skapas (och krävs för att skapa).

properties.administratorLoginPassword
  • string

Administratörens inloggningslösenord (krävs för att skapa en hanterad instans).

properties.administrators

Azure Active Directory-administratören för servern.

properties.collation
  • string

Sortering av den hanterade instansen.

properties.currentBackupStorageRedundancy

Den typ av lagringskonto som används för att lagra säkerhetskopior för den här instansen. Alternativen är Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) och GeoZone(GeoZoneRedundantStorage)

properties.dnsZone
  • string

Dns-zonen som den hanterade instansen finns i.

properties.dnsZonePartner
  • string

Resurs-ID:t för en annan hanterad instans vars DNS-zon den här hanterade instansen kommer att dela när den har skapats.

properties.fullyQualifiedDomainName
  • string

Det fullständigt kvalificerade domännamnet för den hanterade instansen.

properties.instancePoolId
  • string

ID:t för instanspoolen som den hanterade servern tillhör.

properties.keyId
  • string

En CMK-URI för nyckeln som ska användas för kryptering.

properties.licenseType

Licenstypen. Möjliga värden är "LicenseIncluded" (vanligt pris inklusive en ny SQL-licens) och "BasePrice" (rabatterat AHB-pris för att ta med dina egna SQL-licenser).

properties.maintenanceConfigurationId
  • string

Anger underhållskonfigurations-ID som ska tillämpas på den här hanterade instansen.

properties.managedInstanceCreateMode

Anger läget för att skapa databasen.

Standard: Skapande av vanlig instans.

Återställning: Skapar en instans genom att återställa en uppsättning säkerhetskopior till en viss tidpunkt. RestorePointInTime och SourceManagedInstanceId måste anges.

properties.minimalTlsVersion
  • string

Minimal TLS-version. Tillåtna värden: "None", "1.0", "1.1", "1.2"

properties.primaryUserAssignedIdentityId
  • string

Resurs-ID för en användartilldelad identitet som ska användas som standard.

properties.privateEndpointConnections

Lista över privata slutpunktsanslutningar på en hanterad instans.

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

Anslutningstyp som används för att ansluta till instansen.

properties.publicDataEndpointEnabled
  • boolean

Om den offentliga dataslutpunkten är aktiverad eller inte.

properties.requestedBackupStorageRedundancy

Den typ av lagringskonto som ska användas för att lagra säkerhetskopior för den här instansen. Alternativen är Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) och GeoZone(GeoZoneRedundantStorage)

properties.restorePointInTime
  • string

Anger tidpunkten (ISO8601-format) för källdatabasen som ska återställas för att skapa den nya databasen.

properties.servicePrincipal

Den hanterade instansens huvudnamn för tjänsten.

properties.sourceManagedInstanceId
  • string

Resursidentifieraren för den källhanterade instans som är associerad med skapandeåtgärden för den här instansen.

properties.state
  • string

Tillståndet för den hanterade instansen.

properties.storageSizeInGB
  • integer

Lagringsstorlek i GB. Minsta värde: 32. Maxvärde: 16384. Steg på endast 32 GB tillåts. Det maximala värdet beror på den valda maskinvarufamiljen och antalet virtuella kärnor.

properties.subnetId
  • string

Resurs-ID för undernätet för den hanterade instansen.

properties.timezoneId
  • string

ID för tidszonen. Tillåtna värden är tidszoner som stöds av Windows. Windows behåller information om tidszoner som stöds, inklusive ID:t, i registret under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. Du kan hämta dessa registervärden via SQL Server genom att fråga SELECT-namnet AS timezone_id FROM sys.time_zone_info. Du kan också hämta en lista över ID:er genom att köra [System.TimeZoneInfo]::GetSystemTimeZones() i PowerShell. Ett exempel på ett giltigt tidszons-ID är "Pacific Standard Time" eller "W. Europa, standardtid".

properties.vCores
  • integer

Antalet virtuella kärnor. Tillåtna värden: 8, 16, 24, 32, 40, 64, 80.

properties.zoneRedundant
  • boolean

Om multi-az är aktiverat eller inte.

sku

SKU för hanterad instans. Tillåtna värden för sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH

tags
  • object

Resurstaggar.

type
  • string

Resurstyp.

ManagedInstanceExternalAdministrator

Egenskaper för en Active Directory-administratör.

Name Type Description
administratorType

Typ av serveradministratör.

azureADOnlyAuthentication
  • boolean

Endast Azure Active Directory-autentisering aktiverat.

login
  • string

Serveradministratörens inloggningsnamn.

principalType

Huvudtyp för serveradministratören.

sid
  • string

SID (objekt-ID) för serveradministratören.

tenantId
  • string

Administratörens klientorganisations-ID.

ManagedInstanceLicenseType

Licenstypen. Möjliga värden är "LicenseIncluded" (vanligt pris inklusive en ny SQL-licens) och "BasePrice" (rabatterat AHB-pris för att ta med dina egna SQL-licenser).

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

ManagedInstancePecProperty

En privat slutpunktsanslutning under en hanterad instans

Name Type Description
id
  • string

Resurs-ID.

properties

Egenskaper för privat slutpunktsanslutning

ManagedInstancePrivateEndpointConnectionProperties

Egenskaper för en privat slutpunktsanslutning.

Name Type Description
privateEndpoint

Privat slutpunkt som anslutningen tillhör.

privateLinkServiceConnectionState

Anslutningstillstånd för den privata slutpunktsanslutningen.

provisioningState
  • string

Status för den privata slutpunktsanslutningen.

ManagedInstancePrivateEndpointProperty

Name Type Description
id
  • string

Resurs-ID för den privata slutpunkten.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name Type Description
actionsRequired
  • string

Beskrivning av tjänstanslutningen för privat länk.

description
  • string

Beskrivning av tjänstanslutningen för privat länk.

status
  • string

Anslutningsstatus för tjänsten Private Link.

ManagedInstanceProxyOverride

Anslutningstyp som används för att ansluta till instansen.

Name Type Description
Default
  • string
Proxy
  • string
Redirect
  • string

ManagedServerCreateMode

Anger läget för att skapa databasen.

Standard: Skapande av vanlig instans.

Återställning: Skapar en instans genom att återställa en uppsättning säkerhetskopior till en viss tidpunkt. RestorePointInTime och SourceManagedInstanceId måste anges.

Name Type Description
Default
  • string
PointInTimeRestore
  • string

PrincipalType

Huvudtyp för serveradministratören.

Name Type Description
Application
  • string
Group
  • string
User
  • string

ResourceIdentity

Azure Active Directory-identitetskonfiguration för en resurs.

Name Type Description
principalId
  • string

Huvud-ID:t för Azure Active Directory.

tenantId
  • string

Klient-ID:t för Azure Active Directory.

type

Identitetstypen. Ange "SystemAssigned" (SystemAssigned) för att automatiskt skapa och tilldela ett Azure Active Directory-huvudnamn för resursen.

userAssignedIdentities

Resurs-ID:n för de användartilldelade identiteter som ska användas

ServicePrincipal

Den hanterade instansens konfiguration av tjänstens huvudnamn för en resurs.

Name Type Description
clientId
  • string

Klient-ID för Azure Active Directory-program.

principalId
  • string

Objekt-ID för Azure Active Directory-program.

tenantId
  • string

Klient-ID:t för Azure Active Directory.

type

Tjänstens huvudnamnstyp.

ServicePrincipalType

Tjänstens huvudnamnstyp.

Name Type Description
None
  • string
SystemAssigned
  • string

Sku

En ARM-resurs-SKU.

Name Type Description
capacity
  • integer

Kapacitet för den specifika SKU:n.

family
  • string

Om tjänsten har olika generationer av maskinvara, för samma SKU, kan den samlas in här.

name
  • string

Namnet på SKU:n, vanligtvis en bokstav + nummerkod, t.ex. P3.

size
  • string

Storleken på den specifika SKU:n

tier
  • string

Nivån eller utgåvan av den specifika SKU:n, t.ex. Basic, Premium.

UserIdentity

Azure Active Directory-identitetskonfiguration för en resurs.

Name Type Description
clientId
  • string

Azure Active Directory-klient-ID: t.

principalId
  • string

Huvud-ID:t för Azure Active Directory.