Ddos Protection Plans - Create Or Update

Referencia

Service:: Virtual Networks

API Version:: 2023-09-01

DDoS védelmi tervet hoz létre vagy frissít.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}?api-version=2023-09-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
ddosProtectionPlanName	path	True	string	A DDoS védelmi terv neve.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Típus	Description
location	string	Erőforrás helye.
tags	object	Erőforráscímkék.

Válaszok

Name	Típus	Description
200 OK	DdosProtectionPlan	A frissítés sikeres. A művelet az eredményül kapott DDoS védelmi terv erőforrást adja vissza.
201 Created	DdosProtectionPlan	Sikeres létrehozás. A művelet az eredményül kapott DDoS védelmi terv erőforrást adja vissza.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Create DDoS protection plan

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan?api-version=2023-09-01

{
  "location": "westus",
  "properties": {}
}


import com.azure.resourcemanager.network.fluent.models.DdosProtectionPlanInner;

/**
 * Samples for DdosProtectionPlans CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/DdosProtectionPlanCreate.json
     */
    /**
     * Sample code: Create DDoS protection plan.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createDDoSProtectionPlan(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getDdosProtectionPlans().createOrUpdate("rg1", "test-plan",
            new DdosProtectionPlanInner().withLocation("westus"), com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python ddos_protection_plan_create.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 = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.ddos_protection_plans.begin_create_or_update(
        resource_group_name="rg1",
        ddos_protection_plan_name="test-plan",
        parameters={"location": "westus", "properties": {}},
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/DdosProtectionPlanCreate.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

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/DdosProtectionPlanCreate.json
func ExampleDdosProtectionPlansClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDdosProtectionPlansClient().BeginCreateOrUpdate(ctx, "rg1", "test-plan", armnetwork.DdosProtectionPlan{
		Location:   to.Ptr("westus"),
		Properties: &armnetwork.DdosProtectionPlanPropertiesFormat{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DdosProtectionPlan = armnetwork.DdosProtectionPlan{
	// 	Name: to.Ptr("test-plan"),
	// 	Type: to.Ptr("Microsoft.Network/ddosProtectionPlans"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan"),
	// 	Location: to.Ptr("westus"),
	// 	Properties: &armnetwork.DdosProtectionPlanPropertiesFormat{
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		PublicIPAddresses: []*armnetwork.SubResource{
	// 		},
	// 		ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		VirtualNetworks: []*armnetwork.SubResource{
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Creates or updates a DDoS protection plan.
 *
 * @summary Creates or updates a DDoS protection plan.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/DdosProtectionPlanCreate.json
 */
async function createDDoSProtectionPlan() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const ddosProtectionPlanName = "test-plan";
  const parameters = { location: "westus" };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.ddosProtectionPlans.beginCreateOrUpdateAndWait(
    resourceGroupName,
    ddosProtectionPlanName,
    parameters,
  );
  console.log(result);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/DdosProtectionPlanCreate.json
// this example is just showing the usage of "DdosProtectionPlans_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this DdosProtectionPlanResource
DdosProtectionPlanCollection collection = resourceGroupResource.GetDdosProtectionPlans();

// invoke the operation
string ddosProtectionPlanName = "test-plan";
DdosProtectionPlanData data = new DdosProtectionPlanData(new AzureLocation("westus"));
ArmOperation<DdosProtectionPlanResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, ddosProtectionPlanName, data);
DdosProtectionPlanResource 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
DdosProtectionPlanData 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

Sample Response

Status code:: 200

{
  "name": "test-plan",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan",
  "type": "Microsoft.Network/ddosProtectionPlans",
  "location": "westus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "publicIPAddresses": [],
    "virtualNetworks": []
  }
}

Status code:: 201

{
  "name": "test-plan",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan",
  "type": "Microsoft.Network/ddosProtectionPlans",
  "location": "westus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "publicIPAddresses": [],
    "virtualNetworks": []
  }
}

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
DdosProtectionPlan	DDoS védelmi terv egy erőforráscsoportban.
ProvisioningState	Az aktuális kiépítési állapot.
SubResource	Hivatkozás egy másik alforrásra.

CloudError

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Felhőbeli hibatörzs.

CloudErrorBody

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hibával kapcsolatos további részletek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a hibás tulajdonság neve.

DdosProtectionPlan

DDoS védelmi terv egy erőforráscsoportban.

Name	Típus	Description
etag	string	Egyedi írásvédett sztring, amely az erőforrás frissítésekor változik.
id	string	Erőforrás-azonosító.
location	string	Erőforrás helye.
name	string	Erőforrás neve.
properties.provisioningState	ProvisioningState	A DDoS védelmi terv erőforrásának kiépítési állapota.
properties.publicIPAddresses	SubResource[]	A DDoS védelmi terv erőforrásához társított nyilvános IP-címek listája. Ez a lista írásvédett.
properties.resourceGuid	string	A DDoS védelmi terv erőforrás GUID tulajdonsága. Egyedileg azonosítja az erőforrást, még akkor is, ha a felhasználó megváltoztatja a nevét, vagy áttelepíti az erőforrást előfizetések vagy erőforráscsoportok között.
properties.virtualNetworks	SubResource[]	A DDoS védelmi terv erőforrásához társított virtuális hálózatok listája. Ez a lista írásvédett.
tags	object	Erőforráscímkék.
type	string	Erőforrástípus.

ProvisioningState

Az aktuális kiépítési állapot.

Name	Típus	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Hivatkozás egy másik alforrásra.

Name	Típus	Description
id	string	Erőforrás-azonosító.