Microsoft.AVS privateClouds/workloadNetworks/dhcpConfigurations

• Latest
• 2022-05-01
• 2021-12-01
• 2021-06-01
• 2021-01-01-preview
• 2020-07-17-preview

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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 Bicep to your template.

resource symbolicname 'Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2022-05-01' = {
  name: 'string'
  parent: resourceSymbolicName
  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
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: workloadNetworks
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

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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

Terraform (AzAPI provider) resource definition

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

• Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2022-05-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    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@2022-05-01"
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: workloadNetworks
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