Managed Instances - Get

Получает Управляемый экземпляр.

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

Name In Required Type Description
managedInstanceName
path True
  • string

Имя управляемого экземпляра.

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

$expand
query
  • string

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

Ответы

Name Type Description
200 OK

Успешно получен указанный управляемый экземпляр.

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 — запрос на обслуживание превысил допустимое время ожидания.

Примеры

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

Определения

AdministratorType

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

BackupStorageRedundancy

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

IdentityType

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

ManagedInstance

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

ManagedInstanceExternalAdministrator

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

ManagedInstanceLicenseType

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

ManagedInstancePecProperty

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

ManagedInstancePrivateEndpointConnectionProperties

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

ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride

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

ManagedServerCreateMode

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

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

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

PrincipalType

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

ResourceIdentity

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

ServicePrincipal

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

ServicePrincipalType

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

Sku

SKU ресурса ARM.

UserIdentity

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

AdministratorType

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

Name Type Description
ActiveDirectory
  • string

BackupStorageRedundancy

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

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

IdentityType

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

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

ManagedInstance

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

Name Type Description
id
  • string

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

identity

Удостоверение Azure Active Directory управляемого экземпляра.

location
  • string

Расположение ресурса.

name
  • string

Имя ресурса.

properties.administratorLogin
  • string

Имя администратора для управляемого экземпляра. Можно указать только при создании управляемого экземпляра (и требуется для создания).

properties.administratorLoginPassword
  • string

Пароль для входа администратора (требуется для создания управляемого экземпляра).

properties.administrators

Администратор Azure Active Directory сервера.

properties.collation
  • string

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

properties.currentBackupStorageRedundancy

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

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

properties.maintenanceConfigurationId
  • string

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

properties.managedInstanceCreateMode

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

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

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

properties.minimalTlsVersion
  • string

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

properties.primaryUserAssignedIdentityId
  • string

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

properties.privateEndpointConnections

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

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

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

properties.publicDataEndpointEnabled
  • boolean

Указывает, включена ли общедоступная конечная точка данных.

properties.requestedBackupStorageRedundancy

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

properties.restorePointInTime
  • string

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

properties.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 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.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH

tags
  • object

Теги ресурсов.

type
  • string

Тип ресурса.

ManagedInstanceExternalAdministrator

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

Name Type Description
administratorType

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

azureADOnlyAuthentication
  • boolean

Включена только проверка подлинности Azure Active Directory.

login
  • string

Имя входа администратора сервера.

principalType

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

sid
  • string

Идентификатор безопасности (идентификатор объекта) администратора сервера.

tenantId
  • string

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

ManagedInstanceLicenseType

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

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

ManagedInstancePecProperty

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

Name Type Description
id
  • string

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

properties

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

ManagedInstancePrivateEndpointConnectionProperties

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

Name Type Description
privateEndpoint

Частная конечная точка, к которой принадлежит подключение.

privateLinkServiceConnectionState

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

provisioningState
  • string

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

ManagedInstancePrivateEndpointProperty

Name Type Description
id
  • string

Идентификатор ресурса частной конечной точки.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name Type Description
actionsRequired
  • string

Описание подключения службы приватного канала.

description
  • string

Описание подключения службы приватного канала.

status
  • string

Состояние подключения службы приватного канала.

ManagedInstanceProxyOverride

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

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

ManagedServerCreateMode

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

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

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

Name Type Description
Default
  • string
PointInTimeRestore
  • string

PrincipalType

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

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

ResourceIdentity

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

Name Type Description
principalId
  • string

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

tenantId
  • string

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

type

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

userAssignedIdentities

Идентификаторы ресурсов назначенных пользователем удостоверений для использования

ServicePrincipal

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

Name Type Description
clientId
  • string

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

principalId
  • string

Идентификатор объекта приложения Azure Active Directory.

tenantId
  • string

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

type

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

ServicePrincipalType

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

Name Type Description
None
  • string
SystemAssigned
  • string

Sku

SKU ресурса ARM.

Name Type Description
capacity
  • integer

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

family
  • string

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

name
  • string

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

size
  • string

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

tier
  • string

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

UserIdentity

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

Name Type Description
clientId
  • string

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

principalId
  • string

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