Advanced Threat Protection Settings - Update

Serviço:

MySQL

Versão da API:

2024-12-30

Atualiza o estado da Proteção Avançada contra Ameaças de um servidor.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
advancedThreatProtectionName	path	True	AdvancedThreatProtectionName	O nome do estado de Proteção Avançada contra Ameaças.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-z0-9][-a-z0-9]*(?	O nome do servidor.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.state	True	AdvancedThreatProtectionState	Especifica o estado da Proteção Avançada contra Ameaças, se ela está habilitada ou desabilitada ou um estado ainda não foi aplicado no banco de dados ou servidor específico.

Respostas

Nome	Tipo	Description
200 OK	AdvancedThreatProtection	A operação do Azure foi concluída com êxito.
202 Accepted		Solicitação de atualização de recurso aceita. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Código de status:

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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Código de status:

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

Definições

Nome	Description
AdvancedThreatProtection	Proteção Avançada contra Ameaças de um servidor.
AdvancedThreatProtectionForUpdate	Parâmetros permitidos para atualizar a proteção avançada contra ameaças para um servidor.
AdvancedThreatProtectionName	O nome do estado de Proteção Avançada contra Ameaças.
AdvancedThreatProtectionProvisioningState	O estado de provisionamento atual.
AdvancedThreatProtectionState	Especifica o estado da Proteção Avançada contra Ameaças, seja ela habilitada ou desabilitada no servidor.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
systemData	Metadados relativos à criação e última modificação do recurso.

AdvancedThreatProtection

Objeto

Proteção Avançada contra Ameaças de um servidor.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.creationTime	string (date-time)	Especifica a hora de criação utc da política.
properties.provisioningState	AdvancedThreatProtectionProvisioningState	Estado de provisionamento da Proteção contra Ameaças.
properties.state	AdvancedThreatProtectionState	Especifica o estado da Proteção Avançada contra Ameaças, se ela está habilitada ou desabilitada ou um estado ainda não foi aplicado no banco de dados ou servidor específico.
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

AdvancedThreatProtectionForUpdate

Objeto

Parâmetros permitidos para atualizar a proteção avançada contra ameaças para um servidor.

Nome	Tipo	Description
properties.state	AdvancedThreatProtectionState	Especifica o estado da Proteção Avançada contra Ameaças, se ela está habilitada ou desabilitada ou um estado ainda não foi aplicado no banco de dados ou servidor específico.

AdvancedThreatProtectionName

Enumeração

O nome do estado de Proteção Avançada contra Ameaças.

Valor	Description
Default

AdvancedThreatProtectionProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Succeeded
Updating
Canceled
Failed

AdvancedThreatProtectionState

Enumeração

Especifica o estado da Proteção Avançada contra Ameaças, seja ela habilitada ou desabilitada no servidor.

Valor	Description
Enabled
Disabled

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.