次の方法で共有


Connectivity Configurations - Create Or Update

Creates/Updates a new network manager connectivity configuration

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

URI Parameters

Name In Required Type Description
configurationName
path True

string

The name of the network manager connectivity configuration.

networkManagerName
path True

string

The name of the network manager.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client API version.

Request Body

Name Required Type Description
properties.appliesToGroups True

connectivityGroupItem[]

Groups for configuration

properties.connectivityTopology True

ConnectivityTopology

Connectivity topology type.

properties.deleteExistingPeering

DeleteExistingPeering

Flag if need to remove current existing peerings.

properties.description

string

A description of the connectivity configuration.

properties.hubs

Hub[]

List of hubItems

properties.isGlobal

IsGlobal

Flag if global mesh is supported.

Responses

Name Type Description
200 OK

ConnectivityConfiguration

Update successful. The operation returns the resulting network manager connectivity configuration.

201 Created

ConnectivityConfiguration

Create successful. The operation returns the resulting network manager connectivity configuration.

Other Status Codes

CloudError

Resource Provider error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

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=2024-01-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"
  }
}

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ConnectivityConfiguration

The network manager connectivity configuration resource

connectivityGroupItem

Connectivity group item.

ConnectivityTopology

Connectivity topology type.

createdByType

The type of identity that created the resource.

DeleteExistingPeering

Flag if need to remove current existing peerings.

GroupConnectivity

Group connectivity type.

Hub

Hub Item.

IsGlobal

Flag if global mesh is supported.

ProvisioningState

The current provisioning state.

SystemData

Metadata pertaining to creation and last modification of the resource.

UseHubGateway

Flag if need to use hub gateway.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

ConnectivityConfiguration

The network manager connectivity configuration resource

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

name

string

Resource name.

properties.appliesToGroups

connectivityGroupItem[]

Groups for configuration

properties.connectivityTopology

ConnectivityTopology

Connectivity topology type.

properties.deleteExistingPeering

DeleteExistingPeering

Flag if need to remove current existing peerings.

properties.description

string

A description of the connectivity configuration.

properties.hubs

Hub[]

List of hubItems

properties.isGlobal

IsGlobal

Flag if global mesh is supported.

properties.provisioningState

ProvisioningState

The provisioning state of the connectivity configuration resource.

properties.resourceGuid

string

Unique identifier for this resource.

systemData

SystemData

The system metadata related to this resource.

type

string

Resource type.

connectivityGroupItem

Connectivity group item.

Name Type Description
groupConnectivity

GroupConnectivity

Group connectivity type.

isGlobal

IsGlobal

Flag if global is supported.

networkGroupId

string

Network group Id.

useHubGateway

UseHubGateway

Flag if need to use hub gateway.

ConnectivityTopology

Connectivity topology type.

Name Type Description
HubAndSpoke

string

Mesh

string

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DeleteExistingPeering

Flag if need to remove current existing peerings.

Name Type Description
False

string

True

string

GroupConnectivity

Group connectivity type.

Name Type Description
DirectlyConnected

string

None

string

Hub

Hub Item.

Name Type Description
resourceId

string

Resource Id.

resourceType

string

Resource Type.

IsGlobal

Flag if global mesh is supported.

Name Type Description
False

string

True

string

ProvisioningState

The current provisioning state.

Name Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

SystemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The type of identity that last modified the resource.

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

UseHubGateway

Flag if need to use hub gateway.

Name Type Description
False

string

True

string