Microsoft.Compute (stable:2018-10-01)

2025/05/13 • 3 new methods

PublicIPAddresses_ListVirtualMachineScaleSetPublicIPAddresses (new)
Description :  Gets information about all public IP addresses on a virtual machine scale set level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/publicipaddresses
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
virtualMachineScaleSetName:
{
Description: The name of the virtual machine scale set. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of public IP addresses that exists in a resource group. ,
Required: False ,
}
[
{
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
ddosCustomPolicy:
{
Description: The DDoS custom policy associated with the public IP. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
protectionCoverage:
{
Description: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PublicIPAddresses_ListVirtualMachineScaleSetVMPublicIPAddresses (new)
Description :  Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
virtualMachineScaleSetName:
{
Description: The name of the virtual machine scale set. ,
Required: True ,
}
string ,
virtualmachineIndex:
{
Description: The virtual machine index. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: The network interface name. ,
Required: True ,
}
string ,
ipConfigurationName:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of public IP addresses that exists in a resource group. ,
Required: False ,
}
[
{
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
ddosCustomPolicy:
{
Description: The DDoS custom policy associated with the public IP. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
protectionCoverage:
{
Description: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PublicIPAddresses_GetVirtualMachineScaleSetPublicIPAddress (new)
Description :  Get the specified public IP address in a virtual machine scale set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
virtualMachineScaleSetName:
{
Description: The name of the virtual machine scale set. ,
Required: True ,
}
string ,
virtualmachineIndex:
{
Description: The virtual machine index. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: The name of the network interface. ,
Required: True ,
}
string ,
ipConfigurationName:
{
Description: The name of the IP configuration. ,
Required: True ,
}
string ,
publicIpAddressName:
{
Description: The name of the public IP Address. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$expand:
{
Description: Expands referenced resources. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
ddosCustomPolicy:
{
Description: The DDoS custom policy associated with the public IP. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
protectionCoverage:
{
Description: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}