Server DevOps Audit Settings - Create Or Update

Tjänst:: SQL Database

API-version:: 2023-08-01

Skapar eller uppdaterar en servers DevOps-granskningsinställningar.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
devOpsAuditingSettingsName	path	True	DevOpsAuditingSettingsName
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.state	True	BlobAuditingPolicyState	Anger granskningstillståndet. Om tillståndet är Aktiverat krävs storageEndpoint ellerazureMonitorTargetEnabled.
properties.isAzureMonitorTargetEnabled		boolean	Anger om DevOps-granskningshändelser skickas till Azure Monitor. För att skicka händelserna till Azure Monitor anger du "State" som "Enabled" och "IsAzureMonitorTargetEnabled" som true. När du använder REST API för att konfigurera DevOps-granskning bör diagnostikinställningar med diagnostikloggkategorin DevOpsOperationsAudit i huvuddatabasen också skapas. URI-format för diagnostikinställningar: 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` Mer information finns i REST API eller Diagnostikinställningar PowerShell
properties.isManagedIdentityInUse		boolean	Anger om hanterad identitet används för åtkomst till bloblagring
properties.storageAccountAccessKey		string	Anger identifierarnyckeln för granskningslagringskontot. Om tillståndet är Aktiverat och storageEndpoint har angetts används SQL Server systemtilldelad hanterad identitet för att komma åt lagringen genom att inte ange lagringskontotAccountAccessKey. Förutsättningar för att använda hanterad identitetsautentisering: Tilldela SQL Server en systemtilldelad hanterad identitet i Azure Active Directory (AAD). Ge SQL Server-identitet åtkomst till lagringskontot genom att lägga till RBAC-rollen "Storage Blob Data Contributor" i serveridentiteten. Mer information finns i Granskning till lagring med hjälp av hanterad identitetsautentisering
properties.storageAccountSubscriptionId		string (uuid)	Anger prenumerations-ID för bloblagring.
properties.storageEndpoint		string	Anger bloblagringsslutpunkten (t.ex. `https://MyAccount.blob.core.windows.net`). Om tillståndet är Aktiverat krävs storageEndpoint ellerazureMonitorTargetEnabled.

Svar

Name	Typ	Description
200 OK	ServerDevOpsAuditingSettings	DevOps-granskningsinställningarna har uppdaterats.
202 Accepted		Uppdatering av DevOps-inställningarna för granskning pågår. Sidhuvuden Location: string
Other Status Codes	ErrorResponse	Felsvar: *** 400 ManagedInstanceStoppingOrS toppad – Konfliktåtgärd som skickas när instansen är i stopptillstånd 400 ManagedInstanceStarting – Konfliktåtgärd som skickas när instansen är i starttillstånd 400 InvalidServerDevOpsAuditSettingsCreateRequest – Begäran om devops-granskningsprincip för create-servern finns inte eller har inget egenskapsobjekt. 400 DataSecurityInvalidUserSuppliedParameter – Ett ogiltigt parametervärde angavs av klienten. 400 InvalidServerDevOpsAuditSettingsName – Ogiltigt servernamn för DevOps-princip. 400 DevOpsAuditInvalidStorageAccountCredentials – det angivna lagringskontot eller åtkomstnyckeln är inte giltig. 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen. 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 OperationIdNotFound – Åtgärden med ID finns inte. 409 ServerDevOpsAuditSettingsInProgress – Set server DevOps audit pågår redan. 409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas. 409 OperationCancelled – Åtgärden har avbrutits av användaren. 409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs. 429 SubscriptionTooManyCreateUpdateRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser. 500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök igen. 503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Name

Typ

Description

200 OK

ServerDevOpsAuditingSettings

DevOps-granskningsinställningarna har uppdaterats.

202 Accepted

Uppdatering av DevOps-inställningarna för granskning pågår.

Sidhuvuden

Location: string

Other Status Codes

ErrorResponse

Felsvar: ***

400 ManagedInstanceStoppingOrS toppad – Konfliktåtgärd som skickas när instansen är i stopptillstånd
400 ManagedInstanceStarting – Konfliktåtgärd som skickas när instansen är i starttillstånd
400 InvalidServerDevOpsAuditSettingsCreateRequest – Begäran om devops-granskningsprincip för create-servern finns inte eller har inget egenskapsobjekt.
400 DataSecurityInvalidUserSuppliedParameter – Ett ogiltigt parametervärde angavs av klienten.
400 InvalidServerDevOpsAuditSettingsName – Ogiltigt servernamn för DevOps-princip.
400 DevOpsAuditInvalidStorageAccountCredentials – det angivna lagringskontot eller åtkomstnyckeln är inte giltig.
404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.
404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte
404 OperationIdNotFound – Åtgärden med ID finns inte.
409 ServerDevOpsAuditSettingsInProgress – Set server DevOps audit pågår redan.
409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas.
409 OperationCancelled – Åtgärden har avbrutits av användaren.
409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs.
429 SubscriptionTooManyCreateUpdateRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.
429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser.
500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök igen.
503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Exempel

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

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

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

Exempelsvar

Statuskod:: 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
  }
}

Statuskod:: 202

Update a server's DevOps audit settings with minimal input

Exempelbegäran

HTTP
dotnet

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

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

Exempelsvar

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

Statuskod:: 202

Definitioner

Name	Description
BlobAuditingPolicyState	Anger granskningstillståndet. Om tillståndet är Aktiverat krävs storageEndpoint ellerazureMonitorTargetEnabled.
createdByType	Den typ av identitet som skapade resursen.
DevOpsAuditingSettingsName
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ServerDevOpsAuditingSettings	En Server DevOps-granskningsinställningar.
systemData	Metadata som rör skapande och senaste ändring av resursen.

BlobAuditingPolicyState

Uppräkning

Anger granskningstillståndet. Om tillståndet är Aktiverat krävs storageEndpoint ellerazureMonitorTargetEnabled.

Värde	Description
Enabled
Disabled

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

DevOpsAuditingSettingsName

Uppräkning

Värde	Description
Default

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ServerDevOpsAuditingSettings

Objekt

En Server DevOps-granskningsinställningar.

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.isAzureMonitorTargetEnabled	boolean	Anger om DevOps-granskningshändelser skickas till Azure Monitor. För att skicka händelserna till Azure Monitor anger du "State" som "Enabled" och "IsAzureMonitorTargetEnabled" som true. När du använder REST API för att konfigurera DevOps-granskning bör diagnostikinställningar med diagnostikloggkategorin DevOpsOperationsAudit i huvuddatabasen också skapas. URI-format för diagnostikinställningar: 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` Mer information finns i REST API eller Diagnostikinställningar PowerShell
properties.isManagedIdentityInUse	boolean	Anger om hanterad identitet används för åtkomst till bloblagring
properties.state	BlobAuditingPolicyState	Anger granskningstillståndet. Om tillståndet är Aktiverat krävs storageEndpoint ellerazureMonitorTargetEnabled.
properties.storageAccountAccessKey	string	Anger identifierarnyckeln för granskningslagringskontot. Om tillståndet är Aktiverat och storageEndpoint har angetts används SQL Server systemtilldelad hanterad identitet för att komma åt lagringen genom att inte ange lagringskontotAccountAccessKey. Förutsättningar för att använda hanterad identitetsautentisering: Tilldela SQL Server en systemtilldelad hanterad identitet i Azure Active Directory (AAD). Ge SQL Server-identitet åtkomst till lagringskontot genom att lägga till RBAC-rollen "Storage Blob Data Contributor" i serveridentiteten. Mer information finns i Granskning till lagring med hjälp av hanterad identitetsautentisering
properties.storageAccountSubscriptionId	string (uuid)	Anger prenumerations-ID för bloblagring.
properties.storageEndpoint	string	Anger bloblagringsslutpunkten (t.ex. `https://MyAccount.blob.core.windows.net`). Om tillståndet är Aktiverat krävs storageEndpoint ellerazureMonitorTargetEnabled.
systemData	systemData	SystemData för ServerDevOpsAuditSettingsResource.
type	string	Resurstyp.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Dela via

Server DevOps Audit Settings - Create Or Update

URI-parametrar

Begärandetext

Svar

Exempel

Update a server's DevOps audit settings with all params

Exempelbegäran

Exempelsvar

Update a server's DevOps audit settings with minimal input

Exempelbegäran

Exempelsvar

Definitioner

BlobAuditingPolicyState

createdByType

DevOpsAuditingSettingsName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerDevOpsAuditingSettings

systemData