Microsoft.Network (stable:2024-05-01)

2025/05/13 • 12 updated methods

LoadBalancers_Get (updated)
Description Gets the specified load balancer.
Reference Link ¶

⚶ Changes

{
  "#id": "LoadBalancers_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "backendAddressPools": {
              "$properties": {
                "properties": [
                  {
                    "backendIPConfigurations": {
                      "$properties": [
                        {
                          "#name": "properties",
                          "Type": {
                            "new": "string",
                            "old": "object"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "inboundNatRules": {
              "$properties": {
                "properties": [
                  {
                    "backendIPConfiguration": [
                      {
                        "#name": "properties",
                        "Type": {
                          "new": "string",
                          "old": "object"
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}
{
resourceGroupName: string ,
loadBalancerName: string ,
api-version: string ,
subscriptionId: string ,
$expand: string ,
}

⚐ Response (200)

{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
frontendIPConfigurations:
[
{
properties:
{
inboundNatRules:
[
{
id: string ,
}
,
]
,
inboundNatPools:
[
{
id: string ,
}
,
]
,
outboundRules:
[
{
id: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet:
{
properties:
{
addressPrefix: string ,
addressPrefixes:
[
string ,
]
,
networkSecurityGroup:
{
properties:
{
flushConnection: boolean ,
securityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
defaultSecurityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
networkInterfaces:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
virtualMachine:
{
id: string ,
}
,
networkSecurityGroup: string ,
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
ipConfigurations:
[
{
properties:
{
gatewayLoadBalancer:
{
id: string ,
}
,
virtualNetworkTaps:
[
{
properties:
{
networkInterfaceTapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
destinationNetworkInterfaceIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
destinationLoadBalancerFrontEndIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
destinationPort: integer ,
}
,
etag: string ,
}
,
]
,
applicationGatewayBackendAddressPools:
[
{
properties:
{
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
backendAddresses:
[
{
fqdn: string ,
ipAddress: string ,
}
,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerInboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAddressPrefixLength: integer ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet: string ,
primary: boolean ,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
provisioningState: enum ,
privateLinkConnectionProperties:
{
groupId: string ,
requiredMemberName: string ,
fqdns:
[
string ,
]
,
}
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
tapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
dnsSettings:
{
dnsServers:
[
string ,
]
,
appliedDnsServers:
[
string ,
]
,
internalDnsNameLabel: string ,
internalFqdn: string ,
internalDomainNameSuffix: string ,
}
,
macAddress: string ,
primary: boolean ,
vnetEncryptionSupported: boolean ,
defaultOutboundConnectivityEnabled: boolean ,
enableAcceleratedNetworking: boolean ,
disableTcpStateTracking: boolean ,
enableIPForwarding: boolean ,
hostedWorkloads:
[
string ,
]
,
dscpConfiguration:
{
id: string ,
}
,
resourceGuid: string ,
provisioningState: enum ,
workloadType: string ,
nicType: enum ,
privateLinkService:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
loadBalancerFrontendIpConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
primary: boolean ,
provisioningState: enum ,
privateIPAddressVersion: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
destinationIPAddress: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
linkIdentifier: string ,
privateEndpointLocation: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
visibility: string ,
autoApproval: string ,
fqdns:
[
string ,
]
,
alias: string ,
enableProxyProtocol: boolean ,
}
,
etag: string ,
}
,
migrationPhase: enum ,
auxiliaryMode: enum ,
auxiliarySku: enum ,
}
,
etag: string ,
}
,
]
,
subnets:
[
string ,
]
,
flowLogs:
[
{
properties:
{
targetResourceId: string ,
targetResourceGuid: string ,
storageId: string ,
enabledFilteringCriteria: string ,
enabled: boolean ,
retentionPolicy:
{
days: integer ,
enabled: boolean ,
}
,
format:
{
type: enum ,
version: integer ,
}
,
flowAnalyticsConfiguration:
{
networkWatcherFlowAnalyticsConfiguration:
{
enabled: boolean ,
workspaceId: string ,
workspaceRegion: string ,
workspaceResourceId: string ,
trafficAnalyticsInterval: integer ,
}
,
}
,
provisioningState: enum ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
routeTable:
{
properties:
{
routes:
[
{
properties:
{
addressPrefix: string ,
nextHopType: enum ,
nextHopIpAddress: string ,
provisioningState: enum ,
hasBgpOverride: boolean ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
disableBgpRoutePropagation: boolean ,
provisioningState: enum ,
resourceGuid: string ,
}
,
etag: string ,
}
,
natGateway:
{
id: string ,
}
,
serviceEndpoints:
[
{
service: string ,
networkIdentifier:
{
id: string ,
}
,
locations:
[
string ,
]
,
provisioningState: enum ,
}
,
]
,
serviceEndpointPolicies:
[
{
properties:
{
serviceEndpointPolicyDefinitions:
[
{
properties:
{
description: string ,
service: string ,
serviceResources:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
resourceGuid: string ,
provisioningState: enum ,
serviceAlias: string ,
contextualServiceEndpointPolicies:
[
string ,
]
,
}
,
etag: string ,
kind: string ,
}
,
]
,
privateEndpoints:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
]
,
ipConfigurationProfiles:
[
{
properties:
{
subnet: string ,
provisioningState: enum ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
ipAllocations:
[
{
id: string ,
}
,
]
,
resourceNavigationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
}
,
name: string ,
id: string ,
etag: string ,
type: string ,
}
,
]
,
serviceAssociationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
allowDelete: boolean ,
locations:
[
string ,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
delegations:
[
{
properties:
{
serviceName: string ,
actions:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
purpose: string ,
provisioningState: enum ,
privateEndpointNetworkPolicies: enum ,
privateLinkServiceNetworkPolicies: enum ,
applicationGatewayIPConfigurations:
[
{
properties:
{
subnet:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
sharingScope: enum ,
defaultOutboundAccess: boolean ,
ipamPoolPrefixAllocations:
[
{
pool:
{
id: string ,
}
,
numberOfIpAddresses: string ,
allocatedAddressPrefixes:
[
string ,
]
,
}
,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
publicIPPrefix:
{
id: string ,
}
,
gatewayLoadBalancer:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
backendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendAddressPool:
{
id: string ,
}
,
backendAddressPools:
[
{
id: string ,
}
,
]
,
probe:
{
id: string ,
}
,
protocol: enum ,
loadDistribution: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
disableOutboundSnat: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
probes:
[
{
properties:
{
loadBalancingRules:
[
{
id: string ,
}
,
]
,
protocol: enum ,
port: integer ,
intervalInSeconds: integer ,
noHealthyBackendsBehavior: enum ,
numberOfProbes: integer ,
probeThreshold: integer ,
requestPath: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatPools:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
protocol: enum ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
outboundRules:
[
{
properties:
{
allocatedOutboundPorts: integer ,
frontendIPConfigurations:
[
{
id: string ,
}
,
]
,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
protocol: enum ,
enableTcpReset: boolean ,
idleTimeoutInMinutes: integer ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
LoadBalancers_CreateOrUpdate (updated)
Description Creates or updates a load balancer.
Reference Link ¶

⚶ Changes

{
  "#id": "LoadBalancers_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "backendAddressPools": {
              "$properties": {
                "properties": [
                  {
                    "backendIPConfigurations": {
                      "$properties": [
                        {
                          "#name": "properties",
                          "Type": {
                            "new": "string",
                            "old": "object"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "inboundNatRules": {
              "$properties": {
                "properties": [
                  {
                    "backendIPConfiguration": [
                      {
                        "#name": "properties",
                        "Type": {
                          "new": "string",
                          "old": "object"
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "properties": [
          {
            "backendAddressPools": {
              "$properties": {
                "properties": [
                  {
                    "backendIPConfigurations": {
                      "$properties": [
                        {
                          "#name": "properties",
                          "Type": {
                            "new": "string",
                            "old": "object"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "inboundNatRules": {
              "$properties": {
                "properties": [
                  {
                    "backendIPConfiguration": [
                      {
                        "#name": "properties",
                        "Type": {
                          "new": "string",
                          "old": "object"
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    },
    "200": {
      "$properties": {
        "properties": [
          {
            "backendAddressPools": {
              "$properties": {
                "properties": [
                  {
                    "backendIPConfigurations": {
                      "$properties": [
                        {
                          "#name": "properties",
                          "Type": {
                            "new": "string",
                            "old": "object"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "inboundNatRules": {
              "$properties": {
                "properties": [
                  {
                    "backendIPConfiguration": [
                      {
                        "#name": "properties",
                        "Type": {
                          "new": "string",
                          "old": "object"
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}
{
resourceGroupName: string ,
loadBalancerName: string ,
parameters:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
frontendIPConfigurations:
[
{
properties:
{
inboundNatRules:
[
{
id: string ,
}
,
]
,
inboundNatPools:
[
{
id: string ,
}
,
]
,
outboundRules:
[
{
id: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet:
{
properties:
{
addressPrefix: string ,
addressPrefixes:
[
string ,
]
,
networkSecurityGroup:
{
properties:
{
flushConnection: boolean ,
securityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
defaultSecurityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
networkInterfaces:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
virtualMachine:
{
id: string ,
}
,
networkSecurityGroup: string ,
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
ipConfigurations:
[
{
properties:
{
gatewayLoadBalancer:
{
id: string ,
}
,
virtualNetworkTaps:
[
{
properties:
{
networkInterfaceTapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
destinationNetworkInterfaceIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
destinationLoadBalancerFrontEndIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
destinationPort: integer ,
}
,
etag: string ,
}
,
]
,
applicationGatewayBackendAddressPools:
[
{
properties:
{
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
backendAddresses:
[
{
fqdn: string ,
ipAddress: string ,
}
,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerInboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAddressPrefixLength: integer ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet: string ,
primary: boolean ,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
provisioningState: enum ,
privateLinkConnectionProperties:
{
groupId: string ,
requiredMemberName: string ,
fqdns:
[
string ,
]
,
}
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
tapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
dnsSettings:
{
dnsServers:
[
string ,
]
,
appliedDnsServers:
[
string ,
]
,
internalDnsNameLabel: string ,
internalFqdn: string ,
internalDomainNameSuffix: string ,
}
,
macAddress: string ,
primary: boolean ,
vnetEncryptionSupported: boolean ,
defaultOutboundConnectivityEnabled: boolean ,
enableAcceleratedNetworking: boolean ,
disableTcpStateTracking: boolean ,
enableIPForwarding: boolean ,
hostedWorkloads:
[
string ,
]
,
dscpConfiguration:
{
id: string ,
}
,
resourceGuid: string ,
provisioningState: enum ,
workloadType: string ,
nicType: enum ,
privateLinkService:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
loadBalancerFrontendIpConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
primary: boolean ,
provisioningState: enum ,
privateIPAddressVersion: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
destinationIPAddress: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
linkIdentifier: string ,
privateEndpointLocation: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
visibility: string ,
autoApproval: string ,
fqdns:
[
string ,
]
,
alias: string ,
enableProxyProtocol: boolean ,
}
,
etag: string ,
}
,
migrationPhase: enum ,
auxiliaryMode: enum ,
auxiliarySku: enum ,
}
,
etag: string ,
}
,
]
,
subnets:
[
string ,
]
,
flowLogs:
[
{
properties:
{
targetResourceId: string ,
targetResourceGuid: string ,
storageId: string ,
enabledFilteringCriteria: string ,
enabled: boolean ,
retentionPolicy:
{
days: integer ,
enabled: boolean ,
}
,
format:
{
type: enum ,
version: integer ,
}
,
flowAnalyticsConfiguration:
{
networkWatcherFlowAnalyticsConfiguration:
{
enabled: boolean ,
workspaceId: string ,
workspaceRegion: string ,
workspaceResourceId: string ,
trafficAnalyticsInterval: integer ,
}
,
}
,
provisioningState: enum ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
routeTable:
{
properties:
{
routes:
[
{
properties:
{
addressPrefix: string ,
nextHopType: enum ,
nextHopIpAddress: string ,
provisioningState: enum ,
hasBgpOverride: boolean ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
disableBgpRoutePropagation: boolean ,
provisioningState: enum ,
resourceGuid: string ,
}
,
etag: string ,
}
,
natGateway:
{
id: string ,
}
,
serviceEndpoints:
[
{
service: string ,
networkIdentifier:
{
id: string ,
}
,
locations:
[
string ,
]
,
provisioningState: enum ,
}
,
]
,
serviceEndpointPolicies:
[
{
properties:
{
serviceEndpointPolicyDefinitions:
[
{
properties:
{
description: string ,
service: string ,
serviceResources:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
resourceGuid: string ,
provisioningState: enum ,
serviceAlias: string ,
contextualServiceEndpointPolicies:
[
string ,
]
,
}
,
etag: string ,
kind: string ,
}
,
]
,
privateEndpoints:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
]
,
ipConfigurationProfiles:
[
{
properties:
{
subnet: string ,
provisioningState: enum ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
ipAllocations:
[
{
id: string ,
}
,
]
,
resourceNavigationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
}
,
name: string ,
id: string ,
etag: string ,
type: string ,
}
,
]
,
serviceAssociationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
allowDelete: boolean ,
locations:
[
string ,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
delegations:
[
{
properties:
{
serviceName: string ,
actions:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
purpose: string ,
provisioningState: enum ,
privateEndpointNetworkPolicies: enum ,
privateLinkServiceNetworkPolicies: enum ,
applicationGatewayIPConfigurations:
[
{
properties:
{
subnet:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
sharingScope: enum ,
defaultOutboundAccess: boolean ,
ipamPoolPrefixAllocations:
[
{
pool:
{
id: string ,
}
,
numberOfIpAddresses: string ,
allocatedAddressPrefixes:
[
string ,
]
,
}
,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
publicIPPrefix:
{
id: string ,
}
,
gatewayLoadBalancer:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
backendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendAddressPool:
{
id: string ,
}
,
backendAddressPools:
[
{
id: string ,
}
,
]
,
probe:
{
id: string ,
}
,
protocol: enum ,
loadDistribution: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
disableOutboundSnat: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
probes:
[
{
properties:
{
loadBalancingRules:
[
{
id: string ,
}
,
]
,
protocol: enum ,
port: integer ,
intervalInSeconds: integer ,
noHealthyBackendsBehavior: enum ,
numberOfProbes: integer ,
probeThreshold: integer ,
requestPath: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatPools:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
protocol: enum ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
outboundRules:
[
{
properties:
{
allocatedOutboundPorts: integer ,
frontendIPConfigurations:
[
{
id: string ,
}
,
]
,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
protocol: enum ,
enableTcpReset: boolean ,
idleTimeoutInMinutes: integer ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (201)

{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
frontendIPConfigurations:
[
{
properties:
{
inboundNatRules:
[
{
id: string ,
}
,
]
,
inboundNatPools:
[
{
id: string ,
}
,
]
,
outboundRules:
[
{
id: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet:
{
properties:
{
addressPrefix: string ,
addressPrefixes:
[
string ,
]
,
networkSecurityGroup:
{
properties:
{
flushConnection: boolean ,
securityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
defaultSecurityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
networkInterfaces:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
virtualMachine:
{
id: string ,
}
,
networkSecurityGroup: string ,
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
ipConfigurations:
[
{
properties:
{
gatewayLoadBalancer:
{
id: string ,
}
,
virtualNetworkTaps:
[
{
properties:
{
networkInterfaceTapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
destinationNetworkInterfaceIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
destinationLoadBalancerFrontEndIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
destinationPort: integer ,
}
,
etag: string ,
}
,
]
,
applicationGatewayBackendAddressPools:
[
{
properties:
{
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
backendAddresses:
[
{
fqdn: string ,
ipAddress: string ,
}
,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerInboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAddressPrefixLength: integer ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet: string ,
primary: boolean ,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
provisioningState: enum ,
privateLinkConnectionProperties:
{
groupId: string ,
requiredMemberName: string ,
fqdns:
[
string ,
]
,
}
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
tapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
dnsSettings:
{
dnsServers:
[
string ,
]
,
appliedDnsServers:
[
string ,
]
,
internalDnsNameLabel: string ,
internalFqdn: string ,
internalDomainNameSuffix: string ,
}
,
macAddress: string ,
primary: boolean ,
vnetEncryptionSupported: boolean ,
defaultOutboundConnectivityEnabled: boolean ,
enableAcceleratedNetworking: boolean ,
disableTcpStateTracking: boolean ,
enableIPForwarding: boolean ,
hostedWorkloads:
[
string ,
]
,
dscpConfiguration:
{
id: string ,
}
,
resourceGuid: string ,
provisioningState: enum ,
workloadType: string ,
nicType: enum ,
privateLinkService:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
loadBalancerFrontendIpConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
primary: boolean ,
provisioningState: enum ,
privateIPAddressVersion: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
destinationIPAddress: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
linkIdentifier: string ,
privateEndpointLocation: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
visibility: string ,
autoApproval: string ,
fqdns:
[
string ,
]
,
alias: string ,
enableProxyProtocol: boolean ,
}
,
etag: string ,
}
,
migrationPhase: enum ,
auxiliaryMode: enum ,
auxiliarySku: enum ,
}
,
etag: string ,
}
,
]
,
subnets:
[
string ,
]
,
flowLogs:
[
{
properties:
{
targetResourceId: string ,
targetResourceGuid: string ,
storageId: string ,
enabledFilteringCriteria: string ,
enabled: boolean ,
retentionPolicy:
{
days: integer ,
enabled: boolean ,
}
,
format:
{
type: enum ,
version: integer ,
}
,
flowAnalyticsConfiguration:
{
networkWatcherFlowAnalyticsConfiguration:
{
enabled: boolean ,
workspaceId: string ,
workspaceRegion: string ,
workspaceResourceId: string ,
trafficAnalyticsInterval: integer ,
}
,
}
,
provisioningState: enum ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
routeTable:
{
properties:
{
routes:
[
{
properties:
{
addressPrefix: string ,
nextHopType: enum ,
nextHopIpAddress: string ,
provisioningState: enum ,
hasBgpOverride: boolean ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
disableBgpRoutePropagation: boolean ,
provisioningState: enum ,
resourceGuid: string ,
}
,
etag: string ,
}
,
natGateway:
{
id: string ,
}
,
serviceEndpoints:
[
{
service: string ,
networkIdentifier:
{
id: string ,
}
,
locations:
[
string ,
]
,
provisioningState: enum ,
}
,
]
,
serviceEndpointPolicies:
[
{
properties:
{
serviceEndpointPolicyDefinitions:
[
{
properties:
{
description: string ,
service: string ,
serviceResources:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
resourceGuid: string ,
provisioningState: enum ,
serviceAlias: string ,
contextualServiceEndpointPolicies:
[
string ,
]
,
}
,
etag: string ,
kind: string ,
}
,
]
,
privateEndpoints:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
]
,
ipConfigurationProfiles:
[
{
properties:
{
subnet: string ,
provisioningState: enum ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
ipAllocations:
[
{
id: string ,
}
,
]
,
resourceNavigationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
}
,
name: string ,
id: string ,
etag: string ,
type: string ,
}
,
]
,
serviceAssociationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
allowDelete: boolean ,
locations:
[
string ,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
delegations:
[
{
properties:
{
serviceName: string ,
actions:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
purpose: string ,
provisioningState: enum ,
privateEndpointNetworkPolicies: enum ,
privateLinkServiceNetworkPolicies: enum ,
applicationGatewayIPConfigurations:
[
{
properties:
{
subnet:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
sharingScope: enum ,
defaultOutboundAccess: boolean ,
ipamPoolPrefixAllocations:
[
{
pool:
{
id: string ,
}
,
numberOfIpAddresses: string ,
allocatedAddressPrefixes:
[
string ,
]
,
}
,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
publicIPPrefix:
{
id: string ,
}
,
gatewayLoadBalancer:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
backendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendAddressPool:
{
id: string ,
}
,
backendAddressPools:
[
{
id: string ,
}
,
]
,
probe:
{
id: string ,
}
,
protocol: enum ,
loadDistribution: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
disableOutboundSnat: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
probes:
[
{
properties:
{
loadBalancingRules:
[
{
id: string ,
}
,
]
,
protocol: enum ,
port: integer ,
intervalInSeconds: integer ,
noHealthyBackendsBehavior: enum ,
numberOfProbes: integer ,
probeThreshold: integer ,
requestPath: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatPools:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
protocol: enum ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
outboundRules:
[
{
properties:
{
allocatedOutboundPorts: integer ,
frontendIPConfigurations:
[
{
id: string ,
}
,
]
,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
protocol: enum ,
enableTcpReset: boolean ,
idleTimeoutInMinutes: integer ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}

⚐ Response (200)

{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
frontendIPConfigurations:
[
{
properties:
{
inboundNatRules:
[
{
id: string ,
}
,
]
,
inboundNatPools:
[
{
id: string ,
}
,
]
,
outboundRules:
[
{
id: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet:
{
properties:
{
addressPrefix: string ,
addressPrefixes:
[
string ,
]
,
networkSecurityGroup:
{
properties:
{
flushConnection: boolean ,
securityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
defaultSecurityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
networkInterfaces:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
virtualMachine:
{
id: string ,
}
,
networkSecurityGroup: string ,
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
ipConfigurations:
[
{
properties:
{
gatewayLoadBalancer:
{
id: string ,
}
,
virtualNetworkTaps:
[
{
properties:
{
networkInterfaceTapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
destinationNetworkInterfaceIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
destinationLoadBalancerFrontEndIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
destinationPort: integer ,
}
,
etag: string ,
}
,
]
,
applicationGatewayBackendAddressPools:
[
{
properties:
{
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
backendAddresses:
[
{
fqdn: string ,
ipAddress: string ,
}
,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerInboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAddressPrefixLength: integer ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet: string ,
primary: boolean ,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
provisioningState: enum ,
privateLinkConnectionProperties:
{
groupId: string ,
requiredMemberName: string ,
fqdns:
[
string ,
]
,
}
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
tapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
dnsSettings:
{
dnsServers:
[
string ,
]
,
appliedDnsServers:
[
string ,
]
,
internalDnsNameLabel: string ,
internalFqdn: string ,
internalDomainNameSuffix: string ,
}
,
macAddress: string ,
primary: boolean ,
vnetEncryptionSupported: boolean ,
defaultOutboundConnectivityEnabled: boolean ,
enableAcceleratedNetworking: boolean ,
disableTcpStateTracking: boolean ,
enableIPForwarding: boolean ,
hostedWorkloads:
[
string ,
]
,
dscpConfiguration:
{
id: string ,
}
,
resourceGuid: string ,
provisioningState: enum ,
workloadType: string ,
nicType: enum ,
privateLinkService:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
loadBalancerFrontendIpConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
primary: boolean ,
provisioningState: enum ,
privateIPAddressVersion: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
destinationIPAddress: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
linkIdentifier: string ,
privateEndpointLocation: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
visibility: string ,
autoApproval: string ,
fqdns:
[
string ,
]
,
alias: string ,
enableProxyProtocol: boolean ,
}
,
etag: string ,
}
,
migrationPhase: enum ,
auxiliaryMode: enum ,
auxiliarySku: enum ,
}
,
etag: string ,
}
,
]
,
subnets:
[
string ,
]
,
flowLogs:
[
{
properties:
{
targetResourceId: string ,
targetResourceGuid: string ,
storageId: string ,
enabledFilteringCriteria: string ,
enabled: boolean ,
retentionPolicy:
{
days: integer ,
enabled: boolean ,
}
,
format:
{
type: enum ,
version: integer ,
}
,
flowAnalyticsConfiguration:
{
networkWatcherFlowAnalyticsConfiguration:
{
enabled: boolean ,
workspaceId: string ,
workspaceRegion: string ,
workspaceResourceId: string ,
trafficAnalyticsInterval: integer ,
}
,
}
,
provisioningState: enum ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
routeTable:
{
properties:
{
routes:
[
{
properties:
{
addressPrefix: string ,
nextHopType: enum ,
nextHopIpAddress: string ,
provisioningState: enum ,
hasBgpOverride: boolean ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
disableBgpRoutePropagation: boolean ,
provisioningState: enum ,
resourceGuid: string ,
}
,
etag: string ,
}
,
natGateway:
{
id: string ,
}
,
serviceEndpoints:
[
{
service: string ,
networkIdentifier:
{
id: string ,
}
,
locations:
[
string ,
]
,
provisioningState: enum ,
}
,
]
,
serviceEndpointPolicies:
[
{
properties:
{
serviceEndpointPolicyDefinitions:
[
{
properties:
{
description: string ,
service: string ,
serviceResources:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
resourceGuid: string ,
provisioningState: enum ,
serviceAlias: string ,
contextualServiceEndpointPolicies:
[
string ,
]
,
}
,
etag: string ,
kind: string ,
}
,
]
,
privateEndpoints:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
]
,
ipConfigurationProfiles:
[
{
properties:
{
subnet: string ,
provisioningState: enum ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
ipAllocations:
[
{
id: string ,
}
,
]
,
resourceNavigationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
}
,
name: string ,
id: string ,
etag: string ,
type: string ,
}
,
]
,
serviceAssociationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
allowDelete: boolean ,
locations:
[
string ,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
delegations:
[
{
properties:
{
serviceName: string ,
actions:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
purpose: string ,
provisioningState: enum ,
privateEndpointNetworkPolicies: enum ,
privateLinkServiceNetworkPolicies: enum ,
applicationGatewayIPConfigurations:
[
{
properties:
{
subnet:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
sharingScope: enum ,
defaultOutboundAccess: boolean ,
ipamPoolPrefixAllocations:
[
{
pool:
{
id: string ,
}
,
numberOfIpAddresses: string ,
allocatedAddressPrefixes:
[
string ,
]
,
}
,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
publicIPPrefix:
{
id: string ,
}
,
gatewayLoadBalancer:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
backendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendAddressPool:
{
id: string ,
}
,
backendAddressPools:
[
{
id: string ,
}
,
]
,
probe:
{
id: string ,
}
,
protocol: enum ,
loadDistribution: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
disableOutboundSnat: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
probes:
[
{
properties:
{
loadBalancingRules:
[
{
id: string ,
}
,
]
,
protocol: enum ,
port: integer ,
intervalInSeconds: integer ,
noHealthyBackendsBehavior: enum ,
numberOfProbes: integer ,
probeThreshold: integer ,
requestPath: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatPools:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
protocol: enum ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
outboundRules:
[
{
properties:
{
allocatedOutboundPorts: integer ,
frontendIPConfigurations:
[
{
id: string ,
}
,
]
,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
protocol: enum ,
enableTcpReset: boolean ,
idleTimeoutInMinutes: integer ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
LoadBalancers_UpdateTags (updated)
Description Updates a load balancer tags.
Reference Link ¶

⚶ Changes

{
  "#id": "LoadBalancers_UpdateTags",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "backendAddressPools": {
              "$properties": {
                "properties": [
                  {
                    "backendIPConfigurations": {
                      "$properties": [
                        {
                          "#name": "properties",
                          "Type": {
                            "new": "string",
                            "old": "object"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "inboundNatRules": {
              "$properties": {
                "properties": [
                  {
                    "backendIPConfiguration": [
                      {
                        "#name": "properties",
                        "Type": {
                          "new": "string",
                          "old": "object"
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}
{
resourceGroupName: string ,
loadBalancerName: string ,
parameters:
{
tags: object ,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
frontendIPConfigurations:
[
{
properties:
{
inboundNatRules:
[
{
id: string ,
}
,
]
,
inboundNatPools:
[
{
id: string ,
}
,
]
,
outboundRules:
[
{
id: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet:
{
properties:
{
addressPrefix: string ,
addressPrefixes:
[
string ,
]
,
networkSecurityGroup:
{
properties:
{
flushConnection: boolean ,
securityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
defaultSecurityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
networkInterfaces:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
virtualMachine:
{
id: string ,
}
,
networkSecurityGroup: string ,
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
ipConfigurations:
[
{
properties:
{
gatewayLoadBalancer:
{
id: string ,
}
,
virtualNetworkTaps:
[
{
properties:
{
networkInterfaceTapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
destinationNetworkInterfaceIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
destinationLoadBalancerFrontEndIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
destinationPort: integer ,
}
,
etag: string ,
}
,
]
,
applicationGatewayBackendAddressPools:
[
{
properties:
{
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
backendAddresses:
[
{
fqdn: string ,
ipAddress: string ,
}
,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerInboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAddressPrefixLength: integer ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet: string ,
primary: boolean ,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
provisioningState: enum ,
privateLinkConnectionProperties:
{
groupId: string ,
requiredMemberName: string ,
fqdns:
[
string ,
]
,
}
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
tapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
dnsSettings:
{
dnsServers:
[
string ,
]
,
appliedDnsServers:
[
string ,
]
,
internalDnsNameLabel: string ,
internalFqdn: string ,
internalDomainNameSuffix: string ,
}
,
macAddress: string ,
primary: boolean ,
vnetEncryptionSupported: boolean ,
defaultOutboundConnectivityEnabled: boolean ,
enableAcceleratedNetworking: boolean ,
disableTcpStateTracking: boolean ,
enableIPForwarding: boolean ,
hostedWorkloads:
[
string ,
]
,
dscpConfiguration:
{
id: string ,
}
,
resourceGuid: string ,
provisioningState: enum ,
workloadType: string ,
nicType: enum ,
privateLinkService:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
loadBalancerFrontendIpConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
primary: boolean ,
provisioningState: enum ,
privateIPAddressVersion: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
destinationIPAddress: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
linkIdentifier: string ,
privateEndpointLocation: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
visibility: string ,
autoApproval: string ,
fqdns:
[
string ,
]
,
alias: string ,
enableProxyProtocol: boolean ,
}
,
etag: string ,
}
,
migrationPhase: enum ,
auxiliaryMode: enum ,
auxiliarySku: enum ,
}
,
etag: string ,
}
,
]
,
subnets:
[
string ,
]
,
flowLogs:
[
{
properties:
{
targetResourceId: string ,
targetResourceGuid: string ,
storageId: string ,
enabledFilteringCriteria: string ,
enabled: boolean ,
retentionPolicy:
{
days: integer ,
enabled: boolean ,
}
,
format:
{
type: enum ,
version: integer ,
}
,
flowAnalyticsConfiguration:
{
networkWatcherFlowAnalyticsConfiguration:
{
enabled: boolean ,
workspaceId: string ,
workspaceRegion: string ,
workspaceResourceId: string ,
trafficAnalyticsInterval: integer ,
}
,
}
,
provisioningState: enum ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
routeTable:
{
properties:
{
routes:
[
{
properties:
{
addressPrefix: string ,
nextHopType: enum ,
nextHopIpAddress: string ,
provisioningState: enum ,
hasBgpOverride: boolean ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
disableBgpRoutePropagation: boolean ,
provisioningState: enum ,
resourceGuid: string ,
}
,
etag: string ,
}
,
natGateway:
{
id: string ,
}
,
serviceEndpoints:
[
{
service: string ,
networkIdentifier:
{
id: string ,
}
,
locations:
[
string ,
]
,
provisioningState: enum ,
}
,
]
,
serviceEndpointPolicies:
[
{
properties:
{
serviceEndpointPolicyDefinitions:
[
{
properties:
{
description: string ,
service: string ,
serviceResources:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
resourceGuid: string ,
provisioningState: enum ,
serviceAlias: string ,
contextualServiceEndpointPolicies:
[
string ,
]
,
}
,
etag: string ,
kind: string ,
}
,
]
,
privateEndpoints:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
]
,
ipConfigurationProfiles:
[
{
properties:
{
subnet: string ,
provisioningState: enum ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
ipAllocations:
[
{
id: string ,
}
,
]
,
resourceNavigationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
}
,
name: string ,
id: string ,
etag: string ,
type: string ,
}
,
]
,
serviceAssociationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
allowDelete: boolean ,
locations:
[
string ,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
delegations:
[
{
properties:
{
serviceName: string ,
actions:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
purpose: string ,
provisioningState: enum ,
privateEndpointNetworkPolicies: enum ,
privateLinkServiceNetworkPolicies: enum ,
applicationGatewayIPConfigurations:
[
{
properties:
{
subnet:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
sharingScope: enum ,
defaultOutboundAccess: boolean ,
ipamPoolPrefixAllocations:
[
{
pool:
{
id: string ,
}
,
numberOfIpAddresses: string ,
allocatedAddressPrefixes:
[
string ,
]
,
}
,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
publicIPPrefix:
{
id: string ,
}
,
gatewayLoadBalancer:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
backendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendAddressPool:
{
id: string ,
}
,
backendAddressPools:
[
{
id: string ,
}
,
]
,
probe:
{
id: string ,
}
,
protocol: enum ,
loadDistribution: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
disableOutboundSnat: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
probes:
[
{
properties:
{
loadBalancingRules:
[
{
id: string ,
}
,
]
,
protocol: enum ,
port: integer ,
intervalInSeconds: integer ,
noHealthyBackendsBehavior: enum ,
numberOfProbes: integer ,
probeThreshold: integer ,
requestPath: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatPools:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
protocol: enum ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
outboundRules:
[
{
properties:
{
allocatedOutboundPorts: integer ,
frontendIPConfigurations:
[
{
id: string ,
}
,
]
,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
protocol: enum ,
enableTcpReset: boolean ,
idleTimeoutInMinutes: integer ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
LoadBalancers_ListAll (updated)
Description Gets all the load balancers in a subscription.
Reference Link ¶

⚶ Changes

{
  "#id": "LoadBalancers_ListAll",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "backendAddressPools": {
                  "$properties": {
                    "properties": [
                      {
                        "backendIPConfigurations": {
                          "$properties": [
                            {
                              "#name": "properties",
                              "Type": {
                                "new": "string",
                                "old": "object"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              },
              {
                "inboundNatRules": {
                  "$properties": {
                    "properties": [
                      {
                        "backendIPConfiguration": [
                          {
                            "#name": "properties",
                            "Type": {
                              "new": "string",
                              "old": "object"
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/loadBalancers
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
frontendIPConfigurations:
[
{
properties:
{
inboundNatRules:
[
{
id: string ,
}
,
]
,
inboundNatPools:
[
{
id: string ,
}
,
]
,
outboundRules:
[
{
id: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet:
{
properties:
{
addressPrefix: string ,
addressPrefixes:
[
string ,
]
,
networkSecurityGroup:
{
properties:
{
flushConnection: boolean ,
securityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
defaultSecurityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
networkInterfaces:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
virtualMachine:
{
id: string ,
}
,
networkSecurityGroup: string ,
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
ipConfigurations:
[
{
properties:
{
gatewayLoadBalancer:
{
id: string ,
}
,
virtualNetworkTaps:
[
{
properties:
{
networkInterfaceTapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
destinationNetworkInterfaceIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
destinationLoadBalancerFrontEndIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
destinationPort: integer ,
}
,
etag: string ,
}
,
]
,
applicationGatewayBackendAddressPools:
[
{
properties:
{
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
backendAddresses:
[
{
fqdn: string ,
ipAddress: string ,
}
,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerInboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAddressPrefixLength: integer ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet: string ,
primary: boolean ,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
provisioningState: enum ,
privateLinkConnectionProperties:
{
groupId: string ,
requiredMemberName: string ,
fqdns:
[
string ,
]
,
}
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
tapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
dnsSettings:
{
dnsServers:
[
string ,
]
,
appliedDnsServers:
[
string ,
]
,
internalDnsNameLabel: string ,
internalFqdn: string ,
internalDomainNameSuffix: string ,
}
,
macAddress: string ,
primary: boolean ,
vnetEncryptionSupported: boolean ,
defaultOutboundConnectivityEnabled: boolean ,
enableAcceleratedNetworking: boolean ,
disableTcpStateTracking: boolean ,
enableIPForwarding: boolean ,
hostedWorkloads:
[
string ,
]
,
dscpConfiguration:
{
id: string ,
}
,
resourceGuid: string ,
provisioningState: enum ,
workloadType: string ,
nicType: enum ,
privateLinkService:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
loadBalancerFrontendIpConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
primary: boolean ,
provisioningState: enum ,
privateIPAddressVersion: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
destinationIPAddress: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
linkIdentifier: string ,
privateEndpointLocation: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
visibility: string ,
autoApproval: string ,
fqdns:
[
string ,
]
,
alias: string ,
enableProxyProtocol: boolean ,
}
,
etag: string ,
}
,
migrationPhase: enum ,
auxiliaryMode: enum ,
auxiliarySku: enum ,
}
,
etag: string ,
}
,
]
,
subnets:
[
string ,
]
,
flowLogs:
[
{
properties:
{
targetResourceId: string ,
targetResourceGuid: string ,
storageId: string ,
enabledFilteringCriteria: string ,
enabled: boolean ,
retentionPolicy:
{
days: integer ,
enabled: boolean ,
}
,
format:
{
type: enum ,
version: integer ,
}
,
flowAnalyticsConfiguration:
{
networkWatcherFlowAnalyticsConfiguration:
{
enabled: boolean ,
workspaceId: string ,
workspaceRegion: string ,
workspaceResourceId: string ,
trafficAnalyticsInterval: integer ,
}
,
}
,
provisioningState: enum ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
routeTable:
{
properties:
{
routes:
[
{
properties:
{
addressPrefix: string ,
nextHopType: enum ,
nextHopIpAddress: string ,
provisioningState: enum ,
hasBgpOverride: boolean ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
disableBgpRoutePropagation: boolean ,
provisioningState: enum ,
resourceGuid: string ,
}
,
etag: string ,
}
,
natGateway:
{
id: string ,
}
,
serviceEndpoints:
[
{
service: string ,
networkIdentifier:
{
id: string ,
}
,
locations:
[
string ,
]
,
provisioningState: enum ,
}
,
]
,
serviceEndpointPolicies:
[
{
properties:
{
serviceEndpointPolicyDefinitions:
[
{
properties:
{
description: string ,
service: string ,
serviceResources:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
resourceGuid: string ,
provisioningState: enum ,
serviceAlias: string ,
contextualServiceEndpointPolicies:
[
string ,
]
,
}
,
etag: string ,
kind: string ,
}
,
]
,
privateEndpoints:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
]
,
ipConfigurationProfiles:
[
{
properties:
{
subnet: string ,
provisioningState: enum ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
ipAllocations:
[
{
id: string ,
}
,
]
,
resourceNavigationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
}
,
name: string ,
id: string ,
etag: string ,
type: string ,
}
,
]
,
serviceAssociationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
allowDelete: boolean ,
locations:
[
string ,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
delegations:
[
{
properties:
{
serviceName: string ,
actions:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
purpose: string ,
provisioningState: enum ,
privateEndpointNetworkPolicies: enum ,
privateLinkServiceNetworkPolicies: enum ,
applicationGatewayIPConfigurations:
[
{
properties:
{
subnet:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
sharingScope: enum ,
defaultOutboundAccess: boolean ,
ipamPoolPrefixAllocations:
[
{
pool:
{
id: string ,
}
,
numberOfIpAddresses: string ,
allocatedAddressPrefixes:
[
string ,
]
,
}
,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
publicIPPrefix:
{
id: string ,
}
,
gatewayLoadBalancer:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
backendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendAddressPool:
{
id: string ,
}
,
backendAddressPools:
[
{
id: string ,
}
,
]
,
probe:
{
id: string ,
}
,
protocol: enum ,
loadDistribution: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
disableOutboundSnat: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
probes:
[
{
properties:
{
loadBalancingRules:
[
{
id: string ,
}
,
]
,
protocol: enum ,
port: integer ,
intervalInSeconds: integer ,
noHealthyBackendsBehavior: enum ,
numberOfProbes: integer ,
probeThreshold: integer ,
requestPath: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatPools:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
protocol: enum ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
outboundRules:
[
{
properties:
{
allocatedOutboundPorts: integer ,
frontendIPConfigurations:
[
{
id: string ,
}
,
]
,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
protocol: enum ,
enableTcpReset: boolean ,
idleTimeoutInMinutes: integer ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
LoadBalancers_List (updated)
Description Gets all the load balancers in a resource group.
Reference Link ¶

⚶ Changes

{
  "#id": "LoadBalancers_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "backendAddressPools": {
                  "$properties": {
                    "properties": [
                      {
                        "backendIPConfigurations": {
                          "$properties": [
                            {
                              "#name": "properties",
                              "Type": {
                                "new": "string",
                                "old": "object"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              },
              {
                "inboundNatRules": {
                  "$properties": {
                    "properties": [
                      {
                        "backendIPConfiguration": [
                          {
                            "#name": "properties",
                            "Type": {
                              "new": "string",
                              "old": "object"
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers
{
resourceGroupName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
frontendIPConfigurations:
[
{
properties:
{
inboundNatRules:
[
{
id: string ,
}
,
]
,
inboundNatPools:
[
{
id: string ,
}
,
]
,
outboundRules:
[
{
id: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet:
{
properties:
{
addressPrefix: string ,
addressPrefixes:
[
string ,
]
,
networkSecurityGroup:
{
properties:
{
flushConnection: boolean ,
securityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
defaultSecurityRules:
[
{
properties:
{
description: string ,
protocol: enum ,
sourcePortRange: string ,
destinationPortRange: string ,
sourceAddressPrefix: string ,
sourceAddressPrefixes:
[
string ,
]
,
sourceApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
destinationAddressPrefix: string ,
destinationAddressPrefixes:
[
string ,
]
,
destinationApplicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
access: enum ,
priority: integer ,
direction: enum ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
networkInterfaces:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
virtualMachine:
{
id: string ,
}
,
networkSecurityGroup: string ,
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
ipConfigurations:
[
{
properties:
{
gatewayLoadBalancer:
{
id: string ,
}
,
virtualNetworkTaps:
[
{
properties:
{
networkInterfaceTapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
destinationNetworkInterfaceIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
destinationLoadBalancerFrontEndIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
destinationPort: integer ,
}
,
etag: string ,
}
,
]
,
applicationGatewayBackendAddressPools:
[
{
properties:
{
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
backendAddresses:
[
{
fqdn: string ,
ipAddress: string ,
}
,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancerInboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
privateIPAddress: string ,
privateIPAddressPrefixLength: integer ,
privateIPAllocationMethod: enum ,
privateIPAddressVersion: enum ,
subnet: string ,
primary: boolean ,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
provisioningState: enum ,
privateLinkConnectionProperties:
{
groupId: string ,
requiredMemberName: string ,
fqdns:
[
string ,
]
,
}
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
tapConfigurations:
[
{
properties:
{
virtualNetworkTap: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
dnsSettings:
{
dnsServers:
[
string ,
]
,
appliedDnsServers:
[
string ,
]
,
internalDnsNameLabel: string ,
internalFqdn: string ,
internalDomainNameSuffix: string ,
}
,
macAddress: string ,
primary: boolean ,
vnetEncryptionSupported: boolean ,
defaultOutboundConnectivityEnabled: boolean ,
enableAcceleratedNetworking: boolean ,
disableTcpStateTracking: boolean ,
enableIPForwarding: boolean ,
hostedWorkloads:
[
string ,
]
,
dscpConfiguration:
{
id: string ,
}
,
resourceGuid: string ,
provisioningState: enum ,
workloadType: string ,
nicType: enum ,
privateLinkService:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
loadBalancerFrontendIpConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
primary: boolean ,
provisioningState: enum ,
privateIPAddressVersion: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
destinationIPAddress: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
linkIdentifier: string ,
privateEndpointLocation: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
visibility: string ,
autoApproval: string ,
fqdns:
[
string ,
]
,
alias: string ,
enableProxyProtocol: boolean ,
}
,
etag: string ,
}
,
migrationPhase: enum ,
auxiliaryMode: enum ,
auxiliarySku: enum ,
}
,
etag: string ,
}
,
]
,
subnets:
[
string ,
]
,
flowLogs:
[
{
properties:
{
targetResourceId: string ,
targetResourceGuid: string ,
storageId: string ,
enabledFilteringCriteria: string ,
enabled: boolean ,
retentionPolicy:
{
days: integer ,
enabled: boolean ,
}
,
format:
{
type: enum ,
version: integer ,
}
,
flowAnalyticsConfiguration:
{
networkWatcherFlowAnalyticsConfiguration:
{
enabled: boolean ,
workspaceId: string ,
workspaceRegion: string ,
workspaceResourceId: string ,
trafficAnalyticsInterval: integer ,
}
,
}
,
provisioningState: enum ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
routeTable:
{
properties:
{
routes:
[
{
properties:
{
addressPrefix: string ,
nextHopType: enum ,
nextHopIpAddress: string ,
provisioningState: enum ,
hasBgpOverride: boolean ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
disableBgpRoutePropagation: boolean ,
provisioningState: enum ,
resourceGuid: string ,
}
,
etag: string ,
}
,
natGateway:
{
id: string ,
}
,
serviceEndpoints:
[
{
service: string ,
networkIdentifier:
{
id: string ,
}
,
locations:
[
string ,
]
,
provisioningState: enum ,
}
,
]
,
serviceEndpointPolicies:
[
{
properties:
{
serviceEndpointPolicyDefinitions:
[
{
properties:
{
description: string ,
service: string ,
serviceResources:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
subnets:
[
string ,
]
,
resourceGuid: string ,
provisioningState: enum ,
serviceAlias: string ,
contextualServiceEndpointPolicies:
[
string ,
]
,
}
,
etag: string ,
kind: string ,
}
,
]
,
privateEndpoints:
[
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
properties:
{
subnet: string ,
networkInterfaces:
[
string ,
]
,
provisioningState: enum ,
privateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
manualPrivateLinkServiceConnections:
[
{
properties:
{
provisioningState: enum ,
privateLinkServiceId: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customDnsConfigs:
[
{
fqdn: string ,
ipAddresses:
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
[
{
properties:
{
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
groupId: string ,
memberName: string ,
privateIPAddress: string ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
customNetworkInterfaceName: string ,
}
,
etag: string ,
}
,
]
,
ipConfigurations:
[
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
]
,
ipConfigurationProfiles:
[
{
properties:
{
subnet: string ,
provisioningState: enum ,
}
,
name: string ,
type: string ,
etag: string ,
}
,
]
,
ipAllocations:
[
{
id: string ,
}
,
]
,
resourceNavigationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
}
,
name: string ,
id: string ,
etag: string ,
type: string ,
}
,
]
,
serviceAssociationLinks:
[
{
properties:
{
linkedResourceType: string ,
link: string ,
provisioningState: enum ,
allowDelete: boolean ,
locations:
[
string ,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
delegations:
[
{
properties:
{
serviceName: string ,
actions:
[
string ,
]
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
purpose: string ,
provisioningState: enum ,
privateEndpointNetworkPolicies: enum ,
privateLinkServiceNetworkPolicies: enum ,
applicationGatewayIPConfigurations:
[
{
properties:
{
subnet:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
sharingScope: enum ,
defaultOutboundAccess: boolean ,
ipamPoolPrefixAllocations:
[
{
pool:
{
id: string ,
}
,
numberOfIpAddresses: string ,
allocatedAddressPrefixes:
[
string ,
]
,
}
,
]
,
}
,
name: string ,
etag: string ,
type: string ,
}
,
publicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties:
{
publicIPAllocationMethod: enum ,
publicIPAddressVersion: enum ,
ipConfiguration:
{
properties:
{
privateIPAddress: string ,
privateIPAllocationMethod: enum ,
subnet: string ,
publicIPAddress: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
}
,
dnsSettings:
{
domainNameLabel: string ,
domainNameLabelScope: enum ,
fqdn: string ,
reverseFqdn: string ,
}
,
ddosSettings:
{
protectionMode: enum ,
ddosProtectionPlan:
{
id: string ,
}
,
}
,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
ipAddress: string ,
publicIPPrefix:
{
id: string ,
}
,
idleTimeoutInMinutes: integer ,
resourceGuid: string ,
provisioningState: enum ,
servicePublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
natGateway:
{
sku:
{
name: enum ,
}
,
properties:
{
idleTimeoutInMinutes: integer ,
publicIpAddresses:
[
{
id: string ,
}
,
]
,
publicIpPrefixes:
[
{
id: string ,
}
,
]
,
subnets:
[
{
id: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
zones:
[
string ,
]
,
etag: string ,
}
,
migrationPhase: enum ,
linkedPublicIPAddress:
{
extendedLocation:
{
name: string ,
type: enum ,
}
,
sku:
{
name: enum ,
tier: enum ,
}
,
properties: string ,
etag: string ,
zones:
[
string ,
]
,
}
,
deleteOption: enum ,
}
,
etag: string ,
zones:
[
string ,
]
,
}
,
publicIPPrefix:
{
id: string ,
}
,
gatewayLoadBalancer:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
zones:
[
string ,
]
,
}
,
]
,
backendAddressPools:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendAddressPool:
{
id: string ,
}
,
backendAddressPools:
[
{
id: string ,
}
,
]
,
probe:
{
id: string ,
}
,
protocol: enum ,
loadDistribution: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
disableOutboundSnat: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
probes:
[
{
properties:
{
loadBalancingRules:
[
{
id: string ,
}
,
]
,
protocol: enum ,
port: integer ,
intervalInSeconds: integer ,
noHealthyBackendsBehavior: enum ,
numberOfProbes: integer ,
probeThreshold: integer ,
requestPath: string ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatRules:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
inboundNatPools:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
protocol: enum ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
outboundRules:
[
{
properties:
{
allocatedOutboundPorts: integer ,
frontendIPConfigurations:
[
{
id: string ,
}
,
]
,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
protocol: enum ,
enableTcpReset: boolean ,
idleTimeoutInMinutes: integer ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
resourceGuid: string ,
provisioningState: enum ,
}
,
etag: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
LoadBalancerBackendAddressPools_List (updated)
Description Gets all the load balancer backed address pools.
Reference Link ¶

⚶ Changes

{
  "#id": "LoadBalancerBackendAddressPools_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "backendIPConfigurations": {
                  "$properties": [
                    {
                      "#name": "properties",
                      "Type": {
                        "new": "string",
                        "old": "object"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools
{
resourceGroupName: string ,
loadBalancerName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
LoadBalancerBackendAddressPools_Get (updated)
Description Gets load balancer backend address pool.
Reference Link ¶

⚶ Changes

{
  "#id": "LoadBalancerBackendAddressPools_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "backendIPConfigurations": {
              "$properties": [
                {
                  "#name": "properties",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}
{
resourceGroupName: string ,
loadBalancerName: string ,
backendAddressPoolName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
LoadBalancerBackendAddressPools_CreateOrUpdate (updated)
Description Creates or updates a load balancer backend address pool.
Reference Link ¶

⚶ Changes

{
  "#id": "LoadBalancerBackendAddressPools_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "backendIPConfigurations": {
              "$properties": [
                {
                  "#name": "properties",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "properties": [
          {
            "backendIPConfigurations": {
              "$properties": [
                {
                  "#name": "properties",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "200": {
      "$properties": {
        "properties": [
          {
            "backendIPConfigurations": {
              "$properties": [
                {
                  "#name": "properties",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}
{
resourceGroupName: string ,
loadBalancerName: string ,
backendAddressPoolName: string ,
parameters:
{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (201)

{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}

⚐ Response (200)

{
properties:
{
location: string ,
tunnelInterfaces:
[
{
port: integer ,
identifier: integer ,
protocol: enum ,
type: enum ,
}
,
]
,
loadBalancerBackendAddresses:
[
{
properties:
{
virtualNetwork:
{
id: string ,
}
,
subnet:
{
id: string ,
}
,
ipAddress: string ,
networkInterfaceIPConfiguration:
{
id: string ,
}
,
loadBalancerFrontendIPConfiguration:
{
id: string ,
}
,
inboundNatRulesPortMapping:
[
{
inboundNatRuleName: string ,
frontendPort: integer ,
backendPort: integer ,
}
,
]
,
adminState: enum ,
}
,
name: string ,
}
,
]
,
backendIPConfigurations:
[
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
]
,
loadBalancingRules:
[
{
id: string ,
}
,
]
,
outboundRule:
{
id: string ,
}
,
outboundRules:
[
{
id: string ,
}
,
]
,
inboundNatRules:
[
{
id: string ,
}
,
]
,
provisioningState: enum ,
drainPeriodInSeconds: integer ,
virtualNetwork:
{
id: string ,
}
,
syncMode: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
InboundNatRules_List (updated)
Description Gets all the inbound NAT rules in a load balancer.
Reference Link ¶

⚶ Changes

{
  "#id": "InboundNatRules_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "backendIPConfiguration": [
                  {
                    "#name": "properties",
                    "Type": {
                      "new": "string",
                      "old": "object"
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules
{
resourceGroupName: string ,
loadBalancerName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
InboundNatRules_Get (updated)
Description Gets the specified load balancer inbound NAT rule.
Reference Link ¶

⚶ Changes

{
  "#id": "InboundNatRules_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "backendIPConfiguration": [
              {
                "#name": "properties",
                "Type": {
                  "new": "string",
                  "old": "object"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}
{
resourceGroupName: string ,
loadBalancerName: string ,
inboundNatRuleName: string ,
api-version: string ,
subscriptionId: string ,
$expand: string ,
}

⚐ Response (200)

{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
InboundNatRules_CreateOrUpdate (updated)
Description Creates or updates a load balancer inbound NAT rule.
Reference Link ¶

⚶ Changes

{
  "#id": "InboundNatRules_CreateOrUpdate",
  "$parameters": {
    "inboundNatRuleParameters": {
      "$properties": {
        "properties": [
          {
            "backendIPConfiguration": [
              {
                "#name": "properties",
                "Type": {
                  "new": "string",
                  "old": "object"
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "properties": [
          {
            "backendIPConfiguration": [
              {
                "#name": "properties",
                "Type": {
                  "new": "string",
                  "old": "object"
                }
              }
            ]
          }
        ]
      }
    },
    "200": {
      "$properties": {
        "properties": [
          {
            "backendIPConfiguration": [
              {
                "#name": "properties",
                "Type": {
                  "new": "string",
                  "old": "object"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}
{
resourceGroupName: string ,
loadBalancerName: string ,
inboundNatRuleName: string ,
inboundNatRuleParameters:
{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}
,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (201)

{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}

⚐ Response (200)

{
properties:
{
frontendIPConfiguration:
{
id: string ,
}
,
backendIPConfiguration:
{
properties: string ,
name: string ,
etag: string ,
type: string ,
}
,
protocol: enum ,
frontendPort: integer ,
backendPort: integer ,
idleTimeoutInMinutes: integer ,
enableFloatingIP: boolean ,
enableTcpReset: boolean ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
backendAddressPool:
{
id: string ,
}
,
provisioningState: enum ,
}
,
name: string ,
etag: string ,
type: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
LoadBalancerLoadBalancingRules_Health (updated)
Description Get health details of a load balancing rule.
Reference Link ¶

⚶ Changes

{
  "#id": "LoadBalancerLoadBalancingRules_Health",
  "$responses": {
    "200": {
      "$properties": {
        "loadBalancerBackendAddresses": {
          "$properties": [
            {
              "#name": "networkInterfaceIPConfigurationId",
              "Description": {
                "new": "Resource ID of the Network Interface IP Configuration.",
                "old": "The id of the network interface ip configuration belonging to the backend address"
              },
              "Type": {
                "new": "string",
                "old": "object"
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules/{loadBalancingRuleName}/health
{
groupName: string ,
loadBalancerName: string ,
loadBalancingRuleName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
up: integer ,
down: integer ,
loadBalancerBackendAddresses:
[
{
ipAddress: string ,
networkInterfaceIPConfigurationId: string ,
state: string ,
reason: string ,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}