Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.avs.getWorkloadNetworkDhcp

Explore with Pulumi AI

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
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. 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>
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
The ID of the DHCP configuration
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
The ID of the DHCP configuration
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
The ID of the DHCP configuration
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
The ID of the DHCP configuration
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
The ID of the DHCP configuration
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
The ID of the DHCP configuration
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:

AzureApiVersion string
The Azure API version of the resource.
DhcpType string
Type of DHCP: SERVER or RELAY.
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
ProvisioningState string
The provisioning state
Segments List<string>
NSX Segments consuming DHCP.
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"
DisplayName string
Display name of the DHCP entity.
Revision double
NSX revision number.
AzureApiVersion string
The Azure API version of the resource.
DhcpType string
Type of DHCP: SERVER or RELAY.
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
ProvisioningState string
The provisioning state
Segments []string
NSX Segments consuming DHCP.
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"
DisplayName string
Display name of the DHCP entity.
Revision float64
NSX revision number.
azureApiVersion String
The Azure API version of the resource.
dhcpType String
Type of DHCP: SERVER or RELAY.
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
provisioningState String
The provisioning state
segments List<String>
NSX Segments consuming DHCP.
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"
displayName String
Display name of the DHCP entity.
revision Double
NSX revision number.
azureApiVersion string
The Azure API version of the resource.
dhcpType string
Type of DHCP: SERVER or RELAY.
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
provisioningState string
The provisioning state
segments string[]
NSX Segments consuming DHCP.
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"
displayName string
Display name of the DHCP entity.
revision number
NSX revision number.
azure_api_version str
The Azure API version of the resource.
dhcp_type str
Type of DHCP: SERVER or RELAY.
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
provisioning_state str
The provisioning state
segments Sequence[str]
NSX Segments consuming DHCP.
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"
display_name str
Display name of the DHCP entity.
revision float
NSX revision number.
azureApiVersion String
The Azure API version of the resource.
dhcpType String
Type of DHCP: SERVER or RELAY.
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
provisioningState String
The provisioning state
segments List<String>
NSX Segments consuming DHCP.
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"
displayName String
Display name of the DHCP entity.
revision Number
NSX revision number.

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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native