Managed Instance Vulnerability Assessments - Create Or Update

  • Referência
Service:
SQL Database
API Version:
2021-11-01

Cria ou atualiza a avaliação de vulnerabilidades da instância gerida. Saiba mais sobre como definir a avaliação de vulnerabilidades do SQL com a identidade gerida – https://docs.microsoft.com/azure/azure-sql/database/sql-database-vulnerability-assessment-storage

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/vulnerabilityAssessments/default?api-version=2021-11-01

Parâmetros do URI

Name Em Necessário Tipo Description
managedInstanceName
 path True

string

O nome da instância gerida para a qual a avaliação de vulnerabilidades está definida.
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
subscriptionId
 path True

string

O ID da subscrição que identifica uma subscrição do Azure.
vulnerabilityAssessmentName
 path True

VulnerabilityAssessmentName

O nome da avaliação de vulnerabilidades.
api-version
 query True

string

A versão da API a utilizar para o pedido.

Corpo do Pedido

Name Necessário Tipo Description
properties.storageContainerPath True

string

Um caminho de contentor de armazenamento de blobs para manter os resultados da análise (por exemplo, https://myStorage.blob.core.windows.net/VaScans/).
properties.recurringScans

VulnerabilityAssessmentRecurringScansProperties

As definições de análise periódica
properties.storageAccountAccessKey

string

Especifica a chave de identificador da conta de armazenamento para os resultados da análise da avaliação de vulnerabilidades. Se "StorageContainerSasKey" não for especificado, é necessário storageAccountAccessKey. Aplica-se apenas se a conta de armazenamento não estiver atrás de uma Vnet ou de uma firewall
properties.storageContainerSasKey

string

Uma assinatura de acesso partilhado (Chave SAS) que tem acesso de escrita ao contentor de blobs especificado no parâmetro "storageContainerPath". Se "storageAccountAccessKey" não for especificado, é necessário StorageContainerSasKey. Aplica-se apenas se a conta de armazenamento não estiver atrás de uma Vnet ou de uma firewall

Respostas

Name Tipo Description
200 OK

ManagedInstanceVulnerabilityAssessment

Defina com êxito a avaliação de vulnerabilidades.
201 Created

ManagedInstanceVulnerabilityAssessment

A avaliação de vulnerabilidades foi criada com êxito.
Other Status Codes

Respostas de Erro: ***

  • 400 InvalidStorageAccountName – a conta de armazenamento fornecida não é válida ou não existe.

  • 400 InvalidStorageAccountCredentials – a assinatura de acesso partilhado da conta de armazenamento fornecida ou a chave de armazenamento da conta não é válida.

  • 400 VulnerabilityAssessmentADSIsDisabled – o Advanced Data Security deve ser ativado para utilizar a Avaliação de Vulnerabilidades.

  • 400 VulnerabilityAssessmentStorageOutboundFirewallNotAllowed – a conta de armazenamento não está na lista de Regras de Firewall de Saída.

  • 400 VulnerabilityAssessmentInsufficientStorageAccountPermissions – Permissões insuficientes na conta de armazenamento fornecida.

  • 400 VulnerabilityAssessmentStorageAccountIsDisabled – a conta de armazenamento fornecida está desativada.

  • 400 InvalidVulnerabilityAssessmentOperationRequest - O pedido de operação de avaliação de vulnerabilidades não existe ou não tem nenhum objeto de propriedades.

  • 400 DataSecurityInvalidUserSuppliedParameter – foi fornecido um valor de parâmetro inválido pelo cliente.

  • 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado

Exemplos

Create a managed instance's vulnerability assessment with all parameters
Create a managed instance's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified
Create a managed instance's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified

Create a managed instance's vulnerability assessment with all parameters

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default?api-version=2021-11-01

{
  "properties": {
    "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/",
    "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "recurringScans": {
      "isEnabled": true,
      "emailSubscriptionAdmins": true,
      "emails": [
        "email1@mail.com",
        "email2@mail.com"
      ]
    }
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default",
  "name": "default",
  "type": "Microsoft.Sql/managedInstances/vulnerabilityAssessments",
  "properties": {
    "recurringScans": {
      "isEnabled": true,
      "emailSubscriptionAdmins": true,
      "emails": [
        "email1@mail.com",
        "email2@mail.com"
      ]
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default",
  "name": "default",
  "type": "Microsoft.Sql/managedInstances/vulnerabilityAssessments",
  "properties": {
    "recurringScans": {
      "isEnabled": true,
      "emailSubscriptionAdmins": true,
      "emails": [
        "email1@mail.com",
        "email2@mail.com"
      ]
    }
  }
}

Create a managed instance's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default?api-version=2021-11-01

{
  "properties": {
    "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/",
    "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default",
  "name": "default",
  "type": "Microsoft.Sql/managedInstances/vulnerabilityAssessments",
  "properties": {
    "recurringScans": {
      "isEnabled": true,
      "emailSubscriptionAdmins": false,
      "emails": []
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default",
  "name": "default",
  "type": "Microsoft.Sql/managedInstances/vulnerabilityAssessments",
  "properties": {
    "recurringScans": {
      "isEnabled": true,
      "emailSubscriptionAdmins": false,
      "emails": []
    }
  }
}

Create a managed instance's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default?api-version=2021-11-01

{
  "properties": {
    "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/",
    "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default",
  "name": "default",
  "type": "Microsoft.Sql/managedInstances/vulnerabilityAssessments",
  "properties": {
    "recurringScans": {
      "isEnabled": true,
      "emailSubscriptionAdmins": false,
      "emails": []
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default",
  "name": "default",
  "type": "Microsoft.Sql/managedInstances/vulnerabilityAssessments",
  "properties": {
    "recurringScans": {
      "isEnabled": true,
      "emailSubscriptionAdmins": false,
      "emails": []
    }
  }
}

Definições

Name Description
ManagedInstanceVulnerabilityAssessment

Uma avaliação de vulnerabilidades de instância gerida.
VulnerabilityAssessmentName

O nome da avaliação de vulnerabilidades.
VulnerabilityAssessmentRecurringScansProperties

Propriedades de uma Análise periódica da Avaliação de Vulnerabilidades.

ManagedInstanceVulnerabilityAssessment

Uma avaliação de vulnerabilidades de instância gerida.

Name Tipo Description
id

string

ID do Recurso.
name

string

Nome do recurso.
properties.recurringScans

VulnerabilityAssessmentRecurringScansProperties

As definições de análise periódica
properties.storageAccountAccessKey

string

Especifica a chave de identificador da conta de armazenamento para os resultados da análise da avaliação de vulnerabilidades. Se "StorageContainerSasKey" não for especificado, é necessário storageAccountAccessKey. Aplica-se apenas se a conta de armazenamento não estiver atrás de uma Vnet ou de uma firewall
properties.storageContainerPath

string

Um caminho de contentor de armazenamento de blobs para manter os resultados da análise (por exemplo, https://myStorage.blob.core.windows.net/VaScans/).
properties.storageContainerSasKey

string

Uma assinatura de acesso partilhado (Chave SAS) que tem acesso de escrita ao contentor de blobs especificado no parâmetro "storageContainerPath". Se "storageAccountAccessKey" não for especificado, é necessário StorageContainerSasKey. Aplica-se apenas se a conta de armazenamento não estiver atrás de uma Vnet ou de uma firewall
type

string

Tipo de recurso.

VulnerabilityAssessmentName

O nome da avaliação de vulnerabilidades.

Name Tipo Description
default

string

VulnerabilityAssessmentRecurringScansProperties

Propriedades de uma Análise periódica da Avaliação de Vulnerabilidades.

Name Tipo Valor Predefinido Description
emailSubscriptionAdmins

boolean

True

Especifica que a notificação de análise de agenda será enviada aos administradores da subscrição.
emails

string[]

Especifica uma matriz de endereços de e-mail para os quais a notificação de análise é enviada.
isEnabled

boolean

Estado das análises periódicas.