1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. listNetworkManagerEffectiveConnectivityConfigurations
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

azure-native.network.listNetworkManagerEffectiveConnectivityConfigurations

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

List all effective connectivity configurations applied on a virtual network. Azure REST API version: 2023-02-01.

Other available API versions: 2021-05-01-preview, 2022-02-01-preview, 2022-04-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Using listNetworkManagerEffectiveConnectivityConfigurations

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function listNetworkManagerEffectiveConnectivityConfigurations(args: ListNetworkManagerEffectiveConnectivityConfigurationsArgs, opts?: InvokeOptions): Promise<ListNetworkManagerEffectiveConnectivityConfigurationsResult>
function listNetworkManagerEffectiveConnectivityConfigurationsOutput(args: ListNetworkManagerEffectiveConnectivityConfigurationsOutputArgs, opts?: InvokeOptions): Output<ListNetworkManagerEffectiveConnectivityConfigurationsResult>
Copy
def list_network_manager_effective_connectivity_configurations(resource_group_name: Optional[str] = None,
                                                               skip_token: Optional[str] = None,
                                                               top: Optional[int] = None,
                                                               virtual_network_name: Optional[str] = None,
                                                               opts: Optional[InvokeOptions] = None) -> ListNetworkManagerEffectiveConnectivityConfigurationsResult
def list_network_manager_effective_connectivity_configurations_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                                               skip_token: Optional[pulumi.Input[str]] = None,
                                                               top: Optional[pulumi.Input[int]] = None,
                                                               virtual_network_name: Optional[pulumi.Input[str]] = None,
                                                               opts: Optional[InvokeOptions] = None) -> Output[ListNetworkManagerEffectiveConnectivityConfigurationsResult]
Copy
func ListNetworkManagerEffectiveConnectivityConfigurations(ctx *Context, args *ListNetworkManagerEffectiveConnectivityConfigurationsArgs, opts ...InvokeOption) (*ListNetworkManagerEffectiveConnectivityConfigurationsResult, error)
func ListNetworkManagerEffectiveConnectivityConfigurationsOutput(ctx *Context, args *ListNetworkManagerEffectiveConnectivityConfigurationsOutputArgs, opts ...InvokeOption) ListNetworkManagerEffectiveConnectivityConfigurationsResultOutput
Copy

> Note: This function is named ListNetworkManagerEffectiveConnectivityConfigurations in the Go SDK.

public static class ListNetworkManagerEffectiveConnectivityConfigurations 
{
    public static Task<ListNetworkManagerEffectiveConnectivityConfigurationsResult> InvokeAsync(ListNetworkManagerEffectiveConnectivityConfigurationsArgs args, InvokeOptions? opts = null)
    public static Output<ListNetworkManagerEffectiveConnectivityConfigurationsResult> Invoke(ListNetworkManagerEffectiveConnectivityConfigurationsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListNetworkManagerEffectiveConnectivityConfigurationsResult> listNetworkManagerEffectiveConnectivityConfigurations(ListNetworkManagerEffectiveConnectivityConfigurationsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Copy
fn::invoke:
  function: azure-native:network:listNetworkManagerEffectiveConnectivityConfigurations
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualNetworkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network.
SkipToken string
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
Top int
An optional query parameter which specifies the maximum number of records to be returned by the server.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualNetworkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network.
SkipToken string
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
Top int
An optional query parameter which specifies the maximum number of records to be returned by the server.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualNetworkName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual network.
skipToken String
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
top Integer
An optional query parameter which specifies the maximum number of records to be returned by the server.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
virtualNetworkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network.
skipToken string
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
top number
An optional query parameter which specifies the maximum number of records to be returned by the server.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
virtual_network_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the virtual network.
skip_token str
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
top int
An optional query parameter which specifies the maximum number of records to be returned by the server.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualNetworkName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual network.
skipToken String
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
top Number
An optional query parameter which specifies the maximum number of records to be returned by the server.

listNetworkManagerEffectiveConnectivityConfigurations Result

The following output properties are available:

SkipToken string
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
Value List<Pulumi.AzureNative.Network.Outputs.EffectiveConnectivityConfigurationResponse>
Gets a page of NetworkManagerEffectiveConnectivityConfiguration
SkipToken string
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
Value []EffectiveConnectivityConfigurationResponse
Gets a page of NetworkManagerEffectiveConnectivityConfiguration
skipToken String
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
value List<EffectiveConnectivityConfigurationResponse>
Gets a page of NetworkManagerEffectiveConnectivityConfiguration
skipToken string
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
value EffectiveConnectivityConfigurationResponse[]
Gets a page of NetworkManagerEffectiveConnectivityConfiguration
skip_token str
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
value Sequence[EffectiveConnectivityConfigurationResponse]
Gets a page of NetworkManagerEffectiveConnectivityConfiguration
skipToken String
When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
value List<Property Map>
Gets a page of NetworkManagerEffectiveConnectivityConfiguration

Supporting Types

ConfigurationGroupResponse

ProvisioningState This property is required. string
The provisioning state of the scope assignment resource.
ResourceGuid This property is required. string
Unique identifier for this resource.
ConditionalMembership string
Network group conditional filter.
Description string
A description of the network group.
DisplayName string
A friendly name for the network group.
GroupMembers List<Pulumi.AzureNative.Network.Inputs.GroupMembersItemResponse>
Group members of network group.
Id string
Network group ID.
MemberType string
Group member type.
ProvisioningState This property is required. string
The provisioning state of the scope assignment resource.
ResourceGuid This property is required. string
Unique identifier for this resource.
ConditionalMembership string
Network group conditional filter.
Description string
A description of the network group.
DisplayName string
A friendly name for the network group.
GroupMembers []GroupMembersItemResponse
Group members of network group.
Id string
Network group ID.
MemberType string
Group member type.
provisioningState This property is required. String
The provisioning state of the scope assignment resource.
resourceGuid This property is required. String
Unique identifier for this resource.
conditionalMembership String
Network group conditional filter.
description String
A description of the network group.
displayName String
A friendly name for the network group.
groupMembers List<GroupMembersItemResponse>
Group members of network group.
id String
Network group ID.
memberType String
Group member type.
provisioningState This property is required. string
The provisioning state of the scope assignment resource.
resourceGuid This property is required. string
Unique identifier for this resource.
conditionalMembership string
Network group conditional filter.
description string
A description of the network group.
displayName string
A friendly name for the network group.
groupMembers GroupMembersItemResponse[]
Group members of network group.
id string
Network group ID.
memberType string
Group member type.
provisioning_state This property is required. str
The provisioning state of the scope assignment resource.
resource_guid This property is required. str
Unique identifier for this resource.
conditional_membership str
Network group conditional filter.
description str
A description of the network group.
display_name str
A friendly name for the network group.
group_members Sequence[GroupMembersItemResponse]
Group members of network group.
id str
Network group ID.
member_type str
Group member type.
provisioningState This property is required. String
The provisioning state of the scope assignment resource.
resourceGuid This property is required. String
Unique identifier for this resource.
conditionalMembership String
Network group conditional filter.
description String
A description of the network group.
displayName String
A friendly name for the network group.
groupMembers List<Property Map>
Group members of network group.
id String
Network group ID.
memberType String
Group member type.

ConnectivityGroupItemResponse

GroupConnectivity This property is required. string
Group connectivity type.
NetworkGroupId This property is required. string
Network group Id.
IsGlobal string
Flag if global is supported.
UseHubGateway string
Flag if need to use hub gateway.
GroupConnectivity This property is required. string
Group connectivity type.
NetworkGroupId This property is required. string
Network group Id.
IsGlobal string
Flag if global is supported.
UseHubGateway string
Flag if need to use hub gateway.
groupConnectivity This property is required. String
Group connectivity type.
networkGroupId This property is required. String
Network group Id.
isGlobal String
Flag if global is supported.
useHubGateway String
Flag if need to use hub gateway.
groupConnectivity This property is required. string
Group connectivity type.
networkGroupId This property is required. string
Network group Id.
isGlobal string
Flag if global is supported.
useHubGateway string
Flag if need to use hub gateway.
group_connectivity This property is required. str
Group connectivity type.
network_group_id This property is required. str
Network group Id.
is_global str
Flag if global is supported.
use_hub_gateway str
Flag if need to use hub gateway.
groupConnectivity This property is required. String
Group connectivity type.
networkGroupId This property is required. String
Network group Id.
isGlobal String
Flag if global is supported.
useHubGateway String
Flag if need to use hub gateway.

EffectiveConnectivityConfigurationResponse

AppliesToGroups This property is required. List<Pulumi.AzureNative.Network.Inputs.ConnectivityGroupItemResponse>
Groups for configuration
ConnectivityTopology This property is required. string
Connectivity topology type.
ProvisioningState This property is required. string
The provisioning state of the connectivity configuration resource.
ResourceGuid This property is required. string
Unique identifier for this resource.
ConfigurationGroups List<Pulumi.AzureNative.Network.Inputs.ConfigurationGroupResponse>
Effective configuration groups.
DeleteExistingPeering string
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.HubResponse>
List of hubItems
Id string
Connectivity configuration ID.
IsGlobal string
Flag if global mesh is supported.
AppliesToGroups This property is required. []ConnectivityGroupItemResponse
Groups for configuration
ConnectivityTopology This property is required. string
Connectivity topology type.
ProvisioningState This property is required. string
The provisioning state of the connectivity configuration resource.
ResourceGuid This property is required. string
Unique identifier for this resource.
ConfigurationGroups []ConfigurationGroupResponse
Effective configuration groups.
DeleteExistingPeering string
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 []HubResponse
List of hubItems
Id string
Connectivity configuration ID.
IsGlobal string
Flag if global mesh is supported.
appliesToGroups This property is required. List<ConnectivityGroupItemResponse>
Groups for configuration
connectivityTopology This property is required. String
Connectivity topology type.
provisioningState This property is required. String
The provisioning state of the connectivity configuration resource.
resourceGuid This property is required. String
Unique identifier for this resource.
configurationGroups List<ConfigurationGroupResponse>
Effective configuration groups.
deleteExistingPeering String
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<HubResponse>
List of hubItems
id String
Connectivity configuration ID.
isGlobal String
Flag if global mesh is supported.
appliesToGroups This property is required. ConnectivityGroupItemResponse[]
Groups for configuration
connectivityTopology This property is required. string
Connectivity topology type.
provisioningState This property is required. string
The provisioning state of the connectivity configuration resource.
resourceGuid This property is required. string
Unique identifier for this resource.
configurationGroups ConfigurationGroupResponse[]
Effective configuration groups.
deleteExistingPeering string
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 HubResponse[]
List of hubItems
id string
Connectivity configuration ID.
isGlobal string
Flag if global mesh is supported.
applies_to_groups This property is required. Sequence[ConnectivityGroupItemResponse]
Groups for configuration
connectivity_topology This property is required. str
Connectivity topology type.
provisioning_state This property is required. str
The provisioning state of the connectivity configuration resource.
resource_guid This property is required. str
Unique identifier for this resource.
configuration_groups Sequence[ConfigurationGroupResponse]
Effective configuration groups.
delete_existing_peering str
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[HubResponse]
List of hubItems
id str
Connectivity configuration ID.
is_global str
Flag if global mesh is supported.
appliesToGroups This property is required. List<Property Map>
Groups for configuration
connectivityTopology This property is required. String
Connectivity topology type.
provisioningState This property is required. String
The provisioning state of the connectivity configuration resource.
resourceGuid This property is required. String
Unique identifier for this resource.
configurationGroups List<Property Map>
Effective configuration groups.
deleteExistingPeering String
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
id String
Connectivity configuration ID.
isGlobal String
Flag if global mesh is supported.

GroupMembersItemResponse

ResourceId string
Resource Id.
ResourceId string
Resource Id.
resourceId String
Resource Id.
resourceId string
Resource Id.
resource_id str
Resource Id.
resourceId String
Resource Id.

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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.82.0 published on Friday, Jan 10, 2025 by Pulumi