Network Managers - Create Or Update

Dienst:

Network Manager

API-Version:

2024-05-01

Erstellt oder aktualisiert einen Netzwerk-Manager.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Der Name des Netzwerk-Managers.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.networkManagerScopes	True	NetworkManagerScopes	Bereich des Netzwerk-Managers.
id		string	Ressourcen-ID.
location		string	Ressourcenspeicherort.
properties.description		string	Eine Beschreibung des Netzwerk-Managers.
properties.networkManagerScopeAccesses		ConfigurationType[]	Bereichszugriff.
tags		object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	NetworkManager	Aktualisiert – Gibt Informationen zum Netzwerk-Manager zurück.
201 Created	NetworkManager	Erstellt – Gibt Informationen zum Netzwerk-Manager zurück.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Put Network Manager

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager?api-version=2024-05-01

{
  "properties": {
    "description": "My Test Network Manager",
    "networkManagerScopes": {
      "managementGroups": [
        "/Microsoft.Management/testmg"
      ],
      "subscriptions": [
        "/subscriptions/00000000-0000-0000-0000-000000000000"
      ]
    },
    "networkManagerScopeAccesses": [
      "Connectivity"
    ]
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.NetworkManagerInner;
import com.azure.resourcemanager.network.models.ConfigurationType;
import com.azure.resourcemanager.network.models.NetworkManagerPropertiesNetworkManagerScopes;
import java.util.Arrays;

/**
 * Samples for NetworkManagers CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkManagerPut.json
     */
    /**
     * Sample code: Put Network Manager.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void putNetworkManager(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkManagers().createOrUpdateWithResponse("rg1",
            "TestNetworkManager",
            new NetworkManagerInner().withDescription("My Test Network Manager")
                .withNetworkManagerScopes(new NetworkManagerPropertiesNetworkManagerScopes()
                    .withManagementGroups(Arrays.asList("/Microsoft.Management/testmg"))
                    .withSubscriptions(Arrays.asList("/subscriptions/00000000-0000-0000-0000-000000000000")))
                .withNetworkManagerScopeAccesses(Arrays.asList(ConfigurationType.CONNECTIVITY)),
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_manager_put.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.network_managers.create_or_update(
        resource_group_name="rg1",
        network_manager_name="TestNetworkManager",
        parameters={
            "properties": {
                "description": "My Test Network Manager",
                "networkManagerScopeAccesses": ["Connectivity"],
                "networkManagerScopes": {
                    "managementGroups": ["/Microsoft.Management/testmg"],
                    "subscriptions": ["/subscriptions/00000000-0000-0000-0000-000000000000"],
                },
            }
        },
    )
    print(response)


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

Go

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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkManagerPut.json
func ExampleManagersClient_CreateOrUpdate() {
	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)
	}
	res, err := clientFactory.NewManagersClient().CreateOrUpdate(ctx, "rg1", "TestNetworkManager", armnetwork.Manager{
		Properties: &armnetwork.ManagerProperties{
			Description: to.Ptr("My Test Network Manager"),
			NetworkManagerScopeAccesses: []*armnetwork.ConfigurationType{
				to.Ptr(armnetwork.ConfigurationTypeConnectivity)},
			NetworkManagerScopes: &armnetwork.ManagerPropertiesNetworkManagerScopes{
				ManagementGroups: []*string{
					to.Ptr("/Microsoft.Management/testmg")},
				Subscriptions: []*string{
					to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000")},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.Manager = armnetwork.Manager{
	// 	Name: to.Ptr("TestNetworkManager"),
	// 	Type: to.Ptr("Microsoft.Network/networkManagers"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager"),
	// 	Etag: to.Ptr("sadf-asdf-asdf-asdf"),
	// 	Properties: &armnetwork.ManagerProperties{
	// 		Description: to.Ptr("My Test Network Manager"),
	// 		NetworkManagerScopeAccesses: []*armnetwork.ConfigurationType{
	// 			to.Ptr(armnetwork.ConfigurationTypeConnectivity)},
	// 			NetworkManagerScopes: &armnetwork.ManagerPropertiesNetworkManagerScopes{
	// 				ManagementGroups: []*string{
	// 					to.Ptr("Microsoft.Management/managementGroups/testMg")},
	// 					Subscriptions: []*string{
	// 						to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000")},
	// 					},
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				},
	// 				SystemData: &armnetwork.SystemData{
	// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
	// 					CreatedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
	// 					CreatedByType: to.Ptr(armnetwork.CreatedByTypeUser),
	// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
	// 					LastModifiedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
	// 					LastModifiedByType: to.Ptr(armnetwork.CreatedByTypeUser),
	// 				},
	// 			}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Creates or updates a Network Manager.
 *
 * @summary Creates or updates a Network Manager.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkManagerPut.json
 */
async function putNetworkManager() {
  const subscriptionId =
    process.env["NETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkManagerName = "TestNetworkManager";
  const parameters = {
    description: "My Test Network Manager",
    networkManagerScopeAccesses: ["Connectivity"],
    networkManagerScopes: {
      managementGroups: ["/Microsoft.Management/testmg"],
      subscriptions: ["/subscriptions/00000000-0000-0000-0000-000000000000"],
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkManagers.createOrUpdate(
    resourceGroupName,
    networkManagerName,
    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

dotnet

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkManagerPut.json
// this example is just showing the usage of "NetworkManagers_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 = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this NetworkManagerResource
NetworkManagerCollection collection = resourceGroupResource.GetNetworkManagers();

// invoke the operation
string networkManagerName = "TestNetworkManager";
NetworkManagerData data = new NetworkManagerData
{
    Description = "My Test Network Manager",
    NetworkManagerScopes = new NetworkManagerPropertiesNetworkManagerScopes
    {
        ManagementGroups = { "/Microsoft.Management/testmg" },
        Subscriptions = { "/subscriptions/00000000-0000-0000-0000-000000000000" },
    },
    NetworkManagerScopeAccesses = { NetworkConfigurationDeploymentType.Connectivity },
};
ArmOperation<NetworkManagerResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, networkManagerName, data);
NetworkManagerResource 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
NetworkManagerData 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

Beispiel für eine Antwort

Statuscode:

200

{
  "name": "TestNetworkManager",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager",
  "type": "Microsoft.Network/networkManagers",
  "etag": "sadf-asdf-asdf-asdf",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "createdAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z"
  },
  "properties": {
    "description": "My Test Network Manager",
    "networkManagerScopes": {
      "managementGroups": [
        "Microsoft.Management/managementGroups/testMg"
      ],
      "subscriptions": [
        "/subscriptions/00000000-0000-0000-0000-000000000000"
      ]
    },
    "networkManagerScopeAccesses": [
      "Connectivity"
    ],
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000"
  }
}

Statuscode:

201

{
  "name": "TestNetworkManager",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager",
  "type": "Microsoft.Network/networkManagers",
  "etag": "sadf-asdf-asdf-asdf",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "createdAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z"
  },
  "properties": {
    "description": "My Test Network Manager",
    "networkManagerScopes": {
      "managementGroups": [
        "Microsoft.Management/managementGroups/testMg"
      ],
      "subscriptions": [
        "/subscriptions/00000000-0000-0000-0000-000000000000"
      ]
    },
    "networkManagerScopeAccesses": [
      "Connectivity"
    ],
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000"
  }
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
ConfigurationType	Konfigurationsbereitstellungstyp.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CrossTenantScopes	Mandantenübergreifende Bereiche.
NetworkManager	Die Verwaltete Netzwerkressource
NetworkManagerScopes	Bereich des Netzwerk-Managers.
ProvisioningState	Der aktuelle Bereitstellungsstatus.
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloudfehlertext.

CloudErrorBody

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

ConfigurationType

Enumeration

Konfigurationsbereitstellungstyp.

Wert	Beschreibung
Connectivity
Routing
SecurityAdmin
SecurityUser

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

CrossTenantScopes

Objekt

Mandantenübergreifende Bereiche.

Name	Typ	Beschreibung
managementGroups	string[]	Liste der Verwaltungsgruppen.
subscriptions	string[]	Liste der Abonnements.
tenantId	string	Mandanten-ID.

NetworkManager

Objekt

Die Verwaltete Netzwerkressource

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.description	string	Eine Beschreibung des Netzwerk-Managers.
properties.networkManagerScopeAccesses	ConfigurationType[]	Bereichszugriff.
properties.networkManagerScopes	NetworkManagerScopes	Bereich des Netzwerk-Managers.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Netzwerk-Manager-Ressource.
properties.resourceGuid	string	Eindeutiger Bezeichner für diese Ressource.
systemData	SystemData	Die Systemmetadaten im Zusammenhang mit dieser Ressource.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

NetworkManagerScopes

Objekt

Bereich des Netzwerk-Managers.

Name	Typ	Beschreibung
crossTenantScopes	CrossTenantScopes[]	Liste der mandantenübergreifenden Bereiche.
managementGroups	string[]	Liste der Verwaltungsgruppen.
subscriptions	string[]	Liste der Abonnements.

ProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Deleting
Failed
Succeeded
Updating

SystemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.