1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. listEffectiveConnectivityConfiguration
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi

azure-native.network.listEffectiveConnectivityConfiguration

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi

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

    Using listEffectiveConnectivityConfiguration

    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 listEffectiveConnectivityConfiguration(args: ListEffectiveConnectivityConfigurationArgs, opts?: InvokeOptions): Promise<ListEffectiveConnectivityConfigurationResult>
    function listEffectiveConnectivityConfigurationOutput(args: ListEffectiveConnectivityConfigurationOutputArgs, opts?: InvokeOptions): Output<ListEffectiveConnectivityConfigurationResult>
    def list_effective_connectivity_configuration(resource_group_name: Optional[str] = None,
                                                  skip_token: Optional[str] = None,
                                                  virtual_network_name: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> ListEffectiveConnectivityConfigurationResult
    def list_effective_connectivity_configuration_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                                  skip_token: Optional[pulumi.Input[str]] = None,
                                                  virtual_network_name: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[ListEffectiveConnectivityConfigurationResult]
    func ListEffectiveConnectivityConfiguration(ctx *Context, args *ListEffectiveConnectivityConfigurationArgs, opts ...InvokeOption) (*ListEffectiveConnectivityConfigurationResult, error)
    func ListEffectiveConnectivityConfigurationOutput(ctx *Context, args *ListEffectiveConnectivityConfigurationOutputArgs, opts ...InvokeOption) ListEffectiveConnectivityConfigurationResultOutput

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

    public static class ListEffectiveConnectivityConfiguration 
    {
        public static Task<ListEffectiveConnectivityConfigurationResult> InvokeAsync(ListEffectiveConnectivityConfigurationArgs args, InvokeOptions? opts = null)
        public static Output<ListEffectiveConnectivityConfigurationResult> Invoke(ListEffectiveConnectivityConfigurationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<ListEffectiveConnectivityConfigurationResult> listEffectiveConnectivityConfiguration(ListEffectiveConnectivityConfigurationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:network:listEffectiveConnectivityConfiguration
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group.
    VirtualNetworkName 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.
    ResourceGroupName string
    The name of the resource group.
    VirtualNetworkName 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.
    resourceGroupName String
    The name of the resource group.
    virtualNetworkName 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.
    resourceGroupName string
    The name of the resource group.
    virtualNetworkName 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.
    resource_group_name str
    The name of the resource group.
    virtual_network_name 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.
    resourceGroupName String
    The name of the resource group.
    virtualNetworkName 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.

    listEffectiveConnectivityConfiguration 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 string
    The provisioning state of the scope assignment resource.
    ResourceGuid 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 string
    The provisioning state of the scope assignment resource.
    ResourceGuid 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 String
    The provisioning state of the scope assignment resource.
    resourceGuid 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 string
    The provisioning state of the scope assignment resource.
    resourceGuid 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 str
    The provisioning state of the scope assignment resource.
    resource_guid 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 String
    The provisioning state of the scope assignment resource.
    resourceGuid 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 string
    Group connectivity type.
    NetworkGroupId string
    Network group Id.
    IsGlobal string
    Flag if global is supported.
    UseHubGateway string
    Flag if need to use hub gateway.
    GroupConnectivity string
    Group connectivity type.
    NetworkGroupId string
    Network group Id.
    IsGlobal string
    Flag if global is supported.
    UseHubGateway string
    Flag if need to use hub gateway.
    groupConnectivity String
    Group connectivity type.
    networkGroupId String
    Network group Id.
    isGlobal String
    Flag if global is supported.
    useHubGateway String
    Flag if need to use hub gateway.
    groupConnectivity string
    Group connectivity type.
    networkGroupId string
    Network group Id.
    isGlobal string
    Flag if global is supported.
    useHubGateway string
    Flag if need to use hub gateway.
    group_connectivity str
    Group connectivity type.
    network_group_id str
    Network group Id.
    is_global str
    Flag if global is supported.
    use_hub_gateway str
    Flag if need to use hub gateway.
    groupConnectivity String
    Group connectivity type.
    networkGroupId String
    Network group Id.
    isGlobal String
    Flag if global is supported.
    useHubGateway String
    Flag if need to use hub gateway.

    EffectiveConnectivityConfigurationResponse

    AppliesToGroups List<Pulumi.AzureNative.Network.Inputs.ConnectivityGroupItemResponse>
    Groups for configuration
    ConnectivityTopology string
    Connectivity topology type.
    ProvisioningState string
    The provisioning state of the connectivity configuration resource.
    ResourceGuid 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 []ConnectivityGroupItemResponse
    Groups for configuration
    ConnectivityTopology string
    Connectivity topology type.
    ProvisioningState string
    The provisioning state of the connectivity configuration resource.
    ResourceGuid 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 List<ConnectivityGroupItemResponse>
    Groups for configuration
    connectivityTopology String
    Connectivity topology type.
    provisioningState String
    The provisioning state of the connectivity configuration resource.
    resourceGuid 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 ConnectivityGroupItemResponse[]
    Groups for configuration
    connectivityTopology string
    Connectivity topology type.
    provisioningState string
    The provisioning state of the connectivity configuration resource.
    resourceGuid 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 Sequence[ConnectivityGroupItemResponse]
    Groups for configuration
    connectivity_topology str
    Connectivity topology type.
    provisioning_state str
    The provisioning state of the connectivity configuration resource.
    resource_guid 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 List<Property Map>
    Groups for configuration
    connectivityTopology String
    Connectivity topology type.
    provisioningState String
    The provisioning state of the connectivity configuration resource.
    resourceGuid 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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi