Managed Instances - List

Service:

SQL Database

API Version:

2021-11-01

Hiermee haalt u een lijst op met alle beheerde exemplaren in het abonnement.

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

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.
$expand	query		string	De onderliggende resources die in het antwoord moeten worden opgenomen.

Antwoorden

Name	Type	Description
200 OK	ManagedInstanceListResult	De lijst met beheerde exemplaren is opgehaald.
Other Status Codes		Foutreacties: ***

Voorbeelden

List managed instances

List managed instances with $expand=administrators/activedirectory

List managed instances

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Sql/managedInstances?api-version=2021-11-01

Java

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

GET https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Sql/managedInstances?api-version=2021-11-01

Java

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

Definities

Name	Description
AdministratorType	Type van de serverbeheerder.
BackupStorageRedundancy	Het opslagaccounttype dat wordt gebruikt voor het opslaan van back-ups voor dit exemplaar. De opties zijn Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) en GeoZone(GeoZoneRedundantStorage)
IdentityType	Het identiteitstype. Stel dit in op SystemAssigned om automatisch een Azure Active Directory-principal voor de resource te maken en toe te wijzen.
ManagedInstance	Een Azure SQL beheerd exemplaar.
ManagedInstanceExternalAdministrator	Eigenschappen van een Active Directory-beheerder.
ManagedInstanceLicenseType	Het licentietype. Mogelijke waarden zijn 'LicenseIncluded' (normale prijs inclusief een nieuwe SQL-licentie) en 'BasePrice' (korting op AHB-prijs voor het meenemen van uw eigen SQL-licenties).
ManagedInstanceListResult	Een lijst met beheerde exemplaren.
ManagedInstancePecProperty	Een privé-eindpuntverbinding onder een beheerd exemplaar
ManagedInstancePrivateEndpointConnectionProperties	Eigenschappen van een privé-eindpuntverbinding.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	Verbindingstype dat wordt gebruikt om verbinding te maken met het exemplaar.
ManagedServerCreateMode	Hiermee geeft u de modus voor het maken van de database op. Standaardinstelling: Het maken van een normaal exemplaar. Herstellen: hiermee maakt u een exemplaar door een set back-ups te herstellen naar een bepaald tijdstip. RestorePointInTime en SourceManagedInstanceId moeten worden opgegeven.
PrincipalType	Principal Type van de serverbeheerder.
ResourceIdentity	Azure Active Directory-identiteitsconfiguratie voor een resource.
ServicePrincipal	De service-principalconfiguratie van het beheerde exemplaar voor een resource.
ServicePrincipalType	Type service-principal.
Sku	Een ARM-resource-SKU.
UserIdentity	Azure Active Directory-identiteitsconfiguratie voor een resource.

AdministratorType

Type van de serverbeheerder.

Name	Type	Description
ActiveDirectory	string

BackupStorageRedundancy

Het opslagaccounttype dat wordt gebruikt voor het opslaan van back-ups voor dit exemplaar. De opties zijn Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) en GeoZone(GeoZoneRedundantStorage)

Name	Type	Description
Geo	string
GeoZone	string
Local	string
Zone	string

IdentityType

Het identiteitstype. Stel dit in op SystemAssigned om automatisch een Azure Active Directory-principal voor de resource te maken en toe te wijzen.

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

ManagedInstance

Een Azure SQL beheerd exemplaar.

Name	Type	Description
id	string	Resource-id.
identity	ResourceIdentity	De Azure Active Directory-identiteit van het beheerde exemplaar.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.administratorLogin	string	Gebruikersnaam van beheerder voor het beheerde exemplaar. Kan alleen worden opgegeven wanneer het beheerde exemplaar wordt gemaakt (en is vereist voor het maken).
properties.administratorLoginPassword	string	Het aanmeldingswachtwoord van de beheerder (vereist voor het maken van een beheerd exemplaar).
properties.administrators	ManagedInstanceExternalAdministrator	De Azure Active Directory-beheerder van de server.
properties.collation	string	Sortering van het beheerde exemplaar.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Het opslagaccounttype dat wordt gebruikt voor het opslaan van back-ups voor dit exemplaar. De opties zijn Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) en GeoZone(GeoZoneRedundantStorage)
properties.dnsZone	string	De DNS-zone waarin het beheerde exemplaar zich bevindt.
properties.dnsZonePartner	string	De resource-id van een ander beheerd exemplaar waarvan de DNS-zone dit beheerde exemplaar deelt na het maken.
properties.fullyQualifiedDomainName	string	De volledig gekwalificeerde domeinnaam van het beheerde exemplaar.
properties.instancePoolId	string	De id van de exemplaargroep waartoe deze beheerde server behoort.
properties.keyId	string	Een CMK-URI van de sleutel die moet worden gebruikt voor versleuteling.
properties.licenseType	ManagedInstanceLicenseType	Het licentietype. Mogelijke waarden zijn 'LicenseIncluded' (normale prijs inclusief een nieuwe SQL-licentie) en 'BasePrice' (korting op AHB-prijs voor het meenemen van uw eigen SQL-licenties).
properties.maintenanceConfigurationId	string	Hiermee geeft u de onderhoudsconfiguratie-id op die moet worden toegepast op dit beheerde exemplaar.
properties.managedInstanceCreateMode	ManagedServerCreateMode	Hiermee geeft u de modus voor het maken van de database op. Standaardinstelling: Het maken van een normaal exemplaar. Herstellen: hiermee maakt u een exemplaar door een set back-ups te herstellen naar een bepaald tijdstip. RestorePointInTime en SourceManagedInstanceId moeten worden opgegeven.
properties.minimalTlsVersion	string	Minimale TLS-versie. Toegestane waarden: 'None', '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	De resource-id van een door de gebruiker toegewezen identiteit die standaard moet worden gebruikt.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	Lijst met privé-eindpuntverbindingen in een beheerd exemplaar.
properties.provisioningState	enum: Accepted Canceled Created Creating Deleted Deleting Failed NotSpecified Registering Running Succeeded TimedOut Unknown Unrecognized Updating
properties.proxyOverride	ManagedInstanceProxyOverride	Verbindingstype dat wordt gebruikt om verbinding te maken met het exemplaar.
properties.publicDataEndpointEnabled	boolean	Of het eindpunt voor openbare gegevens is ingeschakeld.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Het type opslagaccount dat moet worden gebruikt voor het opslaan van back-ups voor dit exemplaar. De opties zijn Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) en GeoZone(GeoZoneRedundantStorage)
properties.restorePointInTime	string	Hiermee geeft u het tijdstip (ISO8601 indeling) op van de brondatabase die wordt hersteld om de nieuwe database te maken.
properties.servicePrincipal	ServicePrincipal	De service-principal van het beheerde exemplaar.
properties.sourceManagedInstanceId	string	De resource-id van het beheerde bronexemplaren die is gekoppeld aan de maakbewerking van dit exemplaar.
properties.state	string	De status van het beheerde exemplaar.
properties.storageSizeInGB	integer	Opslaggrootte in GB. Minimale waarde: 32. Maximale waarde: 16384. Stappen van 32 GB zijn alleen toegestaan. De maximale waarde is afhankelijk van de geselecteerde hardwarefamilie en het aantal vCores.
properties.subnetId	string	Subnetresource-id voor het beheerde exemplaar.
properties.timezoneId	string	Id van de tijdzone. Toegestane waarden zijn tijdzones die worden ondersteund door Windows. Windows bewaart details over ondersteunde tijdzones, waaronder de id, in het register onder KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Tijdzones. U kunt deze registerwaarden ophalen via SQL Server door een query uit te voeren op SELECT-naam AS timezone_id FROM sys.time_zone_info. Een lijst met id's kan ook worden verkregen door [System.TimeZoneInfo]::GetSystemTimeZones() uit te voeren in PowerShell. Een voorbeeld van een geldige tijdzone-id is 'Pacific Standard Time' of 'W. Europa (standaardtijd).
properties.vCores	integer	Het aantal vCores. Toegestane waarden: 8, 16, 24, 32, 40, 64, 80.
properties.zoneRedundant	boolean	Of de multi-az is ingeschakeld of niet.
sku	Sku	Beheerde exemplaar-SKU. Toegestane waarden voor sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
tags	object	Resourcetags.
type	string	Resourcetype.

ManagedInstanceExternalAdministrator

Eigenschappen van een Active Directory-beheerder.

Name	Type	Description
administratorType	AdministratorType	Type van de serverbeheerder.
azureADOnlyAuthentication	boolean	Alleen Azure Active Directory-verificatie ingeschakeld.
login	string	Aanmeldingsnaam van de serverbeheerder.
principalType	PrincipalType	Principal Type van de serverbeheerder.
sid	string	SID (object-id) van de serverbeheerder.
tenantId	string	Tenant-id van de beheerder.

ManagedInstanceLicenseType

Het licentietype. Mogelijke waarden zijn 'LicenseIncluded' (normale prijs inclusief een nieuwe SQL-licentie) en 'BasePrice' (korting op AHB-prijs voor het meenemen van uw eigen SQL-licenties).

Name	Type	Description
BasePrice	string
LicenseIncluded	string

ManagedInstanceListResult

Een lijst met beheerde exemplaren.

Name	Type	Description
nextLink	string	Koppeling om de volgende pagina met resultaten op te halen.
value	ManagedInstance[]	Matrix met resultaten.

ManagedInstancePecProperty

Een privé-eindpuntverbinding onder een beheerd exemplaar

Name	Type	Description
id	string	Resource-id.
properties	ManagedInstancePrivateEndpointConnectionProperties	Eigenschappen van privé-eindpuntverbinding

ManagedInstancePrivateEndpointConnectionProperties

Eigenschappen van een privé-eindpuntverbinding.

Name	Type	Description
privateEndpoint	ManagedInstancePrivateEndpointProperty	Privé-eindpunt waartoe de verbinding behoort.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	Verbindingsstatus van de privé-eindpuntverbinding.
provisioningState	string	Status van de privé-eindpuntverbinding.

ManagedInstancePrivateEndpointProperty

Name	Type	Description
id	string	Resource-id van het privé-eindpunt.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name	Type	Description
actionsRequired	string	De beschrijving van de private link-serviceverbinding.
description	string	De beschrijving van de private link-serviceverbinding.
status	string	De verbindingsstatus van de Private Link-service.

ManagedInstanceProxyOverride

Verbindingstype dat wordt gebruikt om verbinding te maken met het exemplaar.

Name	Type	Description
Default	string
Proxy	string
Redirect	string

ManagedServerCreateMode

Hiermee geeft u de modus voor het maken van de database op.

Standaardinstelling: Het maken van een normaal exemplaar.

Herstellen: hiermee maakt u een exemplaar door een set back-ups te herstellen naar een bepaald tijdstip. RestorePointInTime en SourceManagedInstanceId moeten worden opgegeven.

Name	Type	Description
Default	string
PointInTimeRestore	string

PrincipalType

Principal Type van de serverbeheerder.

Name	Type	Description
Application	string
Group	string
User	string

ResourceIdentity

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name	Type	Description
principalId	string	De principal-id van Azure Active Directory.
tenantId	string	De tenant-id van Azure Active Directory.
type	IdentityType	Het identiteitstype. Stel dit in op SystemAssigned om automatisch een Azure Active Directory-principal voor de resource te maken en toe te wijzen.
userAssignedIdentities	<string,  UserIdentity>	De resource-id's van de door de gebruiker toegewezen identiteiten die moeten worden gebruikt

ServicePrincipal

De service-principalconfiguratie van het beheerde exemplaar voor een resource.

Name	Type	Description
clientId	string	De client-id van de Azure Active Directory-toepassing.
principalId	string	De object-id van de Azure Active Directory-toepassing.
tenantId	string	De tenant-id van Azure Active Directory.
type	ServicePrincipalType	Type service-principal.

ServicePrincipalType

Type service-principal.

Name	Type	Description
None	string
SystemAssigned	string

Sku

Een ARM-resource-SKU.

Name	Type	Description
capacity	integer	Capaciteit van de specifieke SKU.
family	string	Als de service verschillende generaties hardware voor dezelfde SKU heeft, kan die hier worden vastgelegd.
name	string	De naam van de SKU, meestal een letter + cijfercode, bijvoorbeeld P3.
size	string	Grootte van de specifieke SKU
tier	string	De laag of editie van de specifieke SKU, bijvoorbeeld Basic, Premium.

UserIdentity

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name	Type	Description
clientId	string	De Azure Active Directory-client-id.
principalId	string	De principal-id van Azure Active Directory.