Application Gateways - Backend Health On Demand

Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/getBackendHealthOnDemand?api-version=2019-06-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/getBackendHealthOnDemand?api-version=2019-06-01&$expand={$expand}

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

applicationGatewayName
path True
  • string

The name of the application gateway.

api-version
query True
  • string

Client API version.

$expand
query
  • string

Expands BackendAddressPool and BackendHttpSettings referenced in backend health.

Request Body

Name Type Description
backendAddressPool

Reference of backend pool of application gateway to which probe request will be sent.

backendHttpSettings

Reference of backend http setting of application gateway to be used for test probe.

host
  • string

Host name to send the probe to.

match

Criterion for classifying a healthy probe response.

path
  • string

Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.

pickHostNameFromBackendHttpSettings
  • boolean

Whether the host header should be picked from the backend http settings. Default value is false.

protocol

The protocol used for the probe.

timeout
  • integer

The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

Responses

Name Type Description
200 OK

Request successful.

202 Accepted

Accepted and the operation will complete asynchronously.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Test Backend Health

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/getBackendHealthOnDemand?api-version=2019-06-01
{
  "protocol": "Http",
  "pickHostNameFromBackendHttpSettings": true,
  "path": "/",
  "timeout": 30,
  "backendAddressPool": {
    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool"
  },
  "backendHttpSettings": {
    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings"
  }
}

Sample Response

{
  "backendAddressPool": {
    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool"
  },
  "backendHealthHttpSettings": {
    "backendHttpSettings": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings"
    },
    "servers": [
      {
        "address": "10.220.1.4",
        "health": "Up"
      },
      {
        "address": "10.220.1.5",
        "health": "Up"
      }
    ]
  }
}

Definitions

ApplicationGatewayBackendAddress

Backend address of an application gateway.

ApplicationGatewayBackendAddressPool

Backend Address Pool of an application gateway.

ApplicationGatewayBackendHealthHttpSettings

Application gateway BackendHealthHttp settings.

ApplicationGatewayBackendHealthOnDemand

Result of on demand test probe.

ApplicationGatewayBackendHealthServer

Application gateway backendhealth http settings.

ApplicationGatewayBackendHealthServerHealth

Health of backend server.

ApplicationGatewayBackendHttpSettings

Backend address pool settings of an application gateway.

ApplicationGatewayConnectionDraining

Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.

ApplicationGatewayCookieBasedAffinity

Cookie based affinity.

ApplicationGatewayOnDemandProbe

Details of on demand test probe request.

ApplicationGatewayProbeHealthResponseMatch

Application gateway probe health response match.

ApplicationGatewayProtocol

Application Gateway protocol.

ApplicationSecurityGroup

An application security group in a resource group.

BackendAddressPool

Pool of backend IP addresses.

DdosSettings

Contains the DDoS protection settings of the public IP.

DdosSettingsProtectionCoverage

The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

Delegation

Details the service to which the subnet is delegated.

FrontendIPConfiguration

Frontend IP address of the load balancer.

InboundNatRule

Inbound NAT rule of the load balancer.

IPAllocationMethod

IP address allocation method.

IPConfiguration

IP configuration.

IPConfigurationProfile

IP configuration profile child resource.

IpTag

Contains the IpTag associated with the object.

IPVersion

IP address version.

NetworkInterface

A network interface in a resource group.

NetworkInterfaceDnsSettings

DNS settings of a network interface.

NetworkInterfaceIPConfiguration

IPConfiguration in a network interface.

NetworkInterfaceTapConfiguration

Tap configuration in a Network Interface.

NetworkSecurityGroup

NetworkSecurityGroup resource.

PrivateEndpoint

Private endpoint resource.

PrivateLinkServiceConnection

PrivateLinkServiceConnection resource.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

ProvisioningState

The current provisioning state.

PublicIPAddress

Public IP address resource.

PublicIPAddressDnsSettings

Contains FQDN of the DNS record associated with the public IP address.

PublicIPAddressSku

SKU of a public IP address.

PublicIPAddressSkuName

Name of a public IP address SKU.

ResourceNavigationLink

ResourceNavigationLink resource.

Route

Route resource.

RouteNextHopType

The type of Azure hop the packet should be sent to.

RouteTable

Route table resource.

SecurityRule

Network security rule.

SecurityRuleAccess

Whether network traffic is allowed or denied.

SecurityRuleDirection

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.

SecurityRuleProtocol

Network protocol this rule applies to.

ServiceAssociationLink

ServiceAssociationLink resource.

ServiceEndpointPolicy

Service End point policy resource.

ServiceEndpointPolicyDefinition

Service Endpoint policy definitions.

ServiceEndpointPropertiesFormat

The service endpoint properties.

Subnet

Subnet in a virtual network resource.

SubResource

Reference to another subresource.

TransportProtocol

The transport protocol for the endpoint.

VirtualNetworkTap

Virtual Network Tap resource.

ApplicationGatewayBackendAddress

Backend address of an application gateway.

Name Type Description
fqdn
  • string

Fully qualified domain name (FQDN).

ipAddress
  • string

IP address.

ApplicationGatewayBackendAddressPool

Backend Address Pool of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the backend address pool that is unique within an Application Gateway.

properties.backendAddresses

Backend addresses.

properties.backendIPConfigurations

Collection of references to IPs defined in network interfaces.

properties.provisioningState
  • string

Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

type
  • string

Type of the resource.

ApplicationGatewayBackendHealthHttpSettings

Application gateway BackendHealthHttp settings.

Name Type Description
backendHttpSettings

Reference of an ApplicationGatewayBackendHttpSettings resource.

servers

List of ApplicationGatewayBackendHealthServer resources.

ApplicationGatewayBackendHealthOnDemand

Result of on demand test probe.

Name Type Description
backendAddressPool

Reference of an ApplicationGatewayBackendAddressPool resource.

backendHealthHttpSettings

Application gateway BackendHealthHttp settings.

ApplicationGatewayBackendHealthServer

Application gateway backendhealth http settings.

Name Type Description
address
  • string

IP address or FQDN of backend server.

health

Health of backend server.

healthProbeLog
  • string

Health Probe Log.

ipConfiguration

Reference of IP configuration of backend server.

ApplicationGatewayBackendHealthServerHealth

Health of backend server.

Name Type Description
Down
  • string
Draining
  • string
Partial
  • string
Unknown
  • string
Up
  • string

ApplicationGatewayBackendHttpSettings

Backend address pool settings of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the backend http settings that is unique within an Application Gateway.

properties.affinityCookieName
  • string

Cookie name to use for the affinity cookie.

properties.authenticationCertificates

Array of references to application gateway authentication certificates.

properties.connectionDraining

Connection draining of the backend http settings resource.

properties.cookieBasedAffinity

Cookie based affinity.

properties.hostName
  • string

Host header to be sent to the backend servers.

properties.path
  • string

Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.

properties.pickHostNameFromBackendAddress
  • boolean

Whether to pick host header should be picked from the host name of the backend server. Default value is false.

properties.port
  • integer

The destination port on the backend.

properties.probe

Probe resource of an application gateway.

properties.probeEnabled
  • boolean

Whether the probe is enabled. Default value is false.

properties.protocol

The protocol used to communicate with the backend.

properties.provisioningState
  • string

Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.requestTimeout
  • integer

Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.

properties.trustedRootCertificates

Array of references to application gateway trusted root certificates.

type
  • string

Type of the resource.

ApplicationGatewayConnectionDraining

Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.

Name Type Description
drainTimeoutInSec
  • integer

The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.

enabled
  • boolean

Whether connection draining is enabled or not.

ApplicationGatewayCookieBasedAffinity

Cookie based affinity.

Name Type Description
Disabled
  • string
Enabled
  • string

ApplicationGatewayOnDemandProbe

Details of on demand test probe request.

Name Type Description
backendAddressPool

Reference of backend pool of application gateway to which probe request will be sent.

backendHttpSettings

Reference of backend http setting of application gateway to be used for test probe.

host
  • string

Host name to send the probe to.

match

Criterion for classifying a healthy probe response.

path
  • string

Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.

pickHostNameFromBackendHttpSettings
  • boolean

Whether the host header should be picked from the backend http settings. Default value is false.

protocol

The protocol used for the probe.

timeout
  • integer

The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

ApplicationGatewayProbeHealthResponseMatch

Application gateway probe health response match.

Name Type Description
body
  • string

Body that must be contained in the health response. Default value is empty.

statusCodes
  • string[]

Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.

ApplicationGatewayProtocol

Application Gateway protocol.

Name Type Description
Http
  • string
Https
  • string

ApplicationSecurityGroup

An application security group in a resource group.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.provisioningState
  • string

The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'.

properties.resourceGuid
  • string

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.

tags
  • object

Resource tags.

type
  • string

Resource type.

BackendAddressPool

Pool of backend IP addresses.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Gets name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.

properties.backendIPConfigurations

Gets collection of references to IP addresses defined in network interfaces.

properties.loadBalancingRules

Gets load balancing rules that use this backend address pool.

properties.outboundRule

Gets outbound rules that use this backend address pool.

properties.outboundRules

Gets outbound rules that use this backend address pool.

properties.provisioningState
  • string

Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

type
  • string

Type of the resource.

DdosSettings

Contains the DDoS protection settings of the public IP.

Name Type Description
ddosCustomPolicy

The DDoS custom policy associated with the public IP.

protectionCoverage

The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

DdosSettingsProtectionCoverage

The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

Name Type Description
Basic
  • string
Standard
  • string

Delegation

Details the service to which the subnet is delegated.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a subnet. This name can be used to access the resource.

properties.actions
  • string[]

Describes the actions permitted to the service upon delegation.

properties.provisioningState
  • string

The provisioning state of the resource.

properties.serviceName
  • string

The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).

FrontendIPConfiguration

Frontend IP address of the load balancer.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.

properties.inboundNatPools

Read only. Inbound pools URIs that use this frontend IP.

properties.inboundNatRules

Read only. Inbound rules URIs that use this frontend IP.

properties.loadBalancingRules

Gets load balancing rules URIs that use this frontend IP.

properties.outboundRules

Read only. Outbound rules URIs that use this frontend IP.

properties.privateIPAddress
  • string

The private IP address of the IP configuration.

properties.privateIPAddressVersion

It represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.

properties.privateIPAllocationMethod

The Private IP allocation method.

properties.provisioningState
  • string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.publicIPAddress

The reference of the Public IP resource.

properties.publicIPPrefix

The reference of the Public IP Prefix resource.

properties.subnet

The reference of the subnet resource.

type
  • string

Type of the resource.

zones
  • string[]

A list of availability zones denoting the IP allocated for the resource needs to come from.

InboundNatRule

Inbound NAT rule of the load balancer.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Gets name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.

properties.backendIPConfiguration

A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP.

properties.backendPort
  • integer

The port used for the internal endpoint. Acceptable values range from 1 to 65535.

properties.enableFloatingIP
  • boolean

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

properties.enableTcpReset
  • boolean

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

properties.frontendIPConfiguration

A reference to frontend IP addresses.

properties.frontendPort
  • integer

The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.

properties.idleTimeoutInMinutes
  • integer

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

properties.protocol

The reference to the transport protocol used by the load balancing rule.

properties.provisioningState
  • string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

type
  • string

Type of the resource.

IPAllocationMethod

IP address allocation method.

Name Type Description
Dynamic
  • string
Static
  • string

IPConfiguration

IP configuration.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.privateIPAddress
  • string

The private IP address of the IP configuration.

properties.privateIPAllocationMethod

The private IP address allocation method.

properties.provisioningState
  • string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.publicIPAddress

The reference of the public IP resource.

properties.subnet

The reference of the subnet resource.

IPConfigurationProfile

IP configuration profile child resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource. This name can be used to access the resource.

properties.provisioningState
  • string

The provisioning state of the resource.

properties.subnet

The reference of the subnet resource to create a container network interface ip configuration.

type
  • string

Sub Resource type.

IpTag

Contains the IpTag associated with the object.

Name Type Description
ipTagType
  • string

Gets or sets the ipTag type: Example FirstPartyUsage.

tag
  • string

Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc.

IPVersion

IP address version.

Name Type Description
IPv4
  • string
IPv6
  • string

NetworkInterface

A network interface in a resource group.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.dnsSettings

The DNS settings in network interface.

properties.enableAcceleratedNetworking
  • boolean

If the network interface is accelerated networking enabled.

properties.enableIPForwarding
  • boolean

Indicates whether IP forwarding is enabled on this network interface.

properties.hostedWorkloads
  • string[]

A list of references to linked BareMetal resources.

properties.ipConfigurations

A list of IPConfigurations of the network interface.

properties.macAddress
  • string

The MAC address of the network interface.

properties.networkSecurityGroup

The reference of the NetworkSecurityGroup resource.

properties.primary
  • boolean

Gets whether this is a primary network interface on a virtual machine.

properties.privateEndpoint

A reference to the private endpoint to which the network interface is linked.

properties.provisioningState
  • string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.resourceGuid
  • string

The resource GUID property of the network interface resource.

properties.tapConfigurations

A list of TapConfigurations of the network interface.

properties.virtualMachine

The reference of a virtual machine.

tags
  • object

Resource tags.

type
  • string

Resource type.

NetworkInterfaceDnsSettings

DNS settings of a network interface.

Name Type Description
appliedDnsServers
  • string[]

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.

dnsServers
  • string[]

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.

internalDnsNameLabel
  • string

Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.

internalDomainNameSuffix
  • string

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.

internalFqdn
  • string

Fully qualified DNS name supporting internal communications between VMs in the same virtual network.

NetworkInterfaceIPConfiguration

IPConfiguration in a network interface.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.applicationGatewayBackendAddressPools

The reference of ApplicationGatewayBackendAddressPool resource.

properties.applicationSecurityGroups

Application security groups in which the IP configuration is included.

properties.loadBalancerBackendAddressPools

The reference of LoadBalancerBackendAddressPool resource.

properties.loadBalancerInboundNatRules

A list of references of LoadBalancerInboundNatRules.

properties.primary
  • boolean

Gets whether this is a primary customer address on the network interface.

properties.privateIPAddress
  • string

Private IP address of the IP configuration.

properties.privateIPAddressVersion

Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.

properties.privateIPAllocationMethod

The private IP address allocation method.

properties.provisioningState
  • string

The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.publicIPAddress

Public IP address bound to the IP configuration.

properties.subnet

Subnet bound to the IP configuration.

properties.virtualNetworkTaps

The reference to Virtual Network Taps.

NetworkInterfaceTapConfiguration

Tap configuration in a Network Interface.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.provisioningState
  • string

The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.virtualNetworkTap

The reference of the Virtual Network Tap resource.

type
  • string

Sub Resource type.

NetworkSecurityGroup

NetworkSecurityGroup resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.defaultSecurityRules

The default security rules of network security group.

properties.networkInterfaces

A collection of references to network interfaces.

properties.provisioningState
  • string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.resourceGuid
  • string

The resource GUID property of the network security group resource.

properties.securityRules

A collection of security rules of the network security group.

properties.subnets

A collection of references to subnets.

tags
  • object

Resource tags.

type
  • string

Resource type.

PrivateEndpoint

Private endpoint resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.manualPrivateLinkServiceConnections

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.

properties.networkInterfaces

Gets an array of references to the network interfaces created for this private endpoint.

properties.privateLinkServiceConnections

A grouping of information about the connection to the remote resource.

properties.provisioningState

The provisioning state of the private endpoint.

properties.subnet

The ID of the subnet from which the private IP will be allocated.

tags
  • object

Resource tags.

type
  • string

Resource type.

PrivateLinkServiceConnection

PrivateLinkServiceConnection resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.groupIds
  • string[]

The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.

properties.privateLinkServiceConnectionState

A collection of read-only information about the state of the connection to the remote resource.

properties.privateLinkServiceId
  • string

The resource id of private link service.

properties.provisioningState

The provisioning state of the private link service connection.

properties.requestMessage
  • string

A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.

type
  • string

The resource type.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Name Type Description
actionRequired
  • string

A message indicating if changes on the service provider require any updates on the consumer.

description
  • string

The reason for approval/rejection of the connection.

status
  • string

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ProvisioningState

The current provisioning state.

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

PublicIPAddress

Public IP address resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.ddosSettings

The DDoS protection custom policy associated with the public IP address.

properties.dnsSettings

The FQDN of the DNS record associated with the public IP address.

properties.idleTimeoutInMinutes
  • integer

The idle timeout of the public IP address.

properties.ipAddress
  • string

The IP address associated with the public IP address resource.

properties.ipConfiguration

The IP configuration associated with the public IP address.

properties.ipTags

The list of tags associated with the public IP address.

properties.provisioningState
  • string

The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.publicIPAddressVersion

The public IP address version.

properties.publicIPAllocationMethod

The public IP address allocation method.

properties.publicIPPrefix

The Public IP Prefix this Public IP Address should be allocated from.

properties.resourceGuid
  • string

The resource GUID property of the public IP resource.

sku

The public IP address SKU.

tags
  • object

Resource tags.

type
  • string

Resource type.

zones
  • string[]

A list of availability zones denoting the IP allocated for the resource needs to come from.

PublicIPAddressDnsSettings

Contains FQDN of the DNS record associated with the public IP address.

Name Type Description
domainNameLabel
  • string

Gets or sets 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.

fqdn
  • string

Gets the FQDN, 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.

reverseFqdn
  • string

Gets or Sets 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.

PublicIPAddressSku

SKU of a public IP address.

Name Type Description
name

Name of a public IP address SKU.

PublicIPAddressSkuName

Name of a public IP address SKU.

Name Type Description
Basic
  • string
Standard
  • string

ResourceNavigationLink resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource navigation link identifier.

name
  • string

Name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.link
  • string

Link to the external resource.

properties.linkedResourceType
  • string

Resource type of the linked resource.

properties.provisioningState
  • string

Provisioning state of the ResourceNavigationLink resource.

type
  • string

Resource type.

Route

Route resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.addressPrefix
  • string

The destination CIDR to which the route applies.

properties.nextHopIpAddress
  • string

The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

properties.nextHopType

The type of Azure hop the packet should be sent to.

properties.provisioningState
  • string

The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

RouteNextHopType

The type of Azure hop the packet should be sent to.

Name Type Description
Internet
  • string
None
  • string
VirtualAppliance
  • string
VirtualNetworkGateway
  • string
VnetLocal
  • string

RouteTable

Route table resource.

Name Type Description
etag
  • string

Gets a unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.disableBgpRoutePropagation
  • boolean

Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.

properties.provisioningState
  • string

The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.routes

Collection of routes contained within a route table.

properties.subnets

A collection of references to subnets.

tags
  • object

Resource tags.

type
  • string

Resource type.

SecurityRule

Network security rule.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.access

The network traffic is allowed or denied.

properties.description
  • string

A description for this rule. Restricted to 140 chars.

properties.destinationAddressPrefix
  • string

The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.

properties.destinationAddressPrefixes
  • string[]

The destination address prefixes. CIDR or destination IP ranges.

properties.destinationApplicationSecurityGroups

The application security group specified as destination.

properties.destinationPortRange
  • string

The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.

properties.destinationPortRanges
  • string[]

The destination port ranges.

properties.direction

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.

properties.priority
  • integer

The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.

properties.protocol

Network protocol this rule applies to.

properties.provisioningState
  • string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.sourceAddressPrefix
  • string

The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.

properties.sourceAddressPrefixes
  • string[]

The CIDR or source IP ranges.

properties.sourceApplicationSecurityGroups

The application security group specified as source.

properties.sourcePortRange
  • string

The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.

properties.sourcePortRanges
  • string[]

The source port ranges.

SecurityRuleAccess

Whether network traffic is allowed or denied.

Name Type Description
Allow
  • string
Deny
  • string

SecurityRuleDirection

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.

Name Type Description
Inbound
  • string
Outbound
  • string

SecurityRuleProtocol

Network protocol this rule applies to.

Name Type Description
*
  • string
Esp
  • string
Icmp
  • string
Tcp
  • string
Udp
  • string

ServiceAssociationLink resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.allowDelete
  • boolean

If true, the resource can be deleted.

properties.link
  • string

Link to the external resource.

properties.linkedResourceType
  • string

Resource type of the linked resource.

properties.locations
  • string[]

A list of locations.

properties.provisioningState
  • string

Provisioning state of the ServiceAssociationLink resource.

type
  • string

Resource type.

ServiceEndpointPolicy

Service End point policy resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.provisioningState
  • string

The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.resourceGuid
  • string

The resource GUID property of the service endpoint policy resource.

properties.serviceEndpointPolicyDefinitions

A collection of service endpoint policy definitions of the service endpoint policy.

properties.subnets

A collection of references to subnets.

tags
  • object

Resource tags.

type
  • string

Resource type.

ServiceEndpointPolicyDefinition

Service Endpoint policy definitions.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.description
  • string

A description for this rule. Restricted to 140 chars.

properties.provisioningState
  • string

The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.service
  • string

Service endpoint name.

properties.serviceResources
  • string[]

A list of service resources.

ServiceEndpointPropertiesFormat

The service endpoint properties.

Name Type Description
locations
  • string[]

A list of locations.

provisioningState
  • string

The provisioning state of the resource.

service
  • string

The type of the endpoint service.

Subnet

Subnet in a virtual network resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.addressPrefix
  • string

The address prefix for the subnet.

properties.addressPrefixes
  • string[]

List of address prefixes for the subnet.

properties.delegations

Gets an array of references to the delegations on the subnet.

properties.ipConfigurationProfiles

Array of IP configuration profiles which reference this subnet.

properties.ipConfigurations

Gets an array of references to the network interface IP configurations using subnet.

properties.natGateway

Nat gateway associated with this subnet.

properties.networkSecurityGroup

The reference of the NetworkSecurityGroup resource.

properties.privateEndpointNetworkPolicies
  • string

Enable or Disable apply network policies on private end point in the subnet.

properties.privateEndpoints

An array of references to private endpoints.

properties.privateLinkServiceNetworkPolicies
  • string

Enable or Disable apply network policies on private link service in the subnet.

properties.provisioningState
  • string

The provisioning state of the resource.

properties.purpose
  • string

A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties.

properties.resourceNavigationLinks

Gets an array of references to the external resources using subnet.

properties.routeTable

The reference of the RouteTable resource.

properties.serviceAssociationLinks

Gets an array of references to services injecting into this subnet.

properties.serviceEndpointPolicies

An array of service endpoint policies.

properties.serviceEndpoints

An array of service endpoints.

SubResource

Reference to another subresource.

Name Type Description
id
  • string

Resource ID.

TransportProtocol

The transport protocol for the endpoint.

Name Type Description
All
  • string
Tcp
  • string
Udp
  • string

VirtualNetworkTap

Virtual Network Tap resource.

Name Type Description
etag
  • string

Gets a unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.destinationLoadBalancerFrontEndIPConfiguration

The reference to the private IP address on the internal Load Balancer that will receive the tap.

properties.destinationNetworkInterfaceIPConfiguration

The reference to the private IP Address of the collector nic that will receive the tap.

properties.destinationPort
  • integer

The VXLAN destination port that will receive the tapped traffic.

properties.networkInterfaceTapConfigurations

Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped.

properties.provisioningState
  • string

The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'.

properties.resourceGuid
  • string

The resourceGuid property of the virtual network tap.

tags
  • object

Resource tags.

type
  • string

Resource type.