Managed Instances - Get

リファレンス

サービス:: SQL Database

API バージョン:: 2021-11-01

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

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 - サービス要求が許可されたタイムアウトを超えました。

名前

型

説明

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


import com.azure.core.util.Context;

/** Samples for ManagedInstances GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceGet.json
     */
    /**
     * Sample code: Get managed instance.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getManagedInstance(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().getByResourceGroupWithResponse("testrg",
            "testinstance", null, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

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

要求のサンプル

HTTP
Java

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


import com.azure.core.util.Context;

/** Samples for ManagedInstances GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceGetWithExpandEqualsAdministrators.json
     */
    /**
     * Sample code: Get managed instance with $expand=administrators/activedirectory.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getManagedInstanceWithExpandAdministratorsActivedirectory(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().getByResourceGroupWithResponse("testrg",
            "testinstance", null, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

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