Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. avs
  5. getWorkloadNetworkDhcp
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.getWorkloadNetworkDhcp

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 DHCP Azure REST API version: 2022-05-01.

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

Using getWorkloadNetworkDhcp

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 getWorkloadNetworkDhcp(args: GetWorkloadNetworkDhcpArgs, opts?: InvokeOptions): Promise<GetWorkloadNetworkDhcpResult>
function getWorkloadNetworkDhcpOutput(args: GetWorkloadNetworkDhcpOutputArgs, opts?: InvokeOptions): Output<GetWorkloadNetworkDhcpResult>
Copy
def get_workload_network_dhcp(dhcp_id: Optional[str] = None,
                              private_cloud_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetWorkloadNetworkDhcpResult
def get_workload_network_dhcp_output(dhcp_id: Optional[pulumi.Input[str]] = None,
                              private_cloud_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetWorkloadNetworkDhcpResult]
Copy
func LookupWorkloadNetworkDhcp(ctx *Context, args *LookupWorkloadNetworkDhcpArgs, opts ...InvokeOption) (*LookupWorkloadNetworkDhcpResult, error)
func LookupWorkloadNetworkDhcpOutput(ctx *Context, args *LookupWorkloadNetworkDhcpOutputArgs, opts ...InvokeOption) LookupWorkloadNetworkDhcpResultOutput
Copy

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

public static class GetWorkloadNetworkDhcp 
{
    public static Task<GetWorkloadNetworkDhcpResult> InvokeAsync(GetWorkloadNetworkDhcpArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkloadNetworkDhcpResult> Invoke(GetWorkloadNetworkDhcpInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkloadNetworkDhcpResult> getWorkloadNetworkDhcp(GetWorkloadNetworkDhcpArgs args, InvokeOptions options)
public static Output<GetWorkloadNetworkDhcpResult> getWorkloadNetworkDhcp(GetWorkloadNetworkDhcpArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:avs:getWorkloadNetworkDhcp
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DhcpId
This property is required.
Changes to this property will trigger replacement.
string
NSX DHCP identifier. Generally the same as the DHCP 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.
DhcpId
This property is required.
Changes to this property will trigger replacement.
string
NSX DHCP identifier. Generally the same as the DHCP 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.
dhcpId
This property is required.
Changes to this property will trigger replacement.
String
NSX DHCP identifier. Generally the same as the DHCP 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.
dhcpId
This property is required.
Changes to this property will trigger replacement.
string
NSX DHCP identifier. Generally the same as the DHCP 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.
dhcp_id
This property is required.
Changes to this property will trigger replacement.
str
NSX DHCP identifier. Generally the same as the DHCP 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.
dhcpId
This property is required.
Changes to this property will trigger replacement.
String
NSX DHCP identifier. Generally the same as the DHCP 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.

getWorkloadNetworkDhcp Result

The following output properties are available:

Id string
Resource ID.
Name string
Resource name.
Properties WorkloadNetworkDhcpRelayResponse | WorkloadNetworkDhcpServerResponse
DHCP properties.
Type string
Resource type.
id String
Resource ID.
name String
Resource name.
properties WorkloadNetworkDhcpRelayResponse | WorkloadNetworkDhcpServerResponse
DHCP properties.
type String
Resource type.
id string
Resource ID.
name string
Resource name.
properties WorkloadNetworkDhcpRelayResponse | WorkloadNetworkDhcpServerResponse
DHCP properties.
type string
Resource type.
id str
Resource ID.
name str
Resource name.
properties WorkloadNetworkDhcpRelayResponse | WorkloadNetworkDhcpServerResponse
DHCP properties.
type str
Resource type.
id String
Resource ID.
name String
Resource name.
properties Property Map | Property Map
DHCP properties.
type String
Resource type.

Supporting Types

WorkloadNetworkDhcpRelayResponse

ProvisioningState This property is required. string
The provisioning state
Segments This property is required. List<string>
NSX Segments consuming DHCP.
DisplayName string
Display name of the DHCP entity.
Revision double
NSX revision number.
ServerAddresses List<string>
DHCP Relay Addresses. Max 3.
ProvisioningState This property is required. string
The provisioning state
Segments This property is required. []string
NSX Segments consuming DHCP.
DisplayName string
Display name of the DHCP entity.
Revision float64
NSX revision number.
ServerAddresses []string
DHCP Relay Addresses. Max 3.
provisioningState This property is required. String
The provisioning state
segments This property is required. List<String>
NSX Segments consuming DHCP.
displayName String
Display name of the DHCP entity.
revision Double
NSX revision number.
serverAddresses List<String>
DHCP Relay Addresses. Max 3.
provisioningState This property is required. string
The provisioning state
segments This property is required. string[]
NSX Segments consuming DHCP.
displayName string
Display name of the DHCP entity.
revision number
NSX revision number.
serverAddresses string[]
DHCP Relay Addresses. Max 3.
provisioning_state This property is required. str
The provisioning state
segments This property is required. Sequence[str]
NSX Segments consuming DHCP.
display_name str
Display name of the DHCP entity.
revision float
NSX revision number.
server_addresses Sequence[str]
DHCP Relay Addresses. Max 3.
provisioningState This property is required. String
The provisioning state
segments This property is required. List<String>
NSX Segments consuming DHCP.
displayName String
Display name of the DHCP entity.
revision Number
NSX revision number.
serverAddresses List<String>
DHCP Relay Addresses. Max 3.

WorkloadNetworkDhcpServerResponse

ProvisioningState This property is required. string
The provisioning state
Segments This property is required. List<string>
NSX Segments consuming DHCP.
DisplayName string
Display name of the DHCP entity.
LeaseTime double
DHCP Server Lease Time.
Revision double
NSX revision number.
ServerAddress string
DHCP Server Address.
ProvisioningState This property is required. string
The provisioning state
Segments This property is required. []string
NSX Segments consuming DHCP.
DisplayName string
Display name of the DHCP entity.
LeaseTime float64
DHCP Server Lease Time.
Revision float64
NSX revision number.
ServerAddress string
DHCP Server Address.
provisioningState This property is required. String
The provisioning state
segments This property is required. List<String>
NSX Segments consuming DHCP.
displayName String
Display name of the DHCP entity.
leaseTime Double
DHCP Server Lease Time.
revision Double
NSX revision number.
serverAddress String
DHCP Server Address.
provisioningState This property is required. string
The provisioning state
segments This property is required. string[]
NSX Segments consuming DHCP.
displayName string
Display name of the DHCP entity.
leaseTime number
DHCP Server Lease Time.
revision number
NSX revision number.
serverAddress string
DHCP Server Address.
provisioning_state This property is required. str
The provisioning state
segments This property is required. Sequence[str]
NSX Segments consuming DHCP.
display_name str
Display name of the DHCP entity.
lease_time float
DHCP Server Lease Time.
revision float
NSX revision number.
server_address str
DHCP Server Address.
provisioningState This property is required. String
The provisioning state
segments This property is required. List<String>
NSX Segments consuming DHCP.
displayName String
Display name of the DHCP entity.
leaseTime Number
DHCP Server Lease Time.
revision Number
NSX revision number.
serverAddress String
DHCP Server 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