azure-native.network.listActiveConnectivityConfigurations
Explore with Pulumi AI
Lists active connectivity configurations in a network manager.
Uses Azure REST API version 2024-05-01.
Other available API versions: 2022-01-01, 2022-02-01-preview, 2022-04-01-preview, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]
. See the version guide for details.
Using listActiveConnectivityConfigurations
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 listActiveConnectivityConfigurations(args: ListActiveConnectivityConfigurationsArgs, opts?: InvokeOptions): Promise<ListActiveConnectivityConfigurationsResult>
function listActiveConnectivityConfigurationsOutput(args: ListActiveConnectivityConfigurationsOutputArgs, opts?: InvokeOptions): Output<ListActiveConnectivityConfigurationsResult>
def list_active_connectivity_configurations(network_manager_name: Optional[str] = None,
regions: Optional[Sequence[str]] = None,
resource_group_name: Optional[str] = None,
skip_token: Optional[str] = None,
top: Optional[int] = None,
opts: Optional[InvokeOptions] = None) -> ListActiveConnectivityConfigurationsResult
def list_active_connectivity_configurations_output(network_manager_name: Optional[pulumi.Input[str]] = None,
regions: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
skip_token: Optional[pulumi.Input[str]] = None,
top: Optional[pulumi.Input[int]] = None,
opts: Optional[InvokeOptions] = None) -> Output[ListActiveConnectivityConfigurationsResult]
func ListActiveConnectivityConfigurations(ctx *Context, args *ListActiveConnectivityConfigurationsArgs, opts ...InvokeOption) (*ListActiveConnectivityConfigurationsResult, error)
func ListActiveConnectivityConfigurationsOutput(ctx *Context, args *ListActiveConnectivityConfigurationsOutputArgs, opts ...InvokeOption) ListActiveConnectivityConfigurationsResultOutput
> Note: This function is named ListActiveConnectivityConfigurations
in the Go SDK.
public static class ListActiveConnectivityConfigurations
{
public static Task<ListActiveConnectivityConfigurationsResult> InvokeAsync(ListActiveConnectivityConfigurationsArgs args, InvokeOptions? opts = null)
public static Output<ListActiveConnectivityConfigurationsResult> Invoke(ListActiveConnectivityConfigurationsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<ListActiveConnectivityConfigurationsResult> listActiveConnectivityConfigurations(ListActiveConnectivityConfigurationsArgs args, InvokeOptions options)
public static Output<ListActiveConnectivityConfigurationsResult> listActiveConnectivityConfigurations(ListActiveConnectivityConfigurationsArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:network:listActiveConnectivityConfigurations
arguments:
# arguments dictionary
The following arguments are supported:
- Network
Manager stringName - The name of the network manager.
- Resource
Group stringName - The name of the resource group.
- Regions List<string>
- List of regions.
- Skip
Token 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.
- Network
Manager stringName - The name of the network manager.
- Resource
Group stringName - The name of the resource group.
- Regions []string
- List of regions.
- Skip
Token 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.
- network
Manager StringName - The name of the network manager.
- resource
Group StringName - The name of the resource group.
- regions List<String>
- List of regions.
- skip
Token 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.
- network
Manager stringName - The name of the network manager.
- resource
Group stringName - The name of the resource group.
- regions string[]
- List of regions.
- skip
Token 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.
- network_
manager_ strname - The name of the network manager.
- resource_
group_ strname - The name of the resource group.
- regions Sequence[str]
- List of regions.
- 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.
- network
Manager StringName - The name of the network manager.
- resource
Group StringName - The name of the resource group.
- regions List<String>
- List of regions.
- skip
Token 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.
listActiveConnectivityConfigurations Result
The following output properties are available:
- Skip
Token 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.
Azure Native. Network. Outputs. Active Connectivity Configuration Response> - Gets a page of active connectivity configurations.
- Skip
Token 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
[]Active
Connectivity Configuration Response - Gets a page of active connectivity configurations.
- skip
Token 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<Active
Connectivity Configuration Response> - Gets a page of active connectivity configurations.
- skip
Token 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
Active
Connectivity Configuration Response[] - Gets a page of active connectivity configurations.
- 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[Active
Connectivity Configuration Response] - Gets a page of active connectivity configurations.
- skip
Token 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 active connectivity configurations.
Supporting Types
ActiveConnectivityConfigurationResponse
- Applies
To List<Pulumi.Groups Azure Native. Network. Inputs. Connectivity Group Item Response> - Groups for configuration
- Connectivity
Topology string - Connectivity topology type.
- Provisioning
State string - The provisioning state of the connectivity configuration resource.
- Resource
Guid string - Unique identifier for this resource.
- Commit
Time string - Deployment time string.
- Configuration
Groups List<Pulumi.Azure Native. Network. Inputs. Configuration Group Response> - Effective configuration groups.
- Delete
Existing stringPeering - Flag if need to remove current existing peerings.
- Description string
- A description of the connectivity configuration.
- Display
Name string - A friendly name for the resource.
- Hubs
List<Pulumi.
Azure Native. Network. Inputs. Hub Response> - List of hubItems
- Id string
- Connectivity configuration ID.
- Is
Global string - Flag if global mesh is supported.
- Region string
- Deployment region.
- Applies
To []ConnectivityGroups Group Item Response - Groups for configuration
- Connectivity
Topology string - Connectivity topology type.
- Provisioning
State string - The provisioning state of the connectivity configuration resource.
- Resource
Guid string - Unique identifier for this resource.
- Commit
Time string - Deployment time string.
- Configuration
Groups []ConfigurationGroup Response - Effective configuration groups.
- Delete
Existing stringPeering - Flag if need to remove current existing peerings.
- Description string
- A description of the connectivity configuration.
- Display
Name string - A friendly name for the resource.
- Hubs
[]Hub
Response - List of hubItems
- Id string
- Connectivity configuration ID.
- Is
Global string - Flag if global mesh is supported.
- Region string
- Deployment region.
- applies
To List<ConnectivityGroups Group Item Response> - Groups for configuration
- connectivity
Topology String - Connectivity topology type.
- provisioning
State String - The provisioning state of the connectivity configuration resource.
- resource
Guid String - Unique identifier for this resource.
- commit
Time String - Deployment time string.
- configuration
Groups List<ConfigurationGroup Response> - Effective configuration groups.
- delete
Existing StringPeering - Flag if need to remove current existing peerings.
- description String
- A description of the connectivity configuration.
- display
Name String - A friendly name for the resource.
- hubs
List<Hub
Response> - List of hubItems
- id String
- Connectivity configuration ID.
- is
Global String - Flag if global mesh is supported.
- region String
- Deployment region.
- applies
To ConnectivityGroups Group Item Response[] - Groups for configuration
- connectivity
Topology string - Connectivity topology type.
- provisioning
State string - The provisioning state of the connectivity configuration resource.
- resource
Guid string - Unique identifier for this resource.
- commit
Time string - Deployment time string.
- configuration
Groups ConfigurationGroup Response[] - Effective configuration groups.
- delete
Existing stringPeering - Flag if need to remove current existing peerings.
- description string
- A description of the connectivity configuration.
- display
Name string - A friendly name for the resource.
- hubs
Hub
Response[] - List of hubItems
- id string
- Connectivity configuration ID.
- is
Global string - Flag if global mesh is supported.
- region string
- Deployment region.
- applies_
to_ Sequence[Connectivitygroups Group Item Response] - 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.
- commit_
time str - Deployment time string.
- configuration_
groups Sequence[ConfigurationGroup Response] - Effective configuration groups.
- delete_
existing_ strpeering - 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[Hub
Response] - List of hubItems
- id str
- Connectivity configuration ID.
- is_
global str - Flag if global mesh is supported.
- region str
- Deployment region.
- applies
To List<Property Map>Groups - Groups for configuration
- connectivity
Topology String - Connectivity topology type.
- provisioning
State String - The provisioning state of the connectivity configuration resource.
- resource
Guid String - Unique identifier for this resource.
- commit
Time String - Deployment time string.
- configuration
Groups List<Property Map> - Effective configuration groups.
- delete
Existing StringPeering - Flag if need to remove current existing peerings.
- description String
- A description of the connectivity configuration.
- display
Name String - A friendly name for the resource.
- hubs List<Property Map>
- List of hubItems
- id String
- Connectivity configuration ID.
- is
Global String - Flag if global mesh is supported.
- region String
- Deployment region.
ConfigurationGroupResponse
- Provisioning
State string - The provisioning state of the scope assignment resource.
- Resource
Guid string - Unique identifier for this resource.
- Conditional
Membership string - Network group conditional filter.
- Description string
- A description of the network group.
- Display
Name string - A friendly name for the network group.
- Group
Members List<Pulumi.Azure Native. Network. Inputs. Group Members Item Response> - Group members of network group.
- Id string
- Network group ID.
- Member
Type string - The type of the group member.
- Provisioning
State string - The provisioning state of the scope assignment resource.
- Resource
Guid string - Unique identifier for this resource.
- Conditional
Membership string - Network group conditional filter.
- Description string
- A description of the network group.
- Display
Name string - A friendly name for the network group.
- Group
Members []GroupMembers Item Response - Group members of network group.
- Id string
- Network group ID.
- Member
Type string - The type of the group member.
- provisioning
State String - The provisioning state of the scope assignment resource.
- resource
Guid String - Unique identifier for this resource.
- conditional
Membership String - Network group conditional filter.
- description String
- A description of the network group.
- display
Name String - A friendly name for the network group.
- group
Members List<GroupMembers Item Response> - Group members of network group.
- id String
- Network group ID.
- member
Type String - The type of the group member.
- provisioning
State string - The provisioning state of the scope assignment resource.
- resource
Guid string - Unique identifier for this resource.
- conditional
Membership string - Network group conditional filter.
- description string
- A description of the network group.
- display
Name string - A friendly name for the network group.
- group
Members GroupMembers Item Response[] - Group members of network group.
- id string
- Network group ID.
- member
Type string - The type of the group member.
- 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[GroupMembers Item Response] - Group members of network group.
- id str
- Network group ID.
- member_
type str - The type of the group member.
- provisioning
State String - The provisioning state of the scope assignment resource.
- resource
Guid String - Unique identifier for this resource.
- conditional
Membership String - Network group conditional filter.
- description String
- A description of the network group.
- display
Name String - A friendly name for the network group.
- group
Members List<Property Map> - Group members of network group.
- id String
- Network group ID.
- member
Type String - The type of the group member.
ConnectivityGroupItemResponse
- Group
Connectivity string - Group connectivity type.
- Network
Group stringId - Network group Id.
- Is
Global string - Flag if global is supported.
- Use
Hub stringGateway - Flag if need to use hub gateway.
- Group
Connectivity string - Group connectivity type.
- Network
Group stringId - Network group Id.
- Is
Global string - Flag if global is supported.
- Use
Hub stringGateway - Flag if need to use hub gateway.
- group
Connectivity String - Group connectivity type.
- network
Group StringId - Network group Id.
- is
Global String - Flag if global is supported.
- use
Hub StringGateway - Flag if need to use hub gateway.
- group
Connectivity string - Group connectivity type.
- network
Group stringId - Network group Id.
- is
Global string - Flag if global is supported.
- use
Hub stringGateway - Flag if need to use hub gateway.
- group_
connectivity str - Group connectivity type.
- network_
group_ strid - Network group Id.
- is_
global str - Flag if global is supported.
- use_
hub_ strgateway - Flag if need to use hub gateway.
- group
Connectivity String - Group connectivity type.
- network
Group StringId - Network group Id.
- is
Global String - Flag if global is supported.
- use
Hub StringGateway - Flag if need to use hub gateway.
GroupMembersItemResponse
- Resource
Id string - Resource Id.
- Resource
Id string - Resource Id.
- resource
Id String - Resource Id.
- resource
Id string - Resource Id.
- resource_
id str - Resource Id.
- resource
Id String - Resource Id.
HubResponse
- Resource
Id string - Resource Id.
- Resource
Type string - Resource Type.
- Resource
Id string - Resource Id.
- Resource
Type string - Resource Type.
- resource
Id String - Resource Id.
- resource
Type String - Resource Type.
- resource
Id string - Resource Id.
- resource
Type string - Resource Type.
- resource_
id str - Resource Id.
- resource_
type str - Resource Type.
- resource
Id String - Resource Id.
- resource
Type String - Resource Type.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0