Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. getWorkloadNetworkSegment
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.avs.getWorkloadNetworkSegment

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a WorkloadNetworkSegment

    Uses Azure REST API version 2023-09-01.

    Other available API versions: 2022-05-01, 2023-03-01, 2024-09-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native avs [ApiVersion]. See the version guide for details.

    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>
    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]
    func LookupWorkloadNetworkSegment(ctx *Context, args *LookupWorkloadNetworkSegmentArgs, opts ...InvokeOption) (*LookupWorkloadNetworkSegmentResult, error)
func LookupWorkloadNetworkSegmentOutput(ctx *Context, args *LookupWorkloadNetworkSegmentOutputArgs, opts ...InvokeOption) LookupWorkloadNetworkSegmentResultOutput

    > 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)
}
    public static CompletableFuture<GetWorkloadNetworkSegmentResult> getWorkloadNetworkSegment(GetWorkloadNetworkSegmentArgs args, InvokeOptions options)
public static Output<GetWorkloadNetworkSegmentResult> getWorkloadNetworkSegment(GetWorkloadNetworkSegmentArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:avs:getWorkloadNetworkSegment
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SegmentId string
    The ID of the NSX Segment
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SegmentId string
    The ID of the NSX Segment
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    segmentId String
    The ID of the NSX Segment
    privateCloudName string
    Name of the private cloud
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    segmentId string
    The ID of the NSX Segment
    private_cloud_name str
    Name of the private cloud
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    segment_id str
    The ID of the NSX Segment
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    segmentId String
    The ID of the NSX Segment

    getWorkloadNetworkSegment Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PortVif List<Pulumi.AzureNative.AVS.Outputs.WorkloadNetworkSegmentPortVifResponse>
    Port Vif which segment is associated with.
    ProvisioningState string
    The provisioning state
    Status string
    Segment status.
    SystemData Pulumi.AzureNative.AVS.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PortVif []WorkloadNetworkSegmentPortVifResponse
    Port Vif which segment is associated with.
    ProvisioningState string
    The provisioning state
    Status string
    Segment status.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    portVif List<WorkloadNetworkSegmentPortVifResponse>
    Port Vif which segment is associated with.
    provisioningState String
    The provisioning state
    status String
    Segment status.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    portVif WorkloadNetworkSegmentPortVifResponse[]
    Port Vif which segment is associated with.
    provisioningState string
    The provisioning state
    status string
    Segment status.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    port_vif Sequence[WorkloadNetworkSegmentPortVifResponse]
    Port Vif which segment is associated with.
    provisioning_state str
    The provisioning state
    status str
    Segment status.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    portVif List<Property Map>
    Port Vif which segment is associated with.
    provisioningState String
    The provisioning state
    status String
    Segment status.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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

    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native