Ddos Protection Plans - List

Serviço:

Virtual Networks

Versão da API:

2025-05-01

Obtém todos os planos de proteção contra DDoS em uma assinatura.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/ddosProtectionPlans?api-version=2025-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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.

Respostas

Nome	Tipo	Description
200 OK	DdosProtectionPlanListResult	A operação do Azure foi concluída com êxito.
Other Status Codes	CloudError	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

List all DDoS protection plans

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/ddosProtectionPlans?api-version=2025-05-01

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets all DDoS protection plans in a subscription.
 *
 * @summary Gets all DDoS protection plans in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/DdosProtectionPlanListAll.json
 */
async function listAllDDoSProtectionPlans() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.ddosProtectionPlans.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "name": "plan1",
      "type": "Microsoft.Network/ddosProtectionPlans",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1",
      "location": "westus",
      "properties": {
        "provisioningState": "Succeeded",
        "publicIPAddresses": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip"
          }
        ],
        "resourceGuid": "00000000-0000-0000-0000-000000000000",
        "virtualNetworks": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet1"
          }
        ]
      }
    },
    {
      "name": "plan2",
      "type": "Microsoft.Network/ddosProtectionPlans",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2",
      "location": "westus",
      "properties": {
        "provisioningState": "Succeeded",
        "publicIPAddresses": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip2"
          },
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip3"
          }
        ],
        "resourceGuid": "00000000-0000-0000-0000-000000000000",
        "virtualNetworks": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet2"
          },
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet3"
          }
        ]
      }
    }
  ]
}

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
DdosProtectionPlan	Um plano de proteção contra DDoS em um grupo de recursos.
DdosProtectionPlanListResult	A resposta de uma operação da lista DdosProtectionPlan.
ProvisioningState	Provisionando estados de um recurso.
SubResource	Referência a outro sub-recurso.

CloudError

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Corpo do erro da nuvem.

CloudErrorBody

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

DdosProtectionPlan

Objeto

Um plano de proteção contra DDoS em um grupo de recursos.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso do plano de proteção contra DDoS.
properties.publicIPAddresses	SubResource[]	A lista de IPs públicos associados ao recurso do plano de proteção contra DDoS. Esta lista é somente leitura.
properties.resourceGuid	string	A propriedade GUID do recurso do plano de proteção contra DDoS. Ele identifica exclusivamente o recurso, mesmo que o usuário altere seu nome ou migre o recurso entre assinaturas ou grupos de recursos.
properties.virtualNetworks	SubResource[]	A lista de redes virtuais associadas ao recurso do plano de proteção contra DDoS. Esta lista é somente leitura.
tags	object	Tags de recursos.
type	string	Tipo de recurso.

DdosProtectionPlanListResult

Objeto

A resposta de uma operação da lista DdosProtectionPlan.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	DdosProtectionPlan[]	Os itens do Plano de Proteção DDosProteção nesta página

ProvisioningState

Enumeração

Provisionando estados de um recurso.

Valor	Description
Failed	Falha
Succeeded	Succeeded
Canceled	Cancelado
Creating	Criando
Updating	Atualização
Deleting	Excluir

SubResource

Objeto

Referência a outro sub-recurso.

Nome	Tipo	Description
id	string	ID do recurso.