Microsoft.Compute (stable:2024-07-01)

2025/05/13 • 9 new methods

NetworkInterfaces_ListCloudServiceRoleInstanceNetworkInterfaces (new)
Description :  Gets information about all network interfaces in a role instance in a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: The name of the cloud service. ,
Required: True ,
}
string ,
roleInstanceName:
{
Description: The name of role instance. ,
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 network interfaces in a resource group. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the network interface. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the network interface. ,
Required: False ,
}
{
virtualMachine:
{
Description: The reference to a virtual machine. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
networkSecurityGroup:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: A reference to the private endpoint to which the network interface is linked. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group 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 ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
tapConfigurations:
{
Description: A list of TapConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
dnsSettings:
{
Description: The DNS settings in network interface. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. ,
Required: False ,
}
[
string ,
]
,
appliedDnsServers:
{
Description: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. ,
Required: False ,
}
[
string ,
]
,
internalDnsNameLabel:
{
Description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalFqdn:
{
Description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalDomainNameSuffix:
{
Description: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address of the network interface. ,
Required: False ,
}
string ,
primary:
{
Description: Whether this is a primary network interface on a virtual machine. ,
Required: False ,
}
boolean ,
vnetEncryptionSupported:
{
Description: Whether the virtual machine this nic is attached to supports encryption. ,
Required: False ,
}
boolean ,
defaultOutboundConnectivityEnabled:
{
Description: Whether default outbound connectivity for nic was configured or not. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Indicates whether to disable tcp state tracking. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Indicates whether IP forwarding is enabled on this network interface. ,
Required: False ,
}
boolean ,
hostedWorkloads:
{
Description: A list of references to linked BareMetal resources. ,
Required: False ,
}
[
string ,
]
,
dscpConfiguration:
{
Description: A reference to the dscp configuration to which the network interface is linked. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the network interface resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: WorkloadType of the NetworkInterface for BareMetal resources ,
Required: False ,
}
string ,
nicType:
{
Description: Type of Network Interface resource. ,
Enum:
{
Standard: No description available. ,
Elastic: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkService:
{
Description: Privatelinkservice of the network interface resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private link service. ,
Required: False ,
}
{
loadBalancerFrontendIpConfigurations:
{
Description: An array of references to the load balancer IP configurations. ,
Required: False ,
}
[
string ,
]
,
ipConfigurations:
{
Description: An array of private link service IP configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the private link service IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of private link service ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
destinationIPAddress:
{
Description: The destination IP address of the private link service. ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private link service. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private link service resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: An array of list about connections to the private endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private end point connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group 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 ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
privateEndpointLocation:
{
Description: The location of the private endpoint. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
visibility:
{
Description: The visibility list of the private link service. ,
Required: False ,
}
string ,
autoApproval:
{
Description: The auto-approval list of the private link service. ,
Required: False ,
}
string ,
fqdns:
{
Description: The list of Fqdn. ,
Required: False ,
}
[
string ,
]
,
alias:
{
Description: The alias of the private link service. ,
Required: False ,
}
string ,
enableProxyProtocol:
{
Description: Whether the private link service is enabled for proxy protocol or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Network Interface resource. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Auxiliary mode of Network Interface resource. ,
Enum:
{
None: No description available. ,
MaxConnections: No description available. ,
Floating: No description available. ,
AcceleratedConnections: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Auxiliary sku of Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
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 ,
]
,
}
,
}
NetworkInterfaces_ListCloudServiceNetworkInterfaces (new)
Description :  Gets all network interfaces in a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/networkInterfaces
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: The name of the cloud service. ,
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 network interfaces in a resource group. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the network interface. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the network interface. ,
Required: False ,
}
{
virtualMachine:
{
Description: The reference to a virtual machine. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
networkSecurityGroup:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: A reference to the private endpoint to which the network interface is linked. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group 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 ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
tapConfigurations:
{
Description: A list of TapConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
dnsSettings:
{
Description: The DNS settings in network interface. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. ,
Required: False ,
}
[
string ,
]
,
appliedDnsServers:
{
Description: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. ,
Required: False ,
}
[
string ,
]
,
internalDnsNameLabel:
{
Description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalFqdn:
{
Description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalDomainNameSuffix:
{
Description: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address of the network interface. ,
Required: False ,
}
string ,
primary:
{
Description: Whether this is a primary network interface on a virtual machine. ,
Required: False ,
}
boolean ,
vnetEncryptionSupported:
{
Description: Whether the virtual machine this nic is attached to supports encryption. ,
Required: False ,
}
boolean ,
defaultOutboundConnectivityEnabled:
{
Description: Whether default outbound connectivity for nic was configured or not. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Indicates whether to disable tcp state tracking. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Indicates whether IP forwarding is enabled on this network interface. ,
Required: False ,
}
boolean ,
hostedWorkloads:
{
Description: A list of references to linked BareMetal resources. ,
Required: False ,
}
[
string ,
]
,
dscpConfiguration:
{
Description: A reference to the dscp configuration to which the network interface is linked. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the network interface resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: WorkloadType of the NetworkInterface for BareMetal resources ,
Required: False ,
}
string ,
nicType:
{
Description: Type of Network Interface resource. ,
Enum:
{
Standard: No description available. ,
Elastic: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkService:
{
Description: Privatelinkservice of the network interface resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private link service. ,
Required: False ,
}
{
loadBalancerFrontendIpConfigurations:
{
Description: An array of references to the load balancer IP configurations. ,
Required: False ,
}
[
string ,
]
,
ipConfigurations:
{
Description: An array of private link service IP configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the private link service IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of private link service ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
destinationIPAddress:
{
Description: The destination IP address of the private link service. ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private link service. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private link service resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: An array of list about connections to the private endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private end point connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group 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 ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
privateEndpointLocation:
{
Description: The location of the private endpoint. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
visibility:
{
Description: The visibility list of the private link service. ,
Required: False ,
}
string ,
autoApproval:
{
Description: The auto-approval list of the private link service. ,
Required: False ,
}
string ,
fqdns:
{
Description: The list of Fqdn. ,
Required: False ,
}
[
string ,
]
,
alias:
{
Description: The alias of the private link service. ,
Required: False ,
}
string ,
enableProxyProtocol:
{
Description: Whether the private link service is enabled for proxy protocol or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Network Interface resource. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Auxiliary mode of Network Interface resource. ,
Enum:
{
None: No description available. ,
MaxConnections: No description available. ,
Floating: No description available. ,
AcceleratedConnections: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Auxiliary sku of Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
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 ,
]
,
}
,
}
NetworkInterfaces_GetCloudServiceNetworkInterface (new)
Description :  Get the specified network interface in a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: The name of the cloud service. ,
Required: True ,
}
string ,
roleInstanceName:
{
Description: The name of role instance. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: The name of the network interface. ,
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)

{
extendedLocation:
{
Description: The extended location of the network interface. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the network interface. ,
Required: False ,
}
{
virtualMachine:
{
Description: The reference to a virtual machine. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
networkSecurityGroup:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: A reference to the private endpoint to which the network interface is linked. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group 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 ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
tapConfigurations:
{
Description: A list of TapConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
dnsSettings:
{
Description: The DNS settings in network interface. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. ,
Required: False ,
}
[
string ,
]
,
appliedDnsServers:
{
Description: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. ,
Required: False ,
}
[
string ,
]
,
internalDnsNameLabel:
{
Description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalFqdn:
{
Description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalDomainNameSuffix:
{
Description: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address of the network interface. ,
Required: False ,
}
string ,
primary:
{
Description: Whether this is a primary network interface on a virtual machine. ,
Required: False ,
}
boolean ,
vnetEncryptionSupported:
{
Description: Whether the virtual machine this nic is attached to supports encryption. ,
Required: False ,
}
boolean ,
defaultOutboundConnectivityEnabled:
{
Description: Whether default outbound connectivity for nic was configured or not. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Indicates whether to disable tcp state tracking. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Indicates whether IP forwarding is enabled on this network interface. ,
Required: False ,
}
boolean ,
hostedWorkloads:
{
Description: A list of references to linked BareMetal resources. ,
Required: False ,
}
[
string ,
]
,
dscpConfiguration:
{
Description: A reference to the dscp configuration to which the network interface is linked. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the network interface resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: WorkloadType of the NetworkInterface for BareMetal resources ,
Required: False ,
}
string ,
nicType:
{
Description: Type of Network Interface resource. ,
Enum:
{
Standard: No description available. ,
Elastic: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkService:
{
Description: Privatelinkservice of the network interface resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private link service. ,
Required: False ,
}
{
loadBalancerFrontendIpConfigurations:
{
Description: An array of references to the load balancer IP configurations. ,
Required: False ,
}
[
string ,
]
,
ipConfigurations:
{
Description: An array of private link service IP configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the private link service IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of private link service ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
destinationIPAddress:
{
Description: The destination IP address of the private link service. ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private link service. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private link service resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: An array of list about connections to the private endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private end point connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group 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 ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
privateEndpointLocation:
{
Description: The location of the private endpoint. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
visibility:
{
Description: The visibility list of the private link service. ,
Required: False ,
}
string ,
autoApproval:
{
Description: The auto-approval list of the private link service. ,
Required: False ,
}
string ,
fqdns:
{
Description: The list of Fqdn. ,
Required: False ,
}
[
string ,
]
,
alias:
{
Description: The alias of the private link service. ,
Required: False ,
}
string ,
enableProxyProtocol:
{
Description: Whether the private link service is enabled for proxy protocol or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Network Interface resource. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Auxiliary mode of Network Interface resource. ,
Enum:
{
None: No description available. ,
MaxConnections: No description available. ,
Floating: No description available. ,
AcceleratedConnections: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Auxiliary sku of Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
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_ListCloudServicePublicIPAddresses (new)
Description :  Gets information about all public IP addresses on a cloud service level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/publicipaddresses
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: The name of the cloud service. ,
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 ,
}
[
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: 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 ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
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 ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
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 ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
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 ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: 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_ListCloudServiceRoleInstancePublicIPAddresses (new)
Description :  Gets information about all public IP addresses in a role instance IP configuration in a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: The name of the cloud service. ,
Required: True ,
}
string ,
roleInstanceName:
{
Description: The name of role instance. ,
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 ,
}
[
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: 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 ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
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 ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
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 ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
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 ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: 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_GetCloudServicePublicIPAddress (new)
Description :  Get the specified public IP address in a cloud service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: The name of the cloud service. ,
Required: True ,
}
string ,
roleInstanceName:
{
Description: The role instance name. ,
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)

{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: 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 ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
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 ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
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 ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
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 ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: 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 ,
]
,
}
,
}
VipSwap_Get (new)
Description :  Gets the SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots/{singletonResource}
{
groupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the cloud service. ,
Required: True ,
}
string ,
singletonResource:
{
Description: Specifies a synthetic proxy resource that cannot be created or deleted. Value must be set to swap. ,
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 (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 ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Swap resource properties ,
Required: False ,
}
{
slotType:
{
Description: Specifies slot info on a cloud service ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
VipSwap_Create (new)
Description :  Performs vip swap operation on swappable cloud services.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots/{singletonResource}
{
groupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the cloud service. ,
Required: True ,
}
string ,
singletonResource:
{
Description: Specifies a synthetic resource that cannot be created or deleted. Value must be set to swap. ,
Required: True ,
}
string ,
parameters:
{
Description: SwapResource object where slot type should be the target slot after vip swap for the specified cloud service. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Swap resource properties ,
Required: False ,
}
{
slotType:
{
Description: Specifies slot info on a cloud service ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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)

{}

⚐ Response (202)

{}

⚐ 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 ,
]
,
}
,
}
VipSwap_List (new)
Description :  Gets the list of SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots
{
groupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the cloud service. ,
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 (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 ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Swap resource properties ,
Required: False ,
}
{
slotType:
{
Description: Specifies slot info on a cloud service ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}