Azure Native v1.102.0, May 2 23

azure-native.network.ConnectivityConfiguration

Explore with Pulumi AI

The network manager connectivity configuration resource API Version: 2021-02-01-preview.

Example Usage

ConnectivityConfigurationsPut

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var connectivityConfiguration = new AzureNative.Network.ConnectivityConfiguration("connectivityConfiguration", new()
    {
        AppliesToGroups = new[]
        {
            new AzureNative.Network.Inputs.ConnectivityGroupItemArgs
            {
                GroupConnectivity = "None",
                IsGlobal = "False",
                NetworkGroupId = "subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1",
                UseHubGateway = "True",
            },
        },
        ConfigurationName = "myTestConnectivityConfig",
        ConnectivityTopology = "HubAndSpoke",
        DeleteExistingPeering = "True",
        Description = "Sample Configuration",
        DisplayName = "myTestConnectivityConfig",
        Hubs = new[]
        {
            new AzureNative.Network.Inputs.HubArgs
            {
                ResourceId = "subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig",
                ResourceType = "Microsoft.Network/virtualNetworks",
            },
        },
        IsGlobal = "True",
        NetworkManagerName = "testNetworkManager",
        ResourceGroupName = "myResourceGroup",
    });

});

package main

import (
	network "github.com/pulumi/pulumi-azure-native/sdk/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewConnectivityConfiguration(ctx, "connectivityConfiguration", &network.ConnectivityConfigurationArgs{
			AppliesToGroups: []network.ConnectivityGroupItemArgs{
				{
					GroupConnectivity: pulumi.String("None"),
					IsGlobal:          pulumi.String("False"),
					NetworkGroupId:    pulumi.String("subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1"),
					UseHubGateway:     pulumi.String("True"),
				},
			},
			ConfigurationName:     pulumi.String("myTestConnectivityConfig"),
			ConnectivityTopology:  pulumi.String("HubAndSpoke"),
			DeleteExistingPeering: pulumi.String("True"),
			Description:           pulumi.String("Sample Configuration"),
			DisplayName:           pulumi.String("myTestConnectivityConfig"),
			Hubs: []network.HubArgs{
				{
					ResourceId:   pulumi.String("subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig"),
					ResourceType: pulumi.String("Microsoft.Network/virtualNetworks"),
				},
			},
			IsGlobal:           pulumi.String("True"),
			NetworkManagerName: pulumi.String("testNetworkManager"),
			ResourceGroupName:  pulumi.String("myResourceGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.ConnectivityConfiguration;
import com.pulumi.azurenative.network.ConnectivityConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var connectivityConfiguration = new ConnectivityConfiguration("connectivityConfiguration", ConnectivityConfigurationArgs.builder()        
            .appliesToGroups(Map.ofEntries(
                Map.entry("groupConnectivity", "None"),
                Map.entry("isGlobal", "False"),
                Map.entry("networkGroupId", "subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1"),
                Map.entry("useHubGateway", "True")
            ))
            .configurationName("myTestConnectivityConfig")
            .connectivityTopology("HubAndSpoke")
            .deleteExistingPeering("True")
            .description("Sample Configuration")
            .displayName("myTestConnectivityConfig")
            .hubs(Map.ofEntries(
                Map.entry("resourceId", "subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig"),
                Map.entry("resourceType", "Microsoft.Network/virtualNetworks")
            ))
            .isGlobal("True")
            .networkManagerName("testNetworkManager")
            .resourceGroupName("myResourceGroup")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

connectivity_configuration = azure_native.network.ConnectivityConfiguration("connectivityConfiguration",
    applies_to_groups=[azure_native.network.ConnectivityGroupItemArgs(
        group_connectivity="None",
        is_global="False",
        network_group_id="subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1",
        use_hub_gateway="True",
    )],
    configuration_name="myTestConnectivityConfig",
    connectivity_topology="HubAndSpoke",
    delete_existing_peering="True",
    description="Sample Configuration",
    display_name="myTestConnectivityConfig",
    hubs=[azure_native.network.HubArgs(
        resource_id="subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig",
        resource_type="Microsoft.Network/virtualNetworks",
    )],
    is_global="True",
    network_manager_name="testNetworkManager",
    resource_group_name="myResourceGroup")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const connectivityConfiguration = new azure_native.network.ConnectivityConfiguration("connectivityConfiguration", {
    appliesToGroups: [{
        groupConnectivity: "None",
        isGlobal: "False",
        networkGroupId: "subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1",
        useHubGateway: "True",
    }],
    configurationName: "myTestConnectivityConfig",
    connectivityTopology: "HubAndSpoke",
    deleteExistingPeering: "True",
    description: "Sample Configuration",
    displayName: "myTestConnectivityConfig",
    hubs: [{
        resourceId: "subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig",
        resourceType: "Microsoft.Network/virtualNetworks",
    }],
    isGlobal: "True",
    networkManagerName: "testNetworkManager",
    resourceGroupName: "myResourceGroup",
});

resources:
  connectivityConfiguration:
    type: azure-native:network:ConnectivityConfiguration
    properties:
      appliesToGroups:
        - groupConnectivity: None
          isGlobal: False
          networkGroupId: subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1
          useHubGateway: True
      configurationName: myTestConnectivityConfig
      connectivityTopology: HubAndSpoke
      deleteExistingPeering: True
      description: Sample Configuration
      displayName: myTestConnectivityConfig
      hubs:
        - resourceId: subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig
          resourceType: Microsoft.Network/virtualNetworks
      isGlobal: True
      networkManagerName: testNetworkManager
      resourceGroupName: myResourceGroup

Create ConnectivityConfiguration Resource

new ConnectivityConfiguration(name: string, args: ConnectivityConfigurationArgs, opts?: CustomResourceOptions);

@overload
def ConnectivityConfiguration(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              applies_to_groups: Optional[Sequence[ConnectivityGroupItemArgs]] = None,
                              configuration_name: Optional[str] = None,
                              connectivity_topology: Optional[Union[str, ConnectivityTopology]] = None,
                              delete_existing_peering: Optional[Union[str, DeleteExistingPeering]] = None,
                              description: Optional[str] = None,
                              display_name: Optional[str] = None,
                              hubs: Optional[Sequence[HubArgs]] = None,
                              is_global: Optional[Union[str, IsGlobal]] = None,
                              network_manager_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None)
@overload
def ConnectivityConfiguration(resource_name: str,
                              args: ConnectivityConfigurationArgs,
                              opts: Optional[ResourceOptions] = None)

func NewConnectivityConfiguration(ctx *Context, name string, args ConnectivityConfigurationArgs, opts ...ResourceOption) (*ConnectivityConfiguration, error)

public ConnectivityConfiguration(string name, ConnectivityConfigurationArgs args, CustomResourceOptions? opts = null)

public ConnectivityConfiguration(String name, ConnectivityConfigurationArgs args)
public ConnectivityConfiguration(String name, ConnectivityConfigurationArgs args, CustomResourceOptions options)

type: azure-native:network:ConnectivityConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectivityConfigurationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ConnectivityConfigurationArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ConnectivityConfigurationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectivityConfigurationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ConnectivityConfigurationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ConnectivityConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ConnectivityConfiguration resource accepts the following input properties:

ConnectivityTopology string | Pulumi.AzureNative.Network.ConnectivityTopology: Connectivity topology type.
NetworkManagerName string: The name of the network manager.
ResourceGroupName string: The name of the resource group.
AppliesToGroups List<Pulumi.AzureNative.Network.Inputs.ConnectivityGroupItemArgs>: Groups for configuration
ConfigurationName string: The name of the network manager connectivity configuration.
DeleteExistingPeering string | Pulumi.AzureNative.Network.DeleteExistingPeering: Flag if need to remove current existing peerings.
Description string: A description of the connectivity configuration.
DisplayName string: A friendly name for the resource.
Hubs List<Pulumi.AzureNative.Network.Inputs.HubArgs>: List of hubItems
IsGlobal string | Pulumi.AzureNative.Network.IsGlobal: Flag if global mesh is supported.

ConnectivityTopology string | ConnectivityTopology: Connectivity topology type.
NetworkManagerName string: The name of the network manager.
ResourceGroupName string: The name of the resource group.
AppliesToGroups []ConnectivityGroupItemArgs: Groups for configuration
ConfigurationName string: The name of the network manager connectivity configuration.
DeleteExistingPeering string | DeleteExistingPeering: Flag if need to remove current existing peerings.
Description string: A description of the connectivity configuration.
DisplayName string: A friendly name for the resource.
Hubs []HubArgs: List of hubItems
IsGlobal string | IsGlobal: Flag if global mesh is supported.

connectivityTopology String | ConnectivityTopology: Connectivity topology type.
networkManagerName String: The name of the network manager.
resourceGroupName String: The name of the resource group.
appliesToGroups List<ConnectivityGroupItemArgs>: Groups for configuration
configurationName String: The name of the network manager connectivity configuration.
deleteExistingPeering String | DeleteExistingPeering: Flag if need to remove current existing peerings.
description String: A description of the connectivity configuration.
displayName String: A friendly name for the resource.
hubs List<HubArgs>: List of hubItems
isGlobal String | IsGlobal: Flag if global mesh is supported.

connectivityTopology string | ConnectivityTopology: Connectivity topology type.
networkManagerName string: The name of the network manager.
resourceGroupName string: The name of the resource group.
appliesToGroups ConnectivityGroupItemArgs[]: Groups for configuration
configurationName string: The name of the network manager connectivity configuration.
deleteExistingPeering string | DeleteExistingPeering: Flag if need to remove current existing peerings.
description string: A description of the connectivity configuration.
displayName string: A friendly name for the resource.
hubs HubArgs[]: List of hubItems
isGlobal string | IsGlobal: Flag if global mesh is supported.

connectivity_topology str | ConnectivityTopology: Connectivity topology type.
network_manager_name str: The name of the network manager.
resource_group_name str: The name of the resource group.
applies_to_groups Sequence[ConnectivityGroupItemArgs]: Groups for configuration
configuration_name str: The name of the network manager connectivity configuration.
delete_existing_peering str | DeleteExistingPeering: Flag if need to remove current existing peerings.
description str: A description of the connectivity configuration.
display_name str: A friendly name for the resource.
hubs Sequence[HubArgs]: List of hubItems
is_global str | IsGlobal: Flag if global mesh is supported.

connectivityTopology String | "HubAndSpoke" | "Mesh": Connectivity topology type.
networkManagerName String: The name of the network manager.
resourceGroupName String: The name of the resource group.
appliesToGroups List<Property Map>: Groups for configuration
configurationName String: The name of the network manager connectivity configuration.
deleteExistingPeering String | "False" | "True": Flag if need to remove current existing peerings.
description String: A description of the connectivity configuration.
displayName String: A friendly name for the resource.
hubs List<Property Map>: List of hubItems
isGlobal String | "False" | "True": Flag if global mesh is supported.

Outputs

All input properties are implicitly available as output properties. Additionally, the ConnectivityConfiguration resource produces the following output properties:

Etag string: A unique read-only string that changes whenever the resource is updated.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
ProvisioningState string: The provisioning state of the connectivity configuration resource.
SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse: The system metadata related to this resource.
Type string: Resource type.

Etag string: A unique read-only string that changes whenever the resource is updated.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
ProvisioningState string: The provisioning state of the connectivity configuration resource.
SystemData SystemDataResponse: The system metadata related to this resource.
Type string: Resource type.

etag String: A unique read-only string that changes whenever the resource is updated.
id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
provisioningState String: The provisioning state of the connectivity configuration resource.
systemData SystemDataResponse: The system metadata related to this resource.
type String: Resource type.

etag string: A unique read-only string that changes whenever the resource is updated.
id string: The provider-assigned unique ID for this managed resource.
name string: Resource name.
provisioningState string: The provisioning state of the connectivity configuration resource.
systemData SystemDataResponse: The system metadata related to this resource.
type string: Resource type.

etag str: A unique read-only string that changes whenever the resource is updated.
id str: The provider-assigned unique ID for this managed resource.
name str: Resource name.
provisioning_state str: The provisioning state of the connectivity configuration resource.
system_data SystemDataResponse: The system metadata related to this resource.
type str: Resource type.

etag String: A unique read-only string that changes whenever the resource is updated.
id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
provisioningState String: The provisioning state of the connectivity configuration resource.
systemData Property Map: The system metadata related to this resource.
type String: Resource type.

Supporting Types

ConnectivityGroupItem

GroupConnectivity string | Pulumi.AzureNative.Network.GroupConnectivity: Group connectivity type.
IsGlobal string | Pulumi.AzureNative.Network.IsGlobal: Flag if global is supported.
NetworkGroupId string: Network group Id.
UseHubGateway string | Pulumi.AzureNative.Network.UseHubGateway: Flag if need to use hub gateway.

GroupConnectivity string | GroupConnectivity: Group connectivity type.
IsGlobal string | IsGlobal: Flag if global is supported.
NetworkGroupId string: Network group Id.
UseHubGateway string | UseHubGateway: Flag if need to use hub gateway.

groupConnectivity String | GroupConnectivity: Group connectivity type.
isGlobal String | IsGlobal: Flag if global is supported.
networkGroupId String: Network group Id.
useHubGateway String | UseHubGateway: Flag if need to use hub gateway.

groupConnectivity string | GroupConnectivity: Group connectivity type.
isGlobal string | IsGlobal: Flag if global is supported.
networkGroupId string: Network group Id.
useHubGateway string | UseHubGateway: Flag if need to use hub gateway.

group_connectivity str | GroupConnectivity: Group connectivity type.
is_global str | IsGlobal: Flag if global is supported.
network_group_id str: Network group Id.
use_hub_gateway str | UseHubGateway: Flag if need to use hub gateway.

groupConnectivity String | "None" | "DirectlyConnected": Group connectivity type.
isGlobal String | "False" | "True": Flag if global is supported.
networkGroupId String: Network group Id.
useHubGateway String | "False" | "True": Flag if need to use hub gateway.

ConnectivityGroupItemResponse

GroupConnectivity string: Group connectivity type.
IsGlobal string: Flag if global is supported.
NetworkGroupId string: Network group Id.
UseHubGateway string: Flag if need to use hub gateway.

GroupConnectivity string: Group connectivity type.
IsGlobal string: Flag if global is supported.
NetworkGroupId string: Network group Id.
UseHubGateway string: Flag if need to use hub gateway.

groupConnectivity String: Group connectivity type.
isGlobal String: Flag if global is supported.
networkGroupId String: Network group Id.
useHubGateway String: Flag if need to use hub gateway.

groupConnectivity string: Group connectivity type.
isGlobal string: Flag if global is supported.
networkGroupId string: Network group Id.
useHubGateway string: Flag if need to use hub gateway.

group_connectivity str: Group connectivity type.
is_global str: Flag if global is supported.
network_group_id str: Network group Id.
use_hub_gateway str: Flag if need to use hub gateway.

groupConnectivity String: Group connectivity type.
isGlobal String: Flag if global is supported.
networkGroupId String: Network group Id.
useHubGateway String: Flag if need to use hub gateway.

ConnectivityTopology

HubAndSpoke: HubAndSpoke
Mesh: Mesh

ConnectivityTopologyHubAndSpoke: HubAndSpoke
ConnectivityTopologyMesh: Mesh

HubAndSpoke: HubAndSpoke
Mesh: Mesh

HubAndSpoke: HubAndSpoke
Mesh: Mesh

HUB_AND_SPOKE: HubAndSpoke
MESH: Mesh

"HubAndSpoke": HubAndSpoke
"Mesh": Mesh

DeleteExistingPeering

False: False
True: True

DeleteExistingPeeringFalse: False
DeleteExistingPeeringTrue: True

False: False
True: True

False: False
True: True

FALSE: False
TRUE: True

"False": False
"True": True

GroupConnectivity

None: None
DirectlyConnected: DirectlyConnected

GroupConnectivityNone: None
GroupConnectivityDirectlyConnected: DirectlyConnected

None: None
DirectlyConnected: DirectlyConnected

None: None
DirectlyConnected: DirectlyConnected

NONE: None
DIRECTLY_CONNECTED: DirectlyConnected

"None": None
"DirectlyConnected": DirectlyConnected

Hub

ResourceId string: Resource Id.
ResourceType string: Resource Type.

ResourceId string: Resource Id.
ResourceType string: Resource Type.

resourceId String: Resource Id.
resourceType String: Resource Type.

resourceId string: Resource Id.
resourceType string: Resource Type.

resource_id str: Resource Id.
resource_type str: Resource Type.

resourceId String: Resource Id.
resourceType String: Resource Type.

HubResponse

ResourceId string: Resource Id.
ResourceType string: Resource Type.

ResourceId string: Resource Id.
ResourceType string: Resource Type.

resourceId String: Resource Id.
resourceType String: Resource Type.

resourceId string: Resource Id.
resourceType string: Resource Type.

resource_id str: Resource Id.
resource_type str: Resource Type.

resourceId String: Resource Id.
resourceType String: Resource Type.

IsGlobal

False: False
True: True

IsGlobalFalse: False
IsGlobalTrue: True

False: False
True: True

False: False
True: True

FALSE: False
TRUE: True

"False": False
"True": True

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: 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 string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: 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 string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: 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 String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: 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 string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The type of identity that last modified the resource.
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: 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 String: The type of identity that last modified the resource.

UseHubGateway

False: False
True: True

UseHubGatewayFalse: False
UseHubGatewayTrue: True

False: False
True: True

False: False
True: True

FALSE: False
TRUE: True

"False": False
"True": True

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:ConnectivityConfiguration myTestConnectivityConfig subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0