Connectivity Configurations - Create Or Update

Serviço:

Network Manager

Versão da API:

2025-05-01

Cria/atualiza uma nova configuração de conectividade do gerenciador de rede

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
configurationName	path	True	string	O nome da configuração de conectividade do gerenciador de rede.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	O nome do gestor de rede.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.appliesToGroups	True	connectivityGroupItem[]	Grupos para configuração
properties.connectivityTopology	True	ConnectivityTopology	Tipo de topologia de conectividade.
properties.connectivityCapabilities		ConnectivityConfigurationPropertiesConnectivityCapabilities	Coleção de configurações adicionais para aprimorar comportamentos específicos de topologia do recurso de configuração de conectividade.
properties.deleteExistingPeering		DeleteExistingPeering	Sinalize se necessário remover os emparelhamentos existentes atuais.
properties.description		string	Uma descrição da configuração de conectividade.
properties.hubs		Hub[]	Lista de hubItems
properties.isGlobal		IsGlobal	Sinalize se a malha global for suportada.

Respostas

Name	Tipo	Description
200 OK	ConnectivityConfiguration	Operação de atualização do recurso 'ConnectivityConfiguration' bem-sucedida
201 Created	ConnectivityConfiguration	Recurso 'ConnectivityConfiguration' criar operação bem-sucedida
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ConnectivityConfigurationsPut

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Código de estado:

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

Definições

Name	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ConnectedGroupAddressOverlap	Comportamento para manipular o espaço de endereço IP sobreposto entre os membros do grupo conectado da configuração de conectividade.
ConnectedGroupPrivateEndpointsScale	Opção que indica a escala de pontos finais privados permitidos no grupo conectado da configuração de conectividade.
ConnectivityConfiguration	O recurso de configuração de conectividade do gerenciador de rede
ConnectivityConfigurationPropertiesConnectivityCapabilities	Coleção de configurações adicionais para aprimorar comportamentos específicos de topologia do recurso de configuração de conectividade.
connectivityGroupItem	Item do grupo de conectividade.
ConnectivityTopology	Tipo de topologia de conectividade.
createdByType	O tipo de identidade que criou o recurso.
DeleteExistingPeering	Sinalize se necessário remover os emparelhamentos existentes atuais.
GroupConnectivity	Tipo de conectividade de grupo.
Hub	Item de Hub.
IsGlobal	Sinalize se a malha global for suportada.
PeeringEnforcement	Opção que indica a imposição de emparelhamentos criados pela configuração de conectividade.
ProvisioningState	Estados de provisionamento de um recurso.
systemData	Metadados referentes à criação e última modificação do recurso.
UseHubGateway	Sinalize se necessário usar o gateway de hub.

CloudError

Object

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro na nuvem.

CloudErrorBody

Object

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

ConnectedGroupAddressOverlap

Enumeração

Comportamento para manipular o espaço de endereço IP sobreposto entre os membros do grupo conectado da configuração de conectividade.

Valor	Description
Allowed	Predefinição. Permite que os membros do grupo conectado tenham espaço de endereço IP sobreposto.
Disallowed	Estritamente não permite que os membros do grupo conectados tenham espaço de endereço IP sobreposto. Impede a adição de uma rede virtual com endereço sobreposto ao grupo conectado, bloqueia o emparelhamento entre uma rede virtual e um membro do grupo conectado se qualquer membro do grupo conectado tiver um intervalo sobreposto e restringe as modificações de espaço de endereçamento que introduziriam sobreposição.

ConnectedGroupPrivateEndpointsScale

Enumeração

Opção que indica a escala de pontos finais privados permitidos no grupo conectado da configuração de conectividade.

Valor	Description
Standard	Predefinição. Permite até 2K pontos finais privados no grupo conectado.
HighScale	Permite até 20 mil pontos de extremidade privados no grupo conectado.

ConnectivityConfiguration

Object

O recurso de configuração de conectividade do gerenciador de rede

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	Nome do recurso.
properties.appliesToGroups	connectivityGroupItem[]	Grupos para configuração
properties.connectivityCapabilities	ConnectivityConfigurationPropertiesConnectivityCapabilities	Coleção de configurações adicionais para aprimorar comportamentos específicos de topologia do recurso de configuração de conectividade.
properties.connectivityTopology	ConnectivityTopology	Tipo de topologia de conectividade.
properties.deleteExistingPeering	DeleteExistingPeering	Sinalize se necessário remover os emparelhamentos existentes atuais.
properties.description	string	Uma descrição da configuração de conectividade.
properties.hubs	Hub[]	Lista de hubItems
properties.isGlobal	IsGlobal	Sinalize se a malha global for suportada.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de configuração de conectividade.
properties.resourceGuid	string	Identificador exclusivo para este recurso.
systemData	systemData	Os metadados do sistema relacionados a este recurso.
type	string	Tipo de recurso.

ConnectivityConfigurationPropertiesConnectivityCapabilities

Object

Coleção de configurações adicionais para aprimorar comportamentos específicos de topologia do recurso de configuração de conectividade.

Name	Tipo	Default value	Description
connectedGroupAddressOverlap	ConnectedGroupAddressOverlap	Allowed	Comportamento para manipular o espaço de endereço IP sobreposto entre os membros do grupo conectado da configuração de conectividade.
connectedGroupPrivateEndpointsScale	ConnectedGroupPrivateEndpointsScale	Standard	Opção que indica a escala de pontos finais privados permitidos no grupo conectado da configuração de conectividade.
peeringEnforcement	PeeringEnforcement	Unenforced	Opção que indica a imposição de emparelhamentos criados pela configuração de conectividade.

connectivityGroupItem

Object

Item do grupo de conectividade.

Name	Tipo	Description
groupConnectivity	GroupConnectivity	Tipo de conectividade de grupo.
isGlobal	IsGlobal	Sinalize se global for suportado.
networkGroupId	string	Id do grupo de rede.
useHubGateway	UseHubGateway	Sinalize se necessário usar o gateway de hub.

ConnectivityTopology

Enumeração

Tipo de topologia de conectividade.

Valor	Description
HubAndSpoke	HubAndSpoke
Mesh	Malha

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DeleteExistingPeering

Enumeração

Sinalize se necessário remover os emparelhamentos existentes atuais.

Valor	Description
False	Falso
True	Verdade

GroupConnectivity

Enumeração

Tipo de conectividade de grupo.

Valor	Description
None	Nenhum
DirectlyConnected	DirectamenteLigado

Hub

Object

Item de Hub.

Name	Tipo	Description
resourceId	string	Id do recurso.
resourceType	string	Tipo de recurso.

IsGlobal

Enumeração

Sinalize se a malha global for suportada.

Valor	Description
False	Falso
True	Verdade

PeeringEnforcement

Enumeração

Opção que indica a imposição de emparelhamentos criados pela configuração de conectividade.

Valor	Description
Unenforced	Predefinição. Os emparelhamentos criados pela configuração de conectividade podem ser modificados ou excluídos fora do gerenciador de rede.
Enforced	Os emparelhamentos criados pela configuração de conectividade não serão modificáveis ou excluíveis fora do gerenciador de rede.

ProvisioningState

Enumeração

Estados de provisionamento de um recurso.

Valor	Description
Failed	Falha
Succeeded	Succeeded
Canceled	Cancelado
Creating	Criação
Updating	Atualização
Deleting	Eliminar

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UseHubGateway

Enumeração

Sinalize se necessário usar o gateway de hub.

Valor	Description
False	Falso
True	Verdade