Managed Instances - Get

マネージド インスタンスを取得します。

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

URI パラメーター

Name In Required Type Description
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

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

応答

Name Type Description
200 OK

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

Other Status Codes

エラー応答: ***

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

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

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

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

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

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

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

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

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

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

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

  • 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

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-02-01-preview

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",
    "storageAccountType": "GRS"
  },
  "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

Sample Request

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

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",
    "storageAccountType": "GRS",
    "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

サーバー管理者の種類。

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 構成を作成します。

Sku

ARM リソース SKU。

StorageAccountType

このインスタンスのバックアップを格納するために使用されるストレージ アカウントの種類。 オプションは、LRS (LocallyRedundantStorage)、ZRS (ZoneRedundantStorage)、GRS (GeoRedundantStorage) です。

UserIdentity

Azure Active Directoryの ID 構成を作成します。

AdministratorType

サーバー管理者の種類。

Name Type Description
ActiveDirectory
  • string

IdentityType

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

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

ManagedInstance

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

Name Type Description
id
  • string

リソースの ID

identity

マネージド Azure Active Directory ID を指定します。

location
  • string

リソースの場所。

name
  • string

リソース名。

properties.administratorLogin
  • string

マネージド インスタンスの管理者ユーザー名。 マネージド インスタンスが作成されている場合にのみ指定できます (作成に必要です)。

properties.administratorLoginPassword
  • string

管理者ログイン パスワード (マネージド インスタンスの作成に必要)。

properties.administrators

サーバー Azure Active Directory管理者。

properties.collation
  • string

マネージド インスタンスの照合順序。

properties.dnsZone
  • string

マネージド インスタンスが含む Dns ゾーン。

properties.dnsZonePartner
  • string

作成後にこのマネージド インスタンスが共有する DNS ゾーンを持つ別のマネージド インスタンスのリソース ID。

properties.fullyQualifiedDomainName
  • string

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

properties.instancePoolId
  • string

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

properties.keyId
  • string

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

properties.licenseType

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

properties.maintenanceConfigurationId
  • string

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

properties.managedInstanceCreateMode

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

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

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

properties.minimalTlsVersion
  • string

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

properties.primaryUserAssignedIdentityId
  • string

既定で使用されるユーザー割り当て ID のリソース ID。

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.restorePointInTime
  • string

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

properties.sourceManagedInstanceId
  • string

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

properties.state
  • string

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

properties.storageAccountType

このインスタンスのバックアップを格納するために使用されるストレージ アカウントの種類。 オプションは、LRS (LocallyRedundantStorage)、ZRS (ZoneRedundantStorage)、GRS (GeoRedundantStorage) です。

properties.storageSizeInGB
  • integer

ストレージ サイズ (GB 単位)。 最小値: 32。 最大値: 8192。 32 GB の増分のみ許可されます。

properties.subnetId
  • string

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

properties.timezoneId
  • string

タイムゾーンの ID。 使用できる値は、Windows でサポートされているタイムゾーンです。 Windows では、id を含むサポートされているタイムゾーンの詳細が KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones の下のレジストリに保持されます。 これらのレジストリ値は、SELECT name AS SQL Server FROM クエリを実行して、timezone_idを使用sys.time_zone_info。 Id の一覧は、PowerShell で [System.TimeZoneInfo]::GetSystemTimeZones() を実行して取得できます。 有効なタイムゾーン ID の例として、"Pacific Standard Time" または "W" があります。 ヨーロッパ標準時"。

properties.vCores
  • integer

仮想コアの数。 使用できる値: 8、16、24、32、40、64、80。

properties.zoneRedundant
  • boolean

multi-az が有効かどうか。

sku

マネージド インスタンス SKU。 使用できる値: sku.name、GP_Gen4、GP_Gen5、BC_Gen4、BC_Gen5

tags
  • object

リソース タグ。

type
  • string

リソースの種類。

ManagedInstanceExternalAdministrator

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

Name Type Description
administratorType

サーバー管理者の種類。

azureADOnlyAuthentication
  • boolean

Azure Active Directory認証のみを有効にします。

login
  • string

サーバー管理者のログイン名。

principalType

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

sid
  • string

サーバー管理者の SID (オブジェクト ID)。

tenantId
  • string

管理者のテナント ID。

ManagedInstanceLicenseType

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

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

ManagedInstancePecProperty

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

Name Type Description
id
  • string

リソースの ID

properties

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

ManagedInstancePrivateEndpointConnectionProperties

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

Name Type Description
privateEndpoint

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

privateLinkServiceConnectionState

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

provisioningState
  • string

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

ManagedInstancePrivateEndpointProperty

Name Type Description
id
  • string

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

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の ID 構成を作成します。

Name Type Description
principalId
  • string

Azure Active Directory ID。

tenantId
  • string

テナントAzure Active Directory ID。

type

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

userAssignedIdentities

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

Sku

ARM リソース SKU。

Name Type Description
capacity
  • integer

特定の SKU の容量。

family
  • string

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

name
  • string

SKU の名前 (通常は文字 + 番号コード)(P3 など)。

size
  • string

特定の SKU のサイズ

tier
  • string

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

StorageAccountType

このインスタンスのバックアップを格納するために使用されるストレージ アカウントの種類。 オプションは、LRS (LocallyRedundantStorage)、ZRS (ZoneRedundantStorage)、GRS (GeoRedundantStorage) です。

Name Type Description
GRS
  • string
LRS
  • string
ZRS
  • string

UserIdentity

Azure Active Directoryの ID 構成を作成します。

Name Type Description
clientId
  • string

クライアントAzure Active Directory ID。

principalId
  • string

Azure Active Directory ID。