Server DevOps Audit Settings - Create Or Update

Referens

Service:: SQL Database

API Version:: 2021-11-01

Skapar eller uppdaterar en servers DevOps-granskningsinställningar.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
devOpsAuditingSettingsName	path	True	string	Namnet på granskningsinställningarna för devops. Detta bör alltid vara "standard".
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 eller isAzureMonitorTargetEnabled.
properties.isAzureMonitorTargetEnabled		boolean	Anger om DevOps-granskningshändelser skickas till Azure Monitor. För att kunna 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 Diagnostikinställningar REST API eller Diagnostikinställningar PowerShell
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 storageAccountAccessKey. Krav för att använda autentisering med hanterad identitet: 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 hanterad identitetsautentisering
properties.storageAccountSubscriptionId		string	Anger prenumerations-ID:t för Blob Storage.
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.
Other Status Codes		Felsvar: *** 400 InvalidServerDevOpsAuditSettingsCreateRequest – Begäran om att skapa serverns DevOps-granskningsprincip 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 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen. 409 ServerDevOpsAuditSettingsInProgress – DevOps-granskning för uppsättningsserver pågår redan.

Name

Typ

Description

200 OK

ServerDevOpsAuditingSettings

DevOps-granskningsinställningarna har uppdaterats.

202 Accepted

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

Other Status Codes

Felsvar: ***

400 InvalidServerDevOpsAuditSettingsCreateRequest – Begäran om att skapa serverns DevOps-granskningsprincip 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 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte
404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.
409 ServerDevOpsAuditSettingsInProgress – DevOps-granskning för uppsättningsserver pågår redan.

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=2021-11-01

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "isAzureMonitorTargetEnabled": true
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerDevOpsAuditingSettingsInner;
import com.azure.resourcemanager.sql.models.BlobAuditingPolicyState;
import java.util.UUID;

/** Samples for ServerDevOpsAuditSettings CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerDevOpsAuditCreateMax.json
     */
    /**
     * Sample code: Update a server's DevOps audit settings with all params.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSDevOpsAuditSettingsWithAllParams(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerDevOpsAuditSettings().createOrUpdate("devAuditTestRG",
            "devOpsAuditTestSvr", "default",
            new ServerDevOpsAuditingSettingsInner().withIsAzureMonitorTargetEnabled(true)
                .withState(BlobAuditingPolicyState.ENABLED)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder").withStorageAccountSubscriptionId(
                    UUID.fromString("00000000-1234-0000-5678-000000000000")),
            Context.NONE);
    }
}

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

Sample Response

Status code:: 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
  }
}

Status code:: 202

Update a server's DevOps audit settings with minimal input

Sample Request

HTTP
Java

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

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerDevOpsAuditingSettingsInner;
import com.azure.resourcemanager.sql.models.BlobAuditingPolicyState;

/** Samples for ServerDevOpsAuditSettings CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerDevOpsAuditCreateMin.json
     */
    /**
     * Sample code: Update a server's DevOps audit settings with minimal input.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSDevOpsAuditSettingsWithMinimalInput(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerDevOpsAuditSettings().createOrUpdate("devAuditTestRG",
            "devOpsAuditTestSvr", "default",
            new ServerDevOpsAuditingSettingsInner().withState(BlobAuditingPolicyState.ENABLED)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder"),
            Context.NONE);
    }
}

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

Sample Response

Status code:: 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"
  }
}

Status code:: 202

Definitioner

Name	Description
BlobAuditingPolicyState	Anger granskningstillståndet. Om tillståndet är Aktiverat krävs storageEndpoint eller isAzureMonitorTargetEnabled.
createdByType	Den typ av identitet som skapade resursen.
ServerDevOpsAuditingSettings	En Server DevOps-granskningsinställningar.
systemData	Metadata som rör skapande och senaste ändring av resursen.

BlobAuditingPolicyState

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

Name	Typ	Description
Disabled	string
Enabled	string

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ServerDevOpsAuditingSettings

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 kunna 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 Diagnostikinställningar REST API eller Diagnostikinställningar PowerShell
properties.state	BlobAuditingPolicyState	Anger granskningstillståndet. Om tillståndet är Aktiverat krävs storageEndpoint eller isAzureMonitorTargetEnabled.
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 storageAccountAccessKey. Krav för att använda autentisering med hanterad identitet: 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 hanterad identitetsautentisering
properties.storageAccountSubscriptionId	string	Anger prenumerations-ID:t för Blob Storage.
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

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

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	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.

Share via

Server DevOps Audit Settings - Create Or Update

URI-parametrar

Begärandetext

Svar

Exempel

Update a server's DevOps audit settings with all params

Sample Request

Sample Response

Update a server's DevOps audit settings with minimal input

Sample Request

Sample Response

Definitioner

BlobAuditingPolicyState

createdByType

ServerDevOpsAuditingSettings

systemData

Ytterligare resurser