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
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
managed
|
path | True |
string |
Имя управляемого экземпляра. |
resource
|
path | True |
string |
Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала. |
subscription
|
path | True |
string |
Идентификатор подписки Azure. |
api-version
|
query | True |
string |
Версия API для использования в запросе. |
$expand
|
query |
string |
Дочерние ресурсы, которые необходимо включить в ответ. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Указанный управляемый экземпляр успешно получен. |
|
Other Status Codes |
Ответы об ошибках: ***
|
Примеры
Get managed instance |
Get managed instance with $expand=administrators/activedirectory |
Get managed instance
Образец запроса
Пример ответа
{
"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
Образец запроса
Пример ответа
{
"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"
}
Определения
Имя | Описание |
---|---|
Administrator |
Тип администратора серверов. |
Backup |
Тип учетной записи хранения, используемой для хранения резервных копий этого экземпляра. Параметры: Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) и GeoZone(GeoZoneRedundantStorage). |
Identity |
Тип удостоверения. Задайте для этого параметра значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса. |
Managed |
Управляемый экземпляр Azure SQL. |
Managed |
Свойства администратора Active Directory. |
Managed |
Тип лицензии. Возможные значения: LicenseIncluded (обычная цена, включая новую лицензию SQL) и BasePrice (цена со скидкой для получения собственных лицензий SQL). |
Managed |
Подключение к частной конечной точке в управляемом экземпляре |
Managed |
Свойства подключения к частной конечной точке. |
Managed |
|
Managed |
|
Managed |
Тип подключения, используемый для подключения к экземпляру. |
Managed |
Указывает режим создания базы данных. По умолчанию: регулярное создание экземпляра. Восстановление. Создает экземпляр путем восстановления набора резервных копий на определенный момент времени. Необходимо указать Значения RestorePointInTime и SourceManagedInstanceId. |
Principal |
Тип субъекта администратора серверов. |
Resource |
Конфигурация удостоверений Azure Active Directory для ресурса. |
Service |
Конфигурация субъекта-службы управляемого экземпляра для ресурса. |
Service |
Тип субъекта-службы. |
Sku |
SKU ресурса ARM. |
User |
Конфигурация удостоверений 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 |
Удостоверение 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 (цена со скидкой для получения собственных лицензий 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:
|
|
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 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.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH |
|
tags |
object |
Теги ресурсов. |
type |
string |
Тип ресурса. |
ManagedInstanceExternalAdministrator
Свойства администратора Active Directory.
Имя | Тип | Описание |
---|---|---|
administratorType |
Тип администратора северов. |
|
azureADOnlyAuthentication |
boolean |
Включена только проверка подлинности Azure Active Directory. |
login |
string |
Имя входа администратора сервера. |
principalType |
Тип субъекта администратора серверов. |
|
sid |
string |
SID (идентификатор объекта) администратора сервера. |
tenantId |
string |
Идентификатор клиента администратора. |
ManagedInstanceLicenseType
Тип лицензии. Возможные значения: LicenseIncluded (обычная цена, включая новую лицензию SQL) и BasePrice (цена со скидкой для получения собственных лицензий SQL).
Имя | Тип | Описание |
---|---|---|
BasePrice |
string |
|
LicenseIncluded |
string |
ManagedInstancePecProperty
Подключение к частной конечной точке в управляемом экземпляре
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса. |
properties |
Свойства подключения к частной конечной точке |
ManagedInstancePrivateEndpointConnectionProperties
Свойства подключения к частной конечной точке.
Имя | Тип | Описание |
---|---|---|
privateEndpoint |
Частная конечная точка, к которой принадлежит подключение. |
|
privateLinkServiceConnectionState |
Состояние подключения для подключения к частной конечной точке. |
|
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 |
Тип удостоверения. Задайте для этого параметра значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса. |
|
userAssignedIdentities |
<string,
User |
Идентификаторы ресурсов назначенных пользователем удостоверений для использования |
ServicePrincipal
Конфигурация субъекта-службы управляемого экземпляра для ресурса.
Имя | Тип | Описание |
---|---|---|
clientId |
string |
Идентификатор клиента приложения Azure Active Directory. |
principalId |
string |
Идентификатор объекта приложения Azure Active Directory. |
tenantId |
string |
Идентификатор клиента Azure Active Directory. |
type |
Тип субъекта-службы. |
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. |