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


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 Resource Manager или портала.

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 ОбновлениеInstanceAndBackupRedundancy — избыточность зоны экземпляра и избыточность хранилища резервных копий невозможно обновить в том же запросе.

  • 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 InstanceRedundancyUpdateTimeBackupRedundancyUpdateInProgresss — не удается обновить избыточность экземпляра, так как обновление избыточности хранилища резервных копий выполняется.

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

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

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

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

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

  • 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 значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.

ManagedInstance

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

ManagedInstanceExternalAdministrator

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

ManagedInstanceLicenseType

Тип лицензии. Возможные значения: LicenseIncluded (обычная цена включительно с новой лицензией SQL) и BasePrice (скидка на AHB для привлечения собственных лицензий 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

BackupStorageRedundancy

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

Значение Описание
Geo
GeoZone
Local
Zone

IdentityType

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

Значение Описание
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

ManagedInstance

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

Имя Тип Описание
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 (arm-id)

Идентификатор ресурса другого управляемого экземпляра, зона DNS которого будет совместно использовать этот управляемый экземпляр после создания.

properties.fullyQualifiedDomainName

string

Полное доменное имя управляемого экземпляра.

properties.instancePoolId

string

Идентификатор пула экземпляров, к которому принадлежит управляемый сервер.

properties.keyId

string

Универсальный код ресурса (URI) ключа для шифрования.

properties.licenseType

ManagedInstanceLicenseType

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

properties.maintenanceConfigurationId

string

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

properties.managedInstanceCreateMode

ManagedServerCreateMode

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

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

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

properties.minimalTlsVersion

string

Минимальная версия TLS. Допустимые значения: "Нет", "1.0", "1.1", "1.2"

properties.primaryUserAssignedIdentityId

string (arm-id)

Идентификатор ресурса назначаемого пользователем удостоверения, используемого по умолчанию.

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 (date-time)

Указывает точку во времени (ISO8601 формате) исходной базы данных, которая будет восстановлена для создания новой базы данных.

properties.servicePrincipal

ServicePrincipal

Субъект-служба управляемого экземпляра.

properties.sourceManagedInstanceId

string (arm-id)

Идентификатор ресурса исходного управляемого экземпляра, связанного с операцией создания этого экземпляра.

properties.state

string

Состояние управляемого экземпляра.

properties.storageSizeInGB

integer (int32)

Размер хранилища в ГБ. Минимальное значение: 32. Максимальное значение: 16384. Приращение только в 32 ГБ разрешено. Максимальное значение зависит от выбранного семейства оборудования и количества виртуальных ядер.

properties.subnetId

string (arm-id)

Идентификатор ресурса подсети для управляемого экземпляра.

properties.timezoneId

string

Идентификатор часового пояса. Допустимые значения — это часовые пояса, поддерживаемые Windows. Windows хранит сведения о поддерживаемых часовых поясах, включая идентификатор в реестре в разделе KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\TimeZone. Эти значения реестра можно получить с помощью SQL Server, запросив имя SELECT AS timezone_id FROM sys.time_zone_info. Список идентификаторов также можно получить путем выполнения [System.TimeZoneInfo]::GetSystemTimeZones() в PowerShell. Пример допустимого идентификатора часового пояса — "Тихоокеанское стандартное время" или "W". Стандартное время в Европе.

properties.vCores

integer (int32)

Количество виртуальных ядер. Допустимые значения: 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 (uuid)

ИДЕНТИФИКАТОР безопасности (идентификатор объекта) администратора сервера.

tenantId

string (uuid)

Идентификатор клиента администратора.

ManagedInstanceLicenseType

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

Значение Описание
BasePrice
LicenseIncluded

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
Proxy
Redirect

ManagedServerCreateMode

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

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

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

Значение Описание
Default
PointInTimeRestore

PrincipalType

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

Значение Описание
Application
Group
User

ResourceIdentity

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

Имя Тип Описание
principalId

string (uuid)

Идентификатор субъекта Azure Active Directory.

tenantId

string (uuid)

Идентификатор клиента Azure Active Directory.

type

IdentityType

Тип удостоверения. Установите для параметра SystemAssigned значение 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
SystemAssigned

Sku

SKU ресурса ARM.

Имя Тип Описание
capacity

integer (int32)

Емкость конкретного номера SKU.

family

string

Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.

name

string

Имя номера SKU, как правило, буква + код номера, например P3.

size

string

Размер конкретного номера SKU

tier

string

Уровень или выпуск конкретного номера SKU, например "Базовый", "Премиум".

UserIdentity

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

Имя Тип Описание
clientId

string (uuid)

Идентификатор клиента Azure Active Directory.

principalId

string (uuid)

Идентификатор субъекта Azure Active Directory.