Application Gateways - Get

Service:

Application Gateway

API Version:

2024-05-01

Gets the specified application gateway.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
applicationGatewayName	path	True	string	The name of the application gateway.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	ApplicationGateway	Request successful. The operation returns an ApplicationGateway resource.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get ApplicationGateway

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw?api-version=2024-05-01

Java

/**
 * Samples for ApplicationGateways GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ApplicationGatewayGet.json
     */
    /**
     * Sample code: Get ApplicationGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getApplicationGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getApplicationGateways().getByResourceGroupWithResponse("rg1",
            "appgw", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python application_gateway_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.application_gateways.get(
        resource_group_name="rg1",
        application_gateway_name="appgw",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ApplicationGatewayGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ApplicationGatewayGet.json
func ExampleApplicationGatewaysClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewApplicationGatewaysClient().Get(ctx, "rg1", "appgw", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ApplicationGateway = armnetwork.ApplicationGateway{
	// 	Name: to.Ptr("appgw"),
	// 	Type: to.Ptr("Microsoft.Network/applicationGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw"),
	// 	Location: to.Ptr("southcentralus"),
	// 	Properties: &armnetwork.ApplicationGatewayPropertiesFormat{
	// 		AuthenticationCertificates: []*armnetwork.ApplicationGatewayAuthenticationCertificate{
	// 		},
	// 		BackendAddressPools: []*armnetwork.ApplicationGatewayBackendAddressPool{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"),
	// 				Name: to.Ptr("appgwpool"),
	// 				Properties: &armnetwork.ApplicationGatewayBackendAddressPoolPropertiesFormat{
	// 					BackendAddresses: []*armnetwork.ApplicationGatewayBackendAddress{
	// 					},
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 			},
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1"),
	// 				Name: to.Ptr("appgwpool1"),
	// 				Properties: &armnetwork.ApplicationGatewayBackendAddressPoolPropertiesFormat{
	// 					BackendAddresses: []*armnetwork.ApplicationGatewayBackendAddress{
	// 						{
	// 						},
	// 						{
	// 					}},
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 		}},
	// 		BackendHTTPSettingsCollection: []*armnetwork.ApplicationGatewayBackendHTTPSettings{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"),
	// 				Name: to.Ptr("appgwbhs"),
	// 				Properties: &armnetwork.ApplicationGatewayBackendHTTPSettingsPropertiesFormat{
	// 					CookieBasedAffinity: to.Ptr(armnetwork.ApplicationGatewayCookieBasedAffinityDisabled),
	// 					Port: to.Ptr[int32](80),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					RequestTimeout: to.Ptr[int32](30),
	// 					Protocol: to.Ptr(armnetwork.ApplicationGatewayProtocolHTTP),
	// 				},
	// 		}},
	// 		FrontendIPConfigurations: []*armnetwork.ApplicationGatewayFrontendIPConfiguration{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"),
	// 				Name: to.Ptr("appgwfip"),
	// 				Properties: &armnetwork.ApplicationGatewayFrontendIPConfigurationPropertiesFormat{
	// 					PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					PublicIPAddress: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip"),
	// 					},
	// 				},
	// 		}},
	// 		FrontendPorts: []*armnetwork.ApplicationGatewayFrontendPort{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"),
	// 				Name: to.Ptr("appgwfp"),
	// 				Properties: &armnetwork.ApplicationGatewayFrontendPortPropertiesFormat{
	// 					Port: to.Ptr[int32](443),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 			},
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"),
	// 				Name: to.Ptr("appgwfp80"),
	// 				Properties: &armnetwork.ApplicationGatewayFrontendPortPropertiesFormat{
	// 					Port: to.Ptr[int32](80),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 		}},
	// 		GatewayIPConfigurations: []*armnetwork.ApplicationGatewayIPConfiguration{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc"),
	// 				Name: to.Ptr("appgwipc"),
	// 				Properties: &armnetwork.ApplicationGatewayIPConfigurationPropertiesFormat{
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					Subnet: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet"),
	// 					},
	// 				},
	// 		}},
	// 		GlobalConfiguration: &armnetwork.ApplicationGatewayGlobalConfiguration{
	// 			EnableRequestBuffering: to.Ptr(true),
	// 			EnableResponseBuffering: to.Ptr(true),
	// 		},
	// 		HTTPListeners: []*armnetwork.ApplicationGatewayHTTPListener{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"),
	// 				Name: to.Ptr("appgwhl"),
	// 				Properties: &armnetwork.ApplicationGatewayHTTPListenerPropertiesFormat{
	// 					FrontendIPConfiguration: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"),
	// 					},
	// 					FrontendPort: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"),
	// 					},
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					RequireServerNameIndication: to.Ptr(false),
	// 					SSLCertificate: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"),
	// 					},
	// 					SSLProfile: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1"),
	// 					},
	// 					Protocol: to.Ptr(armnetwork.ApplicationGatewayProtocolHTTPS),
	// 				},
	// 			},
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener"),
	// 				Name: to.Ptr("appgwhttplistener"),
	// 				Properties: &armnetwork.ApplicationGatewayHTTPListenerPropertiesFormat{
	// 					FrontendIPConfiguration: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"),
	// 					},
	// 					FrontendPort: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"),
	// 					},
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					Protocol: to.Ptr(armnetwork.ApplicationGatewayProtocolHTTP),
	// 				},
	// 		}},
	// 		LoadDistributionPolicies: []*armnetwork.ApplicationGatewayLoadDistributionPolicy{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"),
	// 				Name: to.Ptr("ldp1"),
	// 				Properties: &armnetwork.ApplicationGatewayLoadDistributionPolicyPropertiesFormat{
	// 					LoadDistributionAlgorithm: to.Ptr(armnetwork.ApplicationGatewayLoadDistributionAlgorithmRoundRobin),
	// 					LoadDistributionTargets: []*armnetwork.ApplicationGatewayLoadDistributionTarget{
	// 						{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1"),
	// 							Name: to.Ptr("ld11"),
	// 							Properties: &armnetwork.ApplicationGatewayLoadDistributionTargetPropertiesFormat{
	// 								BackendAddressPool: &armnetwork.SubResource{
	// 									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"),
	// 								},
	// 								WeightPerServer: to.Ptr[int32](40),
	// 							},
	// 						},
	// 						{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1"),
	// 							Name: to.Ptr("ld11"),
	// 							Properties: &armnetwork.ApplicationGatewayLoadDistributionTargetPropertiesFormat{
	// 								BackendAddressPool: &armnetwork.SubResource{
	// 									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1"),
	// 								},
	// 								WeightPerServer: to.Ptr[int32](60),
	// 							},
	// 					}},
	// 				},
	// 		}},
	// 		OperationalState: to.Ptr(armnetwork.ApplicationGatewayOperationalStateRunning),
	// 		PrivateEndpointConnections: []*armnetwork.ApplicationGatewayPrivateEndpointConnection{
	// 		},
	// 		PrivateLinkConfigurations: []*armnetwork.ApplicationGatewayPrivateLinkConfiguration{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1"),
	// 				Name: to.Ptr("privateLink1"),
	// 				Properties: &armnetwork.ApplicationGatewayPrivateLinkConfigurationProperties{
	// 					IPConfigurations: []*armnetwork.ApplicationGatewayPrivateLinkIPConfiguration{
	// 						{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig1"),
	// 							Name: to.Ptr("natNicIpconfig1"),
	// 							Properties: &armnetwork.ApplicationGatewayPrivateLinkIPConfigurationProperties{
	// 								Primary: to.Ptr(true),
	// 								PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 								ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 								Subnet: &armnetwork.SubResource{
	// 									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet"),
	// 								},
	// 							},
	// 						},
	// 						{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig2"),
	// 							Name: to.Ptr("natNicIpconfig2"),
	// 							Properties: &armnetwork.ApplicationGatewayPrivateLinkIPConfigurationProperties{
	// 								PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 								ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 								Subnet: &armnetwork.SubResource{
	// 									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet"),
	// 								},
	// 							},
	// 					}},
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 		}},
	// 		Probes: []*armnetwork.ApplicationGatewayProbe{
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		RequestRoutingRules: []*armnetwork.ApplicationGatewayRequestRoutingRule{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule"),
	// 				Name: to.Ptr("appgwrule"),
	// 				Properties: &armnetwork.ApplicationGatewayRequestRoutingRulePropertiesFormat{
	// 					BackendAddressPool: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"),
	// 					},
	// 					BackendHTTPSettings: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"),
	// 					},
	// 					HTTPListener: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"),
	// 					},
	// 					LoadDistributionPolicy: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"),
	// 					},
	// 					Priority: to.Ptr[int32](10),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					RewriteRuleSet: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"),
	// 					},
	// 					RuleType: to.Ptr(armnetwork.ApplicationGatewayRequestRoutingRuleTypeBasic),
	// 				},
	// 			},
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule"),
	// 				Name: to.Ptr("appgwPathBasedRule"),
	// 				Properties: &armnetwork.ApplicationGatewayRequestRoutingRulePropertiesFormat{
	// 					HTTPListener: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener"),
	// 					},
	// 					Priority: to.Ptr[int32](20),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					RuleType: to.Ptr(armnetwork.ApplicationGatewayRequestRoutingRuleTypePathBasedRouting),
	// 					URLPathMap: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1"),
	// 					},
	// 				},
	// 		}},
	// 		RewriteRuleSets: []*armnetwork.ApplicationGatewayRewriteRuleSet{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"),
	// 				Name: to.Ptr("rewriteRuleSet1"),
	// 				Properties: &armnetwork.ApplicationGatewayRewriteRuleSetPropertiesFormat{
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					RewriteRules: []*armnetwork.ApplicationGatewayRewriteRule{
	// 						{
	// 							Name: to.Ptr("Set X-Forwarded-For"),
	// 							ActionSet: &armnetwork.ApplicationGatewayRewriteRuleActionSet{
	// 								RequestHeaderConfigurations: []*armnetwork.ApplicationGatewayHeaderConfiguration{
	// 									{
	// 										HeaderName: to.Ptr("X-Forwarded-For"),
	// 										HeaderValue: to.Ptr("{var_remote-addr}"),
	// 								}},
	// 								ResponseHeaderConfigurations: []*armnetwork.ApplicationGatewayHeaderConfiguration{
	// 									{
	// 										HeaderName: to.Ptr("Strict-Transport-Security"),
	// 										HeaderValue: to.Ptr("max-age=31536000"),
	// 								}},
	// 								URLConfiguration: &armnetwork.ApplicationGatewayURLConfiguration{
	// 									ModifiedPath: to.Ptr("/abc"),
	// 									ModifiedQueryString: to.Ptr("x=y&a=b"),
	// 									Reroute: to.Ptr(false),
	// 								},
	// 							},
	// 							Conditions: []*armnetwork.ApplicationGatewayRewriteRuleCondition{
	// 								{
	// 									IgnoreCase: to.Ptr(true),
	// 									Negate: to.Ptr(false),
	// 									Pattern: to.Ptr("^Bearer"),
	// 									Variable: to.Ptr("http_req_Authorization"),
	// 							}},
	// 							RuleSequence: to.Ptr[int32](102),
	// 					}},
	// 				},
	// 		}},
	// 		SKU: &armnetwork.ApplicationGatewaySKU{
	// 			Name: to.Ptr(armnetwork.ApplicationGatewaySKUNameStandardMedium),
	// 			Capacity: to.Ptr[int32](3),
	// 			Tier: to.Ptr(armnetwork.ApplicationGatewayTierStandard),
	// 		},
	// 		SSLCertificates: []*armnetwork.ApplicationGatewaySSLCertificate{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"),
	// 				Name: to.Ptr("sslcert"),
	// 				Properties: &armnetwork.ApplicationGatewaySSLCertificatePropertiesFormat{
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					PublicCertData: to.Ptr("*****"),
	// 				},
	// 		}},
	// 		SSLProfiles: []*armnetwork.ApplicationGatewaySSLProfile{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1"),
	// 				Name: to.Ptr("sslProfile1"),
	// 				Properties: &armnetwork.ApplicationGatewaySSLProfilePropertiesFormat{
	// 					ClientAuthConfiguration: &armnetwork.ApplicationGatewayClientAuthConfiguration{
	// 						VerifyClientCertIssuerDN: to.Ptr(true),
	// 						VerifyClientRevocation: to.Ptr(armnetwork.ApplicationGatewayClientRevocationOptionsOCSP),
	// 					},
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					SSLPolicy: &armnetwork.ApplicationGatewaySSLPolicy{
	// 						CipherSuites: []*armnetwork.ApplicationGatewaySSLCipherSuite{
	// 							to.Ptr(armnetwork.ApplicationGatewaySSLCipherSuiteTLSECDHERSAWITHAES128CBCSHA256)},
	// 							MinProtocolVersion: to.Ptr(armnetwork.ApplicationGatewaySSLProtocolTLSv11),
	// 							PolicyType: to.Ptr(armnetwork.ApplicationGatewaySSLPolicyTypeCustom),
	// 						},
	// 						TrustedClientCertificates: []*armnetwork.SubResource{
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert"),
	// 						}},
	// 					},
	// 			}},
	// 			TrustedClientCertificates: []*armnetwork.ApplicationGatewayTrustedClientCertificate{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert"),
	// 					Name: to.Ptr("clientcert"),
	// 					Properties: &armnetwork.ApplicationGatewayTrustedClientCertificatePropertiesFormat{
	// 						ClientCertIssuerDN: to.Ptr("CN=User1, OU=Eng, O=Company Ltd, L=D4, S=Arizona, C=US"),
	// 						Data: to.Ptr("****"),
	// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 						ValidatedCertData: to.Ptr("****"),
	// 					},
	// 			}},
	// 			URLPathMaps: []*armnetwork.ApplicationGatewayURLPathMap{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1"),
	// 					Name: to.Ptr("pathMap1"),
	// 					Properties: &armnetwork.ApplicationGatewayURLPathMapPropertiesFormat{
	// 						DefaultBackendAddressPool: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"),
	// 						},
	// 						DefaultBackendHTTPSettings: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"),
	// 						},
	// 						DefaultLoadDistributionPolicy: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"),
	// 						},
	// 						DefaultRewriteRuleSet: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"),
	// 						},
	// 						PathRules: []*armnetwork.ApplicationGatewayPathRule{
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths"),
	// 								Name: to.Ptr("apiPaths"),
	// 								Properties: &armnetwork.ApplicationGatewayPathRulePropertiesFormat{
	// 									BackendAddressPool: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"),
	// 									},
	// 									BackendHTTPSettings: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"),
	// 									},
	// 									LoadDistributionPolicy: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"),
	// 									},
	// 									Paths: []*string{
	// 										to.Ptr("/api"),
	// 										to.Ptr("/v1/api")},
	// 										ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 										RewriteRuleSet: &armnetwork.SubResource{
	// 											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"),
	// 										},
	// 									},
	// 							}},
	// 							ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 						},
	// 				}},
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the specified application gateway.
 *
 * @summary Gets the specified application gateway.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ApplicationGatewayGet.json
 */
async function getApplicationGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const applicationGatewayName = "appgw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.applicationGateways.get(resourceGroupName, applicationGatewayName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ApplicationGatewayGet.json
// this example is just showing the usage of "ApplicationGateways_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ApplicationGatewayResource
ApplicationGatewayCollection collection = resourceGroupResource.GetApplicationGateways();

// invoke the operation
string applicationGatewayName = "appgw";
NullableResponse<ApplicationGatewayResource> response = await collection.GetIfExistsAsync(applicationGatewayName);
ApplicationGatewayResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ApplicationGatewayData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "name": "appgw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw",
  "type": "Microsoft.Network/applicationGateways",
  "location": "southcentralus",
  "properties": {
    "provisioningState": "Succeeded",
    "sku": {
      "name": "Standard_Medium",
      "tier": "Standard",
      "capacity": 3
    },
    "operationalState": "Running",
    "gatewayIPConfigurations": [
      {
        "name": "appgwipc",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc",
        "properties": {
          "provisioningState": "Succeeded",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet"
          }
        }
      }
    ],
    "sslCertificates": [
      {
        "name": "sslcert",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert",
        "properties": {
          "provisioningState": "Succeeded",
          "publicCertData": "*****"
        }
      }
    ],
    "trustedClientCertificates": [
      {
        "name": "clientcert",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert",
        "properties": {
          "provisioningState": "Succeeded",
          "data": "****",
          "validatedCertData": "****",
          "clientCertIssuerDN": "CN=User1, OU=Eng, O=Company Ltd, L=D4, S=Arizona, C=US"
        }
      }
    ],
    "authenticationCertificates": [],
    "frontendIPConfigurations": [
      {
        "name": "appgwfip",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip"
          }
        }
      }
    ],
    "frontendPorts": [
      {
        "name": "appgwfp",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 443
        }
      },
      {
        "name": "appgwfp80",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 80
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "appgwpool",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool",
        "properties": {
          "provisioningState": "Succeeded",
          "backendAddresses": []
        }
      },
      {
        "name": "appgwpool1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1",
        "properties": {
          "provisioningState": "Succeeded",
          "backendAddresses": [
            "10.0.0.1",
            "10.0.0.2"
          ]
        }
      }
    ],
    "backendHttpSettingsCollection": [
      {
        "name": "appgwbhs",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 80,
          "protocol": "Http",
          "cookieBasedAffinity": "Disabled",
          "requestTimeout": 30
        }
      }
    ],
    "sslProfiles": [
      {
        "name": "sslProfile1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1",
        "properties": {
          "provisioningState": "Succeeded",
          "sslPolicy": {
            "policyType": "Custom",
            "minProtocolVersion": "TLSv1_1",
            "cipherSuites": [
              "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"
            ]
          },
          "clientAuthConfiguration": {
            "verifyClientCertIssuerDN": true,
            "verifyClientRevocation": "OCSP"
          },
          "trustedClientCertificates": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert"
            }
          ]
        }
      }
    ],
    "httpListeners": [
      {
        "name": "appgwhl",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"
          },
          "protocol": "Https",
          "sslCertificate": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"
          },
          "sslProfile": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1"
          },
          "requireServerNameIndication": false
        }
      },
      {
        "name": "appgwhttplistener",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"
          },
          "protocol": "Http"
        }
      }
    ],
    "urlPathMaps": [
      {
        "name": "pathMap1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1",
        "properties": {
          "provisioningState": "Succeeded",
          "defaultBackendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "defaultBackendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "defaultRewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "defaultLoadDistributionPolicy": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
          },
          "pathRules": [
            {
              "name": "apiPaths",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths",
              "properties": {
                "provisioningState": "Succeeded",
                "paths": [
                  "/api",
                  "/v1/api"
                ],
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                },
                "backendHttpSettings": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
                },
                "rewriteRuleSet": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
                },
                "loadDistributionPolicy": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
                }
              }
            }
          ]
        }
      }
    ],
    "requestRoutingRules": [
      {
        "name": "appgwrule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule",
        "properties": {
          "provisioningState": "Succeeded",
          "ruleType": "Basic",
          "priority": 10,
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"
          },
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "backendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "rewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "loadDistributionPolicy": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
          }
        }
      },
      {
        "name": "appgwPathBasedRule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule",
        "properties": {
          "provisioningState": "Succeeded",
          "ruleType": "PathBasedRouting",
          "priority": 20,
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener"
          },
          "urlPathMap": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1"
          }
        }
      }
    ],
    "rewriteRuleSets": [
      {
        "name": "rewriteRuleSet1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1",
        "properties": {
          "provisioningState": "Succeeded",
          "rewriteRules": [
            {
              "name": "Set X-Forwarded-For",
              "ruleSequence": 102,
              "conditions": [
                {
                  "variable": "http_req_Authorization",
                  "pattern": "^Bearer",
                  "ignoreCase": true,
                  "negate": false
                }
              ],
              "actionSet": {
                "requestHeaderConfigurations": [
                  {
                    "headerName": "X-Forwarded-For",
                    "headerValue": "{var_remote-addr}"
                  }
                ],
                "responseHeaderConfigurations": [
                  {
                    "headerName": "Strict-Transport-Security",
                    "headerValue": "max-age=31536000"
                  }
                ],
                "urlConfiguration": {
                  "modifiedPath": "/abc",
                  "modifiedQueryString": "x=y&a=b",
                  "reroute": false
                }
              }
            }
          ]
        }
      }
    ],
    "probes": [],
    "privateLinkConfigurations": [
      {
        "name": "privateLink1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1",
        "properties": {
          "provisioningState": "Succeeded",
          "ipConfigurations": [
            {
              "name": "natNicIpconfig1",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig1",
              "properties": {
                "provisioningState": "Succeeded",
                "privateIPAllocationMethod": "Dynamic",
                "primary": true,
                "subnet": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet"
                }
              }
            },
            {
              "name": "natNicIpconfig2",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig2",
              "properties": {
                "provisioningState": "Succeeded",
                "privateIPAllocationMethod": "Dynamic",
                "subnet": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet"
                }
              }
            }
          ]
        }
      }
    ],
    "privateEndpointConnections": [],
    "loadDistributionPolicies": [
      {
        "name": "ldp1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1",
        "properties": {
          "loadDistributionAlgorithm": "RoundRobin",
          "loadDistributionTargets": [
            {
              "name": "ld11",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1",
              "properties": {
                "weightPerServer": 40,
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                }
              }
            },
            {
              "name": "ld11",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1",
              "properties": {
                "weightPerServer": 60,
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1"
                }
              }
            }
          ]
        }
      }
    ],
    "globalConfiguration": {
      "enableRequestBuffering": true,
      "enableResponseBuffering": true
    }
  }
}

Definitions

Name	Description
ApplicationGateway	Application gateway resource.
ApplicationGatewayAuthenticationCertificate	Authentication certificates of an application gateway.
ApplicationGatewayAutoscaleConfiguration	Application Gateway autoscale configuration.
ApplicationGatewayBackendAddress	Backend address of an application gateway.
ApplicationGatewayBackendAddressPool	Backend Address Pool of an application gateway.
ApplicationGatewayBackendHttpSettings	Backend address pool settings of an application gateway.
ApplicationGatewayBackendSettings	Backend address pool settings of an application gateway.
ApplicationGatewayClientAuthConfiguration	Application gateway client authentication configuration.
ApplicationGatewayClientRevocationOptions	Verify client certificate revocation status.
ApplicationGatewayConnectionDraining	Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.
ApplicationGatewayCookieBasedAffinity	Cookie based affinity.
ApplicationGatewayCustomError	Custom error of an application gateway.
ApplicationGatewayCustomErrorStatusCode	Status code of the application gateway custom error.
ApplicationGatewayFirewallDisabledRuleGroup	Allows to disable rules within a rule group or an entire rule group.
ApplicationGatewayFirewallExclusion	Allow to exclude some variable satisfy the condition for the WAF check.
ApplicationGatewayFirewallMode	Web application firewall mode.
ApplicationGatewayFrontendIPConfiguration	Frontend IP configuration of an application gateway.
ApplicationGatewayFrontendPort	Frontend port of an application gateway.
ApplicationGatewayGlobalConfiguration	Application Gateway global configuration.
ApplicationGatewayHeaderConfiguration	Header configuration of the Actions set in Application Gateway.
ApplicationGatewayHttpListener	Http listener of an application gateway.
ApplicationGatewayIPConfiguration	IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.
ApplicationGatewayListener	Listener of an application gateway.
ApplicationGatewayLoadDistributionAlgorithm	Load Distribution Targets resource of an application gateway.
ApplicationGatewayLoadDistributionPolicy	Load Distribution Policy of an application gateway.
ApplicationGatewayLoadDistributionTarget	Load Distribution Target of an application gateway.
ApplicationGatewayOperationalState	Operational state of the application gateway resource.
ApplicationGatewayPathRule	Path rule of URL path map of an application gateway.
ApplicationGatewayPrivateEndpointConnection	Private Endpoint connection on an application gateway.
ApplicationGatewayPrivateLinkConfiguration	Private Link Configuration on an application gateway.
ApplicationGatewayPrivateLinkIpConfiguration	The application gateway private link ip configuration.
ApplicationGatewayProbe	Probe of the application gateway.
ApplicationGatewayProbeHealthResponseMatch	Application gateway probe health response match.
ApplicationGatewayProtocol	Application Gateway protocol.
ApplicationGatewayRedirectConfiguration	Redirect configuration of an application gateway.
ApplicationGatewayRedirectType	HTTP redirection type.
ApplicationGatewayRequestRoutingRule	Request routing rule of an application gateway.
ApplicationGatewayRequestRoutingRuleType	Rule type.
ApplicationGatewayRewriteRule	Rewrite rule of an application gateway.
ApplicationGatewayRewriteRuleActionSet	Set of actions in the Rewrite Rule in Application Gateway.
ApplicationGatewayRewriteRuleCondition	Set of conditions in the Rewrite Rule in Application Gateway.
ApplicationGatewayRewriteRuleSet	Rewrite rule set of an application gateway.
ApplicationGatewayRoutingRule	Routing rule of an application gateway.
ApplicationGatewaySku	SKU of an application gateway.
ApplicationGatewaySkuFamily	Family of an application gateway SKU.
ApplicationGatewaySkuName	Name of an application gateway SKU.
ApplicationGatewaySslCertificate	SSL certificates of an application gateway.
ApplicationGatewaySslCipherSuite	Ssl cipher suites to be enabled in the specified order to application gateway.
ApplicationGatewaySslPolicy	Application Gateway Ssl policy.
ApplicationGatewaySslPolicyName	Name of Ssl predefined policy.
ApplicationGatewaySslPolicyType	Type of Ssl Policy.
ApplicationGatewaySslProfile	SSL profile of an application gateway.
ApplicationGatewaySslProtocol	Ssl protocols to be disabled on application gateway.
ApplicationGatewayTier	Tier of an application gateway.
ApplicationGatewayTrustedClientCertificate	Trusted client certificates of an application gateway.
ApplicationGatewayTrustedRootCertificate	Trusted Root certificates of an application gateway.
ApplicationGatewayUrlConfiguration	Url configuration of the Actions set in Application Gateway.
ApplicationGatewayUrlPathMap	UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.
ApplicationGatewayWebApplicationFirewallConfiguration	Application gateway web application firewall configuration.
ApplicationSecurityGroup	An application security group in a resource group.
AutoApproval	The auto-approval list of the private link service.
BackendAddressPool	Pool of backend IP addresses.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
CustomDnsConfigPropertiesFormat	Contains custom Dns resolution configuration from customer.
DdosSettings	Contains the DDoS protection settings of the public IP.
DdosSettingsProtectionMode	The DDoS protection mode of the public IP
Delegation	Details the service to which the subnet is delegated.
DeleteOptions	Specify what happens to the public IP address when the VM using it is deleted
ExtendedLocation	ExtendedLocation complex type.
ExtendedLocationTypes	The type of the extended location.
FlowLog	A flow log resource.
FlowLogFormatParameters	Parameters that define the flow log format.
FlowLogFormatType	The file type of flow log.
FrontendIPConfiguration	Frontend IP address of the load balancer.
GatewayLoadBalancerTunnelInterface	Gateway load balancer tunnel interface of a load balancer backend address pool.
GatewayLoadBalancerTunnelInterfaceType	Traffic type of gateway load balancer tunnel interface.
GatewayLoadBalancerTunnelProtocol	Protocol of gateway load balancer tunnel interface.
HeaderValueMatcher	An optional field under "Rewrite Action". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud
InboundNatRule	Inbound NAT rule of the load balancer.
IPAllocationMethod	IP address allocation method.
IpamPoolPrefixAllocation	IpamPool prefix allocation reference.
IPConfiguration	IP configuration.
IPConfigurationProfile	IP configuration profile child resource.
IpTag	Contains the IpTag associated with the object.
IPVersion	IP address version.
LoadBalancerBackendAddress	Load balancer backend addresses.
LoadBalancerBackendAddressAdminState	A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.
ManagedServiceIdentity	Identity for the resource.
NatGateway	Nat Gateway resource.
NatGatewaySku	SKU of nat gateway.
NatGatewaySkuName	Name of Nat Gateway SKU.
NatRulePortMapping	Individual port mappings for inbound NAT rule created for backend pool.
NetworkInterface	A network interface in a resource group.
NetworkInterfaceAuxiliaryMode	Auxiliary mode of Network Interface resource.
NetworkInterfaceAuxiliarySku	Auxiliary sku of Network Interface resource.
NetworkInterfaceDnsSettings	DNS settings of a network interface.
NetworkInterfaceIPConfiguration	IPConfiguration in a network interface.
NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties	PrivateLinkConnection properties for the network interface.
NetworkInterfaceMigrationPhase	Migration phase of Network Interface resource.
NetworkInterfaceNicType	Type of Network Interface resource.
NetworkInterfaceTapConfiguration	Tap configuration in a Network Interface.
NetworkSecurityGroup	NetworkSecurityGroup resource.
PrivateEndpoint	Private endpoint resource.
PrivateEndpointConnection	PrivateEndpointConnection resource.
PrivateEndpointIPConfiguration	An IP Configuration of the private endpoint.
PrivateLinkService	Private link service resource.
PrivateLinkServiceConnection	PrivateLinkServiceConnection resource.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
PrivateLinkServiceIpConfiguration	The private link service ip configuration.
ProvisioningState	The current provisioning state.
PublicIPAddress	Public IP address resource.
PublicIPAddressDnsSettings	Contains FQDN of the DNS record associated with the public IP address.
PublicIpAddressDnsSettingsDomainNameLabelScope	The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN.
PublicIPAddressMigrationPhase	Migration phase of Public IP Address.
PublicIPAddressSku	SKU of a public IP address.
PublicIPAddressSkuName	Name of a public IP address SKU.
PublicIPAddressSkuTier	Tier of a public IP address SKU.
ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
ResourceNavigationLink	ResourceNavigationLink resource.
RetentionPolicyParameters	Parameters that define the retention policy for flow log.
Route	Route resource.
RouteNextHopType	The type of Azure hop the packet should be sent to.
RouteTable	Route table resource.
SecurityRule	Network security rule.
SecurityRuleAccess	Whether network traffic is allowed or denied.
SecurityRuleDirection	The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.
SecurityRuleProtocol	Network protocol this rule applies to.
ServiceAssociationLink	ServiceAssociationLink resource.
ServiceEndpointPolicy	Service End point policy resource.
ServiceEndpointPolicyDefinition	Service Endpoint policy definitions.
ServiceEndpointPropertiesFormat	The service endpoint properties.
SharingScope	Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.
Subnet	Subnet in a virtual network resource.
SubResource	Reference to another subresource.
SyncMode	Backend address synchronous mode for the backend pool
TrafficAnalyticsConfigurationProperties	Parameters that define the configuration of traffic analytics.
TrafficAnalyticsProperties	Parameters that define the configuration of traffic analytics.
TransportProtocol	The transport protocol for the endpoint.
UserAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualNetworkPrivateEndpointNetworkPolicies	Enable or Disable apply network policies on private end point in the subnet.
VirtualNetworkPrivateLinkServiceNetworkPolicies	Enable or Disable apply network policies on private link service in the subnet.
VirtualNetworkTap	Virtual Network Tap resource.
Visibility	The visibility list of the private link service.

ApplicationGateway

Object

Application gateway resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
identity	ManagedServiceIdentity	The identity of the application gateway, if configured.
location	string	Resource location.
name	string	Resource name.
properties.authenticationCertificates	ApplicationGatewayAuthenticationCertificate[]	Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits.
properties.autoscaleConfiguration	ApplicationGatewayAutoscaleConfiguration	Autoscale Configuration.
properties.backendAddressPools	ApplicationGatewayBackendAddressPool[]	Backend address pool of the application gateway resource. For default limits, see Application Gateway limits.
properties.backendHttpSettingsCollection	ApplicationGatewayBackendHttpSettings[]	Backend http settings of the application gateway resource. For default limits, see Application Gateway limits.
properties.backendSettingsCollection	ApplicationGatewayBackendSettings[]	Backend settings of the application gateway resource. For default limits, see Application Gateway limits.
properties.customErrorConfigurations	ApplicationGatewayCustomError[]	Custom error configurations of the application gateway resource.
properties.defaultPredefinedSslPolicy	ApplicationGatewaySslPolicyName	The default predefined SSL Policy applied on the application gateway resource.
properties.enableFips	boolean	Whether FIPS is enabled on the application gateway resource.
properties.enableHttp2	boolean	Whether HTTP2 is enabled on the application gateway resource.
properties.firewallPolicy	SubResource	Reference to the FirewallPolicy resource.
properties.forceFirewallPolicyAssociation	boolean	If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.
properties.frontendIPConfigurations	ApplicationGatewayFrontendIPConfiguration[]	Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits.
properties.frontendPorts	ApplicationGatewayFrontendPort[]	Frontend ports of the application gateway resource. For default limits, see Application Gateway limits.
properties.gatewayIPConfigurations	ApplicationGatewayIPConfiguration[]	Subnets of the application gateway resource. For default limits, see Application Gateway limits.
properties.globalConfiguration	ApplicationGatewayGlobalConfiguration	Global Configuration.
properties.httpListeners	ApplicationGatewayHttpListener[]	Http listeners of the application gateway resource. For default limits, see Application Gateway limits.
properties.listeners	ApplicationGatewayListener[]	Listeners of the application gateway resource. For default limits, see Application Gateway limits.
properties.loadDistributionPolicies	ApplicationGatewayLoadDistributionPolicy[]	Load distribution policies of the application gateway resource.
properties.operationalState	ApplicationGatewayOperationalState	Operational state of the application gateway resource.
properties.privateEndpointConnections	ApplicationGatewayPrivateEndpointConnection[]	Private Endpoint connections on application gateway.
properties.privateLinkConfigurations	ApplicationGatewayPrivateLinkConfiguration[]	PrivateLink configurations on application gateway.
properties.probes	ApplicationGatewayProbe[]	Probes of the application gateway resource.
properties.provisioningState	ProvisioningState	The provisioning state of the application gateway resource.
properties.redirectConfigurations	ApplicationGatewayRedirectConfiguration[]	Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits.
properties.requestRoutingRules	ApplicationGatewayRequestRoutingRule[]	Request routing rules of the application gateway resource.
properties.resourceGuid	string	The resource GUID property of the application gateway resource.
properties.rewriteRuleSets	ApplicationGatewayRewriteRuleSet[]	Rewrite rules for the application gateway resource.
properties.routingRules	ApplicationGatewayRoutingRule[]	Routing rules of the application gateway resource.
properties.sku	ApplicationGatewaySku	SKU of the application gateway resource.
properties.sslCertificates	ApplicationGatewaySslCertificate[]	SSL certificates of the application gateway resource. For default limits, see Application Gateway limits.
properties.sslPolicy	ApplicationGatewaySslPolicy	SSL policy of the application gateway resource.
properties.sslProfiles	ApplicationGatewaySslProfile[]	SSL profiles of the application gateway resource. For default limits, see Application Gateway limits.
properties.trustedClientCertificates	ApplicationGatewayTrustedClientCertificate[]	Trusted client certificates of the application gateway resource. For default limits, see Application Gateway limits.
properties.trustedRootCertificates	ApplicationGatewayTrustedRootCertificate[]	Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits.
properties.urlPathMaps	ApplicationGatewayUrlPathMap[]	URL path map of the application gateway resource. For default limits, see Application Gateway limits.
properties.webApplicationFirewallConfiguration	ApplicationGatewayWebApplicationFirewallConfiguration	Web application firewall configuration.
tags	object	Resource tags.
type	string	Resource type.
zones	string[]	A list of availability zones denoting where the resource needs to come from.

ApplicationGatewayAuthenticationCertificate

Object

Authentication certificates of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the authentication certificate that is unique within an Application Gateway.
properties.data	string	Certificate public data.
properties.provisioningState	ProvisioningState	The provisioning state of the authentication certificate resource.
type	string	Type of the resource.

ApplicationGatewayAutoscaleConfiguration

Object

Application Gateway autoscale configuration.

Name	Type	Description
maxCapacity	integer (int32) minimum: 2 exclusiveMinimum: False	Upper bound on number of Application Gateway capacity.
minCapacity	integer (int32) minimum: 0 exclusiveMinimum: False	Lower bound on number of Application Gateway capacity.

ApplicationGatewayBackendAddress

Object

Backend address of an application gateway.

Name	Type	Description
fqdn	string	Fully qualified domain name (FQDN).
ipAddress	string	IP address.

ApplicationGatewayBackendAddressPool

Object

Backend Address Pool of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the backend address pool that is unique within an Application Gateway.
properties.backendAddresses	ApplicationGatewayBackendAddress[]	Backend addresses.
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	Collection of references to IPs defined in network interfaces.
properties.provisioningState	ProvisioningState	The provisioning state of the backend address pool resource.
type	string	Type of the resource.

ApplicationGatewayBackendHttpSettings

Object

Backend address pool settings of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the backend http settings that is unique within an Application Gateway.
properties.affinityCookieName	string	Cookie name to use for the affinity cookie.
properties.authenticationCertificates	SubResource[]	Array of references to application gateway authentication certificates.
properties.connectionDraining	ApplicationGatewayConnectionDraining	Connection draining of the backend http settings resource.
properties.cookieBasedAffinity	ApplicationGatewayCookieBasedAffinity	Cookie based affinity.
properties.hostName	string	Host header to be sent to the backend servers.
properties.path	string	Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.
properties.pickHostNameFromBackendAddress	boolean	Whether to pick host header should be picked from the host name of the backend server. Default value is false.
properties.port	integer (int32)	The destination port on the backend.
properties.probe	SubResource	Probe resource of an application gateway.
properties.probeEnabled	boolean	Whether the probe is enabled. Default value is false.
properties.protocol	ApplicationGatewayProtocol	The protocol used to communicate with the backend.
properties.provisioningState	ProvisioningState	The provisioning state of the backend HTTP settings resource.
properties.requestTimeout	integer (int32)	Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.
properties.trustedRootCertificates	SubResource[]	Array of references to application gateway trusted root certificates.
type	string	Type of the resource.

ApplicationGatewayBackendSettings

Object

Backend address pool settings of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the backend settings that is unique within an Application Gateway.
properties.hostName	string	Server name indication to be sent to the backend servers for Tls protocol.
properties.pickHostNameFromBackendAddress	boolean	Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false.
properties.port	integer (int32)	The destination port on the backend.
properties.probe	SubResource	Probe resource of an application gateway.
properties.protocol	ApplicationGatewayProtocol	The protocol used to communicate with the backend.
properties.provisioningState	ProvisioningState	The provisioning state of the backend HTTP settings resource.
properties.timeout	integer (int32)	Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds.
properties.trustedRootCertificates	SubResource[]	Array of references to application gateway trusted root certificates.
type	string	Type of the resource.

ApplicationGatewayClientAuthConfiguration

Object

Application gateway client authentication configuration.

Name	Type	Description
verifyClientCertIssuerDN	boolean	Verify client certificate issuer name on the application gateway.
verifyClientRevocation	ApplicationGatewayClientRevocationOptions	Verify client certificate revocation status.

ApplicationGatewayClientRevocationOptions

Enumeration

Verify client certificate revocation status.

Value	Description
None
OCSP

ApplicationGatewayConnectionDraining

Object

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

Name	Type	Description
drainTimeoutInSec	integer (int32) minimum: 1 maximum: 3600 exclusiveMinimum: False exclusiveMaximum: False	The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.
enabled	boolean	Whether connection draining is enabled or not.

ApplicationGatewayCookieBasedAffinity

Enumeration

Cookie based affinity.

Value	Description
Disabled
Enabled

ApplicationGatewayCustomError

Object

Custom error of an application gateway.

Name	Type	Description
customErrorPageUrl	string	Error page URL of the application gateway custom error.
statusCode	ApplicationGatewayCustomErrorStatusCode	Status code of the application gateway custom error.

ApplicationGatewayCustomErrorStatusCode

Enumeration

Status code of the application gateway custom error.

Value	Description
HttpStatus400
HttpStatus403
HttpStatus404
HttpStatus405
HttpStatus408
HttpStatus500
HttpStatus502
HttpStatus503
HttpStatus504

ApplicationGatewayFirewallDisabledRuleGroup

Object

Allows to disable rules within a rule group or an entire rule group.

Name	Type	Description
ruleGroupName	string	The name of the rule group that will be disabled.
rules	integer[] (int32)	The list of rules that will be disabled. If null, all rules of the rule group will be disabled.

ApplicationGatewayFirewallExclusion

Object

Allow to exclude some variable satisfy the condition for the WAF check.

Name	Type	Description
matchVariable	string	The variable to be excluded.
selector	string	When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.
selectorMatchOperator	string	When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.

ApplicationGatewayFirewallMode

Enumeration

Web application firewall mode.

Value	Description
Detection
Prevention

ApplicationGatewayFrontendIPConfiguration

Object

Frontend IP configuration of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the frontend IP configuration that is unique within an Application Gateway.
properties.privateIPAddress	string	PrivateIPAddress of the network interface IP Configuration.
properties.privateIPAllocationMethod	IPAllocationMethod	The private IP address allocation method.
properties.privateLinkConfiguration	SubResource	Reference to the application gateway private link configuration.
properties.provisioningState	ProvisioningState	The provisioning state of the frontend IP configuration resource.
properties.publicIPAddress	SubResource	Reference to the PublicIP resource.
properties.subnet	SubResource	Reference to the subnet resource.
type	string	Type of the resource.

ApplicationGatewayFrontendPort

Object

Frontend port of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the frontend port that is unique within an Application Gateway.
properties.port	integer (int32)	Frontend port.
properties.provisioningState	ProvisioningState	The provisioning state of the frontend port resource.
type	string	Type of the resource.

ApplicationGatewayGlobalConfiguration

Object

Application Gateway global configuration.

Name	Type	Description
enableRequestBuffering	boolean	Enable request buffering.
enableResponseBuffering	boolean	Enable response buffering.

ApplicationGatewayHeaderConfiguration

Object

Header configuration of the Actions set in Application Gateway.

Name	Type	Description
headerName	string	Header name of the header configuration.
headerValue	string	Header value of the header configuration.
headerValueMatcher	HeaderValueMatcher	An optional field under "Rewrite Action". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud

ApplicationGatewayHttpListener

Object

Http listener of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the HTTP listener that is unique within an Application Gateway.
properties.customErrorConfigurations	ApplicationGatewayCustomError[]	Custom error configurations of the HTTP listener.
properties.firewallPolicy	SubResource	Reference to the FirewallPolicy resource.
properties.frontendIPConfiguration	SubResource	Frontend IP configuration resource of an application gateway.
properties.frontendPort	SubResource	Frontend port resource of an application gateway.
properties.hostName	string	Host name of HTTP listener.
properties.hostNames	string[]	List of Host names for HTTP Listener that allows special wildcard characters as well.
properties.protocol	ApplicationGatewayProtocol	Protocol of the HTTP listener.
properties.provisioningState	ProvisioningState	The provisioning state of the HTTP listener resource.
properties.requireServerNameIndication	boolean	Applicable only if protocol is https. Enables SNI for multi-hosting.
properties.sslCertificate	SubResource	SSL certificate resource of an application gateway.
properties.sslProfile	SubResource	SSL profile resource of the application gateway.
type	string	Type of the resource.

ApplicationGatewayIPConfiguration

Object

IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the IP configuration that is unique within an Application Gateway.
properties.provisioningState	ProvisioningState	The provisioning state of the application gateway IP configuration resource.
properties.subnet	SubResource	Reference to the subnet resource. A subnet from where application gateway gets its private address.
type	string	Type of the resource.

ApplicationGatewayListener

Object

Listener of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the listener that is unique within an Application Gateway.
properties.frontendIPConfiguration	SubResource	Frontend IP configuration resource of an application gateway.
properties.frontendPort	SubResource	Frontend port resource of an application gateway.
properties.hostNames	string[]	List of Server Name Indications(SNI) for TLS Multi-site Listener that allows special wildcard characters as well.
properties.protocol	ApplicationGatewayProtocol	Protocol of the listener.
properties.provisioningState	ProvisioningState	The provisioning state of the listener resource.
properties.sslCertificate	SubResource	SSL certificate resource of an application gateway.
properties.sslProfile	SubResource	SSL profile resource of the application gateway.
type	string	Type of the resource.

ApplicationGatewayLoadDistributionAlgorithm

Enumeration

Load Distribution Targets resource of an application gateway.

Value	Description
IpHash
LeastConnections
RoundRobin

ApplicationGatewayLoadDistributionPolicy

Object

Load Distribution Policy of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the load distribution policy that is unique within an Application Gateway.
properties.loadDistributionAlgorithm	ApplicationGatewayLoadDistributionAlgorithm	Load Distribution Targets resource of an application gateway.
properties.loadDistributionTargets	ApplicationGatewayLoadDistributionTarget[]	Load Distribution Targets resource of an application gateway.
properties.provisioningState	ProvisioningState	The provisioning state of the Load Distribution Policy resource.
type	string	Type of the resource.

ApplicationGatewayLoadDistributionTarget

Object

Load Distribution Target of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the load distribution policy that is unique within an Application Gateway.
properties.backendAddressPool	SubResource	Backend address pool resource of the application gateway.
properties.weightPerServer	integer (int32) minimum: 1 maximum: 100 exclusiveMinimum: False exclusiveMaximum: False	Weight per server. Range between 1 and 100.
type	string	Type of the resource.

ApplicationGatewayOperationalState

Enumeration

Operational state of the application gateway resource.

Value	Description
Running
Starting
Stopped
Stopping

ApplicationGatewayPathRule

Object

Path rule of URL path map of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the path rule that is unique within an Application Gateway.
properties.backendAddressPool	SubResource	Backend address pool resource of URL path map path rule.
properties.backendHttpSettings	SubResource	Backend http settings resource of URL path map path rule.
properties.firewallPolicy	SubResource	Reference to the FirewallPolicy resource.
properties.loadDistributionPolicy	SubResource	Load Distribution Policy resource of URL path map path rule.
properties.paths	string[]	Path rules of URL path map.
properties.provisioningState	ProvisioningState	The provisioning state of the path rule resource.
properties.redirectConfiguration	SubResource	Redirect configuration resource of URL path map path rule.
properties.rewriteRuleSet	SubResource	Rewrite rule set resource of URL path map path rule.
type	string	Type of the resource.

ApplicationGatewayPrivateEndpointConnection

Object

Private Endpoint connection on an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the private endpoint connection on an application gateway.
properties.linkIdentifier	string	The consumer link id.
properties.privateEndpoint	PrivateEndpoint	The resource of private end point.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	ProvisioningState	The provisioning state of the application gateway private endpoint connection resource.
type	string	Type of the resource.

ApplicationGatewayPrivateLinkConfiguration

Object

Private Link Configuration on an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the private link configuration that is unique within an Application Gateway.
properties.ipConfigurations	ApplicationGatewayPrivateLinkIpConfiguration[]	An array of application gateway private link ip configurations.
properties.provisioningState	ProvisioningState	The provisioning state of the application gateway private link configuration.
type	string	Type of the resource.

ApplicationGatewayPrivateLinkIpConfiguration

Object

The application gateway private link ip configuration.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of application gateway private link ip configuration.
properties.primary	boolean	Whether the ip configuration is primary or not.
properties.privateIPAddress	string	The private IP address of the IP configuration.
properties.privateIPAllocationMethod	IPAllocationMethod	The private IP address allocation method.
properties.provisioningState	ProvisioningState	The provisioning state of the application gateway private link IP configuration.
properties.subnet	SubResource	Reference to the subnet resource.
type	string	The resource type.

ApplicationGatewayProbe

Object

Probe of the application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the probe that is unique within an Application Gateway.
properties.host	string	Host name to send the probe to.
properties.interval	integer (int32)	The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.
properties.match	ApplicationGatewayProbeHealthResponseMatch	Criterion for classifying a healthy probe response.
properties.minServers	integer (int32)	Minimum number of servers that are always marked healthy. Default value is 0.
properties.path	string	Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.
properties.pickHostNameFromBackendHttpSettings	boolean	Whether the host header should be picked from the backend http settings. Default value is false.
properties.pickHostNameFromBackendSettings	boolean	Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false.
properties.port	integer (int32) minimum: 1 maximum: 65535	Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Basic, Standard_v2 and WAF_v2 only.
properties.protocol	ApplicationGatewayProtocol	The protocol used for the probe.
properties.provisioningState	ProvisioningState	The provisioning state of the probe resource.
properties.timeout	integer (int32)	The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.
properties.unhealthyThreshold	integer (int32)	The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.
type	string	Type of the resource.

ApplicationGatewayProbeHealthResponseMatch

Object

Application gateway probe health response match.

Name	Type	Description
body	string	Body that must be contained in the health response. Default value is empty.
statusCodes	string[]	Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.

ApplicationGatewayProtocol

Enumeration

Application Gateway protocol.

Value	Description
Http	Supported for httpListeners and backendHttpSettingsCollection properties.
Https	Supported for httpListeners and backendHttpSettingsCollection properties.
Tcp	Supported for listeners and backendSettingsCollection properties.
Tls	Supported for listeners and backendSettingsCollection properties.

ApplicationGatewayRedirectConfiguration

Object

Redirect configuration of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the redirect configuration that is unique within an Application Gateway.
properties.includePath	boolean	Include path in the redirected url.
properties.includeQueryString	boolean	Include query string in the redirected url.
properties.pathRules	SubResource[]	Path rules specifying redirect configuration.
properties.redirectType	ApplicationGatewayRedirectType	HTTP redirection type.
properties.requestRoutingRules	SubResource[]	Request routing specifying redirect configuration.
properties.targetListener	SubResource	Reference to a listener to redirect the request to.
properties.targetUrl	string	Url to redirect the request to.
properties.urlPathMaps	SubResource[]	Url path maps specifying default redirect configuration.
type	string	Type of the resource.

ApplicationGatewayRedirectType

Enumeration

HTTP redirection type.

Value	Description
Found
Permanent
SeeOther
Temporary

ApplicationGatewayRequestRoutingRule

Object

Request routing rule of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the request routing rule that is unique within an Application Gateway.
properties.backendAddressPool	SubResource	Backend address pool resource of the application gateway.
properties.backendHttpSettings	SubResource	Backend http settings resource of the application gateway.
properties.httpListener	SubResource	Http listener resource of the application gateway.
properties.loadDistributionPolicy	SubResource	Load Distribution Policy resource of the application gateway.
properties.priority	integer (int32) minimum: 1 maximum: 20000 exclusiveMinimum: False exclusiveMaximum: False	Priority of the request routing rule.
properties.provisioningState	ProvisioningState	The provisioning state of the request routing rule resource.
properties.redirectConfiguration	SubResource	Redirect configuration resource of the application gateway.
properties.rewriteRuleSet	SubResource	Rewrite Rule Set resource in Basic rule of the application gateway.
properties.ruleType	ApplicationGatewayRequestRoutingRuleType	Rule type.
properties.urlPathMap	SubResource	URL path map resource of the application gateway.
type	string	Type of the resource.

ApplicationGatewayRequestRoutingRuleType

Enumeration

Rule type.

Value	Description
Basic
PathBasedRouting

ApplicationGatewayRewriteRule

Object

Rewrite rule of an application gateway.

Name	Type	Description
actionSet	ApplicationGatewayRewriteRuleActionSet	Set of actions to be done as part of the rewrite Rule.
conditions	ApplicationGatewayRewriteRuleCondition[]	Conditions based on which the action set execution will be evaluated.
name	string	Name of the rewrite rule that is unique within an Application Gateway.
ruleSequence	integer	Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.

ApplicationGatewayRewriteRuleActionSet

Object

Set of actions in the Rewrite Rule in Application Gateway.

Name	Type	Description
requestHeaderConfigurations	ApplicationGatewayHeaderConfiguration[]	Request Header Actions in the Action Set.
responseHeaderConfigurations	ApplicationGatewayHeaderConfiguration[]	Response Header Actions in the Action Set.
urlConfiguration	ApplicationGatewayUrlConfiguration	Url Configuration Action in the Action Set.

ApplicationGatewayRewriteRuleCondition

Object

Set of conditions in the Rewrite Rule in Application Gateway.

Name	Type	Description
ignoreCase	boolean	Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison.
negate	boolean	Setting this value as truth will force to check the negation of the condition given by the user.
pattern	string	The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.
variable	string	The condition parameter of the RewriteRuleCondition.

ApplicationGatewayRewriteRuleSet

Object

Rewrite rule set of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the rewrite rule set that is unique within an Application Gateway.
properties.provisioningState	ProvisioningState	The provisioning state of the rewrite rule set resource.
properties.rewriteRules	ApplicationGatewayRewriteRule[]	Rewrite rules in the rewrite rule set.

ApplicationGatewayRoutingRule

Object

Routing rule of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the routing rule that is unique within an Application Gateway.
properties.backendAddressPool	SubResource	Backend address pool resource of the application gateway.
properties.backendSettings	SubResource	Backend settings resource of the application gateway.
properties.listener	SubResource	Listener resource of the application gateway.
properties.priority	integer (int32) minimum: 1 maximum: 20000 exclusiveMinimum: False exclusiveMaximum: False	Priority of the routing rule.
properties.provisioningState	ProvisioningState	The provisioning state of the request routing rule resource.
properties.ruleType	ApplicationGatewayRequestRoutingRuleType	Rule type.
type	string	Type of the resource.

ApplicationGatewaySku

Object

SKU of an application gateway.

Name	Type	Description
capacity	integer (int32)	Capacity (instance count) of an application gateway.
family	ApplicationGatewaySkuFamily	Family of an application gateway SKU.
name	ApplicationGatewaySkuName	Name of an application gateway SKU.
tier	ApplicationGatewayTier	Tier of an application gateway.

ApplicationGatewaySkuFamily

Enumeration

Family of an application gateway SKU.

Value	Description
Generation_1
Generation_2

ApplicationGatewaySkuName

Enumeration

Name of an application gateway SKU.

Value	Description
Basic
Standard_Large
Standard_Medium
Standard_Small
Standard_v2
WAF_Large
WAF_Medium
WAF_v2

ApplicationGatewaySslCertificate

Object

SSL certificates of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the SSL certificate that is unique within an Application Gateway.
properties.data	string	Base-64 encoded pfx certificate. Only applicable in PUT Request.
properties.keyVaultSecretId	string	Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.
properties.password	string	Password for the pfx file specified in data. Only applicable in PUT request.
properties.provisioningState	ProvisioningState	The provisioning state of the SSL certificate resource.
properties.publicCertData	string	Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.
type	string	Type of the resource.

ApplicationGatewaySslCipherSuite

Enumeration

Ssl cipher suites to be enabled in the specified order to application gateway.

Value	Description
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384

ApplicationGatewaySslPolicy

Object

Application Gateway Ssl policy.

Name	Type	Description
cipherSuites	ApplicationGatewaySslCipherSuite[]	Ssl cipher suites to be enabled in the specified order to application gateway.
disabledSslProtocols	ApplicationGatewaySslProtocol[]	Ssl protocols to be disabled on application gateway.
minProtocolVersion	ApplicationGatewaySslProtocol	Minimum version of Ssl protocol to be supported on application gateway.
policyName	ApplicationGatewaySslPolicyName	Name of Ssl predefined policy.
policyType	ApplicationGatewaySslPolicyType	Type of Ssl Policy.

ApplicationGatewaySslPolicyName

Enumeration

Name of Ssl predefined policy.

Value	Description
AppGwSslPolicy20150501
AppGwSslPolicy20170401
AppGwSslPolicy20170401S
AppGwSslPolicy20220101
AppGwSslPolicy20220101S

ApplicationGatewaySslPolicyType

Enumeration

Type of Ssl Policy.

Value	Description
Custom
CustomV2
Predefined

ApplicationGatewaySslProfile

Object

SSL profile of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the SSL profile that is unique within an Application Gateway.
properties.clientAuthConfiguration	ApplicationGatewayClientAuthConfiguration	Client authentication configuration of the application gateway resource.
properties.provisioningState	ProvisioningState	The provisioning state of the HTTP listener resource.
properties.sslPolicy	ApplicationGatewaySslPolicy	SSL policy of the application gateway resource.
properties.trustedClientCertificates	SubResource[]	Array of references to application gateway trusted client certificates.
type	string	Type of the resource.

ApplicationGatewaySslProtocol

Enumeration

Ssl protocols to be disabled on application gateway.

Value	Description
TLSv1_0
TLSv1_1
TLSv1_2
TLSv1_3

ApplicationGatewayTier

Enumeration

Tier of an application gateway.

Value	Description
Basic
Standard
Standard_v2
WAF
WAF_v2

ApplicationGatewayTrustedClientCertificate

Object

Trusted client certificates of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the trusted client certificate that is unique within an Application Gateway.
properties.clientCertIssuerDN	string	Distinguished name of client certificate issuer.
properties.data	string	Certificate public data.
properties.provisioningState	ProvisioningState	The provisioning state of the trusted client certificate resource.
properties.validatedCertData	string	Validated certificate data.
type	string	Type of the resource.

ApplicationGatewayTrustedRootCertificate

Object

Trusted Root certificates of an application gateway.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the trusted root certificate that is unique within an Application Gateway.
properties.data	string	Certificate public data.
properties.keyVaultSecretId	string	Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.
properties.provisioningState	ProvisioningState	The provisioning state of the trusted root certificate resource.
type	string	Type of the resource.

ApplicationGatewayUrlConfiguration

Object

Url configuration of the Actions set in Application Gateway.

Name	Type	Description
modifiedPath	string	Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null.
modifiedQueryString	string	Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null.
reroute	boolean	If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false.

ApplicationGatewayUrlPathMap

Object

UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the URL path map that is unique within an Application Gateway.
properties.defaultBackendAddressPool	SubResource	Default backend address pool resource of URL path map.
properties.defaultBackendHttpSettings	SubResource	Default backend http settings resource of URL path map.
properties.defaultLoadDistributionPolicy	SubResource	Default Load Distribution Policy resource of URL path map.
properties.defaultRedirectConfiguration	SubResource	Default redirect configuration resource of URL path map.
properties.defaultRewriteRuleSet	SubResource	Default Rewrite rule set resource of URL path map.
properties.pathRules	ApplicationGatewayPathRule[]	Path rule of URL path map resource.
properties.provisioningState	ProvisioningState	The provisioning state of the URL path map resource.
type	string	Type of the resource.

ApplicationGatewayWebApplicationFirewallConfiguration

Object

Application gateway web application firewall configuration.

Name	Type	Description
disabledRuleGroups	ApplicationGatewayFirewallDisabledRuleGroup[]	The disabled rule groups.
enabled	boolean	Whether the web application firewall is enabled or not.
exclusions	ApplicationGatewayFirewallExclusion[]	The exclusion list.
fileUploadLimitInMb	integer (int32) minimum: 0 exclusiveMinimum: False	Maximum file upload size in Mb for WAF.
firewallMode	ApplicationGatewayFirewallMode	Web application firewall mode.
maxRequestBodySize	integer (int32) minimum: 8 maximum: 128 exclusiveMinimum: False exclusiveMaximum: False	Maximum request body size for WAF.
maxRequestBodySizeInKb	integer (int32) minimum: 8 maximum: 128 exclusiveMinimum: False exclusiveMaximum: False	Maximum request body size in Kb for WAF.
requestBodyCheck	boolean	Whether allow WAF to check request Body.
ruleSetType	string	The type of the web application firewall rule set. Possible values are: 'OWASP'.
ruleSetVersion	string	The version of the rule set type.

ApplicationSecurityGroup

Object

An application security group in a resource group.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.provisioningState	ProvisioningState	The provisioning state of the application security group resource.
properties.resourceGuid	string	The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
tags	object	Resource tags.
type	string	Resource type.

AutoApproval

Object

The auto-approval list of the private link service.

Name	Type	Description
subscriptions	string[]	The list of subscriptions.

BackendAddressPool

Object

Pool of backend IP addresses.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	An array of references to IP addresses defined in network interfaces.
properties.drainPeriodInSeconds	integer (int32)	Amount of seconds Load Balancer waits for before sending RESET to client and backend address.
properties.inboundNatRules	SubResource[]	An array of references to inbound NAT rules that use this backend address pool.
properties.loadBalancerBackendAddresses	LoadBalancerBackendAddress[]	An array of backend addresses.
properties.loadBalancingRules	SubResource[]	An array of references to load balancing rules that use this backend address pool.
properties.location	string	The location of the backend address pool.
properties.outboundRule	SubResource	A reference to an outbound rule that uses this backend address pool.
properties.outboundRules	SubResource[]	An array of references to outbound rules that use this backend address pool.
properties.provisioningState	ProvisioningState	The provisioning state of the backend address pool resource.
properties.syncMode	SyncMode	Backend address synchronous mode for the backend pool
properties.tunnelInterfaces	GatewayLoadBalancerTunnelInterface[]	An array of gateway load balancer tunnel interfaces.
properties.virtualNetwork	SubResource	A reference to a virtual network.
type	string	Type of the resource.

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

An error response from the service.

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

CustomDnsConfigPropertiesFormat

Object

Contains custom Dns resolution configuration from customer.

Name	Type	Description
fqdn	string	Fqdn that resolves to private endpoint ip address.
ipAddresses	string[]	A list of private ip addresses of the private endpoint.

DdosSettings

Object

Contains the DDoS protection settings of the public IP.

Name	Type	Description
ddosProtectionPlan	SubResource	The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled
protectionMode	DdosSettingsProtectionMode	The DDoS protection mode of the public IP

DdosSettingsProtectionMode

Enumeration

The DDoS protection mode of the public IP

Value	Description
Disabled
Enabled
VirtualNetworkInherited

Delegation

Object

Details the service to which the subnet is delegated.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a subnet. This name can be used to access the resource.
properties.actions	string[]	The actions permitted to the service upon delegation.
properties.provisioningState	ProvisioningState	The provisioning state of the service delegation resource.
properties.serviceName	string	The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).
type	string	Resource type.

DeleteOptions

Enumeration

Specify what happens to the public IP address when the VM using it is deleted

Value	Description
Delete
Detach

ExtendedLocation

Object

ExtendedLocation complex type.

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationTypes	The type of the extended location.

ExtendedLocationTypes

Enumeration

The type of the extended location.

Value	Description
EdgeZone

FlowLog

Object

A flow log resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
identity	ManagedServiceIdentity	FlowLog resource Managed Identity
location	string	Resource location.
name	string	Resource name.
properties.enabled	boolean	Flag to enable/disable flow logging.
properties.enabledFilteringCriteria	string	Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged.
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parameters that define the configuration of traffic analytics.
properties.format	FlowLogFormatParameters	Parameters that define the flow log format.
properties.provisioningState	ProvisioningState	The provisioning state of the flow log.
properties.retentionPolicy	RetentionPolicyParameters	Parameters that define the retention policy for flow log.
properties.storageId	string	ID of the storage account which is used to store the flow log.
properties.targetResourceGuid	string	Guid of network security group to which flow log will be applied.
properties.targetResourceId	string	ID of network security group to which flow log will be applied.
tags	object	Resource tags.
type	string	Resource type.

FlowLogFormatParameters

Object

Parameters that define the flow log format.

Name	Type	Default value	Description
type	FlowLogFormatType		The file type of flow log.
version	integer (int32)	0	The version (revision) of the flow log.

FlowLogFormatType

Enumeration

The file type of flow log.

Value	Description
JSON

FrontendIPConfiguration

Object

Frontend IP address of the load balancer.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.
properties.gatewayLoadBalancer	SubResource	The reference to gateway load balancer frontend IP.
properties.inboundNatPools	SubResource[]	An array of references to inbound pools that use this frontend IP.
properties.inboundNatRules	SubResource[]	An array of references to inbound rules that use this frontend IP.
properties.loadBalancingRules	SubResource[]	An array of references to load balancing rules that use this frontend IP.
properties.outboundRules	SubResource[]	An array of references to outbound rules that use this frontend IP.
properties.privateIPAddress	string	The private IP address of the IP configuration.
properties.privateIPAddressVersion	IPVersion	Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.
properties.privateIPAllocationMethod	IPAllocationMethod	The Private IP allocation method.
properties.provisioningState	ProvisioningState	The provisioning state of the frontend IP configuration resource.
properties.publicIPAddress	PublicIPAddress	The reference to the Public IP resource.
properties.publicIPPrefix	SubResource	The reference to the Public IP Prefix resource.
properties.subnet	Subnet	The reference to the subnet resource.
type	string	Type of the resource.
zones	string[]	A list of availability zones denoting the IP allocated for the resource needs to come from.

GatewayLoadBalancerTunnelInterface

Object

Gateway load balancer tunnel interface of a load balancer backend address pool.

Name	Type	Description
identifier	integer (int32)	Identifier of gateway load balancer tunnel interface.
port	integer (int32)	Port of gateway load balancer tunnel interface.
protocol	GatewayLoadBalancerTunnelProtocol	Protocol of gateway load balancer tunnel interface.
type	GatewayLoadBalancerTunnelInterfaceType	Traffic type of gateway load balancer tunnel interface.

GatewayLoadBalancerTunnelInterfaceType

Enumeration

Traffic type of gateway load balancer tunnel interface.

Value	Description
External
Internal
None

GatewayLoadBalancerTunnelProtocol

Enumeration

Protocol of gateway load balancer tunnel interface.

Value	Description
Native
None
VXLAN

HeaderValueMatcher

Object

An optional field under "Rewrite Action". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud

Name	Type	Description
ignoreCase	boolean	Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison.
negate	boolean	Setting this value as truth will force to check the negation of the condition given by the user in the pattern field.
pattern	string	The pattern, either fixed string or regular expression, that evaluates if a header value should be selected for rewrite.

InboundNatRule

Object

Inbound NAT rule of the load balancer.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.
properties.backendAddressPool	SubResource	A reference to backendAddressPool resource.
properties.backendIPConfiguration	NetworkInterfaceIPConfiguration	A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP.
properties.backendPort	integer (int32)	The port used for the internal endpoint. Acceptable values range from 1 to 65535.
properties.enableFloatingIP	boolean	Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.
properties.enableTcpReset	boolean	Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
properties.frontendIPConfiguration	SubResource	A reference to frontend IP addresses.
properties.frontendPort	integer (int32)	The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.
properties.frontendPortRangeEnd	integer (int32)	The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
properties.frontendPortRangeStart	integer (int32)	The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
properties.idleTimeoutInMinutes	integer (int32)	The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.
properties.protocol	TransportProtocol	The reference to the transport protocol used by the load balancing rule.
properties.provisioningState	ProvisioningState	The provisioning state of the inbound NAT rule resource.
type	string	Type of the resource.

IPAllocationMethod

Enumeration

IP address allocation method.

Value	Description
Dynamic
Static

IpamPoolPrefixAllocation

Object

IpamPool prefix allocation reference.

Name	Type	Description
allocatedAddressPrefixes	string[]	List of assigned IP address prefixes in the IpamPool of the associated resource.
numberOfIpAddresses	string	Number of IP addresses to allocate.
pool.id	string (arm-id)	Resource id of the associated Azure IpamPool resource.

IPConfiguration

Object

IP configuration.

Name	Type	Default value	Description
etag	string		A unique read-only string that changes whenever the resource is updated.
id	string		Resource ID.
name	string		The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.privateIPAddress	string		The private IP address of the IP configuration.
properties.privateIPAllocationMethod	IPAllocationMethod	Dynamic	The private IP address allocation method.
properties.provisioningState	ProvisioningState		The provisioning state of the IP configuration resource.
properties.publicIPAddress	PublicIPAddress		The reference to the public IP resource.
properties.subnet	Subnet		The reference to the subnet resource.

IPConfigurationProfile

Object

IP configuration profile child resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource. This name can be used to access the resource.
properties.provisioningState	ProvisioningState	The provisioning state of the IP configuration profile resource.
properties.subnet	Subnet	The reference to the subnet resource to create a container network interface ip configuration.
type	string	Sub Resource type.

IpTag

Object

Contains the IpTag associated with the object.

Name	Type	Description
ipTagType	string	The IP tag type. Example: FirstPartyUsage.
tag	string	The value of the IP tag associated with the public IP. Example: SQL.

IPVersion

Enumeration

IP address version.

Value	Description
IPv4
IPv6

LoadBalancerBackendAddress

Object

Load balancer backend addresses.

Name	Type	Description
name	string	Name of the backend address.
properties.adminState	LoadBalancerBackendAddressAdminState	A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.
properties.inboundNatRulesPortMapping	NatRulePortMapping[]	Collection of inbound NAT rule port mappings.
properties.ipAddress	string	IP Address belonging to the referenced virtual network.
properties.loadBalancerFrontendIPConfiguration	SubResource	Reference to the frontend ip address configuration defined in regional loadbalancer.
properties.networkInterfaceIPConfiguration	SubResource	Reference to IP address defined in network interfaces.
properties.subnet	SubResource	Reference to an existing subnet.
properties.virtualNetwork	SubResource	Reference to an existing virtual network.

LoadBalancerBackendAddressAdminState

Enumeration

A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.

Value	Description
Down
None
Up

ManagedServiceIdentity

Object

Identity for the resource.

Name	Type	Description
principalId	string	The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type	ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
userAssignedIdentities	UserAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

NatGateway

Object

Nat Gateway resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.idleTimeoutInMinutes	integer (int32)	The idle timeout of the nat gateway.
properties.provisioningState	ProvisioningState	The provisioning state of the NAT gateway resource.
properties.publicIpAddresses	SubResource[]	An array of public ip addresses associated with the nat gateway resource.
properties.publicIpPrefixes	SubResource[]	An array of public ip prefixes associated with the nat gateway resource.
properties.resourceGuid	string	The resource GUID property of the NAT gateway resource.
properties.subnets	SubResource[]	An array of references to the subnets using this nat gateway resource.
sku	NatGatewaySku	The nat gateway SKU.
tags	object	Resource tags.
type	string	Resource type.
zones	string[]	A list of availability zones denoting the zone in which Nat Gateway should be deployed.

NatGatewaySku

Object

SKU of nat gateway.

Name	Type	Description
name	NatGatewaySkuName	Name of Nat Gateway SKU.

NatGatewaySkuName

Enumeration

Name of Nat Gateway SKU.

Value	Description
Standard

NatRulePortMapping

Object

Individual port mappings for inbound NAT rule created for backend pool.

Name	Type	Description
backendPort	integer (int32)	Backend port.
frontendPort	integer (int32)	Frontend port.
inboundNatRuleName	string	Name of inbound NAT rule.

NetworkInterface

Object

A network interface in a resource group.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	ExtendedLocation	The extended location of the network interface.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Auxiliary mode of Network Interface resource.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Auxiliary sku of Network Interface resource.
properties.defaultOutboundConnectivityEnabled	boolean	Whether default outbound connectivity for nic was configured or not.
properties.disableTcpStateTracking	boolean	Indicates whether to disable tcp state tracking.
properties.dnsSettings	NetworkInterfaceDnsSettings	The DNS settings in network interface.
properties.dscpConfiguration	SubResource	A reference to the dscp configuration to which the network interface is linked.
properties.enableAcceleratedNetworking	boolean	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
properties.enableIPForwarding	boolean	Indicates whether IP forwarding is enabled on this network interface.
properties.hostedWorkloads	string[]	A list of references to linked BareMetal resources.
properties.ipConfigurations	NetworkInterfaceIPConfiguration[]	A list of IPConfigurations of the network interface.
properties.macAddress	string	The MAC address of the network interface.
properties.migrationPhase	NetworkInterfaceMigrationPhase	Migration phase of Network Interface resource.
properties.networkSecurityGroup	NetworkSecurityGroup	The reference to the NetworkSecurityGroup resource.
properties.nicType	NetworkInterfaceNicType	Type of Network Interface resource.
properties.primary	boolean	Whether this is a primary network interface on a virtual machine.
properties.privateEndpoint	PrivateEndpoint	A reference to the private endpoint to which the network interface is linked.
properties.privateLinkService	PrivateLinkService	Privatelinkservice of the network interface resource.
properties.provisioningState	ProvisioningState	The provisioning state of the network interface resource.
properties.resourceGuid	string	The resource GUID property of the network interface resource.
properties.tapConfigurations	NetworkInterfaceTapConfiguration[]	A list of TapConfigurations of the network interface.
properties.virtualMachine	SubResource	The reference to a virtual machine.
properties.vnetEncryptionSupported	boolean	Whether the virtual machine this nic is attached to supports encryption.
properties.workloadType	string	WorkloadType of the NetworkInterface for BareMetal resources
tags	object	Resource tags.
type	string	Resource type.

NetworkInterfaceAuxiliaryMode

Enumeration

Auxiliary mode of Network Interface resource.

Value	Description
AcceleratedConnections
Floating
MaxConnections
None

NetworkInterfaceAuxiliarySku

Enumeration

Auxiliary sku of Network Interface resource.

Value	Description
A1
A2
A4
A8
None

NetworkInterfaceDnsSettings

Object

DNS settings of a network interface.

Name	Type	Description
appliedDnsServers	string[]	If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.
dnsServers	string[]	List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.
internalDnsNameLabel	string	Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.
internalDomainNameSuffix	string	Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.
internalFqdn	string	Fully qualified DNS name supporting internal communications between VMs in the same virtual network.

NetworkInterfaceIPConfiguration

Object

IPConfiguration in a network interface.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.applicationGatewayBackendAddressPools	ApplicationGatewayBackendAddressPool[]	The reference to ApplicationGatewayBackendAddressPool resource.
properties.applicationSecurityGroups	ApplicationSecurityGroup[]	Application security groups in which the IP configuration is included.
properties.gatewayLoadBalancer	SubResource	The reference to gateway load balancer frontend IP.
properties.loadBalancerBackendAddressPools	BackendAddressPool[]	The reference to LoadBalancerBackendAddressPool resource.
properties.loadBalancerInboundNatRules	InboundNatRule[]	A list of references of LoadBalancerInboundNatRules.
properties.primary	boolean	Whether this is a primary customer address on the network interface.
properties.privateIPAddress	string	Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format /.
properties.privateIPAddressPrefixLength	integer (int32) minimum: 1 maximum: 128	The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address.
properties.privateIPAddressVersion	IPVersion	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.
properties.privateIPAllocationMethod	IPAllocationMethod	The private IP address allocation method.
properties.privateLinkConnectionProperties	NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties	PrivateLinkConnection properties for the network interface.
properties.provisioningState	ProvisioningState	The provisioning state of the network interface IP configuration.
properties.publicIPAddress	PublicIPAddress	Public IP address bound to the IP configuration.
properties.subnet	Subnet	Subnet bound to the IP configuration.
properties.virtualNetworkTaps	VirtualNetworkTap[]	The reference to Virtual Network Taps.
type	string	Resource type.

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

Object

PrivateLinkConnection properties for the network interface.

Name	Type	Description
fqdns	string[]	List of FQDNs for current private link connection.
groupId	string	The group ID for current private link connection.
requiredMemberName	string	The required member name for current private link connection.

NetworkInterfaceMigrationPhase

Enumeration

Migration phase of Network Interface resource.

Value	Description
Abort
Commit
Committed
None
Prepare

NetworkInterfaceNicType

Enumeration

Type of Network Interface resource.

Value	Description
Elastic
Standard

NetworkInterfaceTapConfiguration

Object

Tap configuration in a Network Interface.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.provisioningState	ProvisioningState	The provisioning state of the network interface tap configuration resource.
properties.virtualNetworkTap	VirtualNetworkTap	The reference to the Virtual Network Tap resource.
type	string	Sub Resource type.

NetworkSecurityGroup

Object

NetworkSecurityGroup resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.defaultSecurityRules	SecurityRule[]	The default security rules of network security group.
properties.flowLogs	FlowLog[]	A collection of references to flow log resources.
properties.flushConnection	boolean	When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation.
properties.networkInterfaces	NetworkInterface[]	A collection of references to network interfaces.
properties.provisioningState	ProvisioningState	The provisioning state of the network security group resource.
properties.resourceGuid	string	The resource GUID property of the network security group resource.
properties.securityRules	SecurityRule[]	A collection of security rules of the network security group.
properties.subnets	Subnet[]	A collection of references to subnets.
tags	object	Resource tags.
type	string	Resource type.

PrivateEndpoint

Object

Private endpoint resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	ExtendedLocation	The extended location of the load balancer.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.applicationSecurityGroups	ApplicationSecurityGroup[]	Application security groups in which the private endpoint IP configuration is included.
properties.customDnsConfigs	CustomDnsConfigPropertiesFormat[]	An array of custom dns configurations.
properties.customNetworkInterfaceName	string	The custom name of the network interface attached to the private endpoint.
properties.ipConfigurations	PrivateEndpointIPConfiguration[]	A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints.
properties.manualPrivateLinkServiceConnections	PrivateLinkServiceConnection[]	A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.
properties.networkInterfaces	NetworkInterface[]	An array of references to the network interfaces created for this private endpoint.
properties.privateLinkServiceConnections	PrivateLinkServiceConnection[]	A grouping of information about the connection to the remote resource.
properties.provisioningState	ProvisioningState	The provisioning state of the private endpoint resource.
properties.subnet	Subnet	The ID of the subnet from which the private IP will be allocated.
tags	object	Resource tags.
type	string	Resource type.

PrivateEndpointConnection

Object

PrivateEndpointConnection resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.linkIdentifier	string	The consumer link id.
properties.privateEndpoint	PrivateEndpoint	The resource of private end point.
properties.privateEndpointLocation	string	The location of the private endpoint.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	ProvisioningState	The provisioning state of the private endpoint connection resource.
type	string	The resource type.

PrivateEndpointIPConfiguration

Object

An IP Configuration of the private endpoint.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
name	string	The name of the resource that is unique within a resource group.
properties.groupId	string	The ID of a group obtained from the remote resource that this private endpoint should connect to.
properties.memberName	string	The member name of a group obtained from the remote resource that this private endpoint should connect to.
properties.privateIPAddress	string	A private ip address obtained from the private endpoint's subnet.
type	string	The resource type.

PrivateLinkService

Object

Private link service resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	ExtendedLocation	The extended location of the load balancer.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.alias	string	The alias of the private link service.
properties.autoApproval	AutoApproval	The auto-approval list of the private link service.
properties.destinationIPAddress	string	The destination IP address of the private link service.
properties.enableProxyProtocol	boolean	Whether the private link service is enabled for proxy protocol or not.
properties.fqdns	string[]	The list of Fqdn.
properties.ipConfigurations	PrivateLinkServiceIpConfiguration[]	An array of private link service IP configurations.
properties.loadBalancerFrontendIpConfigurations	FrontendIPConfiguration[]	An array of references to the load balancer IP configurations.
properties.networkInterfaces	NetworkInterface[]	An array of references to the network interfaces created for this private link service.
properties.privateEndpointConnections	PrivateEndpointConnection[]	An array of list about connections to the private endpoint.
properties.provisioningState	ProvisioningState	The provisioning state of the private link service resource.
properties.visibility	Visibility	The visibility list of the private link service.
tags	object	Resource tags.
type	string	Resource type.

PrivateLinkServiceConnection

Object

PrivateLinkServiceConnection resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.groupIds	string[]	The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of read-only information about the state of the connection to the remote resource.
properties.privateLinkServiceId	string	The resource id of private link service.
properties.provisioningState	ProvisioningState	The provisioning state of the private link service connection resource.
properties.requestMessage	string	A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
type	string	The resource type.

PrivateLinkServiceConnectionState

Object

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

Name	Type	Description
actionsRequired	string	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The reason for approval/rejection of the connection.
status	string	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

PrivateLinkServiceIpConfiguration

Object

The private link service ip configuration.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of private link service ip configuration.
properties.primary	boolean	Whether the ip configuration is primary or not.
properties.privateIPAddress	string	The private IP address of the IP configuration.
properties.privateIPAddressVersion	IPVersion	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.
properties.privateIPAllocationMethod	IPAllocationMethod	The private IP address allocation method.
properties.provisioningState	ProvisioningState	The provisioning state of the private link service IP configuration resource.
properties.subnet	Subnet	The reference to the subnet resource.
type	string	The resource type.

ProvisioningState

Enumeration

The current provisioning state.

Value	Description
Deleting
Failed
Succeeded
Updating

PublicIPAddress

Object

Public IP address resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	ExtendedLocation	The extended location of the public ip address.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.ddosSettings	DdosSettings	The DDoS protection custom policy associated with the public IP address.
properties.deleteOption	DeleteOptions	Specify what happens to the public IP address when the VM using it is deleted
properties.dnsSettings	PublicIPAddressDnsSettings	The FQDN of the DNS record associated with the public IP address.
properties.idleTimeoutInMinutes	integer (int32)	The idle timeout of the public IP address.
properties.ipAddress	string	The IP address associated with the public IP address resource.
properties.ipConfiguration	IPConfiguration	The IP configuration associated with the public IP address.
properties.ipTags	IpTag[]	The list of tags associated with the public IP address.
properties.linkedPublicIPAddress	PublicIPAddress	The linked public IP address of the public IP address resource.
properties.migrationPhase	PublicIPAddressMigrationPhase	Migration phase of Public IP Address.
properties.natGateway	NatGateway	The NatGateway for the Public IP address.
properties.provisioningState	ProvisioningState	The provisioning state of the public IP address resource.
properties.publicIPAddressVersion	IPVersion	The public IP address version.
properties.publicIPAllocationMethod	IPAllocationMethod	The public IP address allocation method.
properties.publicIPPrefix	SubResource	The Public IP Prefix this Public IP Address should be allocated from.
properties.resourceGuid	string	The resource GUID property of the public IP address resource.
properties.servicePublicIPAddress	PublicIPAddress	The service public IP address of the public IP address resource.
sku	PublicIPAddressSku	The public IP address SKU.
tags	object	Resource tags.
type	string	Resource type.
zones	string[]	A list of availability zones denoting the IP allocated for the resource needs to come from.

PublicIPAddressDnsSettings

Object

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

Name	Type	Description
domainNameLabel	string	The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.
domainNameLabelScope	PublicIpAddressDnsSettingsDomainNameLabelScope	The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN.
fqdn	string	The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.
reverseFqdn	string	The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

PublicIpAddressDnsSettingsDomainNameLabelScope

Enumeration

The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN.

Value	Description
NoReuse
ResourceGroupReuse
SubscriptionReuse
TenantReuse

PublicIPAddressMigrationPhase

Enumeration

Migration phase of Public IP Address.

Value	Description
Abort
Commit
Committed
None
Prepare

PublicIPAddressSku

Object

SKU of a public IP address.

Name	Type	Description
name	PublicIPAddressSkuName	Name of a public IP address SKU.
tier	PublicIPAddressSkuTier	Tier of a public IP address SKU.

PublicIPAddressSkuName

Enumeration

Name of a public IP address SKU.

Value	Description
Basic
Standard

PublicIPAddressSkuTier

Enumeration

Tier of a public IP address SKU.

Value	Description
Global
Regional

ResourceIdentityType

Enumeration

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

Value	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ResourceNavigationLink

Object

ResourceNavigationLink resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource navigation link identifier.
name	string	Name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.link	string	Link to the external resource.
properties.linkedResourceType	string	Resource type of the linked resource.
properties.provisioningState	ProvisioningState	The provisioning state of the resource navigation link resource.
type	string	Resource type.

RetentionPolicyParameters

Object

Parameters that define the retention policy for flow log.

Name	Type	Default value	Description
days	integer (int32)	0	Number of days to retain flow log records.
enabled	boolean	False	Flag to enable/disable retention.

Route

Object

Route resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.addressPrefix	string	The destination CIDR to which the route applies.
properties.hasBgpOverride	boolean	A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
properties.nextHopIpAddress	string	The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
properties.nextHopType	RouteNextHopType	The type of Azure hop the packet should be sent to.
properties.provisioningState	ProvisioningState	The provisioning state of the route resource.
type	string	The type of the resource.

RouteNextHopType

Enumeration

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

Value	Description
Internet
None
VirtualAppliance
VirtualNetworkGateway
VnetLocal

RouteTable

Object

Route table resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.disableBgpRoutePropagation	boolean	Whether to disable the routes learned by BGP on that route table. True means disable.
properties.provisioningState	ProvisioningState	The provisioning state of the route table resource.
properties.resourceGuid	string	The resource GUID property of the route table.
properties.routes	Route[]	Collection of routes contained within a route table.
properties.subnets	Subnet[]	A collection of references to subnets.
tags	object	Resource tags.
type	string	Resource type.

SecurityRule

Object

Network security rule.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.access	SecurityRuleAccess	The network traffic is allowed or denied.
properties.description	string	A description for this rule. Restricted to 140 chars.
properties.destinationAddressPrefix	string	The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.
properties.destinationAddressPrefixes	string[]	The destination address prefixes. CIDR or destination IP ranges.
properties.destinationApplicationSecurityGroups	ApplicationSecurityGroup[]	The application security group specified as destination.
properties.destinationPortRange	string	The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
properties.destinationPortRanges	string[]	The destination port ranges.
properties.direction	SecurityRuleDirection	The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.
properties.priority	integer (int32)	The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
properties.protocol	SecurityRuleProtocol	Network protocol this rule applies to.
properties.provisioningState	ProvisioningState	The provisioning state of the security rule resource.
properties.sourceAddressPrefix	string	The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.
properties.sourceAddressPrefixes	string[]	The CIDR or source IP ranges.
properties.sourceApplicationSecurityGroups	ApplicationSecurityGroup[]	The application security group specified as source.
properties.sourcePortRange	string	The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
properties.sourcePortRanges	string[]	The source port ranges.
type	string	The type of the resource.

SecurityRuleAccess

Enumeration

Whether network traffic is allowed or denied.

Value	Description
Allow
Deny

SecurityRuleDirection

Enumeration

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

Value	Description
Inbound
Outbound

SecurityRuleProtocol

Enumeration

Network protocol this rule applies to.

Value	Description
*
Ah
Esp
Icmp
Tcp
Udp

ServiceAssociationLink

Object

ServiceAssociationLink resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.allowDelete	boolean	If true, the resource can be deleted.
properties.link	string	Link to the external resource.
properties.linkedResourceType	string	Resource type of the linked resource.
properties.locations	string[]	A list of locations.
properties.provisioningState	ProvisioningState	The provisioning state of the service association link resource.
type	string	Resource type.

ServiceEndpointPolicy

Object

Service End point policy resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
kind	string	Kind of service endpoint policy. This is metadata used for the Azure portal experience.
location	string	Resource location.
name	string	Resource name.
properties.contextualServiceEndpointPolicies	string[]	A collection of contextual service endpoint policy.
properties.provisioningState	ProvisioningState	The provisioning state of the service endpoint policy resource.
properties.resourceGuid	string	The resource GUID property of the service endpoint policy resource.
properties.serviceAlias	string	The alias indicating if the policy belongs to a service
properties.serviceEndpointPolicyDefinitions	ServiceEndpointPolicyDefinition[]	A collection of service endpoint policy definitions of the service endpoint policy.
properties.subnets	Subnet[]	A collection of references to subnets.
tags	object	Resource tags.
type	string	Resource type.

ServiceEndpointPolicyDefinition

Object

Service Endpoint policy definitions.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.description	string	A description for this rule. Restricted to 140 chars.
properties.provisioningState	ProvisioningState	The provisioning state of the service endpoint policy definition resource.
properties.service	string	Service endpoint name.
properties.serviceResources	string[]	A list of service resources.
type	string	The type of the resource.

ServiceEndpointPropertiesFormat

Object

The service endpoint properties.

Name	Type	Description
locations	string[]	A list of locations.
networkIdentifier	SubResource	SubResource as network identifier.
provisioningState	ProvisioningState	The provisioning state of the service endpoint resource.
service	string	The type of the endpoint service.

SharingScope

Enumeration

Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.

Value	Description
DelegatedServices
Tenant

Subnet

Object

Subnet in a virtual network resource.

Name	Type	Default value	Description
etag	string		A unique read-only string that changes whenever the resource is updated.
id	string		Resource ID.
name	string		The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.addressPrefix	string		The address prefix for the subnet.
properties.addressPrefixes	string[]		List of address prefixes for the subnet.
properties.applicationGatewayIPConfigurations	ApplicationGatewayIPConfiguration[]		Application gateway IP configurations of virtual network resource.
properties.defaultOutboundAccess	boolean		Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet.
properties.delegations	Delegation[]		An array of references to the delegations on the subnet.
properties.ipAllocations	SubResource[]		Array of IpAllocation which reference this subnet.
properties.ipConfigurationProfiles	IPConfigurationProfile[]		Array of IP configuration profiles which reference this subnet.
properties.ipConfigurations	IPConfiguration[]		An array of references to the network interface IP configurations using subnet.
properties.ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]		A list of IPAM Pools for allocating IP address prefixes.
properties.natGateway	SubResource		Nat gateway associated with this subnet.
properties.networkSecurityGroup	NetworkSecurityGroup		The reference to the NetworkSecurityGroup resource.
properties.privateEndpointNetworkPolicies	VirtualNetworkPrivateEndpointNetworkPolicies	Disabled	Enable or Disable apply network policies on private end point in the subnet.
properties.privateEndpoints	PrivateEndpoint[]		An array of references to private endpoints.
properties.privateLinkServiceNetworkPolicies	VirtualNetworkPrivateLinkServiceNetworkPolicies	Enabled	Enable or Disable apply network policies on private link service in the subnet.
properties.provisioningState	ProvisioningState		The provisioning state of the subnet resource.
properties.purpose	string		A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties.
properties.resourceNavigationLinks	ResourceNavigationLink[]		An array of references to the external resources using subnet.
properties.routeTable	RouteTable		The reference to the RouteTable resource.
properties.serviceAssociationLinks	ServiceAssociationLink[]		An array of references to services injecting into this subnet.
properties.serviceEndpointPolicies	ServiceEndpointPolicy[]		An array of service endpoint policies.
properties.serviceEndpoints	ServiceEndpointPropertiesFormat[]		An array of service endpoints.
properties.sharingScope	SharingScope		Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.
type	string		Resource type.

SubResource

Object

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

SyncMode

Enumeration

Backend address synchronous mode for the backend pool

Value	Description
Automatic
Manual

TrafficAnalyticsConfigurationProperties

Object

Parameters that define the configuration of traffic analytics.

Name	Type	Description
enabled	boolean	Flag to enable/disable traffic analytics.
trafficAnalyticsInterval	integer (int32)	The interval in minutes which would decide how frequently TA service should do flow analytics.
workspaceId	string	The resource guid of the attached workspace.
workspaceRegion	string	The location of the attached workspace.
workspaceResourceId	string	Resource Id of the attached workspace.

TrafficAnalyticsProperties

Object

Parameters that define the configuration of traffic analytics.

Name	Type	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parameters that define the configuration of traffic analytics.

TransportProtocol

Enumeration

The transport protocol for the endpoint.

Value	Description
All
Tcp
Udp

UserAssignedIdentities

Object

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name	Type	Description

VirtualNetworkPrivateEndpointNetworkPolicies

Enumeration

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

Value	Description
Disabled
Enabled
NetworkSecurityGroupEnabled
RouteTableEnabled

VirtualNetworkPrivateLinkServiceNetworkPolicies

Enumeration

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

Value	Description
Disabled
Enabled

VirtualNetworkTap

Object

Virtual Network Tap resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.destinationLoadBalancerFrontEndIPConfiguration	FrontendIPConfiguration	The reference to the private IP address on the internal Load Balancer that will receive the tap.
properties.destinationNetworkInterfaceIPConfiguration	NetworkInterfaceIPConfiguration	The reference to the private IP Address of the collector nic that will receive the tap.
properties.destinationPort	integer	The VXLAN destination port that will receive the tapped traffic.
properties.networkInterfaceTapConfigurations	NetworkInterfaceTapConfiguration[]	Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped.
properties.provisioningState	ProvisioningState	The provisioning state of the virtual network tap resource.
properties.resourceGuid	string	The resource GUID property of the virtual network tap resource.
tags	object	Resource tags.
type	string	Resource type.

Visibility

Object

The visibility list of the private link service.

Name	Type	Description
subscriptions	string[]	The list of subscriptions.