Connectivity Configurations - Create Or Update

Service:: Network Manager

API Version:: 2025-05-01

Creates/Updates a new network manager connectivity configuration

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

URI Parameters

Name	In	Required	Type	Description
configurationName	path	True	string	The name of the network manager connectivity configuration.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	The name of the network manager.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties.appliesToGroups	True	connectivityGroupItem[]	Groups for configuration
properties.connectivityTopology	True	ConnectivityTopology	Connectivity topology type.
properties.connectivityCapabilities		ConnectivityConfigurationPropertiesConnectivityCapabilities	Collection of additional settings to enhance specific topology behaviors of the connectivity configuration resource.
properties.deleteExistingPeering		DeleteExistingPeering	Flag if need to remove current existing peerings.
properties.description		string	A description of the connectivity configuration.
properties.hubs		Hub[]	List of hubItems
properties.isGlobal		IsGlobal	Flag if global mesh is supported.

Responses

Name	Type	Description
200 OK	ConnectivityConfiguration	Resource 'ConnectivityConfiguration' update operation succeeded
201 Created	ConnectivityConfiguration	Resource 'ConnectivityConfiguration' create operation succeeded
Other Status Codes	CloudError	An unexpected error response.

Security

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	impersonate your user account

Examples

ConnectivityConfigurationsPut

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

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

Sample response

Status code:: 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"
  }
}

Status code:: 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"
  }
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ConnectedGroupAddressOverlap	Behavior to handle overlapped IP address space among members of the connected group of the connectivity configuration.
ConnectedGroupPrivateEndpointsScale	Option indicating the scale of private endpoints allowed in the connected group of the connectivity configuration.
ConnectivityConfiguration	The network manager connectivity configuration resource
ConnectivityConfigurationPropertiesConnectivityCapabilities	Collection of additional settings to enhance specific topology behaviors of the connectivity configuration resource.
connectivityGroupItem	Connectivity group item.
ConnectivityTopology	Connectivity topology type.
createdByType	The type of identity that created the resource.
DeleteExistingPeering	Flag if need to remove current existing peerings.
GroupConnectivity	Group connectivity type.
Hub	Hub Item.
IsGlobal	Flag if global mesh is supported.
PeeringEnforcement	Option indicating enforcement of peerings created by the connectivity configuration.
ProvisioningState	Provisioning states of a resource.
systemData	Metadata pertaining to creation and last modification of the resource.
UseHubGateway	Flag if need to use hub gateway.

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ConnectedGroupAddressOverlap

Enumeration

Behavior to handle overlapped IP address space among members of the connected group of the connectivity configuration.

Value	Description
Allowed	Default. Allows connected group members to have overlapping IP address space.
Disallowed	Strictly disallows connected group members from having overlapping IP address space. Prevents the addition of a virtual network with overlapping address to the connected group, blocks peering between a virtual network and a connected group member if any connected group member has an overlapping range, and restricts address space modifications that would introduce overlap.

ConnectedGroupPrivateEndpointsScale

Enumeration

Option indicating the scale of private endpoints allowed in the connected group of the connectivity configuration.

Value	Description
Standard	Default. Allows for up to 2K private endpoints in the connected group.
HighScale	Allows for up to 20K private endpoints in the connected group.