Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. avs
  5. getWorkloadNetworkSegment
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.avs.getWorkloadNetworkSegment

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

NSX Segment Azure REST API version: 2022-05-01.

Other available API versions: 2023-03-01, 2023-09-01.

Using getWorkloadNetworkSegment

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 getWorkloadNetworkSegment(args: GetWorkloadNetworkSegmentArgs, opts?: InvokeOptions): Promise<GetWorkloadNetworkSegmentResult>
function getWorkloadNetworkSegmentOutput(args: GetWorkloadNetworkSegmentOutputArgs, opts?: InvokeOptions): Output<GetWorkloadNetworkSegmentResult>
Copy
def get_workload_network_segment(private_cloud_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 segment_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetWorkloadNetworkSegmentResult
def get_workload_network_segment_output(private_cloud_name: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 segment_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetWorkloadNetworkSegmentResult]
Copy
func LookupWorkloadNetworkSegment(ctx *Context, args *LookupWorkloadNetworkSegmentArgs, opts ...InvokeOption) (*LookupWorkloadNetworkSegmentResult, error)
func LookupWorkloadNetworkSegmentOutput(ctx *Context, args *LookupWorkloadNetworkSegmentOutputArgs, opts ...InvokeOption) LookupWorkloadNetworkSegmentResultOutput
Copy

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

public static class GetWorkloadNetworkSegment 
{
    public static Task<GetWorkloadNetworkSegmentResult> InvokeAsync(GetWorkloadNetworkSegmentArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkloadNetworkSegmentResult> Invoke(GetWorkloadNetworkSegmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkloadNetworkSegmentResult> getWorkloadNetworkSegment(GetWorkloadNetworkSegmentArgs args, InvokeOptions options)
public static Output<GetWorkloadNetworkSegmentResult> getWorkloadNetworkSegment(GetWorkloadNetworkSegmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:avs:getWorkloadNetworkSegment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SegmentId
This property is required.
Changes to this property will trigger replacement.
string
NSX Segment identifier. Generally the same as the Segment's display name
PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SegmentId
This property is required.
Changes to this property will trigger replacement.
string
NSX Segment identifier. Generally the same as the Segment's display name
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
segmentId
This property is required.
Changes to this property will trigger replacement.
String
NSX Segment identifier. Generally the same as the Segment's display name
privateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
segmentId
This property is required.
Changes to this property will trigger replacement.
string
NSX Segment identifier. Generally the same as the Segment's display name
private_cloud_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the private cloud
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
segment_id
This property is required.
Changes to this property will trigger replacement.
str
NSX Segment identifier. Generally the same as the Segment's display name
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
segmentId
This property is required.
Changes to this property will trigger replacement.
String
NSX Segment identifier. Generally the same as the Segment's display name

getWorkloadNetworkSegment Result

The following output properties are available:

Id string
Resource ID.
Name string
Resource name.
PortVif List<Pulumi.AzureNative.AVS.Outputs.WorkloadNetworkSegmentPortVifResponse>
Port Vif which segment is associated with.
ProvisioningState string
The provisioning state
Status string
Segment status.
Type string
Resource type.
ConnectedGateway string
Gateway which to connect segment to.
DisplayName string
Display name of the segment.
Revision double
NSX revision number.
Subnet Pulumi.AzureNative.AVS.Outputs.WorkloadNetworkSegmentSubnetResponse
Subnet which to connect segment to.
Id string
Resource ID.
Name string
Resource name.
PortVif []WorkloadNetworkSegmentPortVifResponse
Port Vif which segment is associated with.
ProvisioningState string
The provisioning state
Status string
Segment status.
Type string
Resource type.
ConnectedGateway string
Gateway which to connect segment to.
DisplayName string
Display name of the segment.
Revision float64
NSX revision number.
Subnet WorkloadNetworkSegmentSubnetResponse
Subnet which to connect segment to.
id String
Resource ID.
name String
Resource name.
portVif List<WorkloadNetworkSegmentPortVifResponse>
Port Vif which segment is associated with.
provisioningState String
The provisioning state
status String
Segment status.
type String
Resource type.
connectedGateway String
Gateway which to connect segment to.
displayName String
Display name of the segment.
revision Double
NSX revision number.
subnet WorkloadNetworkSegmentSubnetResponse
Subnet which to connect segment to.
id string
Resource ID.
name string
Resource name.
portVif WorkloadNetworkSegmentPortVifResponse[]
Port Vif which segment is associated with.
provisioningState string
The provisioning state
status string
Segment status.
type string
Resource type.
connectedGateway string
Gateway which to connect segment to.
displayName string
Display name of the segment.
revision number
NSX revision number.
subnet WorkloadNetworkSegmentSubnetResponse
Subnet which to connect segment to.
id str
Resource ID.
name str
Resource name.
port_vif Sequence[WorkloadNetworkSegmentPortVifResponse]
Port Vif which segment is associated with.
provisioning_state str
The provisioning state
status str
Segment status.
type str
Resource type.
connected_gateway str
Gateway which to connect segment to.
display_name str
Display name of the segment.
revision float
NSX revision number.
subnet WorkloadNetworkSegmentSubnetResponse
Subnet which to connect segment to.
id String
Resource ID.
name String
Resource name.
portVif List<Property Map>
Port Vif which segment is associated with.
provisioningState String
The provisioning state
status String
Segment status.
type String
Resource type.
connectedGateway String
Gateway which to connect segment to.
displayName String
Display name of the segment.
revision Number
NSX revision number.
subnet Property Map
Subnet which to connect segment to.

Supporting Types

WorkloadNetworkSegmentPortVifResponse

PortName string
Name of port or VIF attached to segment.
PortName string
Name of port or VIF attached to segment.
portName String
Name of port or VIF attached to segment.
portName string
Name of port or VIF attached to segment.
port_name str
Name of port or VIF attached to segment.
portName String
Name of port or VIF attached to segment.

WorkloadNetworkSegmentSubnetResponse

DhcpRanges List<string>
DHCP Range assigned for subnet.
GatewayAddress string
Gateway address.
DhcpRanges []string
DHCP Range assigned for subnet.
GatewayAddress string
Gateway address.
dhcpRanges List<String>
DHCP Range assigned for subnet.
gatewayAddress String
Gateway address.
dhcpRanges string[]
DHCP Range assigned for subnet.
gatewayAddress string
Gateway address.
dhcp_ranges Sequence[str]
DHCP Range assigned for subnet.
gateway_address str
Gateway address.
dhcpRanges List<String>
DHCP Range assigned for subnet.
gatewayAddress String
Gateway address.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native