Connectivity Configurations - Create Or Update

Szolgáltatás:

Network Manager

API-verzió:

2025-05-01

Új hálózatkezelői kapcsolati konfigurációt hoz létre/frissít

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
configurationName	path	True	string	A network manager kapcsolati konfigurációjának neve.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	A hálózatkezelő neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
properties.appliesToGroups	True	connectivityGroupItem[]	Konfigurációs csoportok
properties.connectivityTopology	True	ConnectivityTopology	Kapcsolati topológia típusa.
properties.connectivityCapabilities		ConnectivityConfigurationPropertiesConnectivityCapabilities	További beállítások gyűjteménye a kapcsolatkonfigurációs erőforrás adott topológiaviselkedésének javításához.
properties.deleteExistingPeering		DeleteExistingPeering	Jelöljön meg egy jelölőt, ha el kell távolítania a meglévő társviszonyokat.
properties.description		string	A kapcsolat konfigurációjának leírása.
properties.hubs		Hub[]	HubItemek listája
properties.isGlobal		IsGlobal	Jelölje meg, ha a globális háló támogatott.

Válaszok

Name	Típus	Description
200 OK	ConnectivityConfiguration	Az erőforrás 'ConnectivityConfiguration' frissítési művelete sikeres
201 Created	ConnectivityConfiguration	Resource 'ConnectivityConfiguration' létrehozása művelet sikeres
Other Status Codes	CloudError	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ConnectivityConfigurationsPut

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Állapotkód:

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

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
ConnectedGroupAddressOverlap	A kapcsolati konfiguráció csatlakoztatott csoportjának tagjai közötti átfedésben lévő IP-címterület kezeléséhez szükséges viselkedés.
ConnectedGroupPrivateEndpointsScale	A kapcsolati konfiguráció csatlakoztatott csoportjában engedélyezett privát végpontok skáláját jelző beállítás.
ConnectivityConfiguration	A Network Manager kapcsolatkonfigurációs erőforrása
ConnectivityConfigurationPropertiesConnectivityCapabilities	További beállítások gyűjteménye a kapcsolatkonfigurációs erőforrás adott topológiaviselkedésének javításához.
connectivityGroupItem	Kapcsolatcsoportelem.
ConnectivityTopology	Kapcsolati topológia típusa.
createdByType	Az erőforrást létrehozó identitás típusa.
DeleteExistingPeering	Jelöljön meg egy jelölőt, ha el kell távolítania a meglévő társviszonyokat.
GroupConnectivity	Csoportkapcsolat típusa.
Hub	Központi elem.
IsGlobal	Jelölje meg, ha a globális háló támogatott.
PeeringEnforcement	A kapcsolati konfiguráció által létrehozott társviszonyok kényszerítését jelző beállítás.
ProvisioningState	Erőforrás kiépítési állapotai.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UseHubGateway	Jelölő, ha a központi átjárót kell használnia.

CloudError

Tárgy

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Felhőhiba törzse.

CloudErrorBody

Tárgy

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hiba további részleteinek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a tulajdonság neve hibás.

ConnectedGroupAddressOverlap

Felsorolás

A kapcsolati konfiguráció csatlakoztatott csoportjának tagjai közötti átfedésben lévő IP-címterület kezeléséhez szükséges viselkedés.

Érték	Description
Allowed	Default. Lehetővé teszi, hogy a csatlakoztatott csoporttagok átfedésben lévő IP-címterülettel rendelkezzenek.
Disallowed	Szigorúan tiltja, hogy a csatlakoztatott csoporttagok átfedésben legyenek az IP-címterületen. Megakadályozza az átfedésben lévő címmel rendelkező virtuális hálózat hozzáadását a csatlakoztatott csoporthoz, blokkolja a virtuális hálózat és a csatlakoztatott csoporttag közötti társviszonyt, ha a csatlakoztatott csoport bármely tagja átfedésben van, és korlátozza az átfedést okozó címtér-módosításokat.

ConnectedGroupPrivateEndpointsScale

Felsorolás

A kapcsolati konfiguráció csatlakoztatott csoportjában engedélyezett privát végpontok skáláját jelző beállítás.

Érték	Description
Standard	Default. Legfeljebb 2K privát végpontokat tesz lehetővé a csatlakoztatott csoportban.
HighScale	Legfeljebb 20 ezer privát végpontot tesz lehetővé a csatlakoztatott csoportban.

ConnectivityConfiguration

Tárgy

A Network Manager kapcsolatkonfigurációs erőforrása

Name	Típus	Description
etag	string	Egyedi írásvédett sztring, amely az erőforrás frissítésekor változik.
id	string	Erőforrás-azonosító.
name	string	Erőforrás neve.
properties.appliesToGroups	connectivityGroupItem[]	Konfigurációs csoportok
properties.connectivityCapabilities	ConnectivityConfigurationPropertiesConnectivityCapabilities	További beállítások gyűjteménye a kapcsolatkonfigurációs erőforrás adott topológiaviselkedésének javításához.
properties.connectivityTopology	ConnectivityTopology	Kapcsolati topológia típusa.
properties.deleteExistingPeering	DeleteExistingPeering	Jelöljön meg egy jelölőt, ha el kell távolítania a meglévő társviszonyokat.
properties.description	string	A kapcsolat konfigurációjának leírása.
properties.hubs	Hub[]	HubItemek listája
properties.isGlobal	IsGlobal	Jelölje meg, ha a globális háló támogatott.
properties.provisioningState	ProvisioningState	A kapcsolatkonfigurációs erőforrás kiépítési állapota.
properties.resourceGuid	string	Az erőforrás egyedi azonosítója.
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Erőforrás típusa.

ConnectivityConfigurationPropertiesConnectivityCapabilities

Tárgy

További beállítások gyűjteménye a kapcsolatkonfigurációs erőforrás adott topológiaviselkedésének javításához.

Name	Típus	Alapértelmezett érték	Description
connectedGroupAddressOverlap	ConnectedGroupAddressOverlap	Allowed	A kapcsolati konfiguráció csatlakoztatott csoportjának tagjai közötti átfedésben lévő IP-címterület kezeléséhez szükséges viselkedés.
connectedGroupPrivateEndpointsScale	ConnectedGroupPrivateEndpointsScale	Standard	A kapcsolati konfiguráció csatlakoztatott csoportjában engedélyezett privát végpontok skáláját jelző beállítás.
peeringEnforcement	PeeringEnforcement	Unenforced	A kapcsolati konfiguráció által létrehozott társviszonyok kényszerítését jelző beállítás.

connectivityGroupItem

Tárgy

Kapcsolatcsoportelem.

Name	Típus	Description
groupConnectivity	GroupConnectivity	Csoportkapcsolat típusa.
isGlobal	IsGlobal	A globális támogatottság megjelölése.
networkGroupId	string	Hálózati csoport azonosítója.
useHubGateway	UseHubGateway	Jelölő, ha a központi átjárót kell használnia.

ConnectivityTopology

Felsorolás

Kapcsolati topológia típusa.

Érték	Description
HubAndSpoke	HubAndSpoke
Mesh	Háló

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

DeleteExistingPeering

Felsorolás

Jelöljön meg egy jelölőt, ha el kell távolítania a meglévő társviszonyokat.

Érték	Description
False	Téves
True	True

GroupConnectivity

Felsorolás

Csoportkapcsolat típusa.

Érték	Description
None	Nincs
DirectlyConnected	DirectConnected

Hub

Tárgy

Központi elem.

Name	Típus	Description
resourceId	string	Erőforrás-azonosító.
resourceType	string	Erőforrás típusa.

IsGlobal

Felsorolás

Jelölje meg, ha a globális háló támogatott.

Érték	Description
False	Téves
True	True

PeeringEnforcement

Felsorolás

A kapcsolati konfiguráció által létrehozott társviszonyok kényszerítését jelző beállítás.

Érték	Description
Unenforced	Default. A kapcsolati konfiguráció által létrehozott társviszonyok a hálózatkezelőn kívül módosíthatók vagy törölhetők.
Enforced	A kapcsolati konfiguráció által létrehozott társviszonyok nem módosíthatók vagy törölhetők a hálózatkezelőn kívül.

ProvisioningState

Felsorolás

Erőforrás kiépítési állapotai.

Érték	Description
Failed	Meghiúsult
Succeeded	Sikerült
Canceled	Érvénytelenített
Creating	Létrehozás
Updating	Frissítés
Deleting	Törlés

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UseHubGateway

Felsorolás

Jelölő, ha a központi átjárót kell használnia.

Érték	Description
False	Téves
True	True