Microsoft.AVS privateClouds/workloadNetworks/dhcpConfigurations

ARM template resource definition

The privateClouds/workloadNetworks/dhcpConfigurations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations resource, add the following JSON to your template.

{
  "type": "Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations",
  "apiVersion": "2022-05-01",
  "name": "string",
  "properties": {
    "displayName": "string",
    "revision": "int",
    "dhcpType": "string"
    // For remaining properties, see WorkloadNetworkDhcpEntity objects
  }
}

WorkloadNetworkDhcpEntity objects

Set the dhcpType property to specify the type of object.

For RELAY, use:

  "dhcpType": "RELAY",
  "serverAddresses": [ "string" ]

For SERVER, use:

  "dhcpType": "SERVER",
  "leaseTime": "int",
  "serverAddress": "string"

Property values

privateClouds/workloadNetworks/dhcpConfigurations

Name Description Value
type The resource type 'Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations'
apiVersion The resource api version '2022-05-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties DHCP properties. WorkloadNetworkDhcpEntity

WorkloadNetworkDhcpEntity

Name Description Value
displayName Display name of the DHCP entity. string
revision NSX revision number. int
dhcpType Set the object type RELAY
SERVER (required)

WorkloadNetworkDhcpRelay

Name Description Value
dhcpType Type of DHCP: SERVER or RELAY. 'RELAY' (required)
serverAddresses DHCP Relay Addresses. Max 3. string[]

WorkloadNetworkDhcpServer

Name Description Value
dhcpType Type of DHCP: SERVER or RELAY. 'SERVER' (required)
leaseTime DHCP Server Lease Time. int
serverAddress DHCP Server Address. string