workload_networks

Creates, updates, deletes, gets or lists a workload_networks resource.

Overview

Name	workload_networks
Type	Resource
Id	azure_isv.avs.workload_networks

Fields

The following fields are returned by SELECT queries:

get_dhcp

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dhcpType	string	Type of DHCP: SERVER or RELAY. Required. Known values are: "SERVER" and "RELAY".
displayName	string	Display name of the DHCP entity.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Building, Deleting, Updating)
revision	integer	NSX revision number.
segments	array	NSX Segments consuming DHCP.
systemData	object	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".

get_dns_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
defaultDnsZone	string	Default DNS zone of the DNS Service.
displayName	string	Display name of the DNS Service.
dnsServiceIp	string	DNS service IP of the DNS Service.
fqdnZones	array	FQDN zones of the DNS Service.
logLevel	string	DNS Service log level. Known values are: "DEBUG", "INFO", "WARNING", "ERROR", and "FATAL". (DEBUG, INFO, WARNING, ERROR, FATAL)
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Building, Deleting, Updating)
revision	integer	NSX revision number.
status	string	DNS Service status. Known values are: "SUCCESS" and "FAILURE". (SUCCESS, FAILURE)
systemData	object	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".

get_dns_zone

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Display name of the DNS Zone.
dnsServerIps	array	DNS Server IP array of the DNS Zone.
dnsServices	integer	Number of DNS Services using the DNS zone.
domain	array	Domain names of the DNS Zone.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Building, Deleting, Updating)
revision	integer	NSX revision number.
sourceIp	string	Source IP of the DNS Zone.
systemData	object	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".

get_gateway

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Display name of the DHCP entity.
path	string	NSX Gateway Path.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Building, Deleting, Updating)
systemData	object	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".

get_port_mirroring

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
destination	string	Destination VM Group.
direction	string	Direction of port mirroring profile. Known values are: "INGRESS", "EGRESS", and "BIDIRECTIONAL". (INGRESS, EGRESS, BIDIRECTIONAL)
displayName	string	Display name of the port mirroring profile.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Building, Deleting, Updating)
revision	integer	NSX revision number.
source	string	Source VM Group.
status	string	Port Mirroring Status. Known values are: "SUCCESS" and "FAILURE". (SUCCESS, FAILURE)
systemData	object	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".

get_public_ip

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Display name of the Public IP Block.
numberOfPublicIPs	integer	Number of Public IPs requested.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Building, Deleting, Updating)
publicIPBlock	string	CIDR Block of the Public IP Block.
systemData	object	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".

get_segment

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
connectedGateway	string	Gateway which to connect segment to.
displayName	string	Display name of the segment.
portVif	array	Port Vif which segment is associated with.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Building, Deleting, Updating)
revision	integer	NSX revision number.
status	string	Segment status. Known values are: "SUCCESS" and "FAILURE". (SUCCESS, FAILURE)
subnet	object	Subnet which to connect segment to.
systemData	object	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".

get_virtual_machine

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Display name of the VM.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Building, Deleting, Updating)
systemData	object	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".
vmType	string	Virtual machine type. Known values are: "REGULAR", "EDGE", and "SERVICE". (REGULAR, EDGE, SERVICE)

get_vm_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Display name of the VM group.
members	array	Virtual machine members of this group.
provisioningState	string	The provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Building, Deleting, Updating)
revision	integer	NSX revision number.
status	string	VM Group status. Known values are: "SUCCESS" and "FAILURE". (SUCCESS, FAILURE)
systemData	object	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".

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Building, Deleting, Updating)
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dhcp	select	resource_group_name, dhcp_id, private_cloud_name, subscription_id		Get a WorkloadNetworkDhcp.
get_dns_service	select	resource_group_name, private_cloud_name, dns_service_id, subscription_id		Get a WorkloadNetworkDnsService.
get_dns_zone	select	resource_group_name, private_cloud_name, dns_zone_id, subscription_id		Get a WorkloadNetworkDnsZone.
get_gateway	select	resource_group_name, private_cloud_name, gateway_id, subscription_id		Get a WorkloadNetworkGateway.
get_port_mirroring	select	resource_group_name, private_cloud_name, port_mirroring_id, subscription_id		Get a WorkloadNetworkPortMirroring.
get_public_ip	select	resource_group_name, private_cloud_name, public_ip_id, subscription_id		Get a WorkloadNetworkPublicIP.
get_segment	select	resource_group_name, private_cloud_name, segment_id, subscription_id		Get a WorkloadNetworkSegment.
get_virtual_machine	select	resource_group_name, private_cloud_name, virtual_machine_id, subscription_id		Get a WorkloadNetworkVirtualMachine.
get_vm_group	select	resource_group_name, private_cloud_name, vm_group_id, subscription_id		Get a WorkloadNetworkVMGroup.
get	select	resource_group_name, private_cloud_name, subscription_id		Get a WorkloadNetwork.
create_dhcp	insert	resource_group_name, private_cloud_name, dhcp_id, subscription_id		Create a WorkloadNetworkDhcp.
create_dns_service	insert	resource_group_name, private_cloud_name, dns_service_id, subscription_id		Create a WorkloadNetworkDnsService.
create_dns_zone	insert	resource_group_name, private_cloud_name, dns_zone_id, subscription_id		Create a WorkloadNetworkDnsZone.
create_port_mirroring	insert	resource_group_name, private_cloud_name, port_mirroring_id, subscription_id		Create a WorkloadNetworkPortMirroring.
create_public_ip	insert	resource_group_name, private_cloud_name, public_ip_id, subscription_id		Create a WorkloadNetworkPublicIP.
create_segments	insert	resource_group_name, private_cloud_name, segment_id, subscription_id		Create a WorkloadNetworkSegment.
create_vm_group	insert	resource_group_name, private_cloud_name, vm_group_id, subscription_id		Create a WorkloadNetworkVMGroup.
update_dhcp	update	resource_group_name, private_cloud_name, dhcp_id, subscription_id		Update a WorkloadNetworkDhcp.
update_dns_service	update	resource_group_name, private_cloud_name, dns_service_id, subscription_id		Update a WorkloadNetworkDnsService.
update_dns_zone	update	resource_group_name, private_cloud_name, dns_zone_id, subscription_id		Update a WorkloadNetworkDnsZone.
update_port_mirroring	update	resource_group_name, private_cloud_name, port_mirroring_id, subscription_id		Update a WorkloadNetworkPortMirroring.
update_segments	update	resource_group_name, private_cloud_name, segment_id, subscription_id		Update a WorkloadNetworkSegment.
update_vm_group	update	resource_group_name, private_cloud_name, vm_group_id, subscription_id		Update a WorkloadNetworkVMGroup.
delete_dhcp	delete	resource_group_name, private_cloud_name, dhcp_id, subscription_id		Delete a WorkloadNetworkDhcp.
delete_dns_service	delete	resource_group_name, dns_service_id, private_cloud_name, subscription_id		Delete a WorkloadNetworkDnsService.
delete_dns_zone	delete	resource_group_name, dns_zone_id, private_cloud_name, subscription_id		Delete a WorkloadNetworkDnsZone.
delete_port_mirroring	delete	resource_group_name, port_mirroring_id, private_cloud_name, subscription_id		Delete a WorkloadNetworkPortMirroring.
delete_public_ip	delete	resource_group_name, public_ip_id, private_cloud_name, subscription_id		Delete a WorkloadNetworkPublicIP.
delete_segment	delete	resource_group_name, private_cloud_name, segment_id, subscription_id		Delete a WorkloadNetworkSegment.
delete_vm_group	delete	resource_group_name, vm_group_id, private_cloud_name, subscription_id		Delete a WorkloadNetworkVMGroup.
list_dhcp	exec	resource_group_name, private_cloud_name, subscription_id		List WorkloadNetworkDhcp resources by WorkloadNetwork.
list_dns_services	exec	resource_group_name, private_cloud_name, subscription_id		List WorkloadNetworkDnsService resources by WorkloadNetwork.
list_dns_zones	exec	resource_group_name, private_cloud_name, subscription_id		List WorkloadNetworkDnsZone resources by WorkloadNetwork.
list_gateways	exec	resource_group_name, private_cloud_name, subscription_id		List WorkloadNetworkGateway resources by WorkloadNetwork.
list_port_mirroring	exec	resource_group_name, private_cloud_name, subscription_id		List WorkloadNetworkPortMirroring resources by WorkloadNetwork.
list_public_ips	exec	resource_group_name, private_cloud_name, subscription_id		List WorkloadNetworkPublicIP resources by WorkloadNetwork.
list_segments	exec	resource_group_name, private_cloud_name, subscription_id		List WorkloadNetworkSegment resources by WorkloadNetwork.
list_virtual_machines	exec	resource_group_name, private_cloud_name, subscription_id		List WorkloadNetworkVirtualMachine resources by WorkloadNetwork.
list_vm_groups	exec	resource_group_name, private_cloud_name, subscription_id		List WorkloadNetworkVMGroup resources by WorkloadNetwork.
list_raw	exec	resource_group_name, private_cloud_name, subscription_id		List WorkloadNetwork resources by PrivateCloud.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dhcp_id	string	The ID of the DHCP configuration. Required.
dns_service_id	string	ID of the DNS service. Required.
dns_zone_id	string	ID of the DNS zone. Required.
gateway_id	string	The ID of the NSX Gateway. Required.
port_mirroring_id	string	ID of the NSX port mirroring profile. Required.
private_cloud_name	string	Name of the private cloud. Required.
public_ip_id	string	ID of the DNS zone. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
segment_id	string	The ID of the NSX Segment. Required.
subscription_id	string
virtual_machine_id	string	ID of the virtual machine. Required.
vm_group_id	string	ID of the VM group. Required.

SELECT examples

get_dhcp

Get a WorkloadNetworkDhcp.

SELECT
id,
name,
dhcpType,
displayName,
provisioningState,
revision,
segments,
systemData,
type
FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dhcp_id = '{{ dhcp_id }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_dns_service

Get a WorkloadNetworkDnsService.

SELECT
id,
name,
defaultDnsZone,
displayName,
dnsServiceIp,
fqdnZones,
logLevel,
provisioningState,
revision,
status,
systemData,
type
FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND dns_service_id = '{{ dns_service_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_dns_zone

Get a WorkloadNetworkDnsZone.

SELECT
id,
name,
displayName,
dnsServerIps,
dnsServices,
domain,
provisioningState,
revision,
sourceIp,
systemData,
type
FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND dns_zone_id = '{{ dns_zone_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_gateway

Get a WorkloadNetworkGateway.

SELECT
id,
name,
displayName,
path,
provisioningState,
systemData,
type
FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND gateway_id = '{{ gateway_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_port_mirroring

Get a WorkloadNetworkPortMirroring.

SELECT
id,
name,
destination,
direction,
displayName,
provisioningState,
revision,
source,
status,
systemData,
type
FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND port_mirroring_id = '{{ port_mirroring_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_public_ip

Get a WorkloadNetworkPublicIP.

SELECT
id,
name,
displayName,
numberOfPublicIPs,
provisioningState,
publicIPBlock,
systemData,
type
FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND public_ip_id = '{{ public_ip_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_segment

Get a WorkloadNetworkSegment.

SELECT
id,
name,
connectedGateway,
displayName,
portVif,
provisioningState,
revision,
status,
subnet,
systemData,
type
FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND segment_id = '{{ segment_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_virtual_machine

Get a WorkloadNetworkVirtualMachine.

SELECT
id,
name,
displayName,
provisioningState,
systemData,
type,
vmType
FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND virtual_machine_id = '{{ virtual_machine_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_vm_group

Get a WorkloadNetworkVMGroup.

SELECT
id,
name,
displayName,
members,
provisioningState,
revision,
status,
systemData,
type
FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND vm_group_id = '{{ vm_group_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get a WorkloadNetwork.

SELECT
id,
name,
provisioningState,
systemData,
type
FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_dhcp

Create a WorkloadNetworkDhcp.

INSERT INTO azure_isv.avs.workload_networks (
properties,
resource_group_name,
private_cloud_name,
dhcp_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ dhcp_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_dns_service

Create a WorkloadNetworkDnsService.

INSERT INTO azure_isv.avs.workload_networks (
properties,
resource_group_name,
private_cloud_name,
dns_service_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ dns_service_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_dns_zone

Create a WorkloadNetworkDnsZone.

INSERT INTO azure_isv.avs.workload_networks (
properties,
resource_group_name,
private_cloud_name,
dns_zone_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ dns_zone_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_port_mirroring

Create a WorkloadNetworkPortMirroring.

INSERT INTO azure_isv.avs.workload_networks (
properties,
resource_group_name,
private_cloud_name,
port_mirroring_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ port_mirroring_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_public_ip

Create a WorkloadNetworkPublicIP.

INSERT INTO azure_isv.avs.workload_networks (
properties,
resource_group_name,
private_cloud_name,
public_ip_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ public_ip_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_segments

Create a WorkloadNetworkSegment.

INSERT INTO azure_isv.avs.workload_networks (
properties,
resource_group_name,
private_cloud_name,
segment_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ segment_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_vm_group

Create a WorkloadNetworkVMGroup.

INSERT INTO azure_isv.avs.workload_networks (
properties,
resource_group_name,
private_cloud_name,
vm_group_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ vm_group_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workload_networks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workload_networks resource.
  - name: private_cloud_name
    value: "{{ private_cloud_name }}"
    description: Required parameter for the workload_networks resource.
  - name: dhcp_id
    value: "{{ dhcp_id }}"
    description: Required parameter for the workload_networks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workload_networks resource.
  - name: dns_service_id
    value: "{{ dns_service_id }}"
    description: Required parameter for the workload_networks resource.
  - name: dns_zone_id
    value: "{{ dns_zone_id }}"
    description: Required parameter for the workload_networks resource.
  - name: port_mirroring_id
    value: "{{ port_mirroring_id }}"
    description: Required parameter for the workload_networks resource.
  - name: public_ip_id
    value: "{{ public_ip_id }}"
    description: Required parameter for the workload_networks resource.
  - name: segment_id
    value: "{{ segment_id }}"
    description: Required parameter for the workload_networks resource.
  - name: vm_group_id
    value: "{{ vm_group_id }}"
    description: Required parameter for the workload_networks resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      displayName: "{{ displayName }}"
      members:
        - "{{ members }}"
      status: "{{ status }}"
      provisioningState: "{{ provisioningState }}"
      revision: {{ revision }}

UPDATE examples

update_dhcp

Update a WorkloadNetworkDhcp.

UPDATE azure_isv.avs.workload_networks
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND dhcp_id = '{{ dhcp_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

update_dns_service

Update a WorkloadNetworkDnsService.

UPDATE azure_isv.avs.workload_networks
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND dns_service_id = '{{ dns_service_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

update_dns_zone

Update a WorkloadNetworkDnsZone.

UPDATE azure_isv.avs.workload_networks
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND dns_zone_id = '{{ dns_zone_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

update_port_mirroring

Update a WorkloadNetworkPortMirroring.

UPDATE azure_isv.avs.workload_networks
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND port_mirroring_id = '{{ port_mirroring_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

update_segments

Update a WorkloadNetworkSegment.

UPDATE azure_isv.avs.workload_networks
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND segment_id = '{{ segment_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

update_vm_group

Update a WorkloadNetworkVMGroup.

UPDATE azure_isv.avs.workload_networks
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND vm_group_id = '{{ vm_group_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete_dhcp

Delete a WorkloadNetworkDhcp.

DELETE FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND dhcp_id = '{{ dhcp_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete_dns_service

Delete a WorkloadNetworkDnsService.

DELETE FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dns_service_id = '{{ dns_service_id }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete_dns_zone

Delete a WorkloadNetworkDnsZone.

DELETE FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dns_zone_id = '{{ dns_zone_id }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete_port_mirroring

Delete a WorkloadNetworkPortMirroring.

DELETE FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND port_mirroring_id = '{{ port_mirroring_id }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete_public_ip

Delete a WorkloadNetworkPublicIP.

DELETE FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND public_ip_id = '{{ public_ip_id }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete_segment

Delete a WorkloadNetworkSegment.

DELETE FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND segment_id = '{{ segment_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete_vm_group

Delete a WorkloadNetworkVMGroup.

DELETE FROM azure_isv.avs.workload_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vm_group_id = '{{ vm_group_id }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_dhcp

List WorkloadNetworkDhcp resources by WorkloadNetwork.

EXEC azure_isv.avs.workload_networks.list_dhcp 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_dns_services

List WorkloadNetworkDnsService resources by WorkloadNetwork.

EXEC azure_isv.avs.workload_networks.list_dns_services 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_dns_zones

List WorkloadNetworkDnsZone resources by WorkloadNetwork.

EXEC azure_isv.avs.workload_networks.list_dns_zones 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_gateways

List WorkloadNetworkGateway resources by WorkloadNetwork.

EXEC azure_isv.avs.workload_networks.list_gateways 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_port_mirroring

List WorkloadNetworkPortMirroring resources by WorkloadNetwork.

EXEC azure_isv.avs.workload_networks.list_port_mirroring 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_public_ips

List WorkloadNetworkPublicIP resources by WorkloadNetwork.

EXEC azure_isv.avs.workload_networks.list_public_ips 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_segments

List WorkloadNetworkSegment resources by WorkloadNetwork.

EXEC azure_isv.avs.workload_networks.list_segments 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_virtual_machines

List WorkloadNetworkVirtualMachine resources by WorkloadNetwork.

EXEC azure_isv.avs.workload_networks.list_virtual_machines 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_vm_groups

List WorkloadNetworkVMGroup resources by WorkloadNetwork.

EXEC azure_isv.avs.workload_networks.list_vm_groups 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_raw

List WorkloadNetwork resources by PrivateCloud.

EXEC azure_isv.avs.workload_networks.list_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;