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 매개 변수

Name	In(다음 안에)	필수	형식	Description
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 버전입니다.

요청 본문

Name	필수	형식	Description
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	관리 ID를 사용하여 Blob Storage에 액세스할지 여부를 지정합니다.
properties.storageAccountAccessKey		string	감사 스토리지 계정의 식별자 키를 지정합니다. 상태가 사용되고 storageEndpoint가 지정된 경우 storageAccountAccessKey를 지정하지 않으면 SQL Server 시스템 할당 관리 ID를 사용하여 스토리지에 액세스합니다. 관리 ID 인증을 사용하기 위한 필수 구성 요소: AAD(Azure Active Directory)에서 SQL Server에 시스템 할당 관리 ID를 할당합니다. 서버 ID에 'Storage Blob 데이터 기여자' RBAC 역할을 추가하여 스토리지 계정에 대한 SQL Server ID 액세스 권한을 부여합니다. 자세한 내용은 관리 ID 인증 사용하여 스토리지에 대한 감사를 참조하세요.
properties.storageAccountSubscriptionId		string (uuid)	Blob Storage 구독 ID를 지정합니다.
properties.storageEndpoint		string	Blob Storage 엔드포인트(예: https://MyAccount.blob.core.windows.net)를 지정합니다. 상태가 사용되면 storageEndpoint 또는 isAzureMonitorTargetEnabled가 필요합니다.

응답

Name	형식	Description
200 OK	ServerDevOpsAuditingSettings	DevOps 감사 설정을 업데이트했습니다.
202 Accepted		감사 DevOps 설정 업데이트가 진행 중입니다. 헤더 Location: string
Other Status Codes	ErrorResponse	오류 응답: *** 400 ManagedInstanceStoppingOrStopped - 인스턴스가 중지/중지된 상태인 동안 제출된 충돌 작업 400 ManagedInstanceStarting - 인스턴스가 시작 상태에 있는 동안 제출된 충돌 작업 400 InvalidServerDevOpsAuditSettingsCreateRequest - Create Server DevOps 감사 정책 요청이 없거나 속성 개체가 없습니다. 400 DataSecurityInvalidUserSuppliedParameter - 클라이언트에서 잘못된 매개 변수 값을 제공했습니다. 400 InvalidServerDevOpsAuditSettingsName - 잘못된 서버 DevOps 정책 이름입니다. 400 DevOpsAuditInvalidStorageAccountCredentials - 제공된 스토리지 계정 또는 액세스 키가 잘못되었습니다. 404 ServerNotInSubscriptionResourceGroup - 지정된 서버가 지정된 리소스 그룹 및 구독에 없습니다. 404 SubscriptionDoesNotHaveServer - 요청된 서버를 찾을 수 없습니다. 404 OperationIdNotFound - ID가 있는 작업이 없습니다. 409 ServerDevOpsAuditSettingsInProgress - 서버 DevOps 감사 설정이 이미 진행 중입니다. 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
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerDevOpsAuditCreateMax.json
// this example is just showing the usage of "ServerDevOpsAuditSettings_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "devAuditTestRG";
string serverName = "devOpsAuditTestSvr";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerDevOpsAuditingSettingResource
SqlServerDevOpsAuditingSettingCollection collection = sqlServer.GetSqlServerDevOpsAuditingSettings();

// invoke the operation
string devOpsAuditingSettingsName = "Default";
SqlServerDevOpsAuditingSettingData data = new SqlServerDevOpsAuditingSettingData
{
    IsAzureMonitorTargetEnabled = true,
    State = BlobAuditingPolicyState.Enabled,
    StorageEndpoint = "https://mystorage.blob.core.windows.net",
    StorageAccountAccessKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    StorageAccountSubscriptionId = Guid.Parse("00000000-1234-0000-5678-000000000000"),
};
ArmOperation<SqlServerDevOpsAuditingSettingResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, devOpsAuditingSettingsName, data);
SqlServerDevOpsAuditingSettingResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerDevOpsAuditingSettingData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

샘플 응답

상태 코드:

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerDevOpsAuditCreateMin.json
// this example is just showing the usage of "ServerDevOpsAuditSettings_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "devAuditTestRG";
string serverName = "devOpsAuditTestSvr";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerDevOpsAuditingSettingResource
SqlServerDevOpsAuditingSettingCollection collection = sqlServer.GetSqlServerDevOpsAuditingSettings();

// invoke the operation
string devOpsAuditingSettingsName = "Default";
SqlServerDevOpsAuditingSettingData data = new SqlServerDevOpsAuditingSettingData
{
    State = BlobAuditingPolicyState.Enabled,
    StorageEndpoint = "https://mystorage.blob.core.windows.net",
    StorageAccountAccessKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
};
ArmOperation<SqlServerDevOpsAuditingSettingResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, devOpsAuditingSettingsName, data);
SqlServerDevOpsAuditingSettingResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerDevOpsAuditingSettingData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

샘플 응답

상태 코드:

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

정의

Name	Description
BlobAuditingPolicyState	감사 상태를 지정합니다. 상태가 사용되면 storageEndpoint 또는 isAzureMonitorTargetEnabled가 필요합니다.
createdByType	리소스를 만든 ID의 형식입니다.
DevOpsAuditingSettingsName
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
ServerDevOpsAuditingSettings	서버 DevOps 감사 설정입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

BlobAuditingPolicyState

열거형

감사 상태를 지정합니다. 상태가 사용되면 storageEndpoint 또는 isAzureMonitorTargetEnabled가 필요합니다.

값	Description
Enabled
Disabled

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

DevOpsAuditingSettingsName

열거형

값	Description
Default

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

ServerDevOpsAuditingSettings

Object

서버 DevOps 감사 설정입니다.

Name	형식	Description
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	관리 ID를 사용하여 Blob Storage에 액세스할지 여부를 지정합니다.
properties.state	BlobAuditingPolicyState	감사 상태를 지정합니다. 상태가 사용되면 storageEndpoint 또는 isAzureMonitorTargetEnabled가 필요합니다.
properties.storageAccountAccessKey	string	감사 스토리지 계정의 식별자 키를 지정합니다. 상태가 사용되고 storageEndpoint가 지정된 경우 storageAccountAccessKey를 지정하지 않으면 SQL Server 시스템 할당 관리 ID를 사용하여 스토리지에 액세스합니다. 관리 ID 인증을 사용하기 위한 필수 구성 요소: AAD(Azure Active Directory)에서 SQL Server에 시스템 할당 관리 ID를 할당합니다. 서버 ID에 'Storage Blob 데이터 기여자' RBAC 역할을 추가하여 스토리지 계정에 대한 SQL Server ID 액세스 권한을 부여합니다. 자세한 내용은 관리 ID 인증 사용하여 스토리지에 대한 감사를 참조하세요.
properties.storageAccountSubscriptionId	string (uuid)	Blob Storage 구독 ID를 지정합니다.
properties.storageEndpoint	string	Blob Storage 엔드포인트(예: https://MyAccount.blob.core.windows.net)를 지정합니다. 상태가 사용되면 storageEndpoint 또는 isAzureMonitorTargetEnabled가 필요합니다.
systemData	systemData	ServerDevOpsAuditSettingsResource의 SystemData입니다.
type	string	리소스 종류입니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.