public_ip_addresses_virtual_machine_scale_set_public_ip_addresses

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

Overview

Name	public_ip_addresses_virtual_machine_scale_set_public_ip_addresses
Type	Resource
Id	azure.network.public_ip_addresses_virtual_machine_scale_set_public_ip_addresses

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting PublicIPAddress resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the public ip address.
properties	object	Public IP address properties.
sku	object	The public IP address SKU.
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"
zones	array	A list of availability zones denoting the IP allocated for the resource needs to come from.

list

Request successful. The operation returns a list of PublicIPInterface resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the public ip address.
properties	object	Public IP address properties.
sku	object	The public IP address SKU.
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"
zones	array	A list of availability zones denoting the IP allocated for the resource needs to come from.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualMachineScaleSetName, virtualmachineIndex, networkInterfaceName, ipConfigurationName, publicIpAddressName, subscriptionId	api-version, $expand	Get the specified public IP address in a virtual machine scale set.
list	select	resourceGroupName, virtualMachineScaleSetName, subscriptionId	api-version	Gets information about all public IP addresses on a virtual machine scale set level.

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
ipConfigurationName	string	The name of the IP configuration.
networkInterfaceName	string	The name of the network interface.
publicIpAddressName	string	The name of the public IP Address.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualMachineScaleSetName	string	The name of the virtual machine scale set.
virtualmachineIndex	string	The virtual machine index.
$expand	string	Expands referenced resources.
api-version	string	Client API version.

SELECT examples

get

Get the specified public IP address in a virtual machine scale set.

SELECT
id,
name,
etag,
extendedLocation,
properties,
sku,
systemData,
type,
zones
FROM azure.network.public_ip_addresses_virtual_machine_scale_set_public_ip_addresses
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualMachineScaleSetName = '{{ virtualMachineScaleSetName }}' -- required
AND virtualmachineIndex = '{{ virtualmachineIndex }}' -- required
AND networkInterfaceName = '{{ networkInterfaceName }}' -- required
AND ipConfigurationName = '{{ ipConfigurationName }}' -- required
AND publicIpAddressName = '{{ publicIpAddressName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $expand = '{{ $expand }}'
;

list

Gets information about all public IP addresses on a virtual machine scale set level.

SELECT
id,
name,
etag,
extendedLocation,
properties,
sku,
systemData,
type,
zones
FROM azure.network.public_ip_addresses_virtual_machine_scale_set_public_ip_addresses
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualMachineScaleSetName = '{{ virtualMachineScaleSetName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;