次の方法で共有


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 パラメーター

名前 / 必須 説明
managedInstanceName
path True

string

マネージド インスタンスの名前。

resourceGroupName
path True

string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

subscriptionId
path True

string

Azure サブスクリプションを識別するサブスクリプション ID。

api-version
query True

string

要求で使用する API のバージョン。

$expand
query

string

応答に含める子リソース。

応答

名前 説明
200 OK

ManagedInstance

指定したマネージド インスタンスが正常に取得されました。

Other Status Codes

エラー応答: ***

  • 400 MiGeoRestoreWithWrongBackupStorageRedundancy - LRS/ZRS バックアップ ストレージ冗長性を持つマネージド インスタンスでは、Geo-Restore は許可されません。

  • 400 UpdatingInstanceAndBackupRedundancy - インスタンス ゾーンの冗長性とバックアップ ストレージの冗長性を同じ要求で更新することはできません。

  • 400 ProvisioningDisabled - リソース操作承認者からのエラー メッセージをそのまま表示します(変更なし)

  • 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory のみの認証が有効になっています。 システム管理者に問い合わせてください。

  • 400 ManagementServiceFeatureDisabled - ユーザーが無効になっている機能を使用しようとしました。

  • 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。

  • 404 ServerNotInSubscription - 指定されたサブスクリプションに指定されたサーバーが存在しません。

  • 404 ManagedInstanceNotInSubscriptionResourceGroup - 指定されたマネージド インスタンスが、指定されたリソース グループとサブスクリプションに存在しません。

  • 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

  • 409 ConflictingManagedInstanceOperation - マネージド インスタンスの操作は現在進行中です。

  • 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - インスタンスはマルチ az ですが、バックアップ ストレージはゾーン冗長から非ゾーン冗長に更新されています。

  • 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - バックアップ ストレージ冗長更新が進行中のため、インスタンスの冗長性を更新できません。

  • 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - バックアップ ストレージは非ゾーン冗長ですが、インスタンスの冗長性はゾーン冗長に更新されています。

  • 409 BackupRedundancyUpdateConflict - バックアップ ストレージの冗長性の更新が既に進行中のため、バックアップ ストレージの冗長性を更新できません。

  • 409 MiDropFailedOnAuthLocks - ユーザーが、リソースにロックが適用されているサブネット内の最後のManaged Instanceを削除しようとしました。

  • 409 MiCreateFailedNonDelegatedSubnet - ユーザーは、Microsoft.Sql/managedInstances に委任されていないサブネットにManaged InstanceまたはManaged Instance プールをデプロイしようとしました。

  • 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

要求のサンプル

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2021-11-01

応答のサンプル

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

要求のサンプル

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2021-11-01

応答のサンプル

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

切断管理者の種類。

BackupStorageRedundancy

このインスタンスのバックアップを格納するために使用されるストレージ アカウントの種類。 オプションは、Local (LocallyRedundantStorage)、Zone (ZoneRedundantStorage)、Geo (GeoRedundantStorage) および GeoZone(GeoZoneRedundantStorage) です。

IdentityType

ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

ManagedInstance

Azure SQLマネージド インスタンス。

ManagedInstanceExternalAdministrator

Active Directory 管理者のプロパティ。

ManagedInstanceLicenseType

ライセンスの種類。 使用できる値は、"LicenseIncluded" (新しい SQL ライセンスを含む通常価格) と 'BasePrice' (独自の SQL ライセンスを持ち込むための割引された AHB 価格) です。

ManagedInstancePecProperty

マネージド インスタンスでのプライベート エンドポイント接続

ManagedInstancePrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ。

ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride

インスタンスへの接続に使用される接続の種類。

ManagedServerCreateMode

データベースの作成モードを指定します。

既定値: 通常のインスタンスの作成。

復元: 一連のバックアップを特定の時点に復元することによってインスタンスを作成します。 RestorePointInTime と SourceManagedInstanceId を指定する必要があります。

PrincipalType

サーバー管理者のプリンシパルの種類。

ResourceIdentity

リソースの Azure Active Directory ID 構成。

ServicePrincipal

リソースのマネージド インスタンスのサービス プリンシパル構成。

ServicePrincipalType

サービス プリンシパルの種類。

Sku

ARM リソース SKU。

UserIdentity

リソースの Azure Active Directory ID 構成。

AdministratorType

切断管理者の種類。

名前 説明
ActiveDirectory

string

BackupStorageRedundancy

このインスタンスのバックアップを格納するために使用されるストレージ アカウントの種類。 オプションは、Local (LocallyRedundantStorage)、Zone (ZoneRedundantStorage)、Geo (GeoRedundantStorage) および GeoZone(GeoZoneRedundantStorage) です。

名前 説明
Geo

string

GeoZone

string

Local

string

Zone

string

IdentityType

ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

名前 説明
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManagedInstance

Azure SQLマネージド インスタンス。

名前 説明
id

string

リソースの ID

identity

ResourceIdentity

マネージド インスタンスの Azure Active Directory ID。

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 ゾーンを持つ別のマネージド インスタンスのリソース ID。

properties.fullyQualifiedDomainName

string

マネージド インスタンスの完全修飾ドメイン名。

properties.instancePoolId

string

このマネージド サーバーが属しているインスタンス プールの ID。

properties.keyId

string

暗号化に使用するキーの CMK URI。

properties.licenseType

ManagedInstanceLicenseType

ライセンスの種類。 使用できる値は、"LicenseIncluded" (新しい SQL ライセンスを含む通常価格) と 'BasePrice' (独自の SQL ライセンスを持ち込むための割引された AHB 価格) です。

properties.maintenanceConfigurationId

string

このマネージド インスタンスに適用するメンテナンス構成 ID を指定します。

properties.managedInstanceCreateMode

ManagedServerCreateMode

データベースの作成モードを指定します。

既定値: 通常のインスタンスの作成。

復元: 一連のバックアップを特定の時点に復元することによってインスタンスを作成します。 RestorePointInTime と SourceManagedInstanceId を指定する必要があります。

properties.minimalTlsVersion

string

最小 TLS バージョン。 使用できる値: 'None'、'1.0'、'1.1'、'1.2'

properties.primaryUserAssignedIdentityId

string

既定で使用されるユーザー割り当て ID のリソース 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

新しいデータベースを作成するために復元されるソース データベースの時点 (ISO8601形式) を指定します。

properties.servicePrincipal

ServicePrincipal

マネージド インスタンスのサービス プリンシパル。

properties.sourceManagedInstanceId

string

このインスタンスの作成操作に関連付けられているソース マネージド インスタンスのリソース識別子。

properties.state

string

マネージド インスタンスの状態。

properties.storageSizeInGB

integer

ストレージ サイズ (GB 単位)。 最小値: 32。 最大値: 16384。 32 GB の増分のみが許可されます。 最大値は、選択したハードウェア ファミリと仮想コアの数によって異なります。

properties.subnetId

string

マネージド インスタンスのサブネット リソース ID。

properties.timezoneId

string

タイムゾーンの ID。 使用できる値は、Windows でサポートされているタイムゾーンです。 Windows では、サポートされているタイムゾーン (ID を含む) の詳細がレジストリの KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones に保持されます。 SQL SERVERを使用してこれらのレジストリ値を取得するには、SELECT name AS timezone_id FROM sys.time_zone_infoに対してクエリを実行します。 Id の一覧は、PowerShell で [System.TimeZoneInfo]::GetSystemTimeZones() を実行して取得することもできます。 有効なタイムゾーン ID の例として、"太平洋標準時" または "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 (オブジェクト ID)。

tenantId

string

管理者のテナント ID。

ManagedInstanceLicenseType

ライセンスの種類。 使用できる値は、"LicenseIncluded" (新しい SQL ライセンスを含む通常価格) と 'BasePrice' (独自の SQL ライセンスを持ち込むための割引された AHB 価格) です。

名前 説明
BasePrice

string

LicenseIncluded

string

ManagedInstancePecProperty

マネージド インスタンスでのプライベート エンドポイント接続

名前 説明
id

string

リソースの ID

properties

ManagedInstancePrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ

ManagedInstancePrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ。

名前 説明
privateEndpoint

ManagedInstancePrivateEndpointProperty

接続が属するプライベート エンドポイント。

privateLinkServiceConnectionState

ManagedInstancePrivateLinkServiceConnectionStateProperty

プライベート エンドポイント接続の接続状態。

provisioningState

string

プライベート エンドポイント接続の状態。

ManagedInstancePrivateEndpointProperty

名前 説明
id

string

プライベート エンドポイントのリソース ID。

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 ID 構成。

名前 説明
principalId

string

Azure Active Directory プリンシパル ID。

tenantId

string

Azure Active Directory テナント ID。

type

IdentityType

ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

userAssignedIdentities

<string,  UserIdentity>

使用するユーザー割り当て ID のリソース ID

ServicePrincipal

リソースのマネージド インスタンスのサービス プリンシパル構成。

名前 説明
clientId

string

Azure Active Directory アプリケーション クライアント ID。

principalId

string

Azure Active Directory アプリケーション オブジェクト ID。

tenantId

string

Azure Active Directory テナント ID。

type

ServicePrincipalType

サービス プリンシパルの種類。

ServicePrincipalType

サービス プリンシパルの種類。

名前 説明
None

string

SystemAssigned

string

Sku

ARM リソース SKU。

名前 説明
capacity

integer

特定の SKU の容量。

family

string

サービスのハードウェアの世代が異なる場合は、同じ SKU に対して、ここでキャプチャできます。

name

string

SKU の名前 (通常は文字 + 番号コード、例: P3)。

size

string

特定の SKU のサイズ

tier

string

特定の SKU のレベルまたはエディション (Basic、Premium など)。

UserIdentity

リソースの Azure Active Directory ID 構成。

名前 説明
clientId

string

Azure Active Directory クライアント ID。

principalId

string

Azure Active Directory プリンシパル ID。