Managed Instances - Stop

リファレンス

Service:: SQL Database

API Version:: 2023-08-01-preview

マネージドインスタンスを停止します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/stop?api-version=2023-08-01-preview

URI パラメーター

名前	/	必須	型	説明
managedInstanceName	path	True	string	マネージドインスタンスの名前。
resourceGroupName	path	True	string	リソースが含まれているリソースグループの名前。この値は、Azure リソースマネージャー API またはポータルから取得できます。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

応答

名前	型	説明
200 OK	ManagedInstance	マネージドインスタンスを正常に停止しました。
202 Accepted		マネージドインスタンスの停止が進行中です。
Other Status Codes	ErrorResponse	エラー応答: *** 400 ManagementServiceStopManagedInstanceZoneRedundant - ゾーン冗長が有効になっているインスタンスで実行を停止します。 400 ManagementServiceStopManagedInstancePartOfFailoverGroup - フェールオーバーグループの一部であるインスタンスで実行を停止します。 400 NameAlreadyExists - 指定された名前は既に存在します。 400 ManagementServiceStartStopManagedInstanceSubscriptionNotEnabledForFeature - ユーザーは、適切なサブスクリプション機能のサブスクリプション許可リストを持たずに、Start/Stop 機能を使用しようとしました。 400 ManagementServiceStopManagedInstanceNotSupportedOnSKU - 停止操作は、指定された SKU でサポートされていません。 400 InvalidServerName - 指定されたサーバー名が無効です。 400 StartStopOfManagedInstanceIsDisabled - マネージドインスタンスでの開始操作と停止操作が有効になっていません。 400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。 400 ManagementServiceStopManagedInstanceUsingMILink - Managed Instanceリンクが構成されているインスタンスで実行を停止します。 400 ManagementServiceStopManagedInstanceFeatureDisabled - ユーザーが stop Azure SQL Managed Instance機能を使用しようとしましたが、これは無効になっています。 400 ManagementServiceStopManagedInstanceHostedOnRdfePlatform - Feature Wave 2022 年 11 月に実行されていないインスタンスで実行を停止する 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 OperationIdNotFound - Id を持つ操作が存在しません。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。 404 OperationIdNotFound - Id を持つ操作が存在しません。 409 ManagementServiceStopManagedInstanceAlreadyInProgress - 停止/停止状態の操作に対して送信された停止操作。 409 ManagementServiceStopManagedInstanceConflictingOperation - 競合している操作メッセージAzure SQL Managed Instance停止します。 409 ManagementServiceStopManagedInstanceDroppedDuringStop - その間に削除中の状態または削除されたインスタンスで実行を停止します。 409 SubscriptionDisabled - サブスクリプションが無効になっています。 409 CannotCancelOperation - 管理操作は取り消すことができない状態です。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作をやり直してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

名前

型

説明

200 OK

ManagedInstance

マネージドインスタンスを正常に停止しました。

202 Accepted

マネージドインスタンスの停止が進行中です。

Other Status Codes

ErrorResponse

エラー応答: ***

400 ManagementServiceStopManagedInstanceZoneRedundant - ゾーン冗長が有効になっているインスタンスで実行を停止します。
400 ManagementServiceStopManagedInstancePartOfFailoverGroup - フェールオーバーグループの一部であるインスタンスで実行を停止します。
400 NameAlreadyExists - 指定された名前は既に存在します。
400 ManagementServiceStartStopManagedInstanceSubscriptionNotEnabledForFeature - ユーザーは、適切なサブスクリプション機能のサブスクリプション許可リストを持たずに、Start/Stop 機能を使用しようとしました。
400 ManagementServiceStopManagedInstanceNotSupportedOnSKU - 停止操作は、指定された SKU でサポートされていません。
400 InvalidServerName - 指定されたサーバー名が無効です。
400 StartStopOfManagedInstanceIsDisabled - マネージドインスタンスでの開始操作と停止操作が有効になっていません。
400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。
400 ManagementServiceStopManagedInstanceUsingMILink - Managed Instanceリンクが構成されているインスタンスで実行を停止します。
400 ManagementServiceStopManagedInstanceFeatureDisabled - ユーザーが stop Azure SQL Managed Instance機能を使用しようとしましたが、これは無効になっています。
400 ManagementServiceStopManagedInstanceHostedOnRdfePlatform - Feature Wave 2022 年 11 月に実行されていないインスタンスで実行を停止する
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 OperationIdNotFound - Id を持つ操作が存在しません。
404 ResourceNotFound - 要求されたリソースが見つかりませんでした。
404 OperationIdNotFound - Id を持つ操作が存在しません。
409 ManagementServiceStopManagedInstanceAlreadyInProgress - 停止/停止状態の操作に対して送信された停止操作。
409 ManagementServiceStopManagedInstanceConflictingOperation - 競合している操作メッセージAzure SQL Managed Instance停止します。
409 ManagementServiceStopManagedInstanceDroppedDuringStop - その間に削除中の状態または削除されたインスタンスで実行を停止します。
409 SubscriptionDisabled - サブスクリプションが無効になっています。
409 CannotCancelOperation - 管理操作は取り消すことができない状態です。
409 OperationCancelled - 操作がユーザーによって取り消されました。
409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。
429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。
429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作をやり直してください。
503 TooManyRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

例

Stops the managed instance.

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/managedInstances/mitostop/stop?api-version=2023-08-01-preview

Sample Response

Status code:: 200

{
  "sku": {
    "name": "GP_Gen5",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen5"
  },
  "properties": {
    "fullyQualifiedDomainName": "mitostop.1234567891234.database.windows.net",
    "administratorLogin": "dummylogin",
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "state": "Stopped",
    "provisioningState": "Succeeded",
    "vCores": 8,
    "storageSizeInGB": 1024,
    "licenseType": "LicenseIncluded",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "publicDataEndpointEnabled": false,
    "proxyOverride": "Default",
    "minimalTlsVersion": "1.2",
    "dnsZone": "1234567891234",
    "instancePoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/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"
    },
    "externalGovernanceStatus": "Enabled",
    "hybridSecondaryUsage": "Passive",
    "authenticationMetadata": "Windows",
    "databaseFormat": "SQLServer2022"
  },
  "location": "japaneast",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/managedInstances/mitostop",
  "name": "mitostop",
  "type": "Microsoft.Sql/managedInstances"
}

Status code:: 202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/locations/westeurope/stopManagedInstanceOperationResults/11111111-1111-1111-1111-111111111111
Azure-AsyncOperation: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/locations/westeurope/stopManagedInstanceAzureAsyncOperation/11111111-1111-1111-1111-111111111111

定義

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

AdministratorType

管理者の種類。

名前	型	説明
ActiveDirectory	string

AuthMetadataLookupModes

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

名前	型	説明
AzureAD	string
Paired	string
Windows	string

BackupStorageRedundancy

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

名前	型	説明
Geo	string
GeoZone	string
Local	string
Zone	string

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

ExternalGovernanceStatus

外部ガバナンスの状態。

名前	型	説明
Disabled	string
Enabled	string

FreemiumType

天気かManaged Instanceはフリーミアムです。

名前	型	説明
Freemium	string
Regular	string

HybridSecondaryUsage

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

名前	型	説明
Active	string
Passive	string

HybridSecondaryUsageDetected

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

名前	型	説明
Active	string
Passive	string

IdentityType

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

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string