Azure Native v1.103.0, Jun 2 23

azure-native.avs.getWorkloadNetworkSegment

Explore with Pulumi AI

NSX Segment API Version: 2020-07-17-preview.

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)
// Output-based functions aren't available in Java yet

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: NSX Segment identifier. Generally the same as the Segment's display name

PrivateCloudName string: Name of the private cloud
ResourceGroupName string: The name of the resource group. The name is case insensitive.
SegmentId string: NSX Segment identifier. Generally the same as the Segment's display name

privateCloudName String: Name of the private cloud
resourceGroupName String: The name of the resource group. The name is case insensitive.
segmentId String: NSX Segment identifier. Generally the same as the Segment's display name

privateCloudName string: Name of the private cloud
resourceGroupName string: The name of the resource group. The name is case insensitive.
segmentId string: NSX Segment identifier. Generally the same as the Segment's display name

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: NSX Segment identifier. Generally the same as the Segment's display name

privateCloudName String: Name of the private cloud
resourceGroupName String: The name of the resource group. The name is case insensitive.
segmentId 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 pulumi/pulumi-azure-native
License: Apache-2.0