Connectivity Configurations - Create Or Update

Erstellt/Updates einer neuen Netzwerk-Manager-Konnektivitätskonfiguration

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
configurationName
path True

string

Der Name der Netzwerk-Manager-Konnektivitätskonfiguration.

networkManagerName
path True

string

Der Name des Netzwerk-Managers.

resourceGroupName
path True

string

Der Name der Ressourcengruppe.

subscriptionId
path True

string

Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True

string

Client-API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
properties.appliesToGroups True

connectivityGroupItem[]

Gruppen für die Konfiguration

properties.connectivityTopology True

ConnectivityTopology

Konnektivitätstopologietyp.

properties.deleteExistingPeering

DeleteExistingPeering

Kennzeichnen Sie, wenn aktuell vorhandene Peerings entfernt werden müssen.

properties.description

string

Eine Beschreibung der Konnektivitätskonfiguration.

properties.hubs

Hub[]

Liste der hubItems

properties.isGlobal

IsGlobal

Flag, wenn globales Gitter unterstützt wird.

Antworten

Name Typ Beschreibung
200 OK

ConnectivityConfiguration

Aktualisierung erfolgreich. Der Vorgang gibt die resultierende Netzwerk-Manager-Konnektivitätskonfiguration zurück.

201 Created

ConnectivityConfiguration

Erfolgreich erstellen. Der Vorgang gibt die resultierende Netzwerk-Manager-Konnektivitätskonfiguration zurück.

Other Status Codes

CloudError

Fehlerantwort des Ressourcenanbieters, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Annehmen der Identität Ihres Benutzerkontos

Beispiele

ConnectivityConfigurationsPut

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig?api-version=2023-05-01

{
  "properties": {
    "description": "Sample Configuration",
    "connectivityTopology": "HubAndSpoke",
    "hubs": [
      {
        "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig",
        "resourceType": "Microsoft.Network/virtualNetworks"
      }
    ],
    "deleteExistingPeering": "True",
    "isGlobal": "True",
    "appliesToGroups": [
      {
        "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1",
        "useHubGateway": "True",
        "groupConnectivity": "None",
        "isGlobal": "False"
      }
    ]
  }
}

Sample Response

{
  "name": "myTestConnectivityConfig",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig",
  "type": "Microsoft.Network/networkManagers/connectivityConfigurations",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "createdAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z"
  },
  "properties": {
    "description": "Sample Connectivity Configuration",
    "connectivityTopology": "HubAndSpoke",
    "hubs": [
      {
        "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig",
        "resourceType": "Microsoft.Network/virtualNetworks"
      }
    ],
    "deleteExistingPeering": "True",
    "isGlobal": "True",
    "appliesToGroups": [
      {
        "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/groups/group1",
        "useHubGateway": "True",
        "groupConnectivity": "None",
        "isGlobal": "False"
      }
    ],
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000"
  }
}
{
  "name": "myTestConnectivityConfig",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig",
  "type": "Microsoft.Network/networkManagers/connectivityConfigurations",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "createdAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z"
  },
  "properties": {
    "description": "Sample Configuration",
    "connectivityTopology": "HubAndSpoke",
    "hubs": [
      {
        "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig",
        "resourceType": "Microsoft.Network/virtualNetworks"
      }
    ],
    "deleteExistingPeering": "True",
    "isGlobal": "True",
    "appliesToGroups": [
      {
        "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1",
        "useHubGateway": "True",
        "groupConnectivity": "None",
        "isGlobal": "False"
      }
    ],
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000"
  }
}

Definitionen

Name Beschreibung
CloudError

Eine Fehlerantwort vom Dienst.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

ConnectivityConfiguration

Die Netzwerk-Manager-Konnektivitätskonfigurationsressource

connectivityGroupItem

Konnektivitätsgruppenelement.

ConnectivityTopology

Konnektivitätstopologietyp.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

DeleteExistingPeering

Kennzeichnen Sie, wenn aktuell vorhandene Peerings entfernt werden müssen.

GroupConnectivity

Gruppenkonnektivitätstyp.

Hub

Hubelement.

IsGlobal

Flag, wenn globales Gitter unterstützt wird.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

UseHubGateway

Kennzeichnen Sie, wenn Hubgateway verwendet werden muss.

CloudError

Eine Fehlerantwort vom Dienst.

Name Typ Beschreibung
error

CloudErrorBody

Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.

details

CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.

message

string

Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

target

string

Das Ziel des bestimmten Fehlers. Beispiel: Der Name der -Eigenschaft, die einen Fehler aufweist.

ConnectivityConfiguration

Die Netzwerk-Manager-Konnektivitätskonfigurationsressource

Name Typ Beschreibung
etag

string

Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.

id

string

Ressourcen-ID

name

string

Name der Ressource.

properties.appliesToGroups

connectivityGroupItem[]

Gruppen für die Konfiguration

properties.connectivityTopology

ConnectivityTopology

Konnektivitätstopologietyp.

properties.deleteExistingPeering

DeleteExistingPeering

Kennzeichnen Sie, wenn aktuell vorhandene Peerings entfernt werden müssen.

properties.description

string

Eine Beschreibung der Konnektivitätskonfiguration.

properties.hubs

Hub[]

Liste der hubItems

properties.isGlobal

IsGlobal

Flag, wenn globales Gitter unterstützt wird.

properties.provisioningState

ProvisioningState

Der Bereitstellungsstatus der Konnektivitätskonfigurationsressource.

properties.resourceGuid

string

Eindeutiger Bezeichner für diese Ressource.

systemData

SystemData

Die Systemmetadaten, die sich auf diese Ressource beziehen.

type

string

Der Ressourcentyp.

connectivityGroupItem

Konnektivitätsgruppenelement.

Name Typ Beschreibung
groupConnectivity

GroupConnectivity

Gruppenkonnektivitätstyp.

isGlobal

IsGlobal

Flag if global is supported.

networkGroupId

string

Netzwerkgruppen-ID.

useHubGateway

UseHubGateway

Kennzeichnen Sie, wenn Hubgateway verwendet werden muss.

ConnectivityTopology

Konnektivitätstopologietyp.

Name Typ Beschreibung
HubAndSpoke

string

Mesh

string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

DeleteExistingPeering

Kennzeichnen Sie, wenn aktuell vorhandene Peerings entfernt werden müssen.

Name Typ Beschreibung
False

string

True

string

GroupConnectivity

Gruppenkonnektivitätstyp.

Name Typ Beschreibung
DirectlyConnected

string

None

string

Hub

Hubelement.

Name Typ Beschreibung
resourceId

string

Ressourcen-ID.

resourceType

string

Ressourcentyp.

IsGlobal

Flag, wenn globales Gitter unterstützt wird.

Name Typ Beschreibung
False

string

True

string

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name Typ Beschreibung
Deleting

string

Failed

string

Succeeded

string

Updating

string

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Identitätstyp, der die Ressource zuletzt geändert hat.

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

UseHubGateway

Kennzeichnen Sie, wenn Hubgateway verwendet werden muss.

Name Typ Beschreibung
False

string

True

string