Microsoft.AVS privateClouds/workloadNetworks/segments 2021-01-01-preview

  • Article

Bicep resource definition

The privateClouds/workloadNetworks/segments 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/segments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AVS/privateClouds/workloadNetworks/segments@2021-01-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    connectedGateway: 'string'
    displayName: 'string'
    revision: int
    subnet: {
      dhcpRanges: [
        'string'
      ]
      gatewayAddress: 'string'
    }
  }
}

Property values

privateClouds/workloadNetworks/segments

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 The properties of a Workload Segment proxy resource. WorkloadNetworkSegmentProperties

WorkloadNetworkSegmentProperties

Name Description Value
connectedGateway Gateway which to connect segment to. string
displayName Display name of the segment. string
revision NSX revision number. int
subnet Subnet which to connect segment to. WorkloadNetworkSegmentSubnet

WorkloadNetworkSegmentSubnet

Name Description Value
dhcpRanges DHCP Range assigned for subnet. string[]
gatewayAddress Gateway address. string

ARM template resource definition

The privateClouds/workloadNetworks/segments 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/segments resource, add the following JSON to your template.

{
  "type": "Microsoft.AVS/privateClouds/workloadNetworks/segments",
  "apiVersion": "2021-01-01-preview",
  "name": "string",
  "properties": {
    "connectedGateway": "string",
    "displayName": "string",
    "revision": "int",
    "subnet": {
      "dhcpRanges": [ "string" ],
      "gatewayAddress": "string"
    }
  }
}

Property values

privateClouds/workloadNetworks/segments

Name Description Value
type The resource type 'Microsoft.AVS/privateClouds/workloadNetworks/segments'
apiVersion The resource api version '2021-01-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties The properties of a Workload Segment proxy resource. WorkloadNetworkSegmentProperties

WorkloadNetworkSegmentProperties

Name Description Value
connectedGateway Gateway which to connect segment to. string
displayName Display name of the segment. string
revision NSX revision number. int
subnet Subnet which to connect segment to. WorkloadNetworkSegmentSubnet

WorkloadNetworkSegmentSubnet

Name Description Value
dhcpRanges DHCP Range assigned for subnet. string[]
gatewayAddress Gateway address. string

Terraform (AzAPI provider) resource definition

The privateClouds/workloadNetworks/segments 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/segments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AVS/privateClouds/workloadNetworks/segments@2021-01-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      connectedGateway = "string"
      displayName = "string"
      revision = int
      subnet = {
        dhcpRanges = [
          "string"
        ]
        gatewayAddress = "string"
      }
    }
  })
}

Property values

privateClouds/workloadNetworks/segments

Name Description Value
type The resource type "Microsoft.AVS/privateClouds/workloadNetworks/segments@2021-01-01-preview"
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 The properties of a Workload Segment proxy resource. WorkloadNetworkSegmentProperties

WorkloadNetworkSegmentProperties

Name Description Value
connectedGateway Gateway which to connect segment to. string
displayName Display name of the segment. string
revision NSX revision number. int
subnet Subnet which to connect segment to. WorkloadNetworkSegmentSubnet

WorkloadNetworkSegmentSubnet

Name Description Value
dhcpRanges DHCP Range assigned for subnet. string[]
gatewayAddress Gateway address. string