Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. WorkloadNetworkDhcp
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.avs.WorkloadNetworkDhcp

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

NSX DHCP

Uses Azure REST API version 2023-09-01. In version 2.x of the Azure Native provider, it used API version 2022-05-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.

Example Usage

WorkloadNetworks_CreateDhcp

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var workloadNetworkDhcp = new AzureNative.AVS.WorkloadNetworkDhcp("workloadNetworkDhcp", new()
    {
        DhcpId = "dhcp1",
        DhcpType = AzureNative.AVS.DhcpTypeEnum.SERVER,
        DisplayName = "dhcpConfigurations1",
        PrivateCloudName = "cloud1",
        ResourceGroupName = "group1",
        Revision = 1,
    });

});
Copy
package main

import (
	avs "github.com/pulumi/pulumi-azure-native-sdk/avs/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avs.NewWorkloadNetworkDhcp(ctx, "workloadNetworkDhcp", &avs.WorkloadNetworkDhcpArgs{
			DhcpId:            pulumi.String("dhcp1"),
			DhcpType:          pulumi.String(avs.DhcpTypeEnumSERVER),
			DisplayName:       pulumi.String("dhcpConfigurations1"),
			PrivateCloudName:  pulumi.String("cloud1"),
			ResourceGroupName: pulumi.String("group1"),
			Revision:          pulumi.Float64(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.avs.WorkloadNetworkDhcp;
import com.pulumi.azurenative.avs.WorkloadNetworkDhcpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var workloadNetworkDhcp = new WorkloadNetworkDhcp("workloadNetworkDhcp", WorkloadNetworkDhcpArgs.builder()
            .dhcpId("dhcp1")
            .dhcpType("SERVER")
            .displayName("dhcpConfigurations1")
            .privateCloudName("cloud1")
            .resourceGroupName("group1")
            .revision(1.0)
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workloadNetworkDhcp = new azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcp", {
    dhcpId: "dhcp1",
    dhcpType: azure_native.avs.DhcpTypeEnum.SERVER,
    displayName: "dhcpConfigurations1",
    privateCloudName: "cloud1",
    resourceGroupName: "group1",
    revision: 1,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workload_network_dhcp = azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcp",
    dhcp_id="dhcp1",
    dhcp_type=azure_native.avs.DhcpTypeEnum.SERVER,
    display_name="dhcpConfigurations1",
    private_cloud_name="cloud1",
    resource_group_name="group1",
    revision=1)
Copy
resources:
  workloadNetworkDhcp:
    type: azure-native:avs:WorkloadNetworkDhcp
    properties:
      dhcpId: dhcp1
      dhcpType: SERVER
      displayName: dhcpConfigurations1
      privateCloudName: cloud1
      resourceGroupName: group1
      revision: 1
Copy

Create WorkloadNetworkDhcp Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WorkloadNetworkDhcp(name: string, args: WorkloadNetworkDhcpArgs, opts?: CustomResourceOptions);
@overload
def WorkloadNetworkDhcp(resource_name: str,
                        args: WorkloadNetworkDhcpArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def WorkloadNetworkDhcp(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        dhcp_type: Optional[Union[str, DhcpTypeEnum]] = None,
                        private_cloud_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        dhcp_id: Optional[str] = None,
                        display_name: Optional[str] = None,
                        revision: Optional[float] = None)
func NewWorkloadNetworkDhcp(ctx *Context, name string, args WorkloadNetworkDhcpArgs, opts ...ResourceOption) (*WorkloadNetworkDhcp, error)
public WorkloadNetworkDhcp(string name, WorkloadNetworkDhcpArgs args, CustomResourceOptions? opts = null)
public WorkloadNetworkDhcp(String name, WorkloadNetworkDhcpArgs args)
public WorkloadNetworkDhcp(String name, WorkloadNetworkDhcpArgs args, CustomResourceOptions options)

type: azure-native:avs:WorkloadNetworkDhcp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkloadNetworkDhcpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkloadNetworkDhcpArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkloadNetworkDhcpArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkloadNetworkDhcpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkloadNetworkDhcpArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var workloadNetworkDhcpResource = new AzureNative.AVS.WorkloadNetworkDhcp("workloadNetworkDhcpResource", new()
{
    DhcpType = "string",
    PrivateCloudName = "string",
    ResourceGroupName = "string",
    DhcpId = "string",
    DisplayName = "string",
    Revision = 0,
});
Copy
example, err := avs.NewWorkloadNetworkDhcp(ctx, "workloadNetworkDhcpResource", &avs.WorkloadNetworkDhcpArgs{
	DhcpType:          pulumi.String("string"),
	PrivateCloudName:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	DhcpId:            pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	Revision:          pulumi.Float64(0),
})
Copy
var workloadNetworkDhcpResource = new WorkloadNetworkDhcp("workloadNetworkDhcpResource", WorkloadNetworkDhcpArgs.builder()
    .dhcpType("string")
    .privateCloudName("string")
    .resourceGroupName("string")
    .dhcpId("string")
    .displayName("string")
    .revision(0)
    .build());
Copy
workload_network_dhcp_resource = azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcpResource",
    dhcp_type="string",
    private_cloud_name="string",
    resource_group_name="string",
    dhcp_id="string",
    display_name="string",
    revision=0)
Copy
const workloadNetworkDhcpResource = new azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcpResource", {
    dhcpType: "string",
    privateCloudName: "string",
    resourceGroupName: "string",
    dhcpId: "string",
    displayName: "string",
    revision: 0,
});
Copy
type: azure-native:avs:WorkloadNetworkDhcp
properties:
    dhcpId: string
    dhcpType: string
    displayName: string
    privateCloudName: string
    resourceGroupName: string
    revision: 0
Copy

WorkloadNetworkDhcp Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WorkloadNetworkDhcp resource accepts the following input properties:

DhcpType This property is required. string | Pulumi.AzureNative.AVS.DhcpTypeEnum
Type of DHCP: SERVER or RELAY.
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 Changes to this property will trigger replacement. string
The ID of the DHCP configuration
DisplayName string
Display name of the DHCP entity.
Revision double
NSX revision number.
DhcpType This property is required. string | DhcpTypeEnum
Type of DHCP: SERVER or RELAY.
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 Changes to this property will trigger replacement. string
The ID of the DHCP configuration
DisplayName string
Display name of the DHCP entity.
Revision float64
NSX revision number.
dhcpType This property is required. String | DhcpTypeEnum
Type of DHCP: SERVER or RELAY.
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 Changes to this property will trigger replacement. String
The ID of the DHCP configuration
displayName String
Display name of the DHCP entity.
revision Double
NSX revision number.
dhcpType This property is required. string | DhcpTypeEnum
Type of DHCP: SERVER or RELAY.
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 Changes to this property will trigger replacement. string
The ID of the DHCP configuration
displayName string
Display name of the DHCP entity.
revision number
NSX revision number.
dhcp_type This property is required. str | DhcpTypeEnum
Type of DHCP: SERVER or RELAY.
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.
dhcp_id Changes to this property will trigger replacement. str
The ID of the DHCP configuration
display_name str
Display name of the DHCP entity.
revision float
NSX revision number.
dhcpType This property is required. String | "SERVER" | "RELAY"
Type of DHCP: SERVER or RELAY.
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 Changes to this property will trigger replacement. String
The ID of the DHCP configuration
displayName String
Display name of the DHCP entity.
revision Number
NSX revision number.

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkloadNetworkDhcp resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
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"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
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"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
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"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
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"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
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"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
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"

Supporting Types

DhcpTypeEnum
, DhcpTypeEnumArgs

SERVER
SERVER
RELAY
RELAY
DhcpTypeEnumSERVER
SERVER
DhcpTypeEnumRELAY
RELAY
SERVER
SERVER
RELAY
RELAY
SERVER
SERVER
RELAY
RELAY
SERVER
SERVER
RELAY
RELAY
"SERVER"
SERVER
"RELAY"
RELAY

SystemDataResponse
, SystemDataResponseArgs

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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:avs:WorkloadNetworkDhcp dhcp1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
Copy

To learn more about importing existing cloud resources, see Importing resources.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native