Server DevOps Audit Settings - Create Or Update

リファレンス

サービス:: SQL Database

API バージョン:: 2023-08-01

サーバーの DevOps 監査設定を作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/devOpsAuditingSettings/Default?api-version=2023-08-01

URI パラメーター

名前	/	必須	型	説明
devOpsAuditingSettingsName	path	True	DevOpsAuditingSettingsName
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。

要求本文

名前	必須	型	説明
properties.state	True	BlobAuditingPolicyState	監査の状態を指定します。状態が有効の場合、storageEndpoint または isAzureMonitorTargetEnabled が必要です。
properties.isAzureMonitorTargetEnabled		boolean	DevOps 監査イベントを Azure Monitor に送信するかどうかを指定します。 Azure Monitor にイベントを送信するには、'State' を 'Enabled' に、'IsAzureMonitorTargetEnabled' を true に指定します。 REST API を使用して DevOps 監査を構成する場合は、マスターデータベースに "DevOpsOperationsAudit" 診断ログカテゴリを含む診断設定も作成する必要があります。診断設定 URI 形式: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview 詳細については、「診断設定 REST API 」または「診断設定の PowerShell する」を参照してください。
properties.isManagedIdentityInUse		boolean	BLOB ストレージへのアクセスにマネージド ID を使用するかどうかを指定します
properties.storageAccountAccessKey		string	監査ストレージアカウントの識別子キーを指定します。状態が Enabled で storageEndpoint が指定されている場合、storageAccountAccessKey を指定しないと、SQL サーバーのシステム割り当てマネージド ID を使用してストレージにアクセスします。マネージド ID 認証を使用するための前提条件: AZURE Active Directory (AAD) で SQL Server にシステム割り当てマネージド ID を割り当てます。サーバー ID に "ストレージ BLOB データ共同作成者" RBAC ロールを追加して、SQL Server ID にストレージアカウントへのアクセス権を付与します。詳細については、「マネージド ID 認証を使用したストレージへの監査の」を参照してください。
properties.storageAccountSubscriptionId		string (uuid)	BLOB ストレージサブスクリプション ID を指定します。
properties.storageEndpoint		string	BLOB ストレージエンドポイント (例: https://MyAccount.blob.core.windows.net) を指定します。状態が有効の場合、storageEndpoint または isAzureMonitorTargetEnabled が必要です。

応答

名前	型	説明
200 OK	ServerDevOpsAuditingSettings	DevOps 監査設定が正常に更新されました。
202 Accepted		監査 DevOps 設定の更新が進行中です。ヘッダー Location: string
Other Status Codes	ErrorResponse	エラー応答: *** 400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合 400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合 400 InvalidServerDevOpsAuditSettingsCreateRequest - サーバー DevOps 監査ポリシーの作成要求が存在しないか、プロパティオブジェクトがありません。 400 DataSecurityInvalidUserSuppliedParameter - 無効なパラメーター値がクライアントによって提供されました。 400 InvalidServerDevOpsAuditSettingsName - サーバー DevOps ポリシー名が無効です。 400 DevOpsAuditInvalidStorageAccountCredentials - 指定されたストレージアカウントまたはアクセスキーが無効です。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 OperationIdNotFound - Id を持つ操作が存在しません。 409 ServerDevOpsAuditSettingsInProgress - Set server DevOps audit は既に進行中です。 409 CannotCancelOperation - 管理操作が取り消すことができない状態です。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作を再試行してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

名前

型

説明

200 OK

ServerDevOpsAuditingSettings

DevOps 監査設定が正常に更新されました。

202 Accepted

監査 DevOps 設定の更新が進行中です。

ヘッダー

Location: string

Other Status Codes

ErrorResponse

エラー応答: ***

400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合
400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合
400 InvalidServerDevOpsAuditSettingsCreateRequest - サーバー DevOps 監査ポリシーの作成要求が存在しないか、プロパティオブジェクトがありません。
400 DataSecurityInvalidUserSuppliedParameter - 無効なパラメーター値がクライアントによって提供されました。
400 InvalidServerDevOpsAuditSettingsName - サーバー DevOps ポリシー名が無効です。
400 DevOpsAuditInvalidStorageAccountCredentials - 指定されたストレージアカウントまたはアクセスキーが無効です。
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 OperationIdNotFound - Id を持つ操作が存在しません。
409 ServerDevOpsAuditSettingsInProgress - Set server DevOps audit は既に進行中です。
409 CannotCancelOperation - 管理操作が取り消すことができない状態です。
409 OperationCancelled - 操作がユーザーによって取り消されました。
409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。
429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作を再試行してください。
503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

例

Update a server's DevOps audit settings with all params

Update a server's DevOps audit settings with minimal input

Update a server's DevOps audit settings with all params

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/Default?api-version=2023-08-01

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "storageEndpoint": "https://mystorage.blob.core.windows.net",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "isAzureMonitorTargetEnabled": true
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/devOpsAuditingSettings",
  "properties": {
    "state": "Enabled",
    "storageEndpoint": "https://mystorage.blob.core.windows.net",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "isAzureMonitorTargetEnabled": true
  }
}

状態コード:: 202

Update a server's DevOps audit settings with minimal input

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/Default?api-version=2023-08-01

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/devOpsAuditingSettings",
  "properties": {
    "state": "Enabled",
    "storageEndpoint": "https://mystorage.blob.core.windows.net",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000"
  }
}

状態コード:: 202

定義

名前	説明
BlobAuditingPolicyState	監査の状態を指定します。状態が有効の場合、storageEndpoint または isAzureMonitorTargetEnabled が必要です。
createdByType	リソースを作成した ID の種類。
DevOpsAuditingSettingsName
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ServerDevOpsAuditingSettings	サーバー DevOps 監査設定。
systemData	リソースの作成と最後の変更に関連するメタデータ。

BlobAuditingPolicyState

列挙

監査の状態を指定します。状態が有効の場合、storageEndpoint または isAzureMonitorTargetEnabled が必要です。

値	説明
Disabled
Enabled

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

DevOpsAuditingSettingsName

列挙

値	説明
Default

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

ServerDevOpsAuditingSettings

Object

サーバー DevOps 監査設定。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.isAzureMonitorTargetEnabled	boolean	DevOps 監査イベントを Azure Monitor に送信するかどうかを指定します。 Azure Monitor にイベントを送信するには、'State' を 'Enabled' に、'IsAzureMonitorTargetEnabled' を true に指定します。 REST API を使用して DevOps 監査を構成する場合は、マスターデータベースに "DevOpsOperationsAudit" 診断ログカテゴリを含む診断設定も作成する必要があります。診断設定 URI 形式: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview 詳細については、「診断設定 REST API 」または「診断設定の PowerShell する」を参照してください。
properties.isManagedIdentityInUse	boolean	BLOB ストレージへのアクセスにマネージド ID を使用するかどうかを指定します
properties.state	BlobAuditingPolicyState	監査の状態を指定します。状態が有効の場合、storageEndpoint または isAzureMonitorTargetEnabled が必要です。
properties.storageAccountAccessKey	string	監査ストレージアカウントの識別子キーを指定します。状態が Enabled で storageEndpoint が指定されている場合、storageAccountAccessKey を指定しないと、SQL サーバーのシステム割り当てマネージド ID を使用してストレージにアクセスします。マネージド ID 認証を使用するための前提条件: AZURE Active Directory (AAD) で SQL Server にシステム割り当てマネージド ID を割り当てます。サーバー ID に "ストレージ BLOB データ共同作成者" RBAC ロールを追加して、SQL Server ID にストレージアカウントへのアクセス権を付与します。詳細については、「マネージド ID 認証を使用したストレージへの監査の」を参照してください。
properties.storageAccountSubscriptionId	string (uuid)	BLOB ストレージサブスクリプション ID を指定します。
properties.storageEndpoint	string	BLOB ストレージエンドポイント (例: https://MyAccount.blob.core.windows.net) を指定します。状態が有効の場合、storageEndpoint または isAzureMonitorTargetEnabled が必要です。
systemData	systemData	ServerDevOpsAuditSettingsResource の SystemData。
type	string	リソースの種類。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Server DevOps Audit Settings - Create Or Update

URI パラメーター

要求本文

応答

例

Update a server's DevOps audit settings with all params

要求のサンプル

応答のサンプル

Update a server's DevOps audit settings with minimal input

要求のサンプル

応答のサンプル

定義

BlobAuditingPolicyState

createdByType

DevOpsAuditingSettingsName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerDevOpsAuditingSettings

systemData

その他のリソース