1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. getWorkloadNetworkDhcp
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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.avs.getWorkloadNetworkDhcp

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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Get a WorkloadNetworkDhcp

    Uses Azure REST API version 2023-09-01.

    Other available API versions: 2022-05-01, 2023-03-01, 2024-09-01, 2025-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 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>
    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]
    func LookupWorkloadNetworkDhcp(ctx *Context, args *LookupWorkloadNetworkDhcpArgs, opts ...InvokeOption) (*LookupWorkloadNetworkDhcpResult, error)
func LookupWorkloadNetworkDhcpOutput(ctx *Context, args *LookupWorkloadNetworkDhcpOutputArgs, opts ...InvokeOption) LookupWorkloadNetworkDhcpResultOutput

    > 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)
}
    public static CompletableFuture<GetWorkloadNetworkDhcpResult> getWorkloadNetworkDhcp(GetWorkloadNetworkDhcpArgs args, InvokeOptions options)
public static Output<GetWorkloadNetworkDhcpResult> getWorkloadNetworkDhcp(GetWorkloadNetworkDhcpArgs args, InvokeOptions options)

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

    The following arguments are supported:

    DhcpId string
    The ID of the DHCP configuration
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    DhcpId string
    The ID of the DHCP configuration
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    dhcpId String
    The ID of the DHCP configuration
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    dhcpId string
    The ID of the DHCP configuration
    privateCloudName string
    Name of the private cloud
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    dhcp_id str
    The ID of the DHCP configuration
    private_cloud_name str
    Name of the private cloud
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    dhcpId String
    The ID of the DHCP configuration
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getWorkloadNetworkDhcp 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
    Properties Pulumi.AzureNative.AVS.Outputs.WorkloadNetworkDhcpRelayResponse | Pulumi.AzureNative.AVS.Outputs.WorkloadNetworkDhcpServerResponse
    The resource-specific properties for this resource.
    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"
    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
    Properties WorkloadNetworkDhcpRelayResponse | WorkloadNetworkDhcpServerResponse
    The resource-specific properties for this resource.
    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"
    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
    properties WorkloadNetworkDhcpRelayResponse | WorkloadNetworkDhcpServerResponse
    The resource-specific properties for this resource.
    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"
    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
    properties WorkloadNetworkDhcpRelayResponse | WorkloadNetworkDhcpServerResponse
    The resource-specific properties for this resource.
    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"
    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
    properties WorkloadNetworkDhcpRelayResponse | WorkloadNetworkDhcpServerResponse
    The resource-specific properties for this resource.
    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"
    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
    properties Property Map | Property Map
    The resource-specific properties for this resource.
    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"

    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.

    WorkloadNetworkDhcpRelayResponse

    ProvisioningState string
    The provisioning state
    Segments 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 string
    The provisioning state
    Segments []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 String
    The provisioning state
    segments 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 string
    The provisioning state
    segments 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 str
    The provisioning state
    segments 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 String
    The provisioning state
    segments 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 string
    The provisioning state
    Segments 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 string
    The provisioning state
    Segments []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 String
    The provisioning state
    segments 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 string
    The provisioning state
    segments 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 str
    The provisioning state
    segments 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 String
    The provisioning state
    segments 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 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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Meet Neo: Your AI Platform Teammate