Load Balancers - Get

Gets the specified load balancer.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}?api-version=2019-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}?api-version=2019-07-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.

loadBalancerName
path True
  • string

The name of the load balancer.

api-version
query True
  • string

Client API version.

$expand
query
  • string

Expands referenced resources.

Responses

Name Type Description
200 OK

Request successful. The operation returns the resulting LoadBalancer resource.

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

Get load balancer

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2019-07-01

Sample Response

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "type": "Microsoft.Network/loadBalancers",
  "location": "westus",
  "sku": {
    "name": "Basic"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "privateIPAddressVersion": "IPv4",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "type": "Microsoft.Network/loadBalancers/backendAddressPools",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "type": "Microsoft.Network/loadBalancers/loadBalancingRules",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": true,
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
    "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "type": "Microsoft.Network/loadBalancers/probes",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
    "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "etag": "W/\"00000000-0000-0000-0000-00000000\"",
        "type": "Microsoft.Network/loadBalancers/inboundNatRules",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "enableTcpReset": true
        }
      }
    ],
    "inboundNatPools": []
  }
}

Definitions

ApplicationGatewayBackendAddress

Backend address of an application gateway.

ApplicationGatewayBackendAddressPool

Backend Address Pool of an application gateway.

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.

InboundNatPool

Inbound NAT pool 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.

LoadBalancer

LoadBalancer resource.

LoadBalancerOutboundRuleProtocol

The protocol for the outbound rule in load balancer.

LoadBalancerSku

SKU of a load balancer.

LoadBalancerSkuName

Name of a load balancer SKU.

LoadBalancingRule

A load balancing rule for a load balancer.

LoadDistribution

The load distribution policy for this rule.

NetworkInterface

A network interface in a resource group.

NetworkInterfaceDnsSettings

DNS settings of a network interface.

NetworkInterfaceIPConfiguration

IPConfiguration in a network interface.

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

PrivateLinkConnection properties for the network interface.

NetworkInterfaceTapConfiguration

Tap configuration in a Network Interface.

NetworkSecurityGroup

NetworkSecurityGroup resource.

OutboundRule

Outbound rule of the load balancer.

PrivateEndpoint

Private endpoint resource.

PrivateLinkServiceConnection

PrivateLinkServiceConnection resource.

PrivateLinkServiceConnectionState

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

Probe

A load balancer probe.

ProbeProtocol

The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.

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

The provisioning state of the backend address pool resource.

type
  • string

Type of the resource.

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

The provisioning state of the application security group resource.

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

The 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

An array of references to IP addresses defined in network interfaces.

properties.loadBalancingRules

An array of references to load balancing rules that use this backend address pool.

properties.outboundRule

A reference to an outbound rule that uses this backend address pool.

properties.outboundRules

An array of references to outbound rules that use this backend address pool.

properties.provisioningState

The provisioning state of the backend address pool resource.

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

The provisioning state of the service delegation 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

An array of references to inbound pools that use this frontend IP.

properties.inboundNatRules

An array of references to inbound rules that use this frontend IP.

properties.loadBalancingRules

An array of references to load balancing rules that use this frontend IP.

properties.outboundRules

An array of references to outbound rules that use this frontend IP.

properties.privateIPAddress
  • string

The private IP address of the IP configuration.

properties.privateIPAddressVersion

Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.

properties.privateIPAllocationMethod

The Private IP allocation method.

properties.provisioningState

The provisioning state of the frontend IP configuration resource.

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.

InboundNatPool

Inbound NAT pool 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 inbound NAT pools used by the load balancer. This name can be used to access the resource.

properties.backendPort
  • integer

The port used for internal connections on the endpoint. Acceptable values are between 1 and 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.frontendPortRangeEnd
  • integer

The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.

properties.frontendPortRangeStart
  • integer

The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 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 inbound NAT pool.

properties.provisioningState

The provisioning state of the inbound NAT pool resource.

type
  • string

Type of the resource.

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

The 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

The provisioning state of the inbound NAT rule resource.

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

The provisioning state of the IP configuration resource.

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

The provisioning state of the IP configuration profile 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

The IP tag type. Example: FirstPartyUsage.

tag
  • string

The value of the IP tag associated with the public IP. Example: SQL.

IPVersion

IP address version.

Name Type Description
IPv4
  • string
IPv6
  • string

LoadBalancer

LoadBalancer 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.backendAddressPools

Collection of backend address pools used by a load balancer.

properties.frontendIPConfigurations

Object representing the frontend IPs to be used for the load balancer.

properties.inboundNatPools

Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.

properties.inboundNatRules

Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.

properties.loadBalancingRules

Object collection representing the load balancing rules Gets the provisioning.

properties.outboundRules

The outbound rules.

properties.probes

Collection of probe objects used in the load balancer.

properties.provisioningState

The provisioning state of the load balancer resource.

properties.resourceGuid
  • string

The resource GUID property of the load balancer resource.

sku

The load balancer SKU.

tags
  • object

Resource tags.

type
  • string

Resource type.

LoadBalancerOutboundRuleProtocol

The protocol for the outbound rule in load balancer.

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

LoadBalancerSku

SKU of a load balancer.

Name Type Description
name

Name of a load balancer SKU.

LoadBalancerSkuName

Name of a load balancer SKU.

Name Type Description
Basic
  • string
Standard
  • string

LoadBalancingRule

A load balancing rule for a 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 load balancing rules used by the load balancer. This name can be used to access the resource.

properties.backendAddressPool

A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.

properties.backendPort
  • integer

The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".

properties.disableOutboundSnat
  • boolean

Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.

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 are between 0 and 65534. Note that value 0 enables "Any Port".

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.loadDistribution

The load distribution policy for this rule.

properties.probe

The reference of the load balancer probe used by the load balancing rule.

properties.protocol

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

properties.provisioningState

The provisioning state of the load balancing rule resource.

type
  • string

Type of the resource.

LoadDistribution

The load distribution policy for this rule.

Name Type Description
Default
  • string
SourceIP
  • string
SourceIPProtocol
  • 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

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

The provisioning state of the network interface resource.

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

Whether this is a primary customer address on the network interface.

properties.privateIPAddress
  • string

Private IP address of the IP configuration.

properties.privateIPAddressVersion

Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.

properties.privateIPAllocationMethod

The private IP address allocation method.

properties.privateLinkConnectionProperties

PrivateLinkConnection properties for the network interface.

properties.provisioningState

The provisioning state of the network interface IP configuration.

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.

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

PrivateLinkConnection properties for the network interface.

Name Type Description
fqdns
  • string[]

List of FQDNs for current private link connection.

groupId
  • string

The group ID for current private link connection.

requiredMemberName
  • string

The required member name for current private link connection.

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

The provisioning state of the network interface tap configuration resource.

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

The provisioning state of the network security group resource.

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.

OutboundRule

Outbound 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

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

properties.allocatedOutboundPorts
  • integer

The number of outbound ports to be used for NAT.

properties.backendAddressPool

A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.

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.frontendIPConfigurations

The Frontend IP addresses of the load balancer.

properties.idleTimeoutInMinutes
  • integer

The timeout for the TCP idle connection.

properties.protocol

The protocol for the outbound rule in load balancer.

properties.provisioningState

The provisioning state of the outbound rule resource.

type
  • string

Type of the resource.

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

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 resource.

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 resource.

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.

Probe

A load balancer probe.

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 probes used by the load balancer. This name can be used to access the resource.

properties.intervalInSeconds
  • integer

The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.

properties.loadBalancingRules

The load balancer rules that use this probe.

properties.numberOfProbes
  • integer

The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.

properties.port
  • integer

The port for communicating the probe. Possible values range from 1 to 65535, inclusive.

properties.protocol

The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.

properties.provisioningState

The provisioning state of the probe resource.

properties.requestPath
  • string

The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.

type
  • string

Type of the resource.

ProbeProtocol

The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.

Name Type Description
Http
  • string
Https
  • string
Tcp
  • string

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

The provisioning state of the public IP address resource.

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 address 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

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

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.

reverseFqdn
  • string

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

The provisioning state of the resource navigation link 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

The provisioning state of the route resource.

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

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

Whether to disable the routes learned by BGP on that route table. True means disable.

properties.provisioningState

The provisioning state of the route table resource.

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

The provisioning state of the security rule resource.

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

The provisioning state of the service association link 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

The provisioning state of the service endpoint policy resource.

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

The provisioning state of the service endpoint policy definition resource.

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

The provisioning state of the service endpoint 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

An array of references to the delegations on the subnet.

properties.ipConfigurationProfiles

Array of IP configuration profiles which reference this subnet.

properties.ipConfigurations

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

The provisioning state of the subnet 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

An array of references to the external resources using subnet.

properties.routeTable

The reference of the RouteTable resource.

properties.serviceAssociationLinks

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

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

The provisioning state of the virtual network tap resource.

properties.resourceGuid
  • string

The resource GUID property of the virtual network tap resource.

tags
  • object

Resource tags.

type
  • string

Resource type.