Server DevOps Audit Settings - Create Or Update

Referentie

Service:: SQL Database

API Version:: 2021-11-01

Hiermee worden de DevOps-controle-instellingen van een server gemaakt of bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
devOpsAuditingSettingsName	path	True	string	De naam van de devops-auditinstellingen. Dit moet altijd 'standaard' zijn.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name	Vereist	Type	Description
properties.state	True	BlobAuditingPolicyState	Hiermee geeft u de status van de controle. Als de status Ingeschakeld is, zijn storageEndpoint of isAzureMonitorTargetEnabled vereist.
properties.isAzureMonitorTargetEnabled		boolean	Hiermee geeft u op of DevOps-controlegebeurtenissen worden verzonden naar Azure Monitor. Als u de gebeurtenissen naar Azure Monitor wilt verzenden, geeft u 'State' op als 'Enabled' en 'IsAzureMonitorTargetEnabled' als true. Wanneer u rest API gebruikt om DevOps-controle te configureren, moeten diagnostische instellingen met de categorie 'DevOpsOperationsAudit'-diagnostische logboeken op de hoofddatabase ook worden gemaakt. URI-indeling voor diagnostische instellingen: 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 Zie Diagnostische instellingen REST API of Diagnostische instellingen PowerShell voor meer informatie
properties.storageAccountAccessKey		string	Hiermee geeft u de id-sleutel van het controleopslagaccount op. Als de status Ingeschakeld is en storageEndpoint is opgegeven, wordt bij het niet opgeven van de storageAccountAccessKey een door het SQL Server-systeem toegewezen beheerde identiteit gebruikt voor toegang tot de opslag. Vereisten voor het gebruik van verificatie van beheerde identiteiten: Wijs SQL Server een door het systeem toegewezen beheerde identiteit toe in Azure Active Directory (AAD). Ververleent SQL Server identiteit toegang tot het opslagaccount door de RBAC-rol Inzender voor opslagblobgegevens toe te voegen aan de serveridentiteit. Zie Controle op opslag met behulp van verificatie van beheerde identiteiten voor meer informatie
properties.storageAccountSubscriptionId		string	Hiermee geeft u de abonnements-id voor blob-opslag op.
properties.storageEndpoint		string	Hiermee geeft u het eindpunt van de blob-opslag (bijvoorbeeld https://MyAccount.blob.core.windows.net). Als de status Ingeschakeld is, is storageEndpoint of isAzureMonitorTargetEnabled vereist.

Antwoorden

Name	Type	Description
200 OK	ServerDevOpsAuditingSettings	De DevOps-auditinstellingen zijn bijgewerkt.
202 Accepted		Het bijwerken van de DevOps-instellingen voor controle wordt uitgevoerd.
Other Status Codes		Foutreacties: *** 400 InvalidServerDevOpsAuditSettingsCreateRequest - De devOps-controlebeleidsaanvraag voor het maken van de server bestaat niet of heeft geen eigenschappenobject. 400 DataSecurityInvalidUserSuppliedParameter - Er is een ongeldige parameterwaarde opgegeven door de client. 400 InvalidServerDevOpsAuditSettingsName - Ongeldige DevOps-beleidsnaam voor server. 400 DevOpsAuditInvalidStorageAccountCredentials: het opgegeven opslagaccount of de opgegeven toegangssleutel is niet geldig. 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden 404 ServerNotInSubscriptionResourceGroup : de opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement. 409 ServerDevOpsAuditSettingsInProgress - Instellen server DevOps-controle wordt al uitgevoerd.

Name

Type

Description

200 OK

ServerDevOpsAuditingSettings

De DevOps-auditinstellingen zijn bijgewerkt.

202 Accepted

Het bijwerken van de DevOps-instellingen voor controle wordt uitgevoerd.

Other Status Codes

Foutreacties: ***

400 InvalidServerDevOpsAuditSettingsCreateRequest - De devOps-controlebeleidsaanvraag voor het maken van de server bestaat niet of heeft geen eigenschappenobject.
400 DataSecurityInvalidUserSuppliedParameter - Er is een ongeldige parameterwaarde opgegeven door de client.
400 InvalidServerDevOpsAuditSettingsName - Ongeldige DevOps-beleidsnaam voor server.
400 DevOpsAuditInvalidStorageAccountCredentials: het opgegeven opslagaccount of de opgegeven toegangssleutel is niet geldig.
404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden
404 ServerNotInSubscriptionResourceGroup : de opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement.
409 ServerDevOpsAuditSettingsInProgress - Instellen server DevOps-controle wordt al uitgevoerd.

Voorbeelden

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

Definities

Name	Description
BlobAuditingPolicyState	Hiermee geeft u de status van de controle. Als de status Ingeschakeld is, zijn storageEndpoint of isAzureMonitorTargetEnabled vereist.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ServerDevOpsAuditingSettings	Een devOps-controle-instellingen voor de server.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

BlobAuditingPolicyState

Hiermee geeft u de status van de controle. Als de status Ingeschakeld is, zijn storageEndpoint of isAzureMonitorTargetEnabled vereist.

Name	Type	Description
Disabled	string
Enabled	string

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ServerDevOpsAuditingSettings

Een devOps-controle-instellingen voor de server.

Name	Type	Description
id	string	Resource-id.
name	string	Resourcenaam.
properties.isAzureMonitorTargetEnabled	boolean	Hiermee geeft u op of DevOps-controlegebeurtenissen worden verzonden naar Azure Monitor. Als u de gebeurtenissen naar Azure Monitor wilt verzenden, geeft u 'State' op als 'Enabled' en 'IsAzureMonitorTargetEnabled' als true. Wanneer u rest API gebruikt om DevOps-controle te configureren, moeten diagnostische instellingen met de categorie 'DevOpsOperationsAudit'-diagnostische logboeken op de hoofddatabase ook worden gemaakt. URI-indeling voor diagnostische instellingen: 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 Zie Diagnostische instellingen REST API of Diagnostische instellingen PowerShell voor meer informatie
properties.state	BlobAuditingPolicyState	Hiermee geeft u de status van de controle. Als de status Ingeschakeld is, zijn storageEndpoint of isAzureMonitorTargetEnabled vereist.
properties.storageAccountAccessKey	string	Hiermee geeft u de id-sleutel van het controleopslagaccount op. Als de status Ingeschakeld is en storageEndpoint is opgegeven, wordt bij het niet opgeven van de storageAccountAccessKey een door het SQL Server-systeem toegewezen beheerde identiteit gebruikt voor toegang tot de opslag. Vereisten voor het gebruik van verificatie van beheerde identiteiten: Wijs SQL Server een door het systeem toegewezen beheerde identiteit toe in Azure Active Directory (AAD). Ververleent SQL Server identiteit toegang tot het opslagaccount door de RBAC-rol Inzender voor opslagblobgegevens toe te voegen aan de serveridentiteit. Zie Controle op opslag met behulp van verificatie van beheerde identiteiten voor meer informatie
properties.storageAccountSubscriptionId	string	Hiermee geeft u de abonnements-id voor blob-opslag op.
properties.storageEndpoint	string	Hiermee geeft u het eindpunt van de blob-opslag (bijvoorbeeld https://MyAccount.blob.core.windows.net). Als de status Ingeschakeld is, is storageEndpoint of isAzureMonitorTargetEnabled vereist.
systemData	systemData	SystemData van ServerDevOpsAuditSettingsResource.
type	string	Resourcetype.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

Server DevOps Audit Settings - Create Or Update

URI-parameters

Aanvraagbody

Antwoorden

Voorbeelden

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

Definities

BlobAuditingPolicyState

createdByType

ServerDevOpsAuditingSettings

systemData

Aanvullende resources