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, 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.
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",
PrivateCloudName = "cloud1",
Properties = new AzureNative.AVS.Inputs.WorkloadNetworkDhcpServerArgs
{
DhcpType = "SERVER",
DisplayName = "dhcpConfigurations1",
LeaseTime = 86400,
Revision = 1,
ServerAddress = "40.1.5.1/24",
},
ResourceGroupName = "group1",
});
});
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"),
PrivateCloudName: pulumi.String("cloud1"),
Properties: &avs.WorkloadNetworkDhcpServerArgs{
DhcpType: pulumi.String("SERVER"),
DisplayName: pulumi.String("dhcpConfigurations1"),
LeaseTime: pulumi.Float64(86400),
Revision: pulumi.Float64(1),
ServerAddress: pulumi.String("40.1.5.1/24"),
},
ResourceGroupName: pulumi.String("group1"),
})
if err != nil {
return err
}
return nil
})
}
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")
.privateCloudName("cloud1")
.properties(WorkloadNetworkDhcpServerArgs.builder()
.dhcpType("SERVER")
.displayName("dhcpConfigurations1")
.leaseTime(86400.0)
.revision(1.0)
.serverAddress("40.1.5.1/24")
.build())
.resourceGroupName("group1")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const workloadNetworkDhcp = new azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcp", {
dhcpId: "dhcp1",
privateCloudName: "cloud1",
properties: {
dhcpType: "SERVER",
displayName: "dhcpConfigurations1",
leaseTime: 86400,
revision: 1,
serverAddress: "40.1.5.1/24",
},
resourceGroupName: "group1",
});
import pulumi
import pulumi_azure_native as azure_native
workload_network_dhcp = azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcp",
dhcp_id="dhcp1",
private_cloud_name="cloud1",
properties={
"dhcp_type": "SERVER",
"display_name": "dhcpConfigurations1",
"lease_time": 86400,
"revision": 1,
"server_address": "40.1.5.1/24",
},
resource_group_name="group1")
resources:
workloadNetworkDhcp:
type: azure-native:avs:WorkloadNetworkDhcp
properties:
dhcpId: dhcp1
privateCloudName: cloud1
properties:
dhcpType: SERVER
displayName: dhcpConfigurations1
leaseTime: 86400
revision: 1
serverAddress: 40.1.5.1/24
resourceGroupName: group1
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,
private_cloud_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
dhcp_id: Optional[str] = None,
properties: Optional[Union[WorkloadNetworkDhcpRelayArgs, WorkloadNetworkDhcpServerArgs]] = 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 string
- The unique name of the resource.
- args WorkloadNetworkDhcpArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args WorkloadNetworkDhcpArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkloadNetworkDhcpArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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()
{
PrivateCloudName = "string",
ResourceGroupName = "string",
DhcpId = "string",
Properties = new AzureNative.AVS.Inputs.WorkloadNetworkDhcpRelayArgs
{
DhcpType = "RELAY",
DisplayName = "string",
Revision = 0,
ServerAddresses = new[]
{
"string",
},
},
});
example, err := avs.NewWorkloadNetworkDhcp(ctx, "workloadNetworkDhcpResource", &avs.WorkloadNetworkDhcpArgs{
PrivateCloudName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
DhcpId: pulumi.String("string"),
Properties: &avs.WorkloadNetworkDhcpRelayArgs{
DhcpType: pulumi.String("RELAY"),
DisplayName: pulumi.String("string"),
Revision: pulumi.Float64(0),
ServerAddresses: pulumi.StringArray{
pulumi.String("string"),
},
},
})
var workloadNetworkDhcpResource = new WorkloadNetworkDhcp("workloadNetworkDhcpResource", WorkloadNetworkDhcpArgs.builder()
.privateCloudName("string")
.resourceGroupName("string")
.dhcpId("string")
.properties(WorkloadNetworkDhcpRelayArgs.builder()
.dhcpType("RELAY")
.displayName("string")
.revision(0.0)
.serverAddresses("string")
.build())
.build());
workload_network_dhcp_resource = azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcpResource",
private_cloud_name="string",
resource_group_name="string",
dhcp_id="string",
properties={
"dhcp_type": "RELAY",
"display_name": "string",
"revision": 0,
"server_addresses": ["string"],
})
const workloadNetworkDhcpResource = new azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcpResource", {
privateCloudName: "string",
resourceGroupName: "string",
dhcpId: "string",
properties: {
dhcpType: "RELAY",
displayName: "string",
revision: 0,
serverAddresses: ["string"],
},
});
type: azure-native:avs:WorkloadNetworkDhcp
properties:
dhcpId: string
privateCloudName: string
properties:
dhcpType: RELAY
displayName: string
revision: 0
serverAddresses:
- string
resourceGroupName: string
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:
- Private
Cloud stringName - Name of the private cloud
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Dhcp
Id string - The ID of the DHCP configuration
- Properties
Pulumi.
Azure | Pulumi.Native. AVS. Inputs. Workload Network Dhcp Relay Azure Native. AVS. Inputs. Workload Network Dhcp Server - The resource-specific properties for this resource.
- Private
Cloud stringName - Name of the private cloud
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Dhcp
Id string - The ID of the DHCP configuration
- Properties
Workload
Network | WorkloadDhcp Relay Args Network Dhcp Server Args - The resource-specific properties for this resource.
- private
Cloud StringName - Name of the private cloud
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- dhcp
Id String - The ID of the DHCP configuration
- properties
Workload
Network | WorkloadDhcp Relay Network Dhcp Server - The resource-specific properties for this resource.
- private
Cloud stringName - Name of the private cloud
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- dhcp
Id string - The ID of the DHCP configuration
- properties
Workload
Network | WorkloadDhcp Relay Network Dhcp Server - The resource-specific properties for this resource.
- private_
cloud_ strname - Name of the private cloud
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- dhcp_
id str - The ID of the DHCP configuration
- properties
Workload
Network | WorkloadDhcp Relay Args Network Dhcp Server Args - The resource-specific properties for this resource.
- private
Cloud StringName - Name of the private cloud
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- dhcp
Id String - The ID of the DHCP configuration
- properties Property Map | Property Map
- The resource-specific properties for this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkloadNetworkDhcp resource produces the following output properties:
- Azure
Api stringVersion - 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
- System
Data Pulumi.Azure Native. AVS. Outputs. System Data Response - 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 stringVersion - 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
- System
Data SystemData Response - 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 StringVersion - 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
- system
Data SystemData Response - 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 stringVersion - 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
- system
Data SystemData Response - 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_ strversion - 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
- system_
data SystemData Response - 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"
- azure
Api StringVersion - 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
- system
Data 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, SystemDataResponseArgs
Metadata pertaining to creation and last modification of the resource.- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
WorkloadNetworkDhcpRelay, WorkloadNetworkDhcpRelayArgs
NSX DHCP Relay- Display
Name string - Display name of the DHCP entity.
- Revision double
- NSX revision number.
- Server
Addresses List<string> - DHCP Relay Addresses. Max 3.
- Display
Name string - Display name of the DHCP entity.
- Revision float64
- NSX revision number.
- Server
Addresses []string - DHCP Relay Addresses. Max 3.
- display
Name String - Display name of the DHCP entity.
- revision Double
- NSX revision number.
- server
Addresses List<String> - DHCP Relay Addresses. Max 3.
- display
Name string - Display name of the DHCP entity.
- revision number
- NSX revision number.
- server
Addresses string[] - DHCP Relay Addresses. Max 3.
- display_
name str - Display name of the DHCP entity.
- revision float
- NSX revision number.
- server_
addresses Sequence[str] - DHCP Relay Addresses. Max 3.
- display
Name String - Display name of the DHCP entity.
- revision Number
- NSX revision number.
- server
Addresses List<String> - DHCP Relay Addresses. Max 3.
WorkloadNetworkDhcpRelayResponse, WorkloadNetworkDhcpRelayResponseArgs
NSX DHCP Relay- Provisioning
State string - The provisioning state
- Segments List<string>
- NSX Segments consuming DHCP.
- Display
Name string - Display name of the DHCP entity.
- Revision double
- NSX revision number.
- Server
Addresses List<string> - DHCP Relay Addresses. Max 3.
- Provisioning
State string - The provisioning state
- Segments []string
- NSX Segments consuming DHCP.
- Display
Name string - Display name of the DHCP entity.
- Revision float64
- NSX revision number.
- Server
Addresses []string - DHCP Relay Addresses. Max 3.
- provisioning
State String - The provisioning state
- segments List<String>
- NSX Segments consuming DHCP.
- display
Name String - Display name of the DHCP entity.
- revision Double
- NSX revision number.
- server
Addresses List<String> - DHCP Relay Addresses. Max 3.
- provisioning
State string - The provisioning state
- segments string[]
- NSX Segments consuming DHCP.
- display
Name string - Display name of the DHCP entity.
- revision number
- NSX revision number.
- server
Addresses 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.
- provisioning
State String - The provisioning state
- segments List<String>
- NSX Segments consuming DHCP.
- display
Name String - Display name of the DHCP entity.
- revision Number
- NSX revision number.
- server
Addresses List<String> - DHCP Relay Addresses. Max 3.
WorkloadNetworkDhcpServer, WorkloadNetworkDhcpServerArgs
NSX DHCP Server- Display
Name string - Display name of the DHCP entity.
- Lease
Time double - DHCP Server Lease Time.
- Revision double
- NSX revision number.
- Server
Address string - DHCP Server Address.
- Display
Name string - Display name of the DHCP entity.
- Lease
Time float64 - DHCP Server Lease Time.
- Revision float64
- NSX revision number.
- Server
Address string - DHCP Server Address.
- display
Name String - Display name of the DHCP entity.
- lease
Time Double - DHCP Server Lease Time.
- revision Double
- NSX revision number.
- server
Address String - DHCP Server Address.
- display
Name string - Display name of the DHCP entity.
- lease
Time number - DHCP Server Lease Time.
- revision number
- NSX revision number.
- server
Address string - DHCP Server Address.
- 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.
- display
Name String - Display name of the DHCP entity.
- lease
Time Number - DHCP Server Lease Time.
- revision Number
- NSX revision number.
- server
Address String - DHCP Server Address.
WorkloadNetworkDhcpServerResponse, WorkloadNetworkDhcpServerResponseArgs
NSX DHCP Server- Provisioning
State string - The provisioning state
- Segments List<string>
- NSX Segments consuming DHCP.
- Display
Name string - Display name of the DHCP entity.
- Lease
Time double - DHCP Server Lease Time.
- Revision double
- NSX revision number.
- Server
Address string - DHCP Server Address.
- Provisioning
State string - The provisioning state
- Segments []string
- NSX Segments consuming DHCP.
- Display
Name string - Display name of the DHCP entity.
- Lease
Time float64 - DHCP Server Lease Time.
- Revision float64
- NSX revision number.
- Server
Address string - DHCP Server Address.
- provisioning
State String - The provisioning state
- segments List<String>
- NSX Segments consuming DHCP.
- display
Name String - Display name of the DHCP entity.
- lease
Time Double - DHCP Server Lease Time.
- revision Double
- NSX revision number.
- server
Address String - DHCP Server Address.
- provisioning
State string - The provisioning state
- segments string[]
- NSX Segments consuming DHCP.
- display
Name string - Display name of the DHCP entity.
- lease
Time number - DHCP Server Lease Time.
- revision number
- NSX revision number.
- server
Address 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.
- provisioning
State String - The provisioning state
- segments List<String>
- NSX Segments consuming DHCP.
- display
Name String - Display name of the DHCP entity.
- lease
Time Number - DHCP Server Lease Time.
- revision Number
- NSX revision number.
- server
Address String - DHCP Server Address.
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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
