Server DevOps Audit Settings - Create Or Update

Reference

Služba:: SQL Database

Verze rozhraní API:: 2021-11-01

Vytvoří nebo aktualizuje nastavení auditu DevOps serveru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
devOpsAuditingSettingsName	path	True	string	Název nastavení auditu devops. Vždy by to mělo být výchozí.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API azure Resource Manager nebo z portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.state	True	BlobAuditingPolicyState	Určuje stav auditu. Pokud je stav Povoleno, vyžaduje se storageEndpoint nebo isAzureMonitorTargetEnabled.
properties.isAzureMonitorTargetEnabled		boolean	Určuje, jestli se události auditu DevOps odesílají do Azure Monitoru. Pokud chcete odesílat události do Služby Azure Monitor, zadejte State jako Enabled a IsAzureMonitorTargetEnabled jako true. Při použití rozhraní REST API ke konfiguraci auditu DevOps by se měla vytvořit také nastavení diagnostiky s kategorií diagnostických protokolů DevOpsOperationsAudit v hlavní databázi. Formát identifikátoru URI nastavení diagnostiky: 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 Další informace najdete v tématu Nastavení diagnostiky rozhraní REST API nebo Nastavení diagnostiky v PowerShellu.
properties.storageAccountAccessKey		string	Určuje klíč identifikátoru účtu úložiště auditování. Pokud je stav Povoleno a je zadaný parametr storageEndpoint, nezadáte-li klíč storageAccountAccessKey, použije se pro přístup k úložišti spravovaná identita přiřazená systémem SQL Serveru. Předpoklady pro použití ověřování spravované identity: Přiřazení SQL Server spravované identity přiřazené systémem v Azure Active Directory (AAD). Udělte SQL Server identitě přístup k účtu úložiště přidáním role RBAC Přispěvatel dat objektů blob služby Storage k identitě serveru. Další informace najdete v tématu Auditování úložiště pomocí ověřování spravované identity.
properties.storageAccountSubscriptionId		string	Určuje ID předplatného úložiště objektů blob.
properties.storageEndpoint		string	Určuje koncový bod úložiště objektů blob (např. https://MyAccount.blob.core.windows.net). Pokud je stav Povoleno, vyžaduje se storageEndpoint nebo isAzureMonitorTargetEnabled.

Odpovědi

Name	Typ	Description
200 OK	ServerDevOpsAuditingSettings	Nastavení auditu DevOps se úspěšně aktualizovalo.
202 Accepted		Probíhá aktualizace nastavení DevOps pro audit.
Other Status Codes		Chybové odpovědi: *** 400 InvalidServerDevOpsAuditSettingsCreateRequest – požadavek na zásady auditu DevOps pro vytvoření serveru neexistuje nebo nemá žádný objekt properties. 400 DataSecurityInvalidUserSuppliedParameter – klient zadal neplatnou hodnotu parametru. 400 InvalidServerDevOpsAuditSettingsName – neplatný název zásady DevOps serveru. 400 DevOpsAuditInvalidStorageAccountCredentials – zadaný účet úložiště nebo přístupový klíč nejsou platné. 404 SubscriptionDoesNotHaveServer – požadovaný server nebyl nalezen. 404 ServerNotInSubscriptionResourceGroup – zadaný server neexistuje v zadané skupině prostředků a předplatném. 409 ServerDevOpsAuditSettingsInProgress – nastavení auditu DevOps serveru už probíhá.

Name

Typ

Description

200 OK

ServerDevOpsAuditingSettings

Nastavení auditu DevOps se úspěšně aktualizovalo.

202 Accepted

Probíhá aktualizace nastavení DevOps pro audit.

Other Status Codes

Chybové odpovědi: ***

400 InvalidServerDevOpsAuditSettingsCreateRequest – požadavek na zásady auditu DevOps pro vytvoření serveru neexistuje nebo nemá žádný objekt properties.
400 DataSecurityInvalidUserSuppliedParameter – klient zadal neplatnou hodnotu parametru.
400 InvalidServerDevOpsAuditSettingsName – neplatný název zásady DevOps serveru.
400 DevOpsAuditInvalidStorageAccountCredentials – zadaný účet úložiště nebo přístupový klíč nejsou platné.
404 SubscriptionDoesNotHaveServer – požadovaný server nebyl nalezen.
404 ServerNotInSubscriptionResourceGroup – zadaný server neexistuje v zadané skupině prostředků a předplatném.
409 ServerDevOpsAuditSettingsInProgress – nastavení auditu DevOps serveru už probíhá.

Příklady

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.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")),
            com.azure.core.util.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

Ukázková odpověď

Stavový kód:: 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
  }
}

Stavový kód:: 202

Update a server's DevOps audit settings with minimal input

Ukázkový požadavek

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.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"),
            com.azure.core.util.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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 202

Definice

Name	Description
BlobAuditingPolicyState	Určuje stav auditu. Pokud je stav Povoleno, vyžaduje se storageEndpoint nebo isAzureMonitorTargetEnabled.
createdByType	Typ identity, která vytvořila prostředek.
ServerDevOpsAuditingSettings	Nastavení auditování DevOps serveru.
systemData	Metadata týkající se vytvoření a poslední změny prostředku

BlobAuditingPolicyState

Enumeration

Určuje stav auditu. Pokud je stav Povoleno, vyžaduje se storageEndpoint nebo isAzureMonitorTargetEnabled.

Hodnota	Description
Disabled
Enabled

createdByType

Enumeration

Typ identity, která vytvořila prostředek.

Hodnota	Description
Application
Key
ManagedIdentity
User

ServerDevOpsAuditingSettings

Object

Nastavení auditování DevOps serveru.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku.
properties.isAzureMonitorTargetEnabled	boolean	Určuje, jestli se události auditu DevOps odesílají do Azure Monitoru. Pokud chcete odesílat události do Služby Azure Monitor, zadejte State jako Enabled a IsAzureMonitorTargetEnabled jako true. Při použití rozhraní REST API ke konfiguraci auditu DevOps by se měla vytvořit také nastavení diagnostiky s kategorií diagnostických protokolů DevOpsOperationsAudit v hlavní databázi. Formát identifikátoru URI nastavení diagnostiky: 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 Další informace najdete v tématu Nastavení diagnostiky rozhraní REST API nebo Nastavení diagnostiky v PowerShellu.
properties.state	BlobAuditingPolicyState	Určuje stav auditu. Pokud je stav Povoleno, vyžaduje se storageEndpoint nebo isAzureMonitorTargetEnabled.
properties.storageAccountAccessKey	string	Určuje klíč identifikátoru účtu úložiště auditování. Pokud je stav Povoleno a je zadaný parametr storageEndpoint, nezadáte-li klíč storageAccountAccessKey, použije se pro přístup k úložišti spravovaná identita přiřazená systémem SQL Serveru. Předpoklady pro použití ověřování spravované identity: Přiřazení SQL Server spravované identity přiřazené systémem v Azure Active Directory (AAD). Udělte SQL Server identitě přístup k účtu úložiště přidáním role RBAC Přispěvatel dat objektů blob služby Storage k identitě serveru. Další informace najdete v tématu Auditování úložiště pomocí ověřování spravované identity.
properties.storageAccountSubscriptionId	string	Určuje ID předplatného úložiště objektů blob.
properties.storageEndpoint	string	Určuje koncový bod úložiště objektů blob (např. https://MyAccount.blob.core.windows.net). Pokud je stav Povoleno, vyžaduje se storageEndpoint nebo isAzureMonitorTargetEnabled.
systemData	systemData	SystemData serveruDevOpsAuditSettingsResource.
type	string	Typ prostředku.

systemData

Object

Metadata týkající se vytvoření a poslední změny prostředku

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která vytvořila prostředek.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Server DevOps Audit Settings - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Update a server's DevOps audit settings with all params

Ukázkový požadavek

Ukázková odpověď

Update a server's DevOps audit settings with minimal input

Ukázkový požadavek

Ukázková odpověď

Definice

BlobAuditingPolicyState

createdByType

ServerDevOpsAuditingSettings

systemData

Další materiály