你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Connectivity Configurations - Create Or Update

服务:: Network Manager

API 版本:: 2025-05-01

创建/更新新的网络管理器连接配置

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

URI 参数

名称	在	必需	类型	说明
configurationName	path	True	string	网络管理器连接配置的名称。
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	网络管理器的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	必需	类型	说明
properties.appliesToGroups	True	connectivityGroupItem[]	用于配置的组
properties.connectivityTopology	True	ConnectivityTopology	连接拓扑类型。
properties.connectivityCapabilities		ConnectivityConfigurationPropertiesConnectivityCapabilities	用于增强连接配置资源的特定拓扑行为的其他设置的集合。
properties.deleteExistingPeering		DeleteExistingPeering	如果需要删除当前的现有对等互连，则标记。
properties.description		string	连接配置的说明。
properties.hubs		Hub[]	hubItems 列表
properties.isGlobal		IsGlobal	如果支持全局网格，则标记。

响应

名称	类型	说明
200 OK	ConnectivityConfiguration	资源“ConnectivityConfiguration”更新操作成功
201 Created	ConnectivityConfiguration	资源“ConnectivityConfiguration”创建操作成功
Other Status Codes	CloudError	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

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

示例响应

状态代码:: 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"
  }
}

状态代码:: 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"
  }
}

定义

名称	说明
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
ConnectedGroupAddressOverlap	处理连接配置的已连接组成员之间重叠的 IP 地址空间的行为。
ConnectedGroupPrivateEndpointsScale	选项，指示连接配置的已连接组中允许的专用终结点的规模。
ConnectivityConfiguration	网络管理器连接配置资源
ConnectivityConfigurationPropertiesConnectivityCapabilities	用于增强连接配置资源的特定拓扑行为的其他设置的集合。
connectivityGroupItem	连接组项。
ConnectivityTopology	连接拓扑类型。
createdByType	创建资源的标识的类型。
DeleteExistingPeering	如果需要删除当前的现有对等互连，则标记。
GroupConnectivity	组连接类型。
Hub	中心项。
IsGlobal	如果支持全局网格，则标记。
PeeringEnforcement	指示执行由连接配置创建的对等互连的选项。
ProvisioningState	资源的预配状态。
systemData	与创建和上次修改资源相关的元数据。
UseHubGateway	如果需要使用中心网关，则标记。

CloudError

对象

服务的错误响应。

名称	类型	说明
error	CloudErrorBody	云错误正文。

CloudErrorBody

对象

服务的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。例如，错误属性的名称。

ConnectedGroupAddressOverlap

枚举

处理连接配置的已连接组成员之间重叠的 IP 地址空间的行为。

值	说明
Allowed	违约。允许连接的组成员具有重叠的 IP 地址空间。
Disallowed	严格禁止连接的组成员具有重叠的 IP 地址空间。防止将地址重叠的虚拟网络添加到连接的组，如果任何连接的组成员具有重叠范围，则阻止虚拟网络与连接的组成员之间的对等互连，并限制会导致重叠的地址空间修改。

ConnectedGroupPrivateEndpointsScale

枚举

选项，指示连接配置的已连接组中允许的专用终结点的规模。

值	说明
Standard	违约。允许在连接的组中最多使用 2K 个私有终端节点。
HighScale	允许连接组中最多有 20K 个专用终结点。

ConnectivityConfiguration

对象

网络管理器连接配置资源

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源名称。
properties.appliesToGroups	connectivityGroupItem[]	用于配置的组
properties.connectivityCapabilities	ConnectivityConfigurationPropertiesConnectivityCapabilities	用于增强连接配置资源的特定拓扑行为的其他设置的集合。
properties.connectivityTopology	ConnectivityTopology	连接拓扑类型。
properties.deleteExistingPeering	DeleteExistingPeering	如果需要删除当前的现有对等互连，则标记。
properties.description	string	连接配置的说明。
properties.hubs	Hub[]	hubItems 列表
properties.isGlobal	IsGlobal	如果支持全局网格，则标记。
properties.provisioningState	ProvisioningState	连接配置资源的预配状态。
properties.resourceGuid	string	此资源的唯一标识符。
systemData	systemData	与此资源相关的系统元数据。
type	string	资源类型。

ConnectivityConfigurationPropertiesConnectivityCapabilities

对象

用于增强连接配置资源的特定拓扑行为的其他设置的集合。

名称	类型	默认值	说明
connectedGroupAddressOverlap	ConnectedGroupAddressOverlap	Allowed	处理连接配置的已连接组成员之间重叠的 IP 地址空间的行为。
connectedGroupPrivateEndpointsScale	ConnectedGroupPrivateEndpointsScale	Standard	选项，指示连接配置的已连接组中允许的专用终结点的规模。
peeringEnforcement	PeeringEnforcement	Unenforced	指示执行由连接配置创建的对等互连的选项。

connectivityGroupItem

对象

连接组项。

名称	类型	说明
groupConnectivity	GroupConnectivity	组连接类型。
isGlobal	IsGlobal	如果支持全局，则标记。
networkGroupId	string	网络组 ID。
useHubGateway	UseHubGateway	如果需要使用中心网关，则标记。

ConnectivityTopology

枚举

连接拓扑类型。

值	说明
HubAndSpoke	HubAndSpoke
Mesh	网格

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DeleteExistingPeering

枚举

如果需要删除当前的现有对等互连，则标记。

值	说明
False	假
True	True

GroupConnectivity

枚举

组连接类型。

值	说明
None	没有
DirectlyConnected	直连

Hub

对象

中心项。

名称	类型	说明
resourceId	string	资源 ID。
resourceType	string	资源类型。

IsGlobal

枚举

如果支持全局网格，则标记。

值	说明
False	假
True	True

PeeringEnforcement

枚举

指示执行由连接配置创建的对等互连的选项。

值	说明
Unenforced	违约。可以在网络管理器外部修改或删除由连接配置创建的对等互连。
Enforced	由连接配置创建的对等互连在网络管理器之外不可修改或删除。

ProvisioningState

枚举

资源的预配状态。

值	说明
Failed	Failed
Succeeded	成功
Canceled	已取消
Creating	创建
Updating	更新
Deleting	正在删除

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UseHubGateway

枚举

如果需要使用中心网关，则标记。

值	说明
False	假
True	True

通过