Managed Instances - Create Or Update

サービス:: SQL Database

API バージョン:: 2025-01-01

マネージドインスタンスを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}?api-version=2025-01-01

URI パラメーター

名前	/	必須	型	説明
managedInstanceName	path	True	string	マネージドインスタンスの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前の大文字と小文字は区別されません。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
location	True	string	リソースが存在する地理的な場所
identity		ResourceIdentity	管理されたインスタンスのAzure Active Directory IDです。
properties.administratorLogin		string	マネージドインスタンスの管理者ユーザー名。マネージドインスタンスの作成時にのみ指定できます (作成に必要です)。
properties.administratorLoginPassword		string (password)	管理者ログインパスワード (マネージドインスタンスの作成に必要)。
properties.administrators		ManagedInstanceExternalAdministrator	Azure Active Directory管理者は、instanceの作成やインスタンスの更新時に利用できますが、azureADOnlyAuthentication プロパティは例外です。 azureADOnlyAuthentication プロパティを更新するには、個々の API を使用する必要があります。
properties.authenticationMetadata		AuthMetadataLookupModes	マネージドインスタンスの認証メタデータ参照モード。
properties.collation		string	マネージドインスタンスの照合順序。
properties.databaseFormat		ManagedInstanceDatabaseFormat	SQL エンジンのバージョンに固有のインスタンスデータベースの内部形式を指定します。
properties.dnsZonePartner		string (arm-id)	このマネージドインスタンスが作成後に共有する DNS ゾーンを持つ別のマネージドインスタンスのリソース ID。
properties.hybridSecondaryUsage		HybridSecondaryUsage	ハイブリッドセカンダリの使用。指定できる値は、"アクティブ" (既定値) と "パッシブ" です (お客様はセカンダリをパッシブ DR として使用します)。
properties.instancePoolId		string	このマネージドサーバーが属しているインスタンスプールの ID。
properties.isGeneralPurposeV2		boolean	これが General Purpose エディションの GPv2 バリアントであるかどうか。
properties.keyId		string	暗号化に使用するキーの CMK URI。
properties.licenseType		ManagedInstanceLicenseType	ライセンスの種類。指定できる値は、'LicenseIncluded' (新しい SQL ライセンスを含む通常価格) と 'BasePrice' (独自の SQL ライセンスを持ち込む場合の AHB 価格の割引) です。
properties.maintenanceConfigurationId		string	このマネージドインスタンスに適用するメンテナンス構成 ID を指定します。
properties.managedInstanceCreateMode		ManagedServerCreateMode	データベースの作成モードを指定します。既定値: 通常のインスタンスの作成。復元: 特定の時点に一連のバックアップを復元してインスタンスを作成します。 RestorePointInTime と SourceManagedInstanceId を指定する必要があります。
properties.memorySizeInGB		integer (int32)	メモリサイズ(GB)。最小値: 28。最大値: 870。最小値と最大値は、仮想コアの数とサービスレベルによって異なります。リソース制限の詳細については、 https://aka.ms/mi-resource-limits-apiを参照してください。
properties.minimalTlsVersion		string	最小 TLS バージョン。使用できる値: 'None'、'1.0'、'1.1'、'1.2'
properties.pricingModel		PricingModel	Managed Instanceの価格モデル。
properties.primaryUserAssignedIdentityId		string (arm-id)	既定で使用されるユーザー割り当て ID のリソース ID。
properties.proxyOverride		ManagedInstanceProxyOverride	インスタンスへの接続に使用される接続の種類。
properties.publicDataEndpointEnabled		boolean	パブリックデータエンドポイントが有効かどうか。
properties.requestedBackupStorageRedundancy		BackupStorageRedundancy	このインスタンスのバックアップを格納するために使用するストレージアカウントの種類。オプションは、Local (LocallyRedundantStorage)、Zone (ZoneRedundantStorage)、Geo (GeoRedundantStorage)、GeoZone(GeoZoneRedundantStorage) です。
properties.requestedLogicalAvailabilityZone		AvailabilityZoneType	Managed Instanceがピン留めされている論理的可用性ゾーンを指定します。
properties.restorePointInTime		string (date-time)	新しいデータベースを作成するために復元されるソースデータベースの時点 (ISO8601形式) を指定します。
properties.servicePrincipal		ServicePrincipal	マネージドインスタンスのサービスプリンシパル。
properties.sourceManagedInstanceId		string (arm-id)	このインスタンスの作成操作に関連付けられているソースマネージドインスタンスのリソース識別子。
properties.storageIOps		integer (int32)	ストレージ IOps。最小値: 300。最大値: 80000。 1 つの IOps のみをインクリメントできます。最大値は、選択したハードウェアファミリと仮想コアの数によって異なります。
properties.storageSizeInGB		integer (int32)	ストレージサイズ (GB)。最小値: 32。最大値: 32768。 32 GB の増分のみが許可されます。最大値は、選択したハードウェアファミリと仮想コアの数によって異なります。
properties.storageThroughputMBps		integer (int32)	ストレージスループット MBps パラメーターは、インスタンスの作成/更新操作ではサポートされていません。
properties.subnetId		string (arm-id)	マネージドインスタンスのサブネットリソース ID。
properties.timezoneId		string	タイムゾーンの ID。許可された値はWindowsでサポートされているタイムゾーンです。 Windowsは、KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zonesのレジストリに、IDを含むサポートタイムゾーンの詳細を保持しています。 SELECT nameをtimezone_id FROM sys.time_zone_infoでクエリすることで、SQL Serverでレジストリ値を取得できます。 Id の一覧は、PowerShell で [System.TimeZoneInfo]::GetSystemTimeZones() を実行して取得することもできます。有効なタイムゾーン ID の例として、"Pacific Standard Time" または "W" があります。ヨーロッパ標準時"。
properties.vCores		integer (int32)	仮想コアの数。使用できる値: 4、6、8、10、12、16、20、24、32、40、48、56、64、80、96、128。サポートされている仮想コアは、選択したハードウェアファミリとサービスレベルによって異なります。
properties.zoneRedundant		boolean	ゾーン冗長性が有効になっているかどうか。
sku		Sku	マネージドインスタンス SKU。 sku.name に使用できる値: GP_Gen5 (汎用、標準シリーズ);GP_G8IM (汎用、プレミアムシリーズ);GP_G8IH (汎用、プレミアムシリーズメモリ最適化);BC_Gen5 (ビジネスクリティカル、Standard-Series);BC_G8IM (ビジネスクリティカル、プレミアムシリーズ);BC_G8IH (Business Critical、Premium シリーズのメモリ最適化)。
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	ManagedInstance	リソース「ManagedInstance」更新操作が成功しました
201 Created	ManagedInstance	リソース「ManagedInstance」作成操作が成功しましたヘッダー Location: string Retry-After: integer
202 Accepted		リソース操作が受け入れられます。ヘッダー Location: string Retry-After: integer
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Create managed instance with all properties

Create managed instance with minimal properties

Create managed instance with all properties

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2025-01-01

{
  "location": "Japan East",
  "properties": {
    "administratorLogin": "dummylogin",
    "administratorLoginPassword": "PLACEHOLDER",
    "administrators": {
      "azureADOnlyAuthentication": true,
      "login": "bob@contoso.com",
      "principalType": "User",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111"
    },
    "authenticationMetadata": "AzureAD",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "databaseFormat": "AlwaysUpToDate",
    "dnsZonePartner": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
    "hybridSecondaryUsage": "Passive",
    "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1",
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "minimalTlsVersion": "1.2",
    "proxyOverride": "Redirect",
    "publicDataEndpointEnabled": false,
    "requestedBackupStorageRedundancy": "Geo",
    "requestedLogicalAvailabilityZone": "1",
    "servicePrincipal": {
      "type": "SystemAssigned"
    },
    "storageSizeInGB": 1024,
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "timezoneId": "UTC",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "tier": "GeneralPurpose"
  },
  "tags": {
    "tagKey1": "TagValue1"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances",
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "location": "japaneast",
  "properties": {
    "administratorLogin": "dummylogin",
    "administrators": {
      "azureADOnlyAuthentication": true,
      "login": "bob@contoso.com",
      "principalType": "User",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111"
    },
    "authenticationMetadata": "AzureAD",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "currentBackupStorageRedundancy": "Geo",
    "databaseFormat": "AlwaysUpToDate",
    "dnsZone": "1b4e2caff2530",
    "externalGovernanceStatus": "Enabled",
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "hybridSecondaryUsage": "Passive",
    "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1",
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "minimalTlsVersion": "1.2",
    "provisioningState": "Creating",
    "proxyOverride": "Redirect",
    "publicDataEndpointEnabled": false,
    "requestedBackupStorageRedundancy": "Geo",
    "requestedLogicalAvailabilityZone": "1",
    "servicePrincipal": {
      "type": "SystemAssigned",
      "clientId": "00000011-1111-2222-2222-123456789111",
      "principalId": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111"
    },
    "state": "Ready",
    "storageSizeInGB": 1024,
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "timezoneId": "UTC",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "capacity": 8,
    "family": "Gen5",
    "tier": "GeneralPurpose"
  },
  "tags": {
    "tagKey1": "TagValue1"
  }
}

状態コード:: 201

{
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances",
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "location": "japaneast",
  "properties": {
    "administratorLogin": "dummylogin",
    "administrators": {
      "azureADOnlyAuthentication": true,
      "login": "bob@contoso.com",
      "principalType": "User",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111"
    },
    "authenticationMetadata": "AzureAD",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "currentBackupStorageRedundancy": "Geo",
    "databaseFormat": "AlwaysUpToDate",
    "dnsZone": "1b4e2caff2530",
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "hybridSecondaryUsage": "Passive",
    "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/pool1",
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "minimalTlsVersion": "1.2",
    "provisioningState": "Creating",
    "proxyOverride": "Redirect",
    "publicDataEndpointEnabled": false,
    "requestedBackupStorageRedundancy": "Geo",
    "requestedLogicalAvailabilityZone": "1",
    "servicePrincipal": {
      "type": "SystemAssigned",
      "clientId": "00000011-1111-2222-2222-123456789111",
      "principalId": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111"
    },
    "state": "Ready",
    "storageSizeInGB": 1024,
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "timezoneId": "UTC",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "capacity": 8,
    "family": "Gen5",
    "tier": "GeneralPurpose"
  },
  "tags": {
    "tagKey1": "TagValue1"
  }
}

状態コード:: 202

Create managed instance with minimal properties

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2025-01-01

{
  "location": "Japan East",
  "properties": {
    "administratorLogin": "dummylogin",
    "administratorLoginPassword": "PLACEHOLDER",
    "licenseType": "LicenseIncluded",
    "storageSizeInGB": 1024,
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "tier": "GeneralPurpose"
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances",
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "location": "japaneast",
  "properties": {
    "administratorLogin": "dummylogin",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "currentBackupStorageRedundancy": "Geo",
    "databaseFormat": "SQLServer2022",
    "dnsZone": "1b4e2caff2530",
    "externalGovernanceStatus": "Enabled",
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "hybridSecondaryUsage": "Passive",
    "licenseType": "LicenseIncluded",
    "provisioningState": "Creating",
    "proxyOverride": "Redirect",
    "publicDataEndpointEnabled": false,
    "requestedBackupStorageRedundancy": "Geo",
    "state": "Ready",
    "storageSizeInGB": 1024,
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "capacity": 8,
    "family": "Gen4",
    "tier": "GeneralPurpose"
  },
  "tags": {}
}

状態コード:: 201

{
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances",
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "location": "japaneast",
  "properties": {
    "administratorLogin": "dummylogin",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "currentBackupStorageRedundancy": "Geo",
    "databaseFormat": "SQLServer2022",
    "dnsZone": "1b4e2caff2530",
    "externalGovernanceStatus": "Enabled",
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "hybridSecondaryUsage": "Passive",
    "licenseType": "LicenseIncluded",
    "provisioningState": "Creating",
    "proxyOverride": "Redirect",
    "publicDataEndpointEnabled": false,
    "requestedBackupStorageRedundancy": "Geo",
    "state": "Ready",
    "storageSizeInGB": 1024,
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "vCores": 8
  },
  "sku": {
    "name": "GP_Gen5",
    "capacity": 8,
    "family": "Gen4",
    "tier": "GeneralPurpose"
  },
  "tags": {}
}

状態コード:: 202

定義

名前	説明
AdministratorType	管理者の種類。
AuthMetadataLookupModes	マネージドインスタンスの認証メタデータ参照モード。
AvailabilityZoneType	データベースがピン留めされる可用性ゾーンを指定します。
BackupStorageRedundancy	このデータベースのバックアップを格納するために使用されるストレージアカウントの種類。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ExternalGovernanceStatus	外部ガバナンスの状態。
HybridSecondaryUsage	ハイブリッドセカンダリの使用。指定できる値は、"アクティブ" (既定値) と "パッシブ" です (お客様はセカンダリをパッシブ DR として使用します)。
HybridSecondaryUsageDetected	ハイブリッドセカンダリの使用が検出されました。使用可能な値は、"アクティブ" (お客様はセカンダリをパッシブ DR として使用する要件を満たしていません) と "パッシブ" です (お客様は、セカンダリをパッシブ DR として使用する要件を満たしています)。
IdentityType	ID の種類。これを「SystemAssigned」に設定すると、リソースの Azure Active Directory プリンシパルを自動的に作成・割り当てできます。
ManagedInstance	An Azure SQL managed instance.
ManagedInstanceDatabaseFormat	SQL エンジンのバージョンに固有のインスタンスデータベースの内部形式を指定します。
ManagedInstanceExternalAdministrator	Active Directory 管理者のプロパティ。
ManagedInstanceLicenseType	ライセンスの種類。指定できる値は、'LicenseIncluded' (新しい SQL ライセンスを含む通常価格) と 'BasePrice' (独自の SQL ライセンスを持ち込む場合の AHB 価格の割引) です。
ManagedInstancePecProperty	マネージドインスタンスでのプライベートエンドポイント接続
ManagedInstancePrivateEndpointConnectionProperties	プライベートエンドポイント接続のプロパティ。
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	インスタンスへの接続に使用される接続の種類。
ManagedServerCreateMode	データベースの作成モードを指定します。既定値: 通常のインスタンスの作成。復元: 特定の時点に一連のバックアップを復元してインスタンスを作成します。 RestorePointInTime と SourceManagedInstanceId を指定する必要があります。
PricingModel	Managed Instanceの価格モデル。
PrincipalType	サーバー管理者のプリンシパルの種類。
ProvisioningState	ジョブ実行の ARM プロビジョニング状態。
ResourceIdentity	Azure Active Directory identity configuration for a resource.
ServicePrincipal	リソースのマネージドインスタンスのサービスプリンシパル構成。
ServicePrincipalType	サービスプリンシパルの種類。
Sku	ARM リソース SKU。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserIdentity	Azure Active Directory identity configuration for a resource.

AdministratorType

列挙

管理者の種類。

値	説明
ActiveDirectory	アクティブディレクトリ

AuthMetadataLookupModes

列挙

マネージドインスタンスの認証メタデータ参照モード。

値	説明
AzureAD	AzureAD
Paired	対をなすデータの t 検定
Windows	Windows

AvailabilityZoneType

列挙

データベースがピン留めされる可用性ゾーンを指定します。

値	説明
NoPreference	ノープリファレンス
1	1
2	2
3	3

BackupStorageRedundancy

列挙

このデータベースのバックアップを格納するために使用されるストレージアカウントの種類。

値	説明
Geo	ジオ
Local	ローカル
Zone	ゾーン
GeoZone	GeoZone

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ExternalGovernanceStatus

列挙

外部ガバナンスの状態。

値	説明
Enabled	有効
Disabled	Disabled

HybridSecondaryUsage

列挙

ハイブリッドセカンダリの使用。指定できる値は、"アクティブ" (既定値) と "パッシブ" です (お客様はセカンダリをパッシブ DR として使用します)。

値	説明
Active	アクティブ
Passive	Passive

HybridSecondaryUsageDetected

列挙

ハイブリッドセカンダリの使用が検出されました。使用可能な値は、"アクティブ" (お客様はセカンダリをパッシブ DR として使用する要件を満たしていません) と "パッシブ" です (お客様は、セカンダリをパッシブ DR として使用する要件を満たしています)。

値	説明
Active	アクティブ
Passive	Passive

IdentityType

列挙

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

値	説明
None	なし
SystemAssigned	システム割り当て
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SystemAssigned, UserAssigned