Connectivity Configurations - Create Or Update

Dienst:

Network Manager

API-Version:

2025-05-01

Erstellt/aktualisiert eine neue Netzwerk-Manager-Konnektivitätskonfiguration.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
configurationName	path	True	string	Der Name der Netzwerk-Manager-Konnektivitätskonfiguration.
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 minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.appliesToGroups	True	connectivityGroupItem[]	Gruppen für die Konfiguration
properties.connectivityTopology	True	ConnectivityTopology	Verbindungstopologietyp.
properties.connectivityCapabilities		ConnectivityConfigurationPropertiesConnectivityCapabilities	Auflistung zusätzlicher Einstellungen zum Verbessern des spezifischen Topologieverhaltens der Konnektivitätskonfigurationsressource.
properties.deleteExistingPeering		DeleteExistingPeering	Flag, wenn aktuelle vorhandene Peerings entfernt werden müssen.
properties.description		string	Eine Beschreibung der Konnektivitätskonfiguration.
properties.hubs		Hub[]	Liste der hubItems
properties.isGlobal		IsGlobal	Kennzeichnung, wenn das globale Gitter unterstützt wird.

Antworten

Name	Typ	Beschreibung
200 OK	ConnectivityConfiguration	Die Aktualisierung der Ressource 'ConnectivityConfiguration' war erfolgreich
201 Created	ConnectivityConfiguration	Die Erstellungsoperation der Ressource 'ConnectivityConfiguration' war erfolgreich
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

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

ConnectivityConfigurationsPut

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig?api-version=2025-05-01

{
  "properties": {
    "description": "Sample Configuration",
    "appliesToGroups": [
      {
        "groupConnectivity": "None",
        "isGlobal": "False",
        "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1",
        "useHubGateway": "True"
      }
    ],
    "connectivityCapabilities": {
      "connectedGroupAddressOverlap": "Allowed",
      "connectedGroupPrivateEndpointsScale": "Standard",
      "peeringEnforcement": "Unenforced"
    },
    "connectivityTopology": "HubAndSpoke",
    "deleteExistingPeering": "True",
    "hubs": [
      {
        "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig",
        "resourceType": "Microsoft.Network/virtualNetworks"
      }
    ],
    "isGlobal": "True"
  }
}

JavaScript

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

/**
 * This sample demonstrates how to Creates/Updates a new network manager connectivity configuration
 *
 * @summary Creates/Updates a new network manager connectivity configuration
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/NetworkManagerConnectivityConfigurationPut.json
 */
async function connectivityConfigurationsPut() {
  const subscriptionId =
    process.env["NETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "myResourceGroup";
  const networkManagerName = "testNetworkManager";
  const configurationName = "myTestConnectivityConfig";
  const connectivityConfiguration = {
    description: "Sample Configuration",
    appliesToGroups: [
      {
        groupConnectivity: "None",
        isGlobal: "False",
        networkGroupId:
          "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1",
        useHubGateway: "True",
      },
    ],
    connectivityCapabilities: {
      connectedGroupAddressOverlap: "Allowed",
      connectedGroupPrivateEndpointsScale: "Standard",
      peeringEnforcement: "Unenforced",
    },
    connectivityTopology: "HubAndSpoke",
    deleteExistingPeering: "True",
    hubs: [
      {
        resourceId:
          "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig",
        resourceType: "Microsoft.Network/virtualNetworks",
      },
    ],
    isGlobal: "True",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.connectivityConfigurations.createOrUpdate(
    resourceGroupName,
    networkManagerName,
    configurationName,
    connectivityConfiguration,
  );
  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

Beispiel für eine Antwort

Statuscode:

200

{
  "name": "myTestConnectivityConfig",
  "type": "Microsoft.Network/networkManagers/connectivityConfigurations",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig",
  "properties": {
    "description": "Sample Connectivity Configuration",
    "appliesToGroups": [
      {
        "groupConnectivity": "None",
        "isGlobal": "False",
        "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/groups/group1",
        "useHubGateway": "True"
      }
    ],
    "connectivityCapabilities": {
      "connectedGroupAddressOverlap": "Allowed",
      "connectedGroupPrivateEndpointsScale": "Standard",
      "peeringEnforcement": "Unenforced"
    },
    "connectivityTopology": "HubAndSpoke",
    "deleteExistingPeering": "True",
    "hubs": [
      {
        "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig",
        "resourceType": "Microsoft.Network/virtualNetworks"
      }
    ],
    "isGlobal": "True",
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000"
  },
  "systemData": {
    "createdAt": "2021-01-11T18:52:27Z",
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User"
  }
}

Statuscode:

201

{
  "name": "myTestConnectivityConfig",
  "type": "Microsoft.Network/networkManagers/connectivityConfigurations",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig",
  "properties": {
    "description": "Sample Configuration",
    "appliesToGroups": [
      {
        "groupConnectivity": "None",
        "isGlobal": "False",
        "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1",
        "useHubGateway": "True"
      }
    ],
    "connectivityCapabilities": {
      "connectedGroupAddressOverlap": "Allowed",
      "connectedGroupPrivateEndpointsScale": "Standard",
      "peeringEnforcement": "Unenforced"
    },
    "connectivityTopology": "HubAndSpoke",
    "deleteExistingPeering": "True",
    "hubs": [
      {
        "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig",
        "resourceType": "Microsoft.Network/virtualNetworks"
      }
    ],
    "isGlobal": "True",
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000"
  },
  "systemData": {
    "createdAt": "2021-01-11T18:52:27Z",
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User"
  }
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort vom Dienst.
CloudErrorBody	Eine Fehlerantwort vom Dienst.
ConnectedGroupAddressOverlap	Verhalten beim Behandeln von überlappendem IP-Adressraum zwischen Mitgliedern der verbundenen Gruppe der Konnektivitätskonfiguration.
ConnectedGroupPrivateEndpointsScale	Option, die die Skalierung der privaten Endpunkte angibt, die in der verbundenen Gruppe der Konnektivitätskonfiguration zulässig sind.
ConnectivityConfiguration	Die Netzwerk-Manager-Verbindungskonfigurationsressource
ConnectivityConfigurationPropertiesConnectivityCapabilities	Auflistung zusätzlicher Einstellungen zum Verbessern des spezifischen Topologieverhaltens der Konnektivitätskonfigurationsressource.
connectivityGroupItem	Verbindungsgruppenelement.
ConnectivityTopology	Verbindungstopologietyp.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DeleteExistingPeering	Flag, wenn aktuelle vorhandene Peerings entfernt werden müssen.
GroupConnectivity	Gruppenverbindungstyp.
Hub	Hubelement.
IsGlobal	Kennzeichnung, wenn das globale Gitter unterstützt wird.
PeeringEnforcement	Option, die die Erzwingung von Peerings angibt, die von der Konnektivitätskonfiguration erstellt wurden.
ProvisioningState	Bereitstellungszustände einer Ressource.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UseHubGateway	Kennzeichnen, wenn Hubgateway verwendet werden muss.

CloudError

Objekt

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloud-Fehlertext.

CloudErrorBody

Objekt

Eine Fehlerantwort vom Dienst.

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.

ConnectedGroupAddressOverlap

Enumeration

Verhalten beim Behandeln von überlappendem IP-Adressraum zwischen Mitgliedern der verbundenen Gruppe der Konnektivitätskonfiguration.

Wert	Beschreibung
Allowed	Default. Ermöglicht verbundenen Gruppenmitgliedern einen überlappenden IP-Adressraum.
Disallowed	Lässt strikt zu, dass verbundene Gruppenmitglieder einen überlappenden IP-Adressraum haben. Verhindert das Hinzufügen eines virtuellen Netzwerks mit überlappenden Adressen zur verbundenen Gruppe, blockiert das Peering zwischen einem virtuellen Netzwerk und einem verbundenen Gruppenmitglied, wenn ein verbundenes Gruppenmitglied einen überlappenden Bereich aufweist, und schränkt Adressraumänderungen ein, die zu Überschneidungen führen würden.

ConnectedGroupPrivateEndpointsScale

Enumeration

Option, die die Skalierung der privaten Endpunkte angibt, die in der verbundenen Gruppe der Konnektivitätskonfiguration zulässig sind.

Wert	Beschreibung
Standard	Default. Ermöglicht bis zu 2 KB private Endpunkte in der verbundenen Gruppe.
HighScale	Ermöglicht bis zu 20 KB private Endpunkte in der verbundenen Gruppe.

ConnectivityConfiguration

Objekt

Die Netzwerk-Manager-Verbindungskonfigurationsressource

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.appliesToGroups	connectivityGroupItem[]	Gruppen für die Konfiguration
properties.connectivityCapabilities	ConnectivityConfigurationPropertiesConnectivityCapabilities	Auflistung zusätzlicher Einstellungen zum Verbessern des spezifischen Topologieverhaltens der Konnektivitätskonfigurationsressource.
properties.connectivityTopology	ConnectivityTopology	Verbindungstopologietyp.
properties.deleteExistingPeering	DeleteExistingPeering	Flag, wenn aktuelle vorhandene Peerings entfernt werden müssen.
properties.description	string	Eine Beschreibung der Konnektivitätskonfiguration.
properties.hubs	Hub[]	Liste der hubItems
properties.isGlobal	IsGlobal	Kennzeichnung, wenn das globale Gitter unterstützt wird.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Konnektivitätskonfigurationsressource.
properties.resourceGuid	string	Eindeutiger Bezeichner für diese Ressource.
systemData	systemData	Die Systemmetadaten im Zusammenhang mit dieser Ressource.
type	string	Ressourcentyp.

ConnectivityConfigurationPropertiesConnectivityCapabilities

Objekt

Auflistung zusätzlicher Einstellungen zum Verbessern des spezifischen Topologieverhaltens der Konnektivitätskonfigurationsressource.

Name	Typ	Standardwert	Beschreibung
connectedGroupAddressOverlap	ConnectedGroupAddressOverlap	Allowed	Verhalten beim Behandeln von überlappendem IP-Adressraum zwischen Mitgliedern der verbundenen Gruppe der Konnektivitätskonfiguration.
connectedGroupPrivateEndpointsScale	ConnectedGroupPrivateEndpointsScale	Standard	Option, die die Skalierung der privaten Endpunkte angibt, die in der verbundenen Gruppe der Konnektivitätskonfiguration zulässig sind.
peeringEnforcement	PeeringEnforcement	Unenforced	Option, die die Erzwingung von Peerings angibt, die von der Konnektivitätskonfiguration erstellt wurden.

connectivityGroupItem

Objekt

Verbindungsgruppenelement.

Name	Typ	Beschreibung
groupConnectivity	GroupConnectivity	Gruppenverbindungstyp.
isGlobal	IsGlobal	Kennzeichnung, wenn global unterstützt wird.
networkGroupId	string	Netzwerkgruppen-ID.
useHubGateway	UseHubGateway	Kennzeichnen, wenn Hubgateway verwendet werden muss.

ConnectivityTopology

Enumeration

Verbindungstopologietyp.

Wert	Beschreibung
HubAndSpoke	HubAndSpoke
Mesh	Netz

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DeleteExistingPeering

Enumeration

Flag, wenn aktuelle vorhandene Peerings entfernt werden müssen.

Wert	Beschreibung
False	Falsch
True	Richtig

GroupConnectivity

Enumeration

Gruppenverbindungstyp.

Wert	Beschreibung
None	Nichts
DirectlyConnected	DirectConnected

Hub

Objekt

Hubelement.

Name	Typ	Beschreibung
resourceId	string	Ressourcen-ID.
resourceType	string	Ressourcentyp.

IsGlobal

Enumeration

Kennzeichnung, wenn das globale Gitter unterstützt wird.

Wert	Beschreibung
False	Falsch
True	Richtig

PeeringEnforcement

Enumeration

Option, die die Erzwingung von Peerings angibt, die von der Konnektivitätskonfiguration erstellt wurden.

Wert	Beschreibung
Unenforced	Default. Peerings, die von der Konnektivitätskonfiguration erstellt werden, können außerhalb des Netzwerkmanagers geändert oder gelöscht werden.
Enforced	Peerings, die von der Konnektivitätskonfiguration erstellt werden, können außerhalb des Netzwerk-Managers nicht geändert oder gelöscht werden.

ProvisioningState

Enumeration

Bereitstellungszustände einer Ressource.

Wert	Beschreibung
Failed	gescheitert
Succeeded	Erfolgreich
Canceled	Abgesagt
Creating	Erstellen
Updating	Aktualisieren
Deleting	Löschen

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 Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UseHubGateway

Enumeration

Kennzeichnen, wenn Hubgateway verwendet werden muss.

Wert	Beschreibung
False	Falsch
True	Richtig