Microsoft.AVS privateClouds/workloadNetworks/dhcpConfigurations

The privateClouds/workloadNetworks/dhcpConfigurations resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

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

resource symbolicname 'Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2021-06-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

For Bicep, set this value in the resource declaration.
'Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-06-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Base class for WorkloadNetworkDhcpServer and WorkloadNetworkDhcpRelay to inherit from 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

WorkloadNetworkDhcpRelay

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

WorkloadNetworkDhcpServer

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