Managed Instances - List

Ссылка

Служба:: SQL Database

Версия API:: 2021-11-01

Возвращает список всех управляемых экземпляров в подписке.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.
$expand	query		string	Дочерние ресурсы, которые необходимо включить в ответ.

Ответы

Имя	Тип	Описание
200 OK	ManagedInstanceListResult	Список управляемых экземпляров успешно получен.
Other Status Codes		Ответы на ошибки: ***

Примеры

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

Пример ответа

Код состояния:: 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

Образец запроса

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

Пример ответа

Код состояния:: 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
        }
      }
    }
  ]
}

Определения

Имя	Описание
AdministratorType	Тип администратора северов.
BackupStorageRedundancy	Тип учетной записи хранения, используемой для хранения резервных копий этого экземпляра. Параметры: Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) и GeoZone(GeoZoneRedundantStorage).
IdentityType	Тип удостоверения. Задайте для этого параметра значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.
ManagedInstance	Управляемый экземпляр Azure SQL.
ManagedInstanceExternalAdministrator	Свойства администратора Active Directory.
ManagedInstanceLicenseType	Тип лицензии. Возможные значения: LicenseIncluded (обычная цена, включая новую лицензию SQL) и BasePrice (цена со скидкой для получения собственных лицензий SQL).
ManagedInstanceListResult	Список управляемых экземпляров.
ManagedInstancePecProperty	Подключение к частной конечной точке в управляемом экземпляре
ManagedInstancePrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	Тип подключения, используемый для подключения к экземпляру.
ManagedServerCreateMode	Указывает режим создания базы данных. По умолчанию: регулярное создание экземпляра. Восстановление. Создает экземпляр путем восстановления набора резервных копий на определенный момент времени. Необходимо указать Значения RestorePointInTime и SourceManagedInstanceId.
PrincipalType	Тип субъекта администратора серверов.
ResourceIdentity	Конфигурация удостоверений Azure Active Directory для ресурса.
ServicePrincipal	Конфигурация субъекта-службы управляемого экземпляра для ресурса.
ServicePrincipalType	Тип субъекта-службы.
Sku	SKU ресурса ARM.
UserIdentity	Конфигурация удостоверений Azure Active Directory для ресурса.

AdministratorType

Тип администратора северов.

Имя	Тип	Описание
ActiveDirectory	string

BackupStorageRedundancy

Тип учетной записи хранения, используемой для хранения резервных копий этого экземпляра. Параметры: Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) и GeoZone(GeoZoneRedundantStorage).

Имя	Тип	Описание
Geo	string
GeoZone	string
Local	string
Zone	string

IdentityType

Тип удостоверения. Задайте для этого параметра значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.

Имя	Тип	Описание
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManagedInstance

Управляемый экземпляр Azure SQL.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
identity	ResourceIdentity	Удостоверение Azure Active Directory управляемого экземпляра.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.administratorLogin	string	Имя пользователя администратора для управляемого экземпляра. Может указываться только при создании управляемого экземпляра (и требуется для создания).
properties.administratorLoginPassword	string	Пароль для входа администратора (требуется для создания управляемого экземпляра).
properties.administrators	ManagedInstanceExternalAdministrator	Администратор сервера Azure Active Directory.
properties.collation	string	Параметры сортировки управляемого экземпляра.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Тип учетной записи хранения, используемой для хранения резервных копий этого экземпляра. Параметры: Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) и GeoZone(GeoZoneRedundantStorage).
properties.dnsZone	string	Зона DNS, в которую находится управляемый экземпляр.
properties.dnsZonePartner	string	Идентификатор ресурса другого управляемого экземпляра, зона DNS которого будет совместно использовать этот управляемый экземпляр после создания.
properties.fullyQualifiedDomainName	string	Полное доменное имя управляемого экземпляра.
properties.instancePoolId	string	Идентификатор пула экземпляров, к которому принадлежит этот управляемый сервер.
properties.keyId	string	Универсальный код ресурса (URI) CMK ключа, используемого для шифрования.
properties.licenseType	ManagedInstanceLicenseType	Тип лицензии. Возможные значения: LicenseIncluded (обычная цена, включая новую лицензию SQL) и BasePrice (цена со скидкой для получения собственных лицензий SQL).
properties.maintenanceConfigurationId	string	Указывает идентификатор конфигурации обслуживания, применяемый к этому управляемому экземпляру.
properties.managedInstanceCreateMode	ManagedServerCreateMode	Указывает режим создания базы данных. По умолчанию: регулярное создание экземпляра. Восстановление. Создает экземпляр путем восстановления набора резервных копий на определенный момент времени. Необходимо указать Значения RestorePointInTime и SourceManagedInstanceId.
properties.minimalTlsVersion	string	Минимальная версия TLS. Допустимые значения: None, 1.0, 1.1, 1.2
properties.primaryUserAssignedIdentityId	string	Идентификатор ресурса удостоверения, назначаемого пользователем, который будет использоваться по умолчанию.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	Список подключений к частной конечной точке в управляемом экземпляре.
properties.provisioningState	enum: Accepted Canceled Created Creating Deleted Deleting Failed NotSpecified Registering Running Succeeded TimedOut Unknown Unrecognized Updating
properties.proxyOverride	ManagedInstanceProxyOverride	Тип подключения, используемый для подключения к экземпляру.
properties.publicDataEndpointEnabled	boolean	Включена ли общедоступная конечная точка данных.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Тип учетной записи хранения, используемый для хранения резервных копий этого экземпляра. Параметры: Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) и GeoZone(GeoZoneRedundantStorage).
properties.restorePointInTime	string	Указывает точку во времени (ISO8601 формате) базы данных-источника, которая будет восстановлена для создания новой базы данных.
properties.servicePrincipal	ServicePrincipal	Субъект-служба управляемого экземпляра.
properties.sourceManagedInstanceId	string	Идентификатор ресурса исходного управляемого экземпляра, связанного с операцией создания этого экземпляра.
properties.state	string	Состояние управляемого экземпляра.
properties.storageSizeInGB	integer	Размер хранилища в ГБ. Минимальное значение: 32. Максимальное значение: 16384. Допустимы только приращения 32 ГБ. Максимальное значение зависит от выбранного семейства оборудования и количества виртуальных ядер.
properties.subnetId	string	Идентификатор ресурса подсети для управляемого экземпляра.
properties.timezoneId	string	Идентификатор часового пояса. Допустимые значения — это часовые пояса, поддерживаемые Windows. Windows хранит сведения о поддерживаемых часовых поясах, включая идентификатор, в реестре в разделе KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zone. Эти значения реестра можно получить с помощью SQL Server, запросив select name AS timezone_id FROM sys.time_zone_info. Список идентификаторов также можно получить, выполнив [System.TimeZoneInfo]::GetSystemTimeZones() в PowerShell. Пример допустимого идентификатора часового пояса — "Тихоокеанское стандартное время" или "W. Стандартное время Европы".
properties.vCores	integer	Количество виртуальных ядер. Допустимые значения: 8, 16, 24, 32, 40, 64, 80.
properties.zoneRedundant	boolean	Включена ли multi-az.
sku	Sku	Номер SKU управляемого экземпляра. Допустимые значения для sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
tags	object	Теги ресурсов.
type	string	Тип ресурса.

ManagedInstanceExternalAdministrator

Свойства администратора Active Directory.

Имя	Тип	Описание
administratorType	AdministratorType	Тип администратора северов.
azureADOnlyAuthentication	boolean	Включена только проверка подлинности Azure Active Directory.
login	string	Имя входа администратора сервера.
principalType	PrincipalType	Тип субъекта администратора серверов.
sid	string	SID (идентификатор объекта) администратора сервера.
tenantId	string	Идентификатор клиента администратора.

ManagedInstanceLicenseType

Тип лицензии. Возможные значения: LicenseIncluded (обычная цена, включая новую лицензию SQL) и BasePrice (цена со скидкой для получения собственных лицензий SQL).

Имя	Тип	Описание
BasePrice	string
LicenseIncluded	string

ManagedInstanceListResult

Список управляемых экземпляров.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов.
value	ManagedInstance[]	Массив результатов.

ManagedInstancePecProperty

Подключение к частной конечной точке в управляемом экземпляре

Имя	Тип	Описание
id	string	Идентификатор ресурса.
properties	ManagedInstancePrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке

ManagedInstancePrivateEndpointConnectionProperties

Свойства подключения к частной конечной точке.

Имя	Тип	Описание
privateEndpoint	ManagedInstancePrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	Состояние подключения подключения к частной конечной точке.
provisioningState	string	Состояние подключения к частной конечной точке.

ManagedInstancePrivateEndpointProperty

Имя	Тип	Описание
id	string	Идентификатор ресурса частной конечной точки.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Имя	Тип	Описание
actionsRequired	string	Описание подключения службы приватного канала.
description	string	Описание подключения службы приватного канала.
status	string	Состояние подключения службы приватного канала.

ManagedInstanceProxyOverride

Тип подключения, используемый для подключения к экземпляру.

Имя	Тип	Описание
Default	string
Proxy	string
Redirect	string

ManagedServerCreateMode

Указывает режим создания базы данных.

По умолчанию: регулярное создание экземпляра.

Восстановление. Создает экземпляр путем восстановления набора резервных копий на определенный момент времени. Необходимо указать Значения RestorePointInTime и SourceManagedInstanceId.

Имя	Тип	Описание
Default	string
PointInTimeRestore	string

PrincipalType

Тип субъекта администратора серверов.

Имя	Тип	Описание
Application	string
Group	string
User	string

ResourceIdentity

Конфигурация удостоверений Azure Active Directory для ресурса.

Имя	Тип	Описание
principalId	string	Идентификатор субъекта Azure Active Directory.
tenantId	string	Идентификатор клиента Azure Active Directory.
type	IdentityType	Тип удостоверения. Задайте для этого параметра значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.
userAssignedIdentities	<string, UserIdentity>	Идентификаторы ресурсов назначенных пользователем удостоверений для использования

ServicePrincipal

Конфигурация субъекта-службы управляемого экземпляра для ресурса.

Имя	Тип	Описание
clientId	string	Идентификатор клиента приложения Azure Active Directory.
principalId	string	Идентификатор объекта приложения Azure Active Directory.
tenantId	string	Идентификатор клиента Azure Active Directory.
type	ServicePrincipalType	Тип субъекта-службы.

ServicePrincipalType

Тип субъекта-службы.

Имя	Тип	Описание
None	string
SystemAssigned	string

Sku

SKU ресурса ARM.

Имя	Тип	Описание
capacity	integer	Емкость конкретного номера SKU.
family	string	Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.
name	string	Имя номера SKU, как правило, буква + числовой код, например P3.
size	string	Размер конкретного номера SKU
tier	string	Уровень или выпуск конкретного номера SKU, например "Базовый", "Премиум".

UserIdentity

Конфигурация удостоверений Azure Active Directory для ресурса.

Имя	Тип	Описание
clientId	string	Идентификатор клиента Azure Active Directory.
principalId	string	Идентификатор субъекта Azure Active Directory.

Поделиться через

Managed Instances - List

Параметры URI

Ответы

Примеры

List managed instances

Образец запроса

Пример ответа

List managed instances with $expand=administrators/activedirectory

Образец запроса

Пример ответа

Определения

AdministratorType

BackupStorageRedundancy

IdentityType

ManagedInstance

ManagedInstanceExternalAdministrator

ManagedInstanceLicenseType

ManagedInstanceListResult

ManagedInstancePecProperty

ManagedInstancePrivateEndpointConnectionProperties

ManagedInstancePrivateEndpointProperty

ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstanceProxyOverride

ManagedServerCreateMode

PrincipalType

ResourceIdentity

ServicePrincipal

ServicePrincipalType

Sku

UserIdentity

Дополнительные ресурсы