Databases - Update

既存のデータベースを更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?api-version=2021-08-01-preview

URI パラメーター

Name In Required Type Description
databaseName
path True
  • string

データベースの名前。

resourceGroupName
path True
  • string

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

serverName
path True
  • string

サーバーの名前。

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

要求本文

Name Type Description
identity

データベース ID

properties.autoPauseDelay
  • integer

データベースが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します

properties.catalogCollation

メタデータ カタログの照合順序。

properties.collation
  • string

データベースの照合順序。

properties.createMode

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

既定値: 通常のデータベース作成。

コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソース データベースのリソース ID として指定する必要があります。

セカンダリ: 既存のデータベースのセカンダリ レプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリ データベースのリソース ID として指定する必要があります。

PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。

復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベース リソース ID として指定する必要があります。

復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID の場合は、sourceDatabaseDeletionDate を指定する必要があります。 それ以外の場合、sourceDatabaseId は復元可能な削除されたデータベース リソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。

RestoreLongTermRetentionBackup: 長期保持コンテナーから復元してデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。

DataWarehouse エディションでは、コピー、セカンダリ、および RestoreLongTermRetentionBackup はサポートされていません。

properties.elasticPoolId
  • string

このデータベースを含むエラスティック プールのリソース識別子。

properties.federatedClientId
  • string

データベース CMK ごとのテナント間のシナリオに使用されるクライアント ID

properties.highAvailabilityReplicaCount
  • integer

高可用性を提供するために使用されるデータベースに関連付けられているセカンダリ レプリカの数。 エラスティック プール内の Hyperscale データベースには適用されません。

properties.isLedgerOn
  • boolean

このデータベースが台帳データベースであるかどうかは、データベース内のすべてのテーブルが台帳テーブルであることを意味します。 注: データベースの作成後に、このプロパティの値を変更することはできません。

properties.licenseType

このデータベースに適用するライセンスの種類。 LicenseIncludedライセンスが必要な場合、またはBasePriceライセンスをお持ちで、Azure ハイブリッド特典の資格がある場合。

properties.longTermRetentionBackupResourceId
  • string

このデータベースの作成操作に関連付けられている長期保有バックアップのリソース識別子。

properties.maintenanceConfigurationId
  • string

データベースに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンスの更新が行われる期間を定義します。

properties.maxSizeBytes
  • integer

バイト単位で表されるデータベースの最大サイズ。

properties.minCapacity
  • number

データベースが常に割り当てる最小容量 (一時停止されていない場合)

properties.readScale

読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョン内の読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。

properties.recoverableDatabaseId
  • string

このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。

properties.recoveryServicesRecoveryPointId
  • string

このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。

properties.requestedBackupStorageRedundancy

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

properties.restorableDroppedDatabaseId
  • string

このデータベースの作成操作に関連付けられた、復元可能な削除されたデータベースのリソース識別子。

properties.restorePointInTime
  • string

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

properties.sampleName

このデータベースの作成時に適用するサンプル スキーマの名前。

properties.secondaryType

データベースがセカンダリの場合は、データベースのセカンダリ の種類。 有効な値は Geo と Named です。

properties.sourceDatabaseDeletionDate
  • string

データベースが削除された時刻を指定します。

properties.sourceDatabaseId
  • string

このデータベースの作成操作に関連付けられているソース データベースのリソース識別子。

properties.zoneRedundant
  • boolean

このデータベースがゾーン冗長であるかどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。

sku

SKU の名前と階層。

tags
  • object

リソース タグ。

応答

Name Type Description
200 OK

データベースが正常に更新されました。

202 Accepted

データベースの更新が進行中です。

Other Status Codes

エラー応答: ***

  • 400 InvalidDatabaseCreateOrUpdateRequest - データベースの作成または更新操作の要求本文が無効です。

  • 400 InvalidResourceId - リソース識別子が無効です。

  • 400 InvalidSourceDatabaseId - ソース データベース識別子が無効です。

  • 400 MismatchingResourceGroupNameWithUrl - 指定されたリソース グループ名が URL 内の名前と一致しませんでした。

  • 400 MismatchingServerNameWithUrl - 指定されたサーバー名が URL 内の名前と一致しませんでした。

  • 400 MismatchingSubscriptionWithUrl - 指定されたサブスクリプションが URL のサブスクリプションと一致しませんでした。

  • 400 MissingCollation - 照合順序が必要です。

  • 400 MissingMaxSizeBytes - MaxSizeBytes が必要です。

  • 400 MissingSkuName - SKU 名が必要です。

  • 400 MissingSourceDatabaseId - ソース データベース識別子がありません。

  • 400 InvalidLicenseType - 指定されたライセンスの種類が無効です。

  • 400 InvalidSkuName - SKU 名が無効です。

  • 400 MismatchedSkuNameAndCapacity - SKU 名と容量の不一致。

  • 400 MismatchedSkuNameAndTier - SKU 名とレベルが一致しません。

  • 400 MismatchedSkuNameAndFamily - SKU 名とファミリの間の不一致。

  • 400 LedgerNotAllowedWithSpecifiedCreateMode - IsLedgerOn は、指定した作成モードでは許可されません。

  • 400 LedgerNotAllowedOnSampleDatabase - サンプル データベースに対して IsLedgerOn でデータベースを作成することはできません。

  • 400 DatabaseNameDoesNotMatchSourceDatabaseId - 指定されたデータベース名が sourceDatabaseId のデータベース名と一致しません。

  • 400 ElasticPoolNotSupportedForExternalBackupRestore - エラスティック プールは外部バックアップ復元ではサポートされていません

  • 400 InvalidRecoverableDatabaseId - 回復可能なデータベース識別子が無効です。

  • 400 InvalidRecoveryServicesRecoveryPointId - 無効な復旧サービスの復旧ポイント識別子。

  • 400 InvalidRestorableDroppedDatabaseDeletionDate - 指定された復元可能な削除されたデータベースの削除日が無効です

  • 400 InvalidRestorableDroppedDatabaseId - 復元可能な破棄されたデータベース識別子が無効です

  • 400 MissingRecoverableDatabaseId - 回復可能なデータベース識別子がありません。

  • 400 MissingRecoveryServicesRecoveryPointId - Recovery Services 復旧ポイント ID がありません。

  • 400 MissingRestorableDroppedDatabaseId - RestorableDroppedDatabaseId が見つかりません

  • 400 MissingRestorePointInTime - 復元ポイントが見つかりません

  • 400 MissingSourceDatabaseDeletionDate - ソース データベースの削除日がありません

  • 400 MissingStorageContainerSasToken - ストレージ コンテナー SAS トークンがありません

  • 400 MissingStorageContainerUri - ストレージ コンテナー URI がありません

  • 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - sourceDatabaseId が復元作成モードで既に指定されている場合、restorableDroppedDatabaseId を指定できません

  • 400 MultipleIdentitiesOnDatabase - データベース レベルでは、ユーザー割り当てマネージド ID が 1 つだけサポートされます。

  • 400 MultipleIdentityDelegationsOnDatabase - データベース レベルでサポートされる ID 委任は 1 つだけです。

  • 400 MissingPrimaryDelegatedIdentityClientId - 委任された ID を使用するには、プライマリ委任 ID クライアント ID を指定してください。

  • 400 LongTermRetentionMigrationRequestNotSupported - サブスクリプションは LTR バックアップ移行機能を許可されていません。

  • 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - ソース サブスクリプションとターゲット サブスクリプションは、LTR バックアップ コピー機能の通信を許可されていません。

  • 400 LongTermRetentionMigrationParameterMissing - 操作に必須のパラメーターがありません。

  • 400 LongTermRetentionMigrationSameServerNotSupported - LTR コピー機能は、同じサーバー内の LTR バックアップをコピーするためにサポートされていません。

  • 400 LongTermRetentionMigrationTargetServerNotFound - ターゲット サーバーが存在しないか、LTR バックアップ コピー操作の準備ができていません。

  • 400 LongTermRetentionMigrationTargetDatabaseNotFound - ターゲット データベースがサーバーに存在しません。

  • 400 LongTermRetentionMigrationStorageTypeNotSupported - ターゲット リージョンでは、指定されたBackup Storage冗長性はサポートされていません。

  • 400 LongTermRetentionMigrationStorageMismatch - データベースのアクティブ バックアップ冗長性が、お客様が要求したバックアップ冗長性と一致しません。

  • 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR 移行は、マネージド インスタンスと Azure SQL DB LTR バックアップでのみサポートされます。

  • 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - LTR コピー操作でバックアップ ストレージの冗長性を変更することはできません。

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

  • 400 InvalidCollation - 照合順序がサーバーによって認識されません。

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

  • 400 CannotUpdateIsLedgerDatabase - 既存のデータベースの台帳プロパティを更新できません。

  • 400 UnableToResolveRemoteServer - 無効なサーバー名または DNS 接続の問題により、リモート パートナー サーバー名を解決できませんでした。

  • 400 ElasticPoolOverStorageUsage - エラスティック プールのストレージ制限に達したときにデータベースにデータを書き込もうとします。

  • 400 RemoteDatabaseCopyPermission - 指定されたサーバーにデータベース コピーを作成するための十分な権限がありません。

  • 400 UpdateNotAllowedInCurrentReplicationState - 現在のレプリケーション状態のデータベースで操作が許可されていません。

  • 400 SourceDatabaseNotFound - ソース データベースが存在しません。

  • 400 InvalidPublicMaintenanceConfiguration - ユーザーは、内部 ID (形式が正しくないリージョンまたは間違ったリージョン) に変換できないパブリック メンテナンス構成を指定しようとしました。

  • 400 GeoReplicaLimitReached - レプリカごとのレプリケーション制限に達しました。

  • 400 MaintenanceWindowNotSupportedForNamedReplica - ユーザーは、サポートされていない既定以外のメンテナンス期間で名前付きレプリカを作成または更新しようとしました。

  • 400 ReplicationSourceAndTargetMustHaveSameName - レプリケーション ソース データベースとターゲット データベースの名前は同じである必要があります。

  • 400 ReplicationSourceAndTargetMustBeInDifferentServers - レプリケーションソースデータベースとターゲットデータベースは、異なる論理サーバーに存在する必要があります。

  • 400 ChangeUnsupportedOnEntity - ユーザーが特定のエンティティに対してサポートされていない作成/更新/削除操作を試行しました。

  • 400 TierChangeUnsupportedDueToCDCEnabledDatabase - CDC に対して有効になっているため、データベースは SKU を更新できません。

  • 400 PartnerDBNotCompatibleForSGXEnclave - エンクレーブ対応データベースの GeoDR リンクの設定または SLO の更新の試行は、両方のデータベースが DC シリーズ ハードウェアで実行されている場合にのみサポートされます。

  • 400 TierChangeUnsupportedDueToMemoryOptimizedObject - データベースにはメモリ最適化オブジェクトがあるため、その SKU を更新できません。

  • 400 SourceServerNotFound - CreateDatabaseAsCopy API 呼び出しで指定されたソース データベース ID のサーバー部分は、既存のサーバーにマップされません。

  • 400 InvalidDatabaseCreateMode - データベースを作成するための要求が無効です。

  • 400 MissingAsymmetricKeyOnTargetServer - ターゲット サーバーは非対称キーにアクセスできません。

  • 400 MismatchingSubscriptionWithUrl - 指定されたサブスクリプションが URL のサブスクリプションと一致しませんでした。

  • 400 InvalidAddSecondaryPermission - 指定されたサーバーにセカンダリを追加するための十分なアクセス許可がありません。

  • 400 UnsupportedServiceName - 1 つ以上のサポートされていない Unicode 文字が含まれているため、指定された名前は無効な名前です。

  • 400 CurrentDatabaseLogSizeExceedsMaxSize - ユーザーは、現在の使用状況よりも最大ログ サイズが小さい SKU にデータベースを変更しようとしました。

  • 400 TokenTooLong - 指定されたトークンが長すぎます。

  • 400 IsLedgerDatabaseIsNotSupportedOnResourceType - 台帳プロパティの変更は、このリソースの種類ではサポートされていません。

  • 400 InvalidSku - ユーザーが無効な SKU を指定しました。

  • 400 InvalidTierSkuCombination - 指定されたレベルは、指定された SKU をサポートしていません。

  • 400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベース エディションで無効になっている機能を使用しようとしました。

  • 400 OfferDisabledOnSubscription - サブスクリプション オファーの種類は、要求されたリソースのプロビジョニングから制限されます。

  • 400 InvalidTargetSubregion - 読み取り不可能なセカンダリのターゲット サーバーが DR ペアの Azure リージョンにありません。

  • 400 UnableToCreateGeoChain - 台帳ダイジェストの自動アップロードが構成されていても、ユーザーがセカンダリ データベース (チェーン) を作成しようとしました

  • 400 PartnerServerNotCompatible - ユーザーが SAWA V1 サーバーから Sterling サーバーにデータベースをコピーしようとしています。その逆も同様です。

  • 400 IncorrectReplicationLinkState - この操作では、データベースがレプリケーション リンクで予期される状態であることが想定されます。

  • 400 TargetElasticPoolDoesNotExist - エラスティック プールがサーバーに存在しません。

  • 400 CurrentDatabaseSizeExceedsMaxSize - ユーザーは、データベースの最大サイズを現在の使用量より小さいサイズに縮小しようとしました。

  • 400 ElasticPoolSkuCombinationInvalid - エラスティック プールと SKU は、sku が 'ElasticPool' として指定されている場合にのみ一緒に指定できます。

  • 400 ElasticPoolTierCombinationInvalid - データベース層はエラスティック プールサービスレベルとは異なります。

  • 400 ElasticPoolNameRequired - ユーザーは、エラスティック プールの名前を指定せずに、エラスティック プール サービス目標にデータベースを作成または更新しようとしました。

  • 400 AzureKeyVaultKeyDisabled - Azure Key Vault キーが無効になっているため、サーバーで操作を完了できませんでした。

  • 400 AzureKeyVaultInvalidExpirationDate - Azure Key Vault キーの有効期限が無効であるため、操作を完了できませんでした。

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty - Azure Key Vault Uri が null または空であるため、操作を完了できませんでした。

  • 400 AzureKeyVaultNoServerIdentity - サーバー ID が正しく構成されていません。

  • 400 AzureKeyVaultInvalidUri - Azure Key Vault からの無効な応答。 有効な Azure Key Vault URI を使用してください。

  • 400 ElasticPoolInconsistentDtuGuaranteeSettings - エラスティック プールの要求された DTU を超えるエラスティック プール内のデータベースに DTU 最小値を提供しようとしています。

  • 400 AzureKeyVaultMissingPermissions - サーバーに Azure Key Vaultに必要なアクセス許可がありません。

  • 400 InvalidReadScaleEdition - ユーザーがサポートしていないデータベースの種類で読み取りスケールを有効にしようとしました。

  • 400 InvalidReadScaleUnits - ユーザーがサポートされていない読み取りスケール値を指定しようとしました。

  • 400 SecurityAzureKeyVaultInvalidKeyName - サーバー キー名が無効なため、操作を完了できませんでした。

  • 400 ElasticPoolDatabaseCountOverLimit - エラスティック プールのデータベース数の上限に達したときに、エラスティック プールにデータベースを作成または追加しようとしています。

  • 400 CannotChangeToOrFromDataWarehouseTier - ユーザーがデータベースの SKU を DataWarehouse レベルから DataWarehouse 以外の層に変更しようとしました。その逆も同様です。

  • 400 GeoSecondaryMaxSizeUpdateFailed - geo セカンダリ データベースは、要求された maxsize 値をサポートしない SLO であるか、geo セカンダリがサポートされていないリージョンにあるか、geo セカンダリ データベースで更新操作が既に進行中です。

  • 400 AdalGenericError - Azure Active Directory エラーが発生したため、操作を完了できませんでした。

  • 400 AdalServicePrincipalNotFound - Azure Active Directory ライブラリのサービス プリンシパルが見つからないというエラーが発生したため、操作を完了できませんでした。

  • 400 AzureKeyVaultMalformedVaultUri - 指定されたKey Vault URI が無効です。

  • 400 ElasticPoolDecreaseStorageLimitBelowUsage - エラスティック プールのストレージ使用量を下回るストレージ制限を減らそうとしています。

  • 400 UpdateNotAllowedOnPausedDatabase - ユーザーが一時停止しているデータベースで更新を実行しようとしました。

  • 400 RequestedDatabaseSizeRequiresShrink - ユーザーは ALTER DATABASE MODIFY MAXSIZE を試み、データベースの MAXSIZE を現在のサイズより小さいサイズに変更しようとしました。

  • 400 CurrentDatabaseSizeExceedsDbMaxSize - ユーザーがデータベースの最大サイズを現在の使用量より小さいサイズに縮小しようとしました。

  • 400 CannotAssignIdentityToMaster - システム データベースに ID を割り当てることができません。 データベース ID を 'master'、'model'、'tempdb'、'msdb'、または 'resource' データベースに割り当てることはできません。

  • 400 CannotUseTrailingWhitespacesInDatabaseName - データベース名の検証に失敗しました。

  • 400 RegionDoesNotSupportVersion - ユーザーは、指定したバージョンのサーバーを、そのサーバー バージョンがサポートされていない場所に作成しようとしました。

  • 400 SecurityAdalPrincipalCertExpiredError - Azure Key Vault プリンシパル証明書の有効期限が切れているため、操作を完了できませんでした。

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 指定されたKey Vault URI が無効です。

  • 400 KeyMaterialNotFoundOnRemoteServer - リモート サーバーは、TDE 保護機能として使用されるキー マテリアルにアクセスできません。

  • 400 SourceDatabaseEditionCouldNotBeUpgraded - ソース データベースは、ターゲット データベースよりも高いエディションを持つことはできません。

  • 400 AzureKeyVaultRsaKeyNotSupported - 指定されたキー コンテナーでは、サポートされていない RSA キー サイズまたはキーの種類が使用されます。 サポートされている RSA キー サイズは 2048 または 3072 で、キーの種類は RSA または RSA-HSM です。

  • 400 TargetDatabaseEditionCouldNotBeDowngraded - ターゲット データベースのエディションをソース データベースより低くすることはできません。

  • 400 UpdateNotAllowedIfGeoDrOperationInProgress - サーバー '{1}' のデータベース '{0}' のコピーまたはフェールオーバー操作が現在進行中であるため、操作は許可されません。

  • 400 ElasticPoolOverFileSpace - エラスティック プール内のファイル領域が不足しています。

  • 400 SecurityAzureKeyVaultGeoChainError - Azure Key Vault (BYOK) を使用してTransparent Data Encryptionを有効にする場合、セカンダリのセカンダリ (チェーンと呼ばれるプロセス) の作成はサポートされていません。

  • 400 InvalidLicenseType - ユーザーがサポートされていないライセンスの種類でデータベースまたはエラスティック プールを作成または更新しようとしました。

  • 400 UnsupportedCapacity - ユーザーは、サポートされていない容量でデータベースを作成または更新しようとしました。

  • 400 RestoreToFreeEditionNotSupported - Restore ターゲットと GeoRestore ターゲットを無料データベースにすることはできません。

  • 400 RestoreNotSupportedForFreeEdition - 無料のデータベースでは、Restore と GeoRestore はサポートされていません。

  • 400 InvalidDroppedDatabase - 削除されたソース データベースは、サポートされている復旧期間内にサーバーに存在しません。

  • 400 InvalidLiveDatabase - サポートされている復旧期間内にソース データベースがサーバーに存在しません。 削除されたデータベースを復元する場合は、削除日を指定してください。

  • 400 InvalidVldbRecoverySlo - Hyperscale エディションの回復では、Hyperscale サービス レベルの目標を使用するには、ソース データベースとターゲット データベースの両方が必要です。

  • 400 InvalidVldbRestoreSlo - Hyperscale エディションのポイントインタイム リストアでは、ソース データベースとターゲット データベースの両方で Hyperscale サービス レベルの目標を使用する必要があります。

  • 400 CannotSpecifyPoolOrSlo - エラスティック プールの指定や、サービス レベルの目標またはエディションの変更は、エディションではサポートされていません。

  • 400 CannotMoveOrDropJobAccountDatabase - ジョブ アカウントに関連付けられているデータベースを削除できません。

  • 400 JobAgentDatabaseEditionUnsupported - 指定されたデータベースのサービス レベル目標は、ジョブ エージェント データベースとして使用できません。

  • 400 CannotUpdateToFreeDatabase - 無料 SKU へのデータベースの更新はサポートされていません。

  • 400 InvalidBackupStorageAccountType - ユーザーはデータベースの作成/更新中に zrs/lrs を渡しましたが、顧客がホワイトリストに登録されていないか、指定されたリージョンで zrs を使用できないために失敗しました。

  • 400 DatabaseInvalidSkuPropertyCombination - 要求された SKU のプロパティに一貫性がありません。 有効な組み合わせが指定されていることを確認してください。 詳細については、 https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability をご覧ください。

  • 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - プライマリ データベースあたりの許容数を超える名前付きレプリカを作成しようとしました

  • 400 DatabaseIsCurrentlyPinned - Microsoft は、データベースをエンジンのバージョンSQL Server固定しました。 データベースが運用環境の問題にヒットしないようにするために、ピン留めされていないまで、データベースに対する将来のスケール操作はブロックされます。 スケーリングのサポートについては、Microsoft サポートにお問い合わせください。

  • 400 RestoreTargetEditionSizeInsufficient - ユーザーは、ソースの現在割り当てられているサイズよりも小さいサイズのエディションにデータベースを復元しようとしました。

  • 400 InvalidIdentityId - 指定された 1 つ以上の ID ID が有効な ARM リソース ID ではありません。 有効な ID を入力して、もう一度やり直してください。

  • 400 DatabaseCreationBlockedForNonActivatedCMKServer - SQL プールの作成は、ワークスペースがアクティブになるまで CMK が有効なワークスペースでブロックされます。 まず、消去保護を有効にし、ワークスペース キーの Azure Key Vaultに必要なアクセス許可 (Get、Wrap Key、Unwrap Key) をワークスペースマネージド ID に付与します。 次に、アクセス権を付与した後、ワークスペースをアクティブ化します。

  • 400 InvalidNumberOfIdentities - データベース レベルでは、ユーザー割り当てマネージド ID が 1 つだけサポートされます。

  • 400 DatabaseNamedReplicaChainingNotAllowed - ユーザーは、許可されていない名前付きレプリカの名前付きレプリカを作成しようとしました。

  • 400 DatabaseNamedReplicaInvalidOperation - ユーザーが、名前付きレプリカでサポートされていない操作を試行しました。

  • 400 ServerNotFound - 要求されたサーバーが見つかりませんでした。

  • 400 DatabaseNamedReplicaInvalidSourceDatabase - ユーザーがソース データベースとは異なるサブスクリプションまたはリージョンに名前付きレプリカを作成しようとしました。

  • 400 CannotMoveOrDropSyncMetadataDatabase - 同期メタデータ データベースとして使用されるデータベースを削除できません。

  • 400 MissingThumbprintCrm - 必要な TDE 証明書が見つからないため、CRM データベースの復元操作が失敗しました。 既存のエラスティック プールへの復元操作を再試行してください。

  • 400 ElasticPoolOverStorage - エラスティック プールのストレージ制限に達したときにデータベースにデータを書き込もうとします。

  • 400 ElasticPoolInconsistentVcoreGuaranteeSettings - データベース数とデータベースあたりの仮想コアの最小数は、エラスティック プールの要求された仮想コアを超えることはできません。

  • 400 InvalidMaxSizeTierCombination - 指定されたレベルでは、指定したデータベースの最大サイズはサポートされていません。

  • 400 InvalidTier - ユーザーが無効なレベルを指定しました。

  • 400 CannotUseReservedDatabaseName - この操作では予約データベース名を使用できません。

  • 400 InvalidServerName - 指定されたサーバー名が無効です。

  • 404 OperationIdNotFound - ID を持つ操作が存在しません。

  • 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした

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

  • 404 LongTermRetentionMigrationBackupNotFound - 指定された LTR バックアップが存在しません。

  • 404 CannotFindObject - オブジェクトが存在しないか、アクセス許可がないため、オブジェクトが見つかりません

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

  • 404 DatabaseDoesNotExist - ユーザーがこのサーバー インスタンスに存在しないデータベース名を指定しました。

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

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

  • 405 UnsupportedReplicationOperation - データベースでサポートされていないレプリケーション操作が開始されました。

  • 409 OperationCancelled - 操作がユーザーによって取り消されました。

  • 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。

  • 409 LongTermRetentionMigrationRequestConflict - この LTR バックアップに対する競合操作がまだ進行中です。

  • 409 LongTermRetentionMigrationBackupConflict - ターゲット データベースのバックアップ時間が同じ別の LTR バックアップが存在します。

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship - レプリケーション のシード処理操作が、既にレプリケーション関係にあるデータベースに対して実行されました。

  • 409 InvalidOperationForDatabaseInReplicationRelationship - レプリケーション のシード処理操作が、既にレプリケーション関係にあるデータベースに対して実行されました。

  • 409 RemoteDatabaseExists - コピー先のデータベース名は、移行先サーバーに既に存在します。

  • 409 DuplicateGeoDrRelation - データベースは既にレプリケーション関係にあります。 これは重複する要求です。

  • 409 FreeDbAlreadyExists - リージョンごとにサブスクリプションに存在できる無料データベースは 1 つだけです。

  • 409 ConflictingServerOperation - サーバーに対する操作が現在進行中です。

  • 409 SubscriptionDisabled - サブスクリプションが無効になっています。

  • 409 ConflictingSystemOperationInProgress - データベースでシステム メンテナンス操作が進行中であり、それ以上の操作が完了するまで待機する必要があります。

  • 409 SkuAssignmentInProgress - 以前の要求が完了していないため、現在の割り当て要求を処理できません。

  • 409 CurrentMemoryUsageExceedsSkuQuota - ユーザーは、リソース消費量が多いために完了できない SKU 更新操作を試行しました。

  • 409 ServerDtuQuotaExceeded - サーバーが許可されているデータベース スループット ユニットクォータを超えるので、操作を実行できませんでした。

  • 409 ServerKeyNameAlreadyExists - サーバー キーは既にサーバーに存在します。

  • 409 ServerKeyUriAlreadyExists - サーバー キー URI は既にサーバーに存在します。

  • 409 UnableToAlterDatabaseInReplication - レプリケーション関係のデータベースでユーザーがエディションを変更しました。

  • "409 ServerKeyDoesNotExists - The server key does not exist. " (409 ServerKeyDoesNotExists - サーバー キーは存在しません。)

  • 409 UpdateSloInProgress - SLO 更新の進行中に、ユーザーが互換性のない操作を開始しようとしました。

  • 409 UpdateSloFailedDatabaseTooBusy - データベースがビジーであるため、SLO の更新操作を完了できませんでした。

  • 409 AzureKeyVaultKeyNameNotFound - Azure Key Vault キー名が存在しないため、操作を完了できませんでした。

  • 409 AzureKeyVaultKeyInUse - キーは現在サーバーによって使用されています。

  • 409 ElasticPoolBusy - ビジー状態のエラスティック プールで管理操作が試行されました。

  • 409 SimultaneousSkuChangeNotAllowed - レプリケーション関係の両方のデータベースでサービス目標変更操作を同時に実行することはできません。

  • 409 TargetElasticPoolBeingUpdated - このエラスティック プール内のいずれかのデータベースに対してコピー操作が進行中であるため、エラスティック プールの更新を開始できません

  • 409 DatabaseCopyLimitPerReplicaReached - ユーザーが同時データベース コピーの制限に達しました。

  • 409 ConflictRequestToUpdateBackupRedundancy - バックアップ ストレージの冗長性を変更するための競合要求がまだ進行中です。

  • 409 DatabaseElasticPoolMaintenanceConflict - ユーザーは、データベースのエラスティック プールと競合する、指定されたメンテナンス構成でデータベースを作成または更新しようとしました。

  • 409 ServerDisabled - サーバーが無効になっています。

  • 409 ConflictingDatabaseOperation - データベースには既にいくつかの操作があり、現在の操作は完了するまで待機する必要があります。

  • 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

  • 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

  • 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。 操作をやり直してください。

  • 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - ターゲット リージョンで LTR バックアップ コピー要求を開始できませんでした。

  • 500 LongTermRetentionMigrationRequestCopyFailed - LTR バックアップ BLOB のコピー操作が失敗しました。

  • 500 LongTermRetentionMigrationRestoreVerExceeded - 最大試行回数に達した後、復元の検証に失敗しました。

  • 500 LongTermRetentionMigrationRestoreVerFailed - 復元の検証に失敗しました。

  • 500 ActivateOrDeactivateWorkflowThrottling - 同時実行ワークフローが多すぎるため、アクティブ化または非アクティブ化ワークフローが失敗しました

  • 503 AzureKeyVaultConnectionFailed - Azure Key Vaultへの接続が失敗したため、サーバーで操作を完了できませんでした

  • 503 AzureKeyVaultGenericConnectionError - Key Vault情報を取得しようとしたときにエラーが発生したため、操作を完了できませんでした。

  • 503 DatabaseUnavailable - データベースが使用できないため、操作が失敗しました。

  • 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

  • 504 RequestTimeout - サービス要求が許可されたタイムアウトを超えました。

Assigns maintenance window to a database.
Resets maintenance window of a database to default.
Updates a database.

Assigns maintenance window to a database.

Sample Request

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2021-08-01-preview

{
  "sku": {
    "name": "BC_Gen5_4"
  },
  "properties": {
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1"
  }
}

Sample Response

{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 4
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 4
    },
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1"
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Resets maintenance window of a database to default.

Sample Request

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2021-08-01-preview

{
  "sku": {
    "name": "BC_Gen5_4"
  },
  "properties": {
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"
  }
}

Sample Response

{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 4
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_4",
    "requestedServiceObjectiveName": "BC_Gen5_4",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 4
    }
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Updates a database.

Sample Request

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2021-08-01-preview

{
  "sku": {
    "name": "BC_Gen4_4"
  },
  "properties": {
    "maxSizeBytes": 1073741824,
    "licenseType": "LicenseIncluded"
  }
}

Sample Response

{
  "sku": {
    "name": "BC_Gen4",
    "tier": "BusinessCritical",
    "capacity": 4
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen4_2",
    "requestedServiceObjectiveName": "BC_Gen4_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "currentSku": {
      "name": "BC_Gen4",
      "tier": "BusinessCritical",
      "capacity": 4
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Local",
    "isLedgerOn": false
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

定義

BackupStorageRedundancy

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

CatalogCollationType

メタデータ カタログの照合順序。

CreateMode

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

既定値: 通常のデータベース作成。

コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソース データベースのリソース ID として指定する必要があります。

セカンダリ: 既存のデータベースのセカンダリ レプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリ データベースのリソース ID として指定する必要があります。

PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。

復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベース リソース ID として指定する必要があります。

復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID の場合は、sourceDatabaseDeletionDate を指定する必要があります。 それ以外の場合、sourceDatabaseId は復元可能な削除されたデータベース リソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。

RestoreLongTermRetentionBackup: 長期保持コンテナーから復元してデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。

DataWarehouse エディションでは、コピー、セカンダリ、および RestoreLongTermRetentionBackup はサポートされていません。

Database

データベース リソース。

DatabaseIdentity

リソースの ID 構成をAzure Active Directoryします。

DatabaseIdentityType

ID の種類

DatabaseLicenseType

このデータベースに適用するライセンスの種類。 LicenseIncludedライセンスが必要な場合、またはBasePriceライセンスをお持ちで、Azure ハイブリッド特典の資格がある場合。

DatabaseReadScale

読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョン内の読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。

DatabaseStatus

データベースの状態。

DatabaseUpdate

データベース更新リソース。

DatabaseUserIdentity

リソースの ID 構成をAzure Active Directoryします。

SampleName

このデータベースの作成時に適用するサンプル スキーマの名前。

SecondaryType

データベースがセカンダリの場合は、データベースのセカンダリ の種類。 有効な値は Geo と Named です。

Sku

ARM リソース SKU。

BackupStorageRedundancy

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

Name Type Description
Geo
  • string
GeoZone
  • string
Local
  • string
Zone
  • string

CatalogCollationType

メタデータ カタログの照合順序。

Name Type Description
DATABASE_DEFAULT
  • string
SQL_Latin1_General_CP1_CI_AS
  • string

CreateMode

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

既定値: 通常のデータベース作成。

コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソース データベースのリソース ID として指定する必要があります。

セカンダリ: 既存のデータベースのセカンダリ レプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリ データベースのリソース ID として指定する必要があります。

PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。

復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベース リソース ID として指定する必要があります。

復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID の場合は、sourceDatabaseDeletionDate を指定する必要があります。 それ以外の場合、sourceDatabaseId は復元可能な削除されたデータベース リソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。

RestoreLongTermRetentionBackup: 長期保持コンテナーから復元してデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。

DataWarehouse エディションでは、コピー、セカンダリ、および RestoreLongTermRetentionBackup はサポートされていません。

Name Type Description
Copy
  • string
Default
  • string
OnlineSecondary
  • string
PointInTimeRestore
  • string
Recovery
  • string
Restore
  • string
RestoreExternalBackup
  • string
RestoreExternalBackupSecondary
  • string
RestoreLongTermRetentionBackup
  • string
Secondary
  • string

Database

データベース リソース。

Name Type Description
id
  • string

リソースの ID

identity

データベースのAzure Active Directory ID。

kind
  • string

データベースの種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。

location
  • string

リソースの場所。

managedBy
  • string

データベースを管理するリソース。

name
  • string

リソース名。

properties.autoPauseDelay
  • integer

データベースが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します。

properties.catalogCollation

メタデータ カタログの照合順序。

properties.collation
  • string

データベースの照合順序。

properties.createMode

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

既定値: 通常のデータベースの作成。

コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソース データベースのリソース ID として指定する必要があります。

セカンダリ: 既存のデータベースのセカンダリ レプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリ データベースのリソース ID として指定する必要があります。

PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。

復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 復元する回復可能なデータベース リソース ID として sourceDatabaseId を指定する必要があります。

復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID である場合は、sourceDatabaseDeletionDate を指定する必要があります。 それ以外の場合、sourceDatabaseId は復元可能なドロップされたデータベース リソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。

RestoreLongTermRetentionBackup: 長期保持コンテナーから復元してデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。

DataWarehouse エディションでは、コピー、セカンダリ、および RestoreLongTermRetentionBackup はサポートされていません。

properties.creationDate
  • string

データベースの作成日 (ISO8601 形式)。

properties.currentBackupStorageRedundancy

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

properties.currentServiceObjectiveName
  • string

データベースの現在のサービス レベル目標名。

properties.currentSku

SKU の名前とレベル。

properties.databaseId
  • string

データベースの ID です。

properties.defaultSecondaryLocation
  • string

このデータベースの既定のセカンダリ リージョン。

properties.earliestRestoreDate
  • string

これにより、このデータベースで復元できる最も早い開始日と時刻が記録されます (ISO8601 形式)。

properties.elasticPoolId
  • string

このデータベースを含むエラスティック プールのリソース識別子。

properties.failoverGroupId
  • string

このデータベースが属するフェールオーバー グループ リソース識別子。

properties.federatedClientId
  • string

データベース CMK ごとのクロス テナントに使用されるクライアント ID のシナリオ

properties.highAvailabilityReplicaCount
  • integer

高可用性を提供するために使用されるデータベースに関連付けられているセカンダリ レプリカの数。 エラスティック プール内の Hyperscale データベースには適用されません。

properties.isInfraEncryptionEnabled
  • boolean

このデータベースでは、Infra 暗号化が有効になっています。

properties.isLedgerOn
  • boolean

このデータベースが台帳データベースかどうか。つまり、データベース内のすべてのテーブルが台帳テーブルです。 注: このプロパティーの値は、データベースが作成された後は変更できません。

properties.licenseType

このデータベースに適用するライセンスの種類。 LicenseIncludedライセンスが必要な場合、またはBasePriceライセンスをお持ちで、Azure ハイブリッド特典の対象となる場合。

properties.longTermRetentionBackupResourceId
  • string

このデータベースの作成操作に関連付けられている長期リテンション期間バックアップのリソース識別子。

properties.maintenanceConfigurationId
  • string

データベースに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンス更新が発生する期間を定義します。

properties.maxLogSizeBytes
  • integer

このデータベースの最大ログ サイズ。

properties.maxSizeBytes
  • integer

バイト単位で表されるデータベースの最大サイズ。

properties.minCapacity
  • number

一時停止されていない場合、データベースが常に割り当てる最小限の容量

properties.pausedDate
  • string

ユーザー構成またはアクション (ISO8601 形式) によってデータベースが一時停止された日付。 データベースの準備ができた場合は Null。

properties.readScale

読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョン内の読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。

properties.recoverableDatabaseId
  • string

このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。

properties.recoveryServicesRecoveryPointId
  • string

このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。

properties.requestedBackupStorageRedundancy

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

properties.requestedServiceObjectiveName
  • string

データベースの要求されたサービス レベル目標名。

properties.restorableDroppedDatabaseId
  • string

このデータベースの作成操作に関連付けられている復元可能な削除されたデータベースのリソース識別子。

properties.restorePointInTime
  • string

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

properties.resumedDate
  • string

ユーザー アクションまたはデータベース ログイン (ISO8601 形式) によってデータベースが再開された日付。 データベースが一時停止されている場合は Null。

properties.sampleName

このデータベースの作成時に適用するサンプル スキーマの名前。

properties.secondaryType

データベースがセカンダリの場合は、データベースのセカンダリの種類。 有効な値は Geo と Named です。

properties.sourceDatabaseDeletionDate
  • string

データベースが削除された時刻を指定します。

properties.sourceDatabaseId
  • string

このデータベースの作成操作に関連付けられているソース データベースのリソース識別子。

properties.sourceResourceId
  • string

このデータベースの作成操作に関連付けられているソースのリソース識別子。

sourceResourceId が指定されている場合、sourceDatabaseId、recoverableDatabaseId、restoreableDroppedDatabaseId、sourceDatabaseDeletionDate を指定する必要はなく、CreateMode は PointInTimeRestore、Restore、または Recover である必要があります。

createMode が PointInTimeRestore の場合、sourceResourceId は既存のデータベースまたは既存の SQL プールのリソース ID である必要があり、restorePointInTime を指定する必要があります。

createMode が Restore の場合、sourceResourceId は、復元可能な削除されたデータベースまたは復元可能な削除された SQL プールのリソース ID である必要があります。

createMode が Recover の場合、sourceResourceId は回復可能なデータベースまたは回復可能な SQL プールのリソース ID である必要があります。

このプロパティを使用すると、DataWarehouse エディションでのみサポートされているサブスクリプション間で復元できます。

ソース サブスクリプションがターゲット サブスクリプションとは異なるテナントに属している場合、"x-ms-authorization-auxiliary" ヘッダーにはソース テナントの認証トークンが含まれている必要があります。 "x-ms-authorization-auxiliary" ヘッダーの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

properties.status

データベースの状態。

properties.zoneRedundant
  • boolean

このデータベースがゾーン冗長かどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。

sku

データベース SKU。

SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のいずれかのコマンドを使用 Capabilities_ListByLocation します。

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
tags
  • object

リソース タグ。

type
  • string

リソースの種類。

DatabaseIdentity

リソースの ID 構成をAzure Active Directoryします。

Name Type Description
tenantId
  • string

Azure Active Directory テナント ID。

type

ID の種類

userAssignedIdentities

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

DatabaseIdentityType

ID の種類

Name Type Description
None
  • string
UserAssigned
  • string

DatabaseLicenseType

このデータベースに適用するライセンスの種類。 LicenseIncludedライセンスが必要な場合、またはBasePriceライセンスをお持ちで、Azure ハイブリッド特典の資格がある場合。

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

DatabaseReadScale

読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョン内の読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。

Name Type Description
Disabled
  • string
Enabled
  • string

DatabaseStatus

データベースの状態。

Name Type Description
AutoClosed
  • string
Copying
  • string
Creating
  • string
Disabled
  • string
EmergencyMode
  • string
Inaccessible
  • string
Offline
  • string
OfflineChangingDwPerformanceTiers
  • string
OfflineSecondary
  • string
Online
  • string
OnlineChangingDwPerformanceTiers
  • string
Paused
  • string
Pausing
  • string
Recovering
  • string
RecoveryPending
  • string
Restoring
  • string
Resuming
  • string
Scaling
  • string
Shutdown
  • string
Standby
  • string
Starting
  • string
Stopped
  • string
Stopping
  • string
Suspect
  • string

DatabaseUpdate

データベース更新リソース。

Name Type Description
identity

データベース ID

properties.autoPauseDelay
  • integer

データベースが自動的に一時停止されるまでの時間 (分)。 値 -1 は、自動一時停止が無効になっていることを意味します

properties.catalogCollation

メタデータ カタログの照合順序。

properties.collation
  • string

データベースの照合順序。

properties.createMode

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

既定値: 通常のデータベース作成。

コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソース データベースのリソース ID として指定する必要があります。

セカンダリ: 既存のデータベースのセカンダリ レプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリ データベースのリソース ID として指定する必要があります。

PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。

復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベース リソース ID として指定する必要があります。

復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID の場合は、sourceDatabaseDeletionDate を指定する必要があります。 それ以外の場合、sourceDatabaseId は復元可能な削除されたデータベース リソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。

RestoreLongTermRetentionBackup: 長期保持コンテナーから復元してデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。

DataWarehouse エディションでは、コピー、セカンダリ、および RestoreLongTermRetentionBackup はサポートされていません。

properties.creationDate
  • string

データベースの作成日 (ISO8601 形式)。

properties.currentBackupStorageRedundancy

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

properties.currentServiceObjectiveName
  • string

データベースの現在のサービス レベル目標名。

properties.currentSku

SKU の名前と階層。

properties.databaseId
  • string

データベースの ID です。

properties.defaultSecondaryLocation
  • string

このデータベースの既定のセカンダリ リージョン。

properties.earliestRestoreDate
  • string

これにより、このデータベースで復元できる最も早い開始日と時刻が記録されます (ISO8601 形式)。

properties.elasticPoolId
  • string

このデータベースを含むエラスティック プールのリソース識別子。

properties.failoverGroupId
  • string

このデータベースが属するフェールオーバー グループ リソース識別子。

properties.federatedClientId
  • string

データベース CMK ごとのテナント間のシナリオに使用されるクライアント ID

properties.highAvailabilityReplicaCount
  • integer

高可用性を提供するために使用されるデータベースに関連付けられているセカンダリ レプリカの数。 エラスティック プール内の Hyperscale データベースには適用されません。

properties.isInfraEncryptionEnabled
  • boolean

このデータベースに対して Infra 暗号化が有効になっています。

properties.isLedgerOn
  • boolean

このデータベースが台帳データベースであるかどうかは、データベース内のすべてのテーブルが台帳テーブルであることを意味します。 注: データベースの作成後に、このプロパティの値を変更することはできません。

properties.licenseType

このデータベースに適用するライセンスの種類。 LicenseIncludedライセンスが必要な場合、またはBasePriceライセンスをお持ちで、Azure ハイブリッド特典の資格がある場合。

properties.longTermRetentionBackupResourceId
  • string

このデータベースの作成操作に関連付けられている長期保有バックアップのリソース識別子。

properties.maintenanceConfigurationId
  • string

データベースに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンスの更新が行われる期間を定義します。

properties.maxLogSizeBytes
  • integer

このデータベースの最大ログ サイズ。

properties.maxSizeBytes
  • integer

バイト単位で表されるデータベースの最大サイズ。

properties.minCapacity
  • number

データベースが常に割り当てる最小容量 (一時停止されていない場合)

properties.pausedDate
  • string

ユーザー構成またはアクション (ISO8601 形式) によってデータベースが一時停止された日付。 データベースの準備ができた場合は null。

properties.readScale

読み取り専用ルーティングの状態。 有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョン内の読み取り専用セカンダリ レプリカにルーティングされる可能性があります。 エラスティック プール内の Hyperscale データベースには適用されません。

properties.recoverableDatabaseId
  • string

このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。

properties.recoveryServicesRecoveryPointId
  • string

このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。

properties.requestedBackupStorageRedundancy

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

properties.requestedServiceObjectiveName
  • string

データベースの要求されたサービス レベル目標名。

properties.restorableDroppedDatabaseId
  • string

このデータベースの作成操作に関連付けられた、復元可能な削除されたデータベースのリソース識別子。

properties.restorePointInTime
  • string

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

properties.resumedDate
  • string

ユーザー アクションまたはデータベース ログイン (ISO8601 形式) によってデータベースが再開された日付。 データベースが一時停止している場合は null。

properties.sampleName

このデータベースの作成時に適用するサンプル スキーマの名前。

properties.secondaryType

データベースがセカンダリの場合は、データベースのセカンダリ の種類。 有効な値は Geo と Named です。

properties.sourceDatabaseDeletionDate
  • string

データベースが削除された時刻を指定します。

properties.sourceDatabaseId
  • string

このデータベースの作成操作に関連付けられているソース データベースのリソース識別子。

properties.status

データベースの状態。

properties.zoneRedundant
  • boolean

このデータベースがゾーン冗長であるかどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。

sku

SKU の名前とレベル。

tags
  • object

リソース タグ。

DatabaseUserIdentity

リソースの ID 構成をAzure Active Directoryします。

Name Type Description
clientId
  • string

Azure Active Directoryクライアント ID。

principalId
  • string

Azure Active Directory プリンシパル ID。

SampleName

このデータベースの作成時に適用するサンプル スキーマの名前。

Name Type Description
AdventureWorksLT
  • string
WideWorldImportersFull
  • string
WideWorldImportersStd
  • string

SecondaryType

データベースがセカンダリの場合は、データベースのセカンダリ の種類。 有効な値は Geo と Named です。

Name Type Description
Geo
  • string
Named
  • string

Sku

ARM リソース SKU。

Name Type Description
capacity
  • integer

特定の SKU の容量。

family
  • string

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

name
  • string

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

size
  • string

特定の SKU のサイズ

tier
  • string

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