Advanced Threat Protection Settings - Update

Service:

MySQL

API-versie:

2024-12-30

Hiermee wordt de status Advanced Threat Protection van een server bijgewerkt.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/Default?api-version=2024-12-30

URI-parameters

Name	In	Vereist	Type	Description
advancedThreatProtectionName	path	True	AdvancedThreatProtectionName	De naam van de Advanced Threat Protection-status.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
serverName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-z0-9][-a-z0-9]*(?	De naam van de server.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
properties.state	True	AdvancedThreatProtectionState	Hiermee geeft u de status van Advanced Threat Protection, ongeacht of deze is ingeschakeld of uitgeschakeld of een status nog niet is toegepast op de specifieke database of server.

Antwoorden

Name	Type	Description
200 OK	AdvancedThreatProtection	Azure-bewerking is voltooid.
202 Accepted		Verzoek om bronupdate geaccepteerd. Kopteksten Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Disable a server's Advanced Threat Protection settings with all parameters

Enable a server's Advanced Threat Protection settings

Disable a server's Advanced Threat Protection settings with all parameters

Voorbeeldaanvraag

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default?api-version=2024-12-30

{
  "properties": {
    "state": "Disabled"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python advanced_threat_protection_settings_patch_disabled.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.advanced_threat_protection_settings.begin_update(
        resource_group_name="threatprotection-4799",
        server_name="threatprotection-6440",
        advanced_threat_protection_name="Default",
        parameters={"properties": {"state": "Disabled"}},
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2024-12-30/examples/AdvancedThreatProtectionSettingsPatchDisabled.json
if __name__ == "__main__":
    main()

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.MySql.FlexibleServers.Models;
using Azure.ResourceManager.MySql.FlexibleServers;

// Generated from example definition: 2024-12-30/AdvancedThreatProtectionSettingsPatchDisabled.json
// this example is just showing the usage of "AdvancedThreatProtection_Update" 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 AdvancedThreatProtectionResource created on azure
// for more information of creating AdvancedThreatProtectionResource, please refer to the document of AdvancedThreatProtectionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "threatprotection-4799";
string serverName = "threatprotection-6440";
AdvancedThreatProtectionName advancedThreatProtectionName = AdvancedThreatProtectionName.Default;
ResourceIdentifier advancedThreatProtectionResourceId = AdvancedThreatProtectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, advancedThreatProtectionName);
AdvancedThreatProtectionResource advancedThreatProtection = client.GetAdvancedThreatProtectionResource(advancedThreatProtectionResourceId);

// invoke the operation
AdvancedThreatProtectionPatch patch = new AdvancedThreatProtectionPatch();
ArmOperation<AdvancedThreatProtectionResource> lro = await advancedThreatProtection.UpdateAsync(WaitUntil.Completed, patch);
AdvancedThreatProtectionResource 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
AdvancedThreatProtectionData 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

Voorbeeldrespons

Statuscode:

200

{
  "name": "Default",
  "type": "Microsoft.DBforMySQL/flexibleServers/advancedThreatProtectionSettings",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default",
  "properties": {
    "creationTime": "2022-04-03T04:41:33.937Z",
    "provisioningState": "Succeeded",
    "state": "Disabled"
  },
  "systemData": {
    "createdAt": "2022-04-03T04:41:33.937Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2022-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  }
}

Statuscode:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/azureAsyncOperation/00000000-0000-0000-0000-000000000000?api-version=2024-12-30
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-12-30

Enable a server's Advanced Threat Protection settings

Voorbeeldaanvraag

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default?api-version=2024-12-30

{
  "properties": {
    "state": "Enabled"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python advanced_threat_protection_settings_patch_enabled.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.advanced_threat_protection_settings.begin_update(
        resource_group_name="threatprotection-4799",
        server_name="threatprotection-6440",
        advanced_threat_protection_name="Default",
        parameters={"properties": {"state": "Enabled"}},
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2024-12-30/examples/AdvancedThreatProtectionSettingsPatchEnabled.json
if __name__ == "__main__":
    main()

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.MySql.FlexibleServers.Models;
using Azure.ResourceManager.MySql.FlexibleServers;

// Generated from example definition: 2024-12-30/AdvancedThreatProtectionSettingsPatchEnabled.json
// this example is just showing the usage of "AdvancedThreatProtection_Update" 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 AdvancedThreatProtectionResource created on azure
// for more information of creating AdvancedThreatProtectionResource, please refer to the document of AdvancedThreatProtectionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "threatprotection-4799";
string serverName = "threatprotection-6440";
AdvancedThreatProtectionName advancedThreatProtectionName = AdvancedThreatProtectionName.Default;
ResourceIdentifier advancedThreatProtectionResourceId = AdvancedThreatProtectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, advancedThreatProtectionName);
AdvancedThreatProtectionResource advancedThreatProtection = client.GetAdvancedThreatProtectionResource(advancedThreatProtectionResourceId);

// invoke the operation
AdvancedThreatProtectionPatch patch = new AdvancedThreatProtectionPatch();
ArmOperation<AdvancedThreatProtectionResource> lro = await advancedThreatProtection.UpdateAsync(WaitUntil.Completed, patch);
AdvancedThreatProtectionResource 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
AdvancedThreatProtectionData 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

Voorbeeldrespons

Statuscode:

200

{
  "name": "Default",
  "type": "Microsoft.DBforMySQL/flexibleServers/advancedThreatProtectionSettings",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default",
  "properties": {
    "creationTime": "2022-04-03T04:41:33.937Z",
    "provisioningState": "Succeeded",
    "state": "Enabled"
  },
  "systemData": {
    "createdAt": "2022-04-03T04:41:33.937Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2022-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  }
}

Statuscode:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/azureAsyncOperation/00000000-0000-0000-0000-000000000000?api-version=2024-12-30
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-12-30

Definities

Name	Description
AdvancedThreatProtection	Advanced Threat Protection van een server.
AdvancedThreatProtectionForUpdate	Parameters die advanced threat protection voor een server mogen bijwerken.
AdvancedThreatProtectionName	De naam van de Advanced Threat Protection-status.
AdvancedThreatProtectionProvisioningState	De huidige inrichtingsstatus.
AdvancedThreatProtectionState	Hiermee geeft u de status van Advanced Threat Protection op, ongeacht of deze is ingeschakeld of uitgeschakeld op de server.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

AdvancedThreatProtection

Object

Advanced Threat Protection van een server.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.creationTime	string (date-time)	Hiermee geeft u de UTC-aanmaaktijd van het beleid.
properties.provisioningState	AdvancedThreatProtectionProvisioningState	Inrichtingsstatus van threat protection.
properties.state	AdvancedThreatProtectionState	Hiermee geeft u de status van Advanced Threat Protection, ongeacht of deze is ingeschakeld of uitgeschakeld of een status nog niet is toegepast op de specifieke database of server.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

AdvancedThreatProtectionForUpdate

Object

Parameters die advanced threat protection voor een server mogen bijwerken.

Name	Type	Description
properties.state	AdvancedThreatProtectionState	Hiermee geeft u de status van Advanced Threat Protection, ongeacht of deze is ingeschakeld of uitgeschakeld of een status nog niet is toegepast op de specifieke database of server.

AdvancedThreatProtectionName

Opsomming

De naam van de Advanced Threat Protection-status.

Waarde	Description
Default

AdvancedThreatProtectionProvisioningState

Opsomming

De huidige inrichtingsstatus.

Waarde	Description
Succeeded
Updating
Canceled
Failed

AdvancedThreatProtectionState

Opsomming

Hiermee geeft u de status van Advanced Threat Protection op, ongeacht of deze is ingeschakeld of uitgeschakeld op de server.

Waarde	Description
Enabled
Disabled

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

systemData

Object

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

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