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


Managed Instances - List By Resource Group

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

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.

subscriptionId
path True

string

Идентификатор подписки Azure.

api-version
query True

string

Версия API для использования в запросе.

$expand
query

string

Дочерние ресурсы, которые необходимо включить в ответ.

Ответы

Имя Тип Описание
200 OK

ManagedInstanceListResult

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

Other Status Codes

Ответы на ошибки: ***

  • 400 MiGeoRestoreWithWrongBackupStorageRedundancy — Geo-Restore не разрешено для управляемых экземпляров с избыточностью хранилища резервных копий LRS/ZRS.

  • 400 UpdatedInstanceAndBackupRedundancy — избыточность зоны экземпляра и избыточность хранилища резервных копий невозможно обновить в одном запросе.

  • 400 ProvisioningDisabled — отображает сообщение об ошибке от авторизации операции ресурсов без изменений.

  • 400 AadOnlyAuthenticationIsEnabled — включена только проверка подлинности Azure Active Directory. Обратитесь к системному администратору.

  • 400 ManagementServiceFeatureDisabled — пользователь попытался использовать отключенную функцию.

  • 404 SubscriptionNotFound — запрошенная подписка не найдена.

  • 404 ServerNotInSubscription — указанный сервер не существует в указанной подписке.

  • 404 ManagedInstanceNotInSubscriptionResourceGroup — указанный управляемый экземпляр не существует в указанной группе ресурсов и подписке.

  • 404 SubscriptionNotFound — запрошенная подписка не найдена.

  • 404 ResourceNotFound — запрошенный ресурс не найден.

  • 409 ConflictingManagedInstanceOperation — в настоящее время выполняется операция для управляемого экземпляра.

  • 409 BackupRedundancyUpdateAndInstanceRedundancyConflict — экземпляр имеет значение multi-az, но хранилище резервных копий обновляется с избыточности между зонами до неизбыточного между зонами.

  • 409 InstanceRedundancyUpdateTimeBackupRedundancyUpdateInProgress — не удается обновить избыточность экземпляров, так как выполняется обновление избыточности хранилища резервных копий.

  • 409 InstanceRedundancyUpdateAndBackupRedundancyConflict — хранилище резервных копий не является избыточным между зонами, но избыточность экземпляров обновляется до избыточности между зонами.

  • 409 BackupRedundancyUpdateConflict — не удается обновить избыточность хранилища резервных копий, так как обновление избыточности хранилища резервных копий уже выполняется.

  • 409 MiDropFailedOnAuthLocks — пользователь пытался удалить последнее Управляемый экземпляр в подсети, в которую применена блокировка к ресурсам.

  • 409 MiCreateFailedNonDelegatedSubnet — пользователь попытался развернуть Управляемый экземпляр или Управляемый экземпляр пул в подсети, которая не делегирована Microsoft.Sql/managedInstances.

  • 412 InstanceNotReadyForBackupRedundancyUpdate — не удается обновить избыточность хранилища резервных копий, так как экземпляр не готов.

  • 429 SubscriptionTooManyCreateUpdateRequests — запросы, превышающие максимальное количество запросов, которые могут обрабатываться доступными ресурсами.

  • 429 SubscriptionTooManyRequests — запросы, превышающие максимальное количество запросов, которые могут быть обработаны доступными ресурсами.

  • 429 SubscriptionTooManyCreateUpdateRequests — запросы, превышающие максимальное количество запросов, которые могут обрабатываться доступными ресурсами.

  • 429 SubscriptionTooManyRequests — запросы, превышающие максимальное количество запросов, которые могут быть обработаны доступными ресурсами.

  • 429 ConflictingSubscriptionOperation — в настоящее время выполняется операция для подписки.

  • 503 TooManyRequests — запросы, превышающие максимальное количество запросов, которые могут быть обработаны доступными ресурсами.

  • 503 TooManyRequests — запросы, превышающие максимальное количество запросов, которые могут быть обработаны доступными ресурсами.

  • 504 RequestTimeout — превышено допустимое время ожидания запроса на обслуживание.

  • 504 RequestTimeout — превышено допустимое время ожидания запроса на обслуживание.

Примеры

List managed instances by resource group
List managed instances by resource group with $expand=administrators/activedirectory

List managed instances by resource group

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

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

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

{
  "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 by resource group with $expand=administrators/activedirectory

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

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

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

{
  "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 Zones. Эти значения реестра можно получить через 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.