Ddos Protection Plans - List

服務:

Virtual Networks

API 版本:

2025-05-01

取得訂閱中的所有 DDoS 防護方案。

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

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	DdosProtectionPlanListResult	Azure 運作順利完成。
Other Status Codes	CloudError	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List all DDoS protection plans

範例要求

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

範例回覆

狀態碼:

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

定義

名稱	Description
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
DdosProtectionPlan	資源群組中的 DDoS 保護計劃。
DdosProtectionPlanListResult	DdosProtectionPlan 清單操作的回應。
ProvisioningState	布建資源的狀態。
SubResource	另一個子資源的參考。

CloudError

Object

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤內文。

CloudErrorBody

Object

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	有關錯誤的其他詳細資料清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。 例如，錯誤中的屬性名稱。

DdosProtectionPlan

Object

資源群組中的 DDoS 保護計劃。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
location	string	資源位置。
name	string	資源名稱。
properties.provisioningState	ProvisioningState	DDoS 防護計劃資源的佈建狀態。
properties.publicIPAddresses	SubResource[]	與 DDoS 防護計劃資源相關聯的公用 IP 清單。 此清單是唯讀的。
properties.resourceGuid	string	DDoS 防護方案資源的資源 GUID 屬性。 它可唯一識別資源，即使使用者變更其名稱，或跨訂用帳戶或資源群組移轉資源也一樣。
properties.virtualNetworks	SubResource[]	與 DDoS 防護方案資源相關聯的虛擬網路清單。 此清單是唯讀的。
tags	object	資源標籤。
type	string	資源類型。

DdosProtectionPlanListResult

Object

DdosProtectionPlan 清單操作的回應。

名稱	類型	Description
nextLink	string (uri)	專案下一頁的連結
value	DdosProtectionPlan[]	本頁的DdosProtectionPlan項目

ProvisioningState

列舉型別

布建資源的狀態。

值	Description
Failed	失敗
Succeeded	成功
Canceled	已取消
Creating	建立中
Updating	更新中
Deleting	刪除中

SubResource

Object

另一個子資源的參考。

名稱	類型	Description
id	string	資源標識碼。