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)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (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

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ConnectivityConfigurationsPut

Образец запроса

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

Пример ответа

Код состояния:

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	Default. Позволяет подключенным участникам группы иметь перекрывающееся пространство IP-адресов.
Disallowed	Строго запрещает членам подключенной группы иметь перекрывающееся пространство IP-адресов. Запрещает добавление виртуальной сети с перекрывающимся адресом в подключенную группу, блокирует пиринг между виртуальной сетью и подключенным участником группы, если какой-либо из подключенных членов группы имеет перекрывающийся диапазон, и ограничивает изменения адресного пространства, которые могут привести к перекрытию.

ConnectedGroupPrivateEndpointsScale

Перечисление

Опция, указывающая масштаб частных конечных точек, разрешенных в подключенной группе конфигурации подключения.

Значение	Описание
Standard	Default. Позволяет использовать до 2 тыс. частных конечных точек в подключенной группе.
HighScale	Позволяет использовать до 20 тыс. частных конечных точек в подключенной группе.

ConnectivityConfiguration

Объект

Ресурс конфигурации подключения к диспетчеру сети

Имя	Тип	Описание
etag	string	Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id	string	Идентификатор ресурса.
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

Объект

Сбор дополнительных параметров для улучшения определенного поведения топологии ресурса конфигурации связности.

Имя	Тип	Default value	Описание
connectedGroupAddressOverlap	ConnectedGroupAddressOverlap	Allowed	Поведение для обработки перекрывающегося пространства IP-адресов среди членов подключенной группы конфигурации подключения.
connectedGroupPrivateEndpointsScale	ConnectedGroupPrivateEndpointsScale	Standard	Опция, указывающая масштаб частных конечных точек, разрешенных в подключенной группе конфигурации подключения.
peeringEnforcement	PeeringEnforcement	Unenforced	Опция, указывающая на принудительное применение пирингов, созданных конфигурацией связности.

connectivityGroupItem

Объект

Элемент группы подключения.

Имя	Тип	Описание
groupConnectivity	GroupConnectivity	Тип подключения к группе.
isGlobal	IsGlobal	Пометка, если поддерживается глобальный.
networkGroupId	string	Идентификатор группы сети.
useHubGateway	UseHubGateway	Помечайте, если требуется использовать центральный шлюз.

ConnectivityTopology

Перечисление

Тип топологии подключения.

Значение	Описание
HubAndSpoke	HubAndSpoke
Mesh	Сетка

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DeleteExistingPeering

Перечисление

Пометка, если нужно удалить текущие существующие пиринги.

Значение	Описание
False	Неправда
True	True

GroupConnectivity

Перечисление

Тип подключения к группе.

Значение	Описание
None	Нет
DirectlyConnected	DirectlyConnected

Hub

Объект

Элемент концентратора.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса.
resourceType	string	Тип ресурса.

IsGlobal

Перечисление

Пометка, если поддерживается глобальная сетка.

Значение	Описание
False	Неправда
True	True

PeeringEnforcement

Перечисление

Опция, указывающая на принудительное применение пирингов, созданных конфигурацией связности.

Значение	Описание
Unenforced	Default. Пиринги, созданные конфигурацией подключения, могут быть изменены или удалены за пределами диспетчера сети.
Enforced	Пиринги, созданные конфигурацией подключения, не могут быть изменены или удалены за пределами диспетчера сети.

ProvisioningState

Перечисление

Инициализация состояний ресурса.

Значение	Описание
Failed	Неудача
Succeeded	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