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

2026/01/07 • 730 new methods

ApplicationGateways_Delete (new)
Description :  Deletes the specified application gateway.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
applicationGatewayName:
{
Description: The name of the application gateway. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ApplicationGateways_Get (new)
Description :  Gets the specified application gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
applicationGatewayName:
{
Description: The name of the application gateway. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the application gateway. ,
Required: False ,
}
{
sku:
{
Description: SKU of the application gateway resource. ,
Required: False ,
}
{
name:
{
Description: Name of an application gateway SKU. ,
Enum:
{
Standard_Small: No description available. ,
Standard_Medium: No description available. ,
Standard_Large: No description available. ,
WAF_Medium: No description available. ,
WAF_Large: No description available. ,
Standard_v2: No description available. ,
WAF_v2: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of an application gateway. ,
Enum:
{
Standard: No description available. ,
WAF: No description available. ,
Standard_v2: No description available. ,
WAF_v2: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Capacity (instance count) of an application gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
family:
{
Description: Family of an application gateway SKU. ,
Enum:
{
Generation_1: No description available. ,
Generation_2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sslPolicy:
{
Description: SSL policy of the application gateway resource. ,
Required: False ,
}
{
disabledSslProtocols:
{
Description: Ssl protocols to be disabled on application gateway. ,
Required: False ,
}
[
string ,
]
,
policyType:
{
Description: Type of Ssl Policy. ,
Enum:
{
Predefined: No description available. ,
Custom: No description available. ,
CustomV2: No description available. ,
}
,
Required: False ,
}
enum ,
policyName:
{
Description: Name of Ssl predefined policy. ,
Enum:
{
AppGwSslPolicy20150501: No description available. ,
AppGwSslPolicy20170401: No description available. ,
AppGwSslPolicy20170401S: No description available. ,
AppGwSslPolicy20220101: No description available. ,
AppGwSslPolicy20220101S: No description available. ,
}
,
Required: False ,
}
enum ,
cipherSuites:
{
Description: Ssl cipher suites to be enabled in the specified order to application gateway. ,
Required: False ,
}
[
string ,
]
,
minProtocolVersion:
{
Description: Minimum version of Ssl protocol to be supported on application gateway. ,
Enum:
{
TLSv1_0: No description available. ,
TLSv1_1: No description available. ,
TLSv1_2: No description available. ,
TLSv1_3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
operationalState:
{
Description: Operational state of the application gateway resource. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayIPConfigurations:
{
Description: Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway IP configuration. ,
Required: False ,
}
{
subnet:
{
Description: Reference to the subnet resource. A subnet from where application gateway gets its private address. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application gateway IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
authenticationCertificates:
{
Description: Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway authentication certificate. ,
Required: False ,
}
{
data:
{
Description: Certificate public data. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the authentication certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the authentication certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
trustedRootCertificates:
{
Description: Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway trusted root certificate. ,
Required: False ,
}
{
data:
{
Description: Certificate public data. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the trusted root certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the trusted root certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
trustedClientCertificates:
{
Description: Trusted client certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway trusted client certificate. ,
Required: False ,
}
{
data:
{
Description: Certificate public data. ,
Required: False ,
}
string ,
validatedCertData:
{
Description: Validated certificate data. ,
Required: False ,
}
string ,
clientCertIssuerDN:
{
Description: Distinguished name of client certificate issuer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the trusted client certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the trusted client certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
sslCertificates:
{
Description: SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway SSL certificate. ,
Required: False ,
}
{
data:
{
Description: Base-64 encoded pfx certificate. Only applicable in PUT Request. ,
Required: False ,
}
string ,
password:
{
Description: Password for the pfx file specified in data. Only applicable in PUT request. ,
Required: False ,
}
string ,
publicCertData:
{
Description: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the SSL certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the SSL certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
frontendIPConfigurations:
{
Description: Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway frontend IP configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: PrivateIPAddress of the network interface IP Configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Reference to the subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
publicIPAddress:
{
Description: Reference to the PublicIP resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkConfiguration:
{
Description: Reference to the application gateway private link configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the frontend IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the frontend IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
frontendPorts:
{
Description: Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway frontend port. ,
Required: False ,
}
{
port:
{
Description: Frontend port. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the frontend port resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the frontend port that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
probes:
{
Description: Probes of the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway probe. ,
Required: False ,
}
{
protocol:
{
Description: The protocol used for the probe. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
host:
{
Description: Host name to send the probe to. ,
Required: False ,
}
string ,
path:
{
Description: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. ,
Required: False ,
}
string ,
interval:
{
Description: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
unhealthyThreshold:
{
Description: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
pickHostNameFromBackendHttpSettings:
{
Description: Whether the host header should be picked from the backend http settings. Default value is false. ,
Required: False ,
}
boolean ,
pickHostNameFromBackendSettings:
{
Description: Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false. ,
Required: False ,
}
boolean ,
minServers:
{
Description: Minimum number of servers that are always marked healthy. Default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
match:
{
Description: Criterion for classifying a healthy probe response. ,
Required: False ,
}
{
body:
{
Description: Body that must be contained in the health response. Default value is empty. ,
Required: False ,
}
string ,
statusCodes:
{
Description: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. ,
Required: False ,
}
[
string ,
]
,
}
,
enableProbeProxyProtocolHeader:
{
Description: Whether to send Proxy Protocol header along with the Health Probe over TCP or TLS protocol. Default value is false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the probe resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Name of the probe that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
backendAddressPools:
{
Description: Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway backend address pool. ,
Required: False ,
}
{
backendIPConfigurations:
{
Description: Collection of references to IPs defined in network interfaces. ,
Required: False ,
}
[
{
properties:
{
Description: Network interface IP configuration properties. ,
Required: False ,
}
{
gatewayLoadBalancer:
{
Description: The reference to gateway load balancer frontend IP. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
virtualNetworkTaps:
{
Description: The reference to Virtual Network Taps. ,
Required: False ,
}
[
{
properties:
{
Description: Virtual Network Tap Properties. ,
Required: False ,
}
{
networkInterfaceTapConfigurations:
{
Description: Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the virtual network tap resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the virtual network tap resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
destinationNetworkInterfaceIPConfiguration:
{
Required: False ,
}
string ,
destinationLoadBalancerFrontEndIPConfiguration:
{
Description: The reference to the private IP address on the internal Load Balancer that will receive the tap. ,
Required: False ,
}
{
properties:
{
Description: Properties of the load balancer probe. ,
Required: False ,
}
{
inboundNatRules:
{
Description: An array of references to inbound rules that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
inboundNatPools:
{
Description: An array of references to inbound pools that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
outboundRules:
{
Description: An array of references to outbound rules that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancingRules:
{
Description: An array of references to load balancing rules that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The Private IP allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The reference to the subnet resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
networkSecurityGroup:
{
Description: The reference to the NetworkSecurityGroup resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the network security group. ,
Required: False ,
}
{
flushConnection:
{
Description: When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. ,
Required: False ,
}
boolean ,
securityRules:
{
Description: A collection of security rules of the network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
defaultSecurityRules:
{
Description: The default security rules of network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
networkInterfaces:
{
Description: A collection of references to network interfaces. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the network interface. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the network interface. ,
Required: False ,
}
{
virtualMachine:
{
Description: The reference to a virtual machine. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
networkSecurityGroup:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: A reference to the private endpoint to which the network interface is linked. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
tapConfigurations:
{
Description: A list of TapConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
dnsSettings:
{
Description: The DNS settings in network interface. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. ,
Required: False ,
}
[
string ,
]
,
appliedDnsServers:
{
Description: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. ,
Required: False ,
}
[
string ,
]
,
internalDnsNameLabel:
{
Description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalFqdn:
{
Description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalDomainNameSuffix:
{
Description: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address of the network interface. ,
Required: False ,
}
string ,
primary:
{
Description: Whether this is a primary network interface on a virtual machine. ,
Required: False ,
}
boolean ,
vnetEncryptionSupported:
{
Description: Whether the virtual machine this nic is attached to supports encryption. ,
Required: False ,
}
boolean ,
defaultOutboundConnectivityEnabled:
{
Description: Whether default outbound connectivity for nic was configured or not. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Indicates whether to disable tcp state tracking. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Indicates whether IP forwarding is enabled on this network interface. ,
Required: False ,
}
boolean ,
hostedWorkloads:
{
Description: A list of references to linked BareMetal resources. ,
Required: False ,
}
[
string ,
]
,
dscpConfiguration:
{
Description: A reference to the dscp configuration to which the network interface is linked. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the network interface resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: WorkloadType of the NetworkInterface for BareMetal resources ,
Required: False ,
}
string ,
nicType:
{
Description: Type of Network Interface resource. ,
Enum:
{
Standard: No description available. ,
Elastic: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkService:
{
Description: Privatelinkservice of the network interface resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private link service. ,
Required: False ,
}
{
loadBalancerFrontendIpConfigurations:
{
Description: An array of references to the load balancer IP configurations. ,
Required: False ,
}
[
string ,
]
,
ipConfigurations:
{
Description: An array of private link service IP configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the private link service IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of private link service ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
destinationIPAddress:
{
Description: The destination IP address of the private link service. ,
Required: False ,
}
string ,
accessMode:
{
Description: The access mode of the private link service. ,
Enum:
{
Default: Allows unrestricted access to the private link service. ,
Restricted: Limits access to subscriptions which are inside visibility list only. ,
}
,
Required: False ,
}
enum ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private link service. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private link service resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: An array of list about connections to the private endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private end point connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
privateEndpointLocation:
{
Description: The location of the private endpoint. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
visibility:
{
Description: The visibility list of the private link service. ,
Required: False ,
}
string ,
autoApproval:
{
Description: The auto-approval list of the private link service. ,
Required: False ,
}
string ,
fqdns:
{
Description: The list of Fqdn. ,
Required: False ,
}
[
string ,
]
,
alias:
{
Description: The alias of the private link service. ,
Required: False ,
}
string ,
enableProxyProtocol:
{
Description: Whether the private link service is enabled for proxy protocol or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Network Interface resource. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Auxiliary mode of Network Interface resource. ,
Enum:
{
None: No description available. ,
MaxConnections: No description available. ,
Floating: No description available. ,
AcceleratedConnections: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Auxiliary sku of Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
flowLogs:
{
Description: A collection of references to flow log resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the flow log. ,
Required: False ,
}
{
targetResourceId:
{
Description: ID of network security group to which flow log will be applied. ,
Required: True ,
}
string ,
targetResourceGuid:
{
Description: Guid of network security group to which flow log will be applied. ,
Required: False ,
}
string ,
storageId:
{
Description: ID of the storage account which is used to store the flow log. ,
Required: True ,
}
string ,
enabledFilteringCriteria:
{
Description: 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. ,
Required: False ,
}
string ,
recordTypes:
{
Description: Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged. ,
Required: False ,
}
string ,
enabled:
{
Description: Flag to enable/disable flow logging. ,
Required: False ,
}
boolean ,
retentionPolicy:
{
Description: Parameters that define the retention policy for flow log. ,
Required: False ,
}
{
days:
{
Description: Number of days to retain flow log records. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: Flag to enable/disable retention. ,
Required: False ,
}
boolean ,
}
,
format:
{
Description: Parameters that define the flow log format. ,
Required: False ,
}
{
type:
{
Description: The file type of flow log. ,
Enum:
{
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version (revision) of the flow log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
flowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
networkWatcherFlowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
enabled:
{
Description: Flag to enable/disable traffic analytics. ,
Required: False ,
}
boolean ,
workspaceId:
{
Description: The resource guid of the attached workspace. ,
Required: False ,
}
string ,
workspaceRegion:
{
Description: The location of the attached workspace. ,
Required: False ,
}
string ,
workspaceResourceId:
{
Description: Resource Id of the attached workspace. ,
Required: False ,
}
string ,
trafficAnalyticsInterval:
{
Description: The interval in minutes which would decide how frequently TA service should do flow analytics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the flow log. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
identity:
{
Description: FlowLog resource Managed Identity ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the network security group resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: The reference to the RouteTable resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopType:
{
Description: The type of Azure hop the packet should be sent to. ,
Enum:
{
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
Internet: No description available. ,
VirtualAppliance: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the route resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
hasBgpOverride:
{
Description: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
disableBgpRoutePropagation:
{
Description: Whether to disable the routes learned by BGP on that route table. True means disable. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the route table resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resource GUID property of the route table. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
natGateway:
{
Description: Nat gateway associated with this subnet. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceEndpoints:
{
Description: An array of service endpoints. ,
Required: False ,
}
[
{
service:
{
Description: The type of the endpoint service. ,
Required: False ,
}
string ,
networkIdentifier:
{
Description: SubResource as network identifier. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serviceEndpointPolicies:
{
Description: An array of service endpoint policies. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the service end point policy. ,
Required: False ,
}
{
serviceEndpointPolicyDefinitions:
{
Description: A collection of service endpoint policy definitions of the service endpoint policy. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the service endpoint policy definition. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
service:
{
Description: Service endpoint name. ,
Required: False ,
}
string ,
serviceResources:
{
Description: A list of service resources. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service endpoint policy definition resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
resourceGuid:
{
Description: The resource GUID property of the service endpoint policy resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the service endpoint policy resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
serviceAlias:
{
Description: The alias indicating if the policy belongs to a service ,
Required: False ,
}
string ,
contextualServiceEndpointPolicies:
{
Description: A collection of contextual service endpoint policy. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of service endpoint policy. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
}
,
]
,
privateEndpoints:
{
Description: An array of references to private endpoints. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: An array of references to the network interface IP configurations using subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the IP configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
publicIPAddress:
{
Description: The reference to the public IP resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The provisioning state of the IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurationProfiles:
{
Description: Array of IP configuration profiles which reference this subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the IP configuration profile. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the IP configuration profile resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipAllocations:
{
Description: Array of IpAllocation which reference this subnet. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
resourceNavigationLinks:
{
Description: An array of references to the external resources using subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Resource navigation link properties format. ,
Required: False ,
}
{
linkedResourceType:
{
Description: Resource type of the linked resource. ,
Required: False ,
}
string ,
link:
{
Description: Link to the external resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource navigation link resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
id:
{
Description: Resource navigation link identifier. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
serviceAssociationLinks:
{
Description: An array of references to services injecting into this subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Resource navigation link properties format. ,
Required: False ,
}
{
linkedResourceType:
{
Description: Resource type of the linked resource. ,
Required: False ,
}
string ,
link:
{
Description: Link to the external resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the service association link resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
allowDelete:
{
Description: If true, the resource can be deleted. ,
Required: False ,
}
boolean ,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: Name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
delegations:
{
Description: An array of references to the delegations on the subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
serviceName:
{
Description: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). ,
Required: False ,
}
string ,
actions:
{
Description: The actions permitted to the service upon delegation. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service delegation resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a subnet. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
purpose:
{
Description: A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the subnet resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointNetworkPolicies:
{
Description: Enable or Disable apply network policies on private end point in the subnet. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NetworkSecurityGroupEnabled: No description available. ,
RouteTableEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceNetworkPolicies:
{
Description: Enable or Disable apply network policies on private link service in the subnet. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayIPConfigurations:
{
Description: Application gateway IP configurations of virtual network resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway IP configuration. ,
Required: False ,
}
{
subnet:
{
Description: Reference to the subnet resource. A subnet from where application gateway gets its private address. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application gateway IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
sharingScope:
{
Description: 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. ,
Enum:
{
Tenant: No description available. ,
DelegatedServices: No description available. ,
}
,
Required: False ,
}
enum ,
defaultOutboundAccess:
{
Description: Set this property to false to disable default outbound connectivity for all VMs in the subnet. ,
Required: False ,
}
boolean ,
ipamPoolPrefixAllocations:
{
Description: A list of IPAM Pools for allocating IP address prefixes. ,
Required: False ,
}
[
{
pool:
{
Required: False ,
}
{
id:
{
Description: Resource id of the associated Azure IpamPool resource. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
numberOfIpAddresses:
{
Description: Number of IP addresses to allocate. ,
Required: False ,
}
string ,
allocatedAddressPrefixes:
{
Description: List of assigned IP address prefixes in the IpamPool of the associated resource. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
publicIPAddress:
{
Description: The reference to the Public IP resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
publicIPPrefix:
{
Description: The reference to the Public IP Prefix resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
gatewayLoadBalancer:
{
Description: The reference to gateway load balancer frontend IP. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the frontend IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationPort:
{
Description: The VXLAN destination port that will receive the tapped traffic. ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: The reference to ApplicationGatewayBackendAddressPool resource. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: Name of the backend address pool that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: The reference to LoadBalancerBackendAddressPool resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of load balancer backend address pool. ,
Required: False ,
}
{
location:
{
Description: The location of the backend address pool. ,
Required: False ,
}
string ,
tunnelInterfaces:
{
Description: An array of gateway load balancer tunnel interfaces. ,
Required: False ,
}
[
{
port:
{
Description: Port of gateway load balancer tunnel interface. ,
Format: int32 ,
Required: False ,
}
integer ,
identifier:
{
Description: Identifier of gateway load balancer tunnel interface. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: Protocol of gateway load balancer tunnel interface. ,
Enum:
{
None: No description available. ,
Native: No description available. ,
VXLAN: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Traffic type of gateway load balancer tunnel interface. ,
Enum:
{
None: No description available. ,
Internal: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
loadBalancerBackendAddresses:
{
Description: An array of backend addresses. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of load balancer backend address pool. ,
Required: False ,
}
{
virtualNetwork:
{
Description: Reference to an existing virtual network. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: Reference to an existing subnet. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
ipAddress:
{
Description: IP Address belonging to the referenced virtual network. ,
Required: False ,
}
string ,
networkInterfaceIPConfiguration:
{
Description: Reference to IP address defined in network interfaces. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
loadBalancerFrontendIPConfiguration:
{
Description: Reference to the frontend ip address configuration defined in regional loadbalancer. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
inboundNatRulesPortMapping:
{
Description: Collection of inbound NAT rule port mappings. ,
Required: False ,
}
[
{
inboundNatRuleName:
{
Description: Name of inbound NAT rule. ,
Required: False ,
}
string ,
frontendPort:
{
Description: Frontend port. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: Backend port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
adminState:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Up: No description available. ,
Down: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the backend address. ,
Required: False ,
}
string ,
}
,
]
,
backendIPConfigurations:
{
Description: An array of references to IP addresses defined in network interfaces. ,
Required: False ,
}
[
string ,
]
,
loadBalancingRules:
{
Description: An array of references to load balancing rules that use this backend address pool. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
outboundRule:
{
Description: A reference to an outbound rule that uses this backend address pool. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
outboundRules:
{
Description: An array of references to outbound rules that use this backend address pool. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
inboundNatRules:
{
Description: An array of references to inbound NAT rules that use this backend address pool. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the backend address pool resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
drainPeriodInSeconds:
{
Description: Amount of seconds Load Balancer waits for before sending RESET to client and backend address. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualNetwork:
{
Description: A reference to a virtual network. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
syncMode:
{
Description: Backend address synchronous mode for the backend pool ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: 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. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatRules:
{
Description: A list of references of LoadBalancerInboundNatRules. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of load balancer inbound NAT rule. ,
Required: False ,
}
{
frontendIPConfiguration:
{
Description: A reference to frontend IP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
backendIPConfiguration:
{
Required: False ,
}
string ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
Udp: No description available. ,
Tcp: No description available. ,
All: No description available. ,
Quic: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port used for the internal endpoint. Acceptable values range from 1 to 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
idleTimeoutInMinutes:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
enableFloatingIP:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableTcpReset:
{
Description: 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. ,
Required: False ,
}
boolean ,
frontendPortRangeStart:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeEnd:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
backendAddressPool:
{
Description: A reference to backendAddressPool resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the inbound NAT rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
privateIPAddress:
{
Description: Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format
/. ,
Required: False ,
}
string ,
privateIPAddressPrefixLength:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet bound to the IP configuration. ,
Required: False ,
}
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
networkSecurityGroup:
{
Description: The reference to the NetworkSecurityGroup resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the network security group. ,
Required: False ,
}
{
flushConnection:
{
Description: When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. ,
Required: False ,
}
boolean ,
securityRules:
{
Description: A collection of security rules of the network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
defaultSecurityRules:
{
Description: The default security rules of network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
networkInterfaces:
{
Description: A collection of references to network interfaces. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the network interface. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the network interface. ,
Required: False ,
}
{
virtualMachine:
{
Description: The reference to a virtual machine. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
networkSecurityGroup:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: A reference to the private endpoint to which the network interface is linked. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
tapConfigurations:
{
Description: A list of TapConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
dnsSettings:
{
Description: The DNS settings in network interface. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. ,
Required: False ,
}
[
string ,
]
,
appliedDnsServers:
{
Description: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. ,
Required: False ,
}
[
string ,
]
,
internalDnsNameLabel:
{
Description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalFqdn:
{
Description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalDomainNameSuffix:
{
Description: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address of the network interface. ,
Required: False ,
}
string ,
primary:
{
Description: Whether this is a primary network interface on a virtual machine. ,
Required: False ,
}
boolean ,
vnetEncryptionSupported:
{
Description: Whether the virtual machine this nic is attached to supports encryption. ,
Required: False ,
}
boolean ,
defaultOutboundConnectivityEnabled:
{
Description: Whether default outbound connectivity for nic was configured or not. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Indicates whether to disable tcp state tracking. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Indicates whether IP forwarding is enabled on this network interface. ,
Required: False ,
}
boolean ,
hostedWorkloads:
{
Description: A list of references to linked BareMetal resources. ,
Required: False ,
}
[
string ,
]
,
dscpConfiguration:
{
Description: A reference to the dscp configuration to which the network interface is linked. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the network interface resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: WorkloadType of the NetworkInterface for BareMetal resources ,
Required: False ,
}
string ,
nicType:
{
Description: Type of Network Interface resource. ,
Enum:
{
Standard: No description available. ,
Elastic: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkService:
{
Description: Privatelinkservice of the network interface resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private link service. ,
Required: False ,
}
{
loadBalancerFrontendIpConfigurations:
{
Description: An array of references to the load balancer IP configurations. ,
Required: False ,
}
[
string ,
]
,
ipConfigurations:
{
Description: An array of private link service IP configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the private link service IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of private link service ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
destinationIPAddress:
{
Description: The destination IP address of the private link service. ,
Required: False ,
}
string ,
accessMode:
{
Description: The access mode of the private link service. ,
Enum:
{
Default: Allows unrestricted access to the private link service. ,
Restricted: Limits access to subscriptions which are inside visibility list only. ,
}
,
Required: False ,
}
enum ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private link service. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private link service resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: An array of list about connections to the private endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private end point connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
privateEndpointLocation:
{
Description: The location of the private endpoint. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
visibility:
{
Description: The visibility list of the private link service. ,
Required: False ,
}
string ,
autoApproval:
{
Description: The auto-approval list of the private link service. ,
Required: False ,
}
string ,
fqdns:
{
Description: The list of Fqdn. ,
Required: False ,
}
[
string ,
]
,
alias:
{
Description: The alias of the private link service. ,
Required: False ,
}
string ,
enableProxyProtocol:
{
Description: Whether the private link service is enabled for proxy protocol or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Network Interface resource. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Auxiliary mode of Network Interface resource. ,
Enum:
{
None: No description available. ,
MaxConnections: No description available. ,
Floating: No description available. ,
AcceleratedConnections: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Auxiliary sku of Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
flowLogs:
{
Description: A collection of references to flow log resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the flow log. ,
Required: False ,
}
{
targetResourceId:
{
Description: ID of network security group to which flow log will be applied. ,
Required: True ,
}
string ,
targetResourceGuid:
{
Description: Guid of network security group to which flow log will be applied. ,
Required: False ,
}
string ,
storageId:
{
Description: ID of the storage account which is used to store the flow log. ,
Required: True ,
}
string ,
enabledFilteringCriteria:
{
Description: 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. ,
Required: False ,
}
string ,
recordTypes:
{
Description: Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged. ,
Required: False ,
}
string ,
enabled:
{
Description: Flag to enable/disable flow logging. ,
Required: False ,
}
boolean ,
retentionPolicy:
{
Description: Parameters that define the retention policy for flow log. ,
Required: False ,
}
{
days:
{
Description: Number of days to retain flow log records. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: Flag to enable/disable retention. ,
Required: False ,
}
boolean ,
}
,
format:
{
Description: Parameters that define the flow log format. ,
Required: False ,
}
{
type:
{
Description: The file type of flow log. ,
Enum:
{
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version (revision) of the flow log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
flowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
networkWatcherFlowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
enabled:
{
Description: Flag to enable/disable traffic analytics. ,
Required: False ,
}
boolean ,
workspaceId:
{
Description: The resource guid of the attached workspace. ,
Required: False ,
}
string ,
workspaceRegion:
{
Description: The location of the attached workspace. ,
Required: False ,
}
string ,
workspaceResourceId:
{
Description: Resource Id of the attached workspace. ,
Required: False ,
}
string ,
trafficAnalyticsInterval:
{
Description: The interval in minutes which would decide how frequently TA service should do flow analytics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the flow log. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
identity:
{
Description: FlowLog resource Managed Identity ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the network security group resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: The reference to the RouteTable resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopType:
{
Description: The type of Azure hop the packet should be sent to. ,
Enum:
{
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
Internet: No description available. ,
VirtualAppliance: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the route resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
hasBgpOverride:
{
Description: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
disableBgpRoutePropagation:
{
Description: Whether to disable the routes learned by BGP on that route table. True means disable. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the route table resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resource GUID property of the route table. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
natGateway:
{
Description: Nat gateway associated with this subnet. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceEndpoints:
{
Description: An array of service endpoints. ,
Required: False ,
}
[
{
service:
{
Description: The type of the endpoint service. ,
Required: False ,
}
string ,
networkIdentifier:
{
Description: SubResource as network identifier. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serviceEndpointPolicies:
{
Description: An array of service endpoint policies. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the service end point policy. ,
Required: False ,
}
{
serviceEndpointPolicyDefinitions:
{
Description: A collection of service endpoint policy definitions of the service endpoint policy. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the service endpoint policy definition. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
service:
{
Description: Service endpoint name. ,
Required: False ,
}
string ,
serviceResources:
{
Description: A list of service resources. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service endpoint policy definition resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
resourceGuid:
{
Description: The resource GUID property of the service endpoint policy resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the service endpoint policy resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
serviceAlias:
{
Description: The alias indicating if the policy belongs to a service ,
Required: False ,
}
string ,
contextualServiceEndpointPolicies:
{
Description: A collection of contextual service endpoint policy. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of service endpoint policy. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
}
,
]
,
privateEndpoints:
{
Description: An array of references to private endpoints. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: An array of references to the network interface IP configurations using subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the IP configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
publicIPAddress:
{
Description: The reference to the public IP resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The provisioning state of the IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurationProfiles:
{
Description: Array of IP configuration profiles which reference this subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the IP configuration profile. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the IP configuration profile resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipAllocations:
{
Description: Array of IpAllocation which reference this subnet. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
resourceNavigationLinks:
{
Description: An array of references to the external resources using subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Resource navigation link properties format. ,
Required: False ,
}
{
linkedResourceType:
{
Description: Resource type of the linked resource. ,
Required: False ,
}
string ,
link:
{
Description: Link to the external resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource navigation link resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
id:
{
Description: Resource navigation link identifier. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
serviceAssociationLinks:
{
Description: An array of references to services injecting into this subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Resource navigation link properties format. ,
Required: False ,
}
{
linkedResourceType:
{
Description: Resource type of the linked resource. ,
Required: False ,
}
string ,
link:
{
Description: Link to the external resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the service association link resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
allowDelete:
{
Description: If true, the resource can be deleted. ,
Required: False ,
}
boolean ,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: Name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
delegations:
{
Description: An array of references to the delegations on the subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
serviceName:
{
Description: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). ,
Required: False ,
}
string ,
actions:
{
Description: The actions permitted to the service upon delegation. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service delegation resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a subnet. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
purpose:
{
Description: A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the subnet resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointNetworkPolicies:
{
Description: Enable or Disable apply network policies on private end point in the subnet. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NetworkSecurityGroupEnabled: No description available. ,
RouteTableEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceNetworkPolicies:
{
Description: Enable or Disable apply network policies on private link service in the subnet. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayIPConfigurations:
{
Description: Application gateway IP configurations of virtual network resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway IP configuration. ,
Required: False ,
}
{
subnet:
{
Description: Reference to the subnet resource. A subnet from where application gateway gets its private address. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application gateway IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
sharingScope:
{
Description: 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. ,
Enum:
{
Tenant: No description available. ,
DelegatedServices: No description available. ,
}
,
Required: False ,
}
enum ,
defaultOutboundAccess:
{
Description: Set this property to false to disable default outbound connectivity for all VMs in the subnet. ,
Required: False ,
}
boolean ,
ipamPoolPrefixAllocations:
{
Description: A list of IPAM Pools for allocating IP address prefixes. ,
Required: False ,
}
[
{
pool:
{
Required: False ,
}
{
id:
{
Description: Resource id of the associated Azure IpamPool resource. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
numberOfIpAddresses:
{
Description: Number of IP addresses to allocate. ,
Required: False ,
}
string ,
allocatedAddressPrefixes:
{
Description: List of assigned IP address prefixes in the IpamPool of the associated resource. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Whether this is a primary customer address on the network interface. ,
Required: False ,
}
boolean ,
publicIPAddress:
{
Description: Public IP address bound to the IP configuration. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
applicationSecurityGroups:
{
Description: Application security groups in which the IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the network interface IP configuration. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkConnectionProperties:
{
Description: PrivateLinkConnection properties for the network interface. ,
Required: False ,
}
{
groupId:
{
Description: The group ID for current private link connection. ,
Required: False ,
}
string ,
requiredMemberName:
{
Description: The required member name for current private link connection. ,
Required: False ,
}
string ,
fqdns:
{
Description: List of FQDNs for current private link connection. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
backendAddresses:
{
Description: Backend addresses. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fully qualified domain name (FQDN). ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the backend address pool resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the backend address pool that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
backendHttpSettingsCollection:
{
Description: Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway backend HTTP settings. ,
Required: False ,
}
{
port:
{
Description: The destination port on the backend. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol used to communicate with the backend. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
cookieBasedAffinity:
{
Description: Cookie based affinity. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requestTimeout:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
probe:
{
Description: Probe resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
authenticationCertificates:
{
Description: Array of references to application gateway authentication certificates. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trustedRootCertificates:
{
Description: Array of references to application gateway trusted root certificates. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
connectionDraining:
{
Description: Connection draining of the backend http settings resource. ,
Required: False ,
}
{
enabled:
{
Description: Whether connection draining is enabled or not. ,
Required: True ,
}
boolean ,
drainTimeoutInSec:
{
Description: The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
hostName:
{
Description: Host header to be sent to the backend servers. ,
Required: False ,
}
string ,
pickHostNameFromBackendAddress:
{
Description: Whether to pick host header should be picked from the host name of the backend server. Default value is false. ,
Required: False ,
}
boolean ,
affinityCookieName:
{
Description: Cookie name to use for the affinity cookie. ,
Required: False ,
}
string ,
probeEnabled:
{
Description: Whether the probe is enabled. Default value is false. ,
Required: False ,
}
boolean ,
path:
{
Description: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. ,
Required: False ,
}
string ,
dedicatedBackendConnection:
{
Description: Enable or disable dedicated connection per backend server. Default is set to false. ,
Required: False ,
}
boolean ,
validateCertChainAndExpiry:
{
Description: Verify or skip both chain and expiry validations of the certificate on the backend server. Default is set to true. ,
Required: False ,
}
boolean ,
validateSNI:
{
Description: When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value. Default value is true. ,
Required: False ,
}
boolean ,
sniName:
{
Description: Specify an SNI value to match the common name of the certificate on the backend. By default, the application gateway uses the incoming request’s host header as the SNI. Default value is null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the backend HTTP settings resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the backend http settings that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
backendSettingsCollection:
{
Description: Backend settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway backend settings. ,
Required: False ,
}
{
port:
{
Description: The destination port on the backend. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol used to communicate with the backend. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
timeout:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
probe:
{
Description: Probe resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
trustedRootCertificates:
{
Description: Array of references to application gateway trusted root certificates. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
hostName:
{
Description: Server name indication to be sent to the backend servers for Tls protocol. ,
Required: False ,
}
string ,
pickHostNameFromBackendAddress:
{
Description: Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false. ,
Required: False ,
}
boolean ,
enableL4ClientIpPreservation:
{
Description: Whether to send Proxy Protocol header to backend servers over TCP or TLS protocols. Default value is false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the backend HTTP settings resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the backend settings that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
httpListeners:
{
Description: Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway HTTP listener. ,
Required: False ,
}
{
frontendIPConfiguration:
{
Description: Frontend IP configuration resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
frontendPort:
{
Description: Frontend port resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
protocol:
{
Description: Protocol of the HTTP listener. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Host name of HTTP listener. ,
Required: False ,
}
string ,
sslCertificate:
{
Description: SSL certificate resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
sslProfile:
{
Description: SSL profile resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
requireServerNameIndication:
{
Description: Applicable only if protocol is https. Enables SNI for multi-hosting. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the HTTP listener resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customErrorConfigurations:
{
Description: Custom error configurations of the HTTP listener. ,
Required: False ,
}
[
{
statusCode:
{
Description: Status code of the application gateway custom error. ,
Enum:
{
HttpStatus400: No description available. ,
HttpStatus403: No description available. ,
HttpStatus404: No description available. ,
HttpStatus405: No description available. ,
HttpStatus408: No description available. ,
HttpStatus500: No description available. ,
HttpStatus502: No description available. ,
HttpStatus503: No description available. ,
HttpStatus504: No description available. ,
}
,
Required: False ,
}
enum ,
customErrorPageUrl:
{
Description: Error page URL of the application gateway custom error. ,
Required: False ,
}
string ,
}
,
]
,
firewallPolicy:
{
Description: Reference to the FirewallPolicy resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
hostNames:
{
Description: List of Host names for HTTP Listener that allows special wildcard characters as well. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: Name of the HTTP listener that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
listeners:
{
Description: Listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway listener. ,
Required: False ,
}
{
frontendIPConfiguration:
{
Description: Frontend IP configuration resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
frontendPort:
{
Description: Frontend port resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
protocol:
{
Description: Protocol of the listener. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
sslCertificate:
{
Description: SSL certificate resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
sslProfile:
{
Description: SSL profile resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the listener resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
hostNames:
{
Description: List of Server Name Indications(SNI) for TLS Multi-site Listener that allows special wildcard characters as well. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: Name of the listener that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
sslProfiles:
{
Description: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway SSL profile. ,
Required: False ,
}
{
trustedClientCertificates:
{
Description: Array of references to application gateway trusted client certificates. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sslPolicy:
{
Description: SSL policy of the application gateway resource. ,
Required: False ,
}
{
disabledSslProtocols:
{
Description: Ssl protocols to be disabled on application gateway. ,
Required: False ,
}
[
string ,
]
,
policyType:
{
Description: Type of Ssl Policy. ,
Enum:
{
Predefined: No description available. ,
Custom: No description available. ,
CustomV2: No description available. ,
}
,
Required: False ,
}
enum ,
policyName:
{
Description: Name of Ssl predefined policy. ,
Enum:
{
AppGwSslPolicy20150501: No description available. ,
AppGwSslPolicy20170401: No description available. ,
AppGwSslPolicy20170401S: No description available. ,
AppGwSslPolicy20220101: No description available. ,
AppGwSslPolicy20220101S: No description available. ,
}
,
Required: False ,
}
enum ,
cipherSuites:
{
Description: Ssl cipher suites to be enabled in the specified order to application gateway. ,
Required: False ,
}
[
string ,
]
,
minProtocolVersion:
{
Description: Minimum version of Ssl protocol to be supported on application gateway. ,
Enum:
{
TLSv1_0: No description available. ,
TLSv1_1: No description available. ,
TLSv1_2: No description available. ,
TLSv1_3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientAuthConfiguration:
{
Description: Client authentication configuration of the application gateway resource. ,
Required: False ,
}
{
verifyClientCertIssuerDN:
{
Description: Verify client certificate issuer name on the application gateway. ,
Required: False ,
}
boolean ,
verifyClientRevocation:
{
Description: Verify client certificate revocation status. ,
Enum:
{
None: No description available. ,
OCSP: No description available. ,
}
,
Required: False ,
}
enum ,
verifyClientAuthMode:
{
Description: Verify client Authentication mode. ,
Enum:
{
Strict: No description available. ,
Passthrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of the HTTP listener resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the SSL profile that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
urlPathMaps:
{
Description: URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway URL path map. ,
Required: False ,
}
{
defaultBackendAddressPool:
{
Description: Default backend address pool resource of URL path map. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
defaultBackendHttpSettings:
{
Description: Default backend http settings resource of URL path map. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
defaultRewriteRuleSet:
{
Description: Default Rewrite rule set resource of URL path map. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
defaultRedirectConfiguration:
{
Description: Default redirect configuration resource of URL path map. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
defaultLoadDistributionPolicy:
{
Description: Default Load Distribution Policy resource of URL path map. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
pathRules:
{
Description: Path rule of URL path map resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway path rule. ,
Required: False ,
}
{
paths:
{
Description: Path rules of URL path map. ,
Required: False ,
}
[
string ,
]
,
backendAddressPool:
{
Description: Backend address pool resource of URL path map path rule. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
backendHttpSettings:
{
Description: Backend http settings resource of URL path map path rule. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
redirectConfiguration:
{
Description: Redirect configuration resource of URL path map path rule. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
rewriteRuleSet:
{
Description: Rewrite rule set resource of URL path map path rule. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
loadDistributionPolicy:
{
Description: Load Distribution Policy resource of URL path map path rule. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the path rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
firewallPolicy:
{
Description: Reference to the FirewallPolicy resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Name of the path rule that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the URL path map resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the URL path map that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
requestRoutingRules:
{
Description: Request routing rules of the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway request routing rule. ,
Required: False ,
}
{
ruleType:
{
Description: Rule type. ,
Enum:
{
Basic: No description available. ,
PathBasedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of the request routing rule. ,
Format: int32 ,
Required: False ,
}
integer ,
backendAddressPool:
{
Description: Backend address pool resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
backendHttpSettings:
{
Description: Backend http settings resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
httpListener:
{
Description: Http listener resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
urlPathMap:
{
Description: URL path map resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
rewriteRuleSet:
{
Description: Rewrite Rule Set resource in Basic rule of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
redirectConfiguration:
{
Description: Redirect configuration resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
loadDistributionPolicy:
{
Description: Load Distribution Policy resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
entraJWTValidationConfig:
{
Description: Entra JWT validation configuration resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the request routing rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the request routing rule that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
routingRules:
{
Description: Routing rules of the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway routing rule. ,
Required: False ,
}
{
ruleType:
{
Description: Rule type. ,
Enum:
{
Basic: No description available. ,
PathBasedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of the routing rule. ,
Format: int32 ,
Required: True ,
}
integer ,
backendAddressPool:
{
Description: Backend address pool resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
backendSettings:
{
Description: Backend settings resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
listener:
{
Description: Listener resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the request routing rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the routing rule that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
rewriteRuleSets:
{
Description: Rewrite rules for the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway rewrite rule set. ,
Required: False ,
}
{
rewriteRules:
{
Description: Rewrite rules in the rewrite rule set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the rewrite rule that is unique within an Application Gateway. ,
Required: False ,
}
string ,
ruleSequence:
{
Description: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. ,
Required: False ,
}
integer ,
conditions:
{
Description: Conditions based on which the action set execution will be evaluated. ,
Required: False ,
}
[
{
variable:
{
Description: The condition parameter of the RewriteRuleCondition. ,
Required: False ,
}
string ,
pattern:
{
Description: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. ,
Required: False ,
}
string ,
ignoreCase:
{
Description: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. ,
Required: False ,
}
boolean ,
negate:
{
Description: Setting this value as truth will force to check the negation of the condition given by the user. ,
Required: False ,
}
boolean ,
}
,
]
,
actionSet:
{
Description: Set of actions to be done as part of the rewrite Rule. ,
Required: False ,
}
{
requestHeaderConfigurations:
{
Description: Request Header Actions in the Action Set. ,
Required: False ,
}
[
{
headerName:
{
Description: Header name of the header configuration. ,
Required: False ,
}
string ,
headerValueMatcher:
{
Description: 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 ,
Required: False ,
}
{
pattern:
{
Description: The pattern, either fixed string or regular expression, that evaluates if a header value should be selected for rewrite. ,
Required: False ,
}
string ,
ignoreCase:
{
Description: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. ,
Required: False ,
}
boolean ,
negate:
{
Description: Setting this value as truth will force to check the negation of the condition given by the user in the pattern field. ,
Required: False ,
}
boolean ,
}
,
headerValue:
{
Description: Header value of the header configuration. ,
Required: False ,
}
string ,
}
,
]
,
responseHeaderConfigurations:
{
Description: Response Header Actions in the Action Set. ,
Required: False ,
}
[
{
headerName:
{
Description: Header name of the header configuration. ,
Required: False ,
}
string ,
headerValueMatcher:
{
Description: 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 ,
Required: False ,
}
{
pattern:
{
Description: The pattern, either fixed string or regular expression, that evaluates if a header value should be selected for rewrite. ,
Required: False ,
}
string ,
ignoreCase:
{
Description: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. ,
Required: False ,
}
boolean ,
negate:
{
Description: Setting this value as truth will force to check the negation of the condition given by the user in the pattern field. ,
Required: False ,
}
boolean ,
}
,
headerValue:
{
Description: Header value of the header configuration. ,
Required: False ,
}
string ,
}
,
]
,
urlConfiguration:
{
Description: Url Configuration Action in the Action Set. ,
Required: False ,
}
{
modifiedPath:
{
Description: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. ,
Required: False ,
}
string ,
modifiedQueryString:
{
Description: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. ,
Required: False ,
}
string ,
reroute:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the rewrite rule set resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the rewrite rule set that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
redirectConfigurations:
{
Description: Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway redirect configuration. ,
Required: False ,
}
{
redirectType:
{
Description: HTTP redirection type. ,
Enum:
{
Permanent: No description available. ,
Found: No description available. ,
SeeOther: No description available. ,
Temporary: No description available. ,
}
,
Required: False ,
}
enum ,
targetListener:
{
Description: Reference to a listener to redirect the request to. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
targetUrl:
{
Description: Url to redirect the request to. ,
Required: False ,
}
string ,
includePath:
{
Description: Include path in the redirected url. ,
Required: False ,
}
boolean ,
includeQueryString:
{
Description: Include query string in the redirected url. ,
Required: False ,
}
boolean ,
requestRoutingRules:
{
Description: Request routing specifying redirect configuration. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
urlPathMaps:
{
Description: Url path maps specifying default redirect configuration. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
pathRules:
{
Description: Path rules specifying redirect configuration. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
name:
{
Description: Name of the redirect configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
webApplicationFirewallConfiguration:
{
Description: Web application firewall configuration. ,
Required: False ,
}
{
enabled:
{
Description: Whether the web application firewall is enabled or not. ,
Required: True ,
}
boolean ,
firewallMode:
{
Description: Web application firewall mode. ,
Enum:
{
Detection: No description available. ,
Prevention: No description available. ,
}
,
Required: True ,
}
enum ,
ruleSetType:
{
Description: The type of the web application firewall rule set. Possible values are: 'OWASP'. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: The version of the rule set type. ,
Required: True ,
}
string ,
disabledRuleGroups:
{
Description: The disabled rule groups. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: The name of the rule group that will be disabled. ,
Required: True ,
}
string ,
rules:
{
Description: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
requestBodyCheck:
{
Description: Whether allow WAF to check request Body. ,
Required: False ,
}
boolean ,
maxRequestBodySize:
{
Description: Maximum request body size for WAF. ,
Format: int32 ,
Required: False ,
}
integer ,
maxRequestBodySizeInKb:
{
Description: Maximum request body size in Kb for WAF. ,
Format: int32 ,
Required: False ,
}
integer ,
fileUploadLimitInMb:
{
Description: Maximum file upload size in Mb for WAF. ,
Format: int32 ,
Required: False ,
}
integer ,
exclusions:
{
Description: The exclusion list. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be excluded. ,
Required: True ,
}
string ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
firewallPolicy:
{
Description: Reference to the FirewallPolicy resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
enableHttp2:
{
Description: Whether HTTP2 is enabled on the application gateway resource. ,
Required: False ,
}
boolean ,
enableFips:
{
Description: Whether FIPS is enabled on the application gateway resource. ,
Required: False ,
}
boolean ,
autoscaleConfiguration:
{
Description: Autoscale Configuration. ,
Required: False ,
}
{
minCapacity:
{
Description: Lower bound on number of Application Gateway capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
maxCapacity:
{
Description: Upper bound on number of Application Gateway capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
privateLinkConfigurations:
{
Description: PrivateLink configurations on application gateway. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway private link configuration. ,
Required: False ,
}
{
ipConfigurations:
{
Description: An array of application gateway private link ip configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an application gateway private link ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Reference to the subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the application gateway private link IP configuration. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of application gateway private link ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the application gateway private link configuration. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the private link configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
privateEndpointConnections:
{
Description: Private Endpoint connections on application gateway. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application gateway private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the private endpoint connection on an application gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the application gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customErrorConfigurations:
{
Description: Custom error configurations of the application gateway resource. ,
Required: False ,
}
[
{
statusCode:
{
Description: Status code of the application gateway custom error. ,
Enum:
{
HttpStatus400: No description available. ,
HttpStatus403: No description available. ,
HttpStatus404: No description available. ,
HttpStatus405: No description available. ,
HttpStatus408: No description available. ,
HttpStatus500: No description available. ,
HttpStatus502: No description available. ,
HttpStatus503: No description available. ,
HttpStatus504: No description available. ,
}
,
Required: False ,
}
enum ,
customErrorPageUrl:
{
Description: Error page URL of the application gateway custom error. ,
Required: False ,
}
string ,
}
,
]
,
forceFirewallPolicyAssociation:
{
Description: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. ,
Required: False ,
}
boolean ,
loadDistributionPolicies:
{
Description: Load distribution policies of the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway load distribution policy. ,
Required: False ,
}
{
loadDistributionTargets:
{
Description: Load Distribution Targets resource of an application gateway. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway load distribution target. ,
Required: False ,
}
{
weightPerServer:
{
Description: Weight per server. Range between 1 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
backendAddressPool:
{
Description: Backend address pool resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Name of the load distribution policy that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
loadDistributionAlgorithm:
{
Description: Load Distribution Targets resource of an application gateway. ,
Enum:
{
RoundRobin: No description available. ,
LeastConnections: No description available. ,
IpHash: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Load Distribution Policy resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the load distribution policy that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
entraJWTValidationConfigs:
{
Description: Entra JWT validation configurations for the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway entra jwt validation configuration. ,
Required: False ,
}
{
unAuthorizedRequestAction:
{
Description: Unauthorized request action. ,
Enum:
{
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Tenant ID of the Microsoft Entra ID application. ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of the Microsoft Entra ID application. ,
Required: False ,
}
string ,
audiences:
{
Description: List of acceptable audience claims that can be present in the token (aud claim). A maximum of 5 audiences are permitted. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the entra jwt validation configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the entra jwt validation configuration that is unique within an application gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
globalConfiguration:
{
Description: Global Configuration. ,
Required: False ,
}
{
enableRequestBuffering:
{
Description: Enable request buffering. ,
Required: False ,
}
boolean ,
enableResponseBuffering:
{
Description: Enable response buffering. ,
Required: False ,
}
boolean ,
}
,
defaultPredefinedSslPolicy:
{
Description: The default predefined SSL Policy applied on the application gateway resource. ,
Enum:
{
AppGwSslPolicy20150501: No description available. ,
AppGwSslPolicy20170401: No description available. ,
AppGwSslPolicy20170401S: No description available. ,
AppGwSslPolicy20220101: No description available. ,
AppGwSslPolicy20220101S: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the application gateway, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ApplicationGateways_CreateOrUpdate (new)
Description :  Creates or updates the specified application gateway.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
applicationGatewayName:
{
Description: The name of the application gateway. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update application gateway operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the application gateway. ,
Required: False ,
}
{
sku:
{
Description: SKU of the application gateway resource. ,
Required: False ,
}
{
name:
{
Description: Name of an application gateway SKU. ,
Enum:
{
Standard_Small: No description available. ,
Standard_Medium: No description available. ,
Standard_Large: No description available. ,
WAF_Medium: No description available. ,
WAF_Large: No description available. ,
Standard_v2: No description available. ,
WAF_v2: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of an application gateway. ,
Enum:
{
Standard: No description available. ,
WAF: No description available. ,
Standard_v2: No description available. ,
WAF_v2: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Capacity (instance count) of an application gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
family:
{
Description: Family of an application gateway SKU. ,
Enum:
{
Generation_1: No description available. ,
Generation_2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sslPolicy:
{
Description: SSL policy of the application gateway resource. ,
Required: False ,
}
{
disabledSslProtocols:
{
Description: Ssl protocols to be disabled on application gateway. ,
Required: False ,
}
[
string ,
]
,
policyType:
{
Description: Type of Ssl Policy. ,
Enum:
{
Predefined: No description available. ,
Custom: No description available. ,
CustomV2: No description available. ,
}
,
Required: False ,
}
enum ,
policyName:
{
Description: Name of Ssl predefined policy. ,
Enum:
{
AppGwSslPolicy20150501: No description available. ,
AppGwSslPolicy20170401: No description available. ,
AppGwSslPolicy20170401S: No description available. ,
AppGwSslPolicy20220101: No description available. ,
AppGwSslPolicy20220101S: No description available. ,
}
,
Required: False ,
}
enum ,
cipherSuites:
{
Description: Ssl cipher suites to be enabled in the specified order to application gateway. ,
Required: False ,
}
[
string ,
]
,
minProtocolVersion:
{
Description: Minimum version of Ssl protocol to be supported on application gateway. ,
Enum:
{
TLSv1_0: No description available. ,
TLSv1_1: No description available. ,
TLSv1_2: No description available. ,
TLSv1_3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
operationalState:
{
Description: Operational state of the application gateway resource. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayIPConfigurations:
{
Description: Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway IP configuration. ,
Required: False ,
}
{
subnet:
{
Description: Reference to the subnet resource. A subnet from where application gateway gets its private address. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application gateway IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
authenticationCertificates:
{
Description: Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway authentication certificate. ,
Required: False ,
}
{
data:
{
Description: Certificate public data. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the authentication certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the authentication certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
trustedRootCertificates:
{
Description: Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway trusted root certificate. ,
Required: False ,
}
{
data:
{
Description: Certificate public data. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the trusted root certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the trusted root certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
trustedClientCertificates:
{
Description: Trusted client certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway trusted client certificate. ,
Required: False ,
}
{
data:
{
Description: Certificate public data. ,
Required: False ,
}
string ,
validatedCertData:
{
Description: Validated certificate data. ,
Required: False ,
}
string ,
clientCertIssuerDN:
{
Description: Distinguished name of client certificate issuer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the trusted client certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the trusted client certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
sslCertificates:
{
Description: SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway SSL certificate. ,
Required: False ,
}
{
data:
{
Description: Base-64 encoded pfx certificate. Only applicable in PUT Request. ,
Required: False ,
}
string ,
password:
{
Description: Password for the pfx file specified in data. Only applicable in PUT request. ,
Required: False ,
}
string ,
publicCertData:
{
Description: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the SSL certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the SSL certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
frontendIPConfigurations:
{
Description: Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway frontend IP configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: PrivateIPAddress of the network interface IP Configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Reference to the subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
publicIPAddress:
{
Description: Reference to the PublicIP resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkConfiguration:
{
Description: Reference to the application gateway private link configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the frontend IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the frontend IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
frontendPorts:
{
Description: Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway frontend port. ,
Required: False ,
}
{
port:
{
Description: Frontend port. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the frontend port resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the frontend port that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
probes:
{
Description: Probes of the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway probe. ,
Required: False ,
}
{
protocol:
{
Description: The protocol used for the probe. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
host:
{
Description: Host name to send the probe to. ,
Required: False ,
}
string ,
path:
{
Description: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. ,
Required: False ,
}
string ,
interval:
{
Description: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
unhealthyThreshold:
{
Description: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
pickHostNameFromBackendHttpSettings:
{
Description: Whether the host header should be picked from the backend http settings. Default value is false. ,
Required: False ,
}
boolean ,
pickHostNameFromBackendSettings:
{
Description: Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false. ,
Required: False ,
}
boolean ,
minServers:
{
Description: Minimum number of servers that are always marked healthy. Default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
match:
{
Description: Criterion for classifying a healthy probe response. ,
Required: False ,
}
{
body:
{
Description: Body that must be contained in the health response. Default value is empty. ,
Required: False ,
}
string ,
statusCodes:
{
Description: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. ,
Required: False ,
}
[
string ,
]
,
}
,
enableProbeProxyProtocolHeader:
{
Description: Whether to send Proxy Protocol header along with the Health Probe over TCP or TLS protocol. Default value is false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the probe resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Name of the probe that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
backendAddressPools:
{
Description: Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway backend address pool. ,
Required: False ,
}
{
backendIPConfigurations:
{
Description: Collection of references to IPs defined in network interfaces. ,
Required: False ,
}
[
{
properties:
{
Description: Network interface IP configuration properties. ,
Required: False ,
}
{
gatewayLoadBalancer:
{
Description: The reference to gateway load balancer frontend IP. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
virtualNetworkTaps:
{
Description: The reference to Virtual Network Taps. ,
Required: False ,
}
[
{
properties:
{
Description: Virtual Network Tap Properties. ,
Required: False ,
}
{
networkInterfaceTapConfigurations:
{
Description: Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the virtual network tap resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the virtual network tap resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
destinationNetworkInterfaceIPConfiguration:
{
Required: False ,
}
string ,
destinationLoadBalancerFrontEndIPConfiguration:
{
Description: The reference to the private IP address on the internal Load Balancer that will receive the tap. ,
Required: False ,
}
{
properties:
{
Description: Properties of the load balancer probe. ,
Required: False ,
}
{
inboundNatRules:
{
Description: An array of references to inbound rules that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
inboundNatPools:
{
Description: An array of references to inbound pools that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
outboundRules:
{
Description: An array of references to outbound rules that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancingRules:
{
Description: An array of references to load balancing rules that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The Private IP allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The reference to the subnet resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
networkSecurityGroup:
{
Description: The reference to the NetworkSecurityGroup resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the network security group. ,
Required: False ,
}
{
flushConnection:
{
Description: When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. ,
Required: False ,
}
boolean ,
securityRules:
{
Description: A collection of security rules of the network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
defaultSecurityRules:
{
Description: The default security rules of network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
networkInterfaces:
{
Description: A collection of references to network interfaces. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the network interface. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the network interface. ,
Required: False ,
}
{
virtualMachine:
{
Description: The reference to a virtual machine. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
networkSecurityGroup:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: A reference to the private endpoint to which the network interface is linked. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
tapConfigurations:
{
Description: A list of TapConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
dnsSettings:
{
Description: The DNS settings in network interface. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. ,
Required: False ,
}
[
string ,
]
,
appliedDnsServers:
{
Description: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. ,
Required: False ,
}
[
string ,
]
,
internalDnsNameLabel:
{
Description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalFqdn:
{
Description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalDomainNameSuffix:
{
Description: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address of the network interface. ,
Required: False ,
}
string ,
primary:
{
Description: Whether this is a primary network interface on a virtual machine. ,
Required: False ,
}
boolean ,
vnetEncryptionSupported:
{
Description: Whether the virtual machine this nic is attached to supports encryption. ,
Required: False ,
}
boolean ,
defaultOutboundConnectivityEnabled:
{
Description: Whether default outbound connectivity for nic was configured or not. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Indicates whether to disable tcp state tracking. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Indicates whether IP forwarding is enabled on this network interface. ,
Required: False ,
}
boolean ,
hostedWorkloads:
{
Description: A list of references to linked BareMetal resources. ,
Required: False ,
}
[
string ,
]
,
dscpConfiguration:
{
Description: A reference to the dscp configuration to which the network interface is linked. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the network interface resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: WorkloadType of the NetworkInterface for BareMetal resources ,
Required: False ,
}
string ,
nicType:
{
Description: Type of Network Interface resource. ,
Enum:
{
Standard: No description available. ,
Elastic: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkService:
{
Description: Privatelinkservice of the network interface resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private link service. ,
Required: False ,
}
{
loadBalancerFrontendIpConfigurations:
{
Description: An array of references to the load balancer IP configurations. ,
Required: False ,
}
[
string ,
]
,
ipConfigurations:
{
Description: An array of private link service IP configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the private link service IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of private link service ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
destinationIPAddress:
{
Description: The destination IP address of the private link service. ,
Required: False ,
}
string ,
accessMode:
{
Description: The access mode of the private link service. ,
Enum:
{
Default: Allows unrestricted access to the private link service. ,
Restricted: Limits access to subscriptions which are inside visibility list only. ,
}
,
Required: False ,
}
enum ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private link service. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private link service resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: An array of list about connections to the private endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private end point connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
privateEndpointLocation:
{
Description: The location of the private endpoint. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
visibility:
{
Description: The visibility list of the private link service. ,
Required: False ,
}
string ,
autoApproval:
{
Description: The auto-approval list of the private link service. ,
Required: False ,
}
string ,
fqdns:
{
Description: The list of Fqdn. ,
Required: False ,
}
[
string ,
]
,
alias:
{
Description: The alias of the private link service. ,
Required: False ,
}
string ,
enableProxyProtocol:
{
Description: Whether the private link service is enabled for proxy protocol or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Network Interface resource. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Auxiliary mode of Network Interface resource. ,
Enum:
{
None: No description available. ,
MaxConnections: No description available. ,
Floating: No description available. ,
AcceleratedConnections: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Auxiliary sku of Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
flowLogs:
{
Description: A collection of references to flow log resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the flow log. ,
Required: False ,
}
{
targetResourceId:
{
Description: ID of network security group to which flow log will be applied. ,
Required: True ,
}
string ,
targetResourceGuid:
{
Description: Guid of network security group to which flow log will be applied. ,
Required: False ,
}
string ,
storageId:
{
Description: ID of the storage account which is used to store the flow log. ,
Required: True ,
}
string ,
enabledFilteringCriteria:
{
Description: 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. ,
Required: False ,
}
string ,
recordTypes:
{
Description: Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged. ,
Required: False ,
}
string ,
enabled:
{
Description: Flag to enable/disable flow logging. ,
Required: False ,
}
boolean ,
retentionPolicy:
{
Description: Parameters that define the retention policy for flow log. ,
Required: False ,
}
{
days:
{
Description: Number of days to retain flow log records. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: Flag to enable/disable retention. ,
Required: False ,
}
boolean ,
}
,
format:
{
Description: Parameters that define the flow log format. ,
Required: False ,
}
{
type:
{
Description: The file type of flow log. ,
Enum:
{
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version (revision) of the flow log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
flowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
networkWatcherFlowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
enabled:
{
Description: Flag to enable/disable traffic analytics. ,
Required: False ,
}
boolean ,
workspaceId:
{
Description: The resource guid of the attached workspace. ,
Required: False ,
}
string ,
workspaceRegion:
{
Description: The location of the attached workspace. ,
Required: False ,
}
string ,
workspaceResourceId:
{
Description: Resource Id of the attached workspace. ,
Required: False ,
}
string ,
trafficAnalyticsInterval:
{
Description: The interval in minutes which would decide how frequently TA service should do flow analytics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the flow log. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
identity:
{
Description: FlowLog resource Managed Identity ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the network security group resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: The reference to the RouteTable resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopType:
{
Description: The type of Azure hop the packet should be sent to. ,
Enum:
{
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
Internet: No description available. ,
VirtualAppliance: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the route resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
hasBgpOverride:
{
Description: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
disableBgpRoutePropagation:
{
Description: Whether to disable the routes learned by BGP on that route table. True means disable. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the route table resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resource GUID property of the route table. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
natGateway:
{
Description: Nat gateway associated with this subnet. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceEndpoints:
{
Description: An array of service endpoints. ,
Required: False ,
}
[
{
service:
{
Description: The type of the endpoint service. ,
Required: False ,
}
string ,
networkIdentifier:
{
Description: SubResource as network identifier. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serviceEndpointPolicies:
{
Description: An array of service endpoint policies. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the service end point policy. ,
Required: False ,
}
{
serviceEndpointPolicyDefinitions:
{
Description: A collection of service endpoint policy definitions of the service endpoint policy. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the service endpoint policy definition. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
service:
{
Description: Service endpoint name. ,
Required: False ,
}
string ,
serviceResources:
{
Description: A list of service resources. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service endpoint policy definition resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
resourceGuid:
{
Description: The resource GUID property of the service endpoint policy resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the service endpoint policy resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
serviceAlias:
{
Description: The alias indicating if the policy belongs to a service ,
Required: False ,
}
string ,
contextualServiceEndpointPolicies:
{
Description: A collection of contextual service endpoint policy. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of service endpoint policy. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
}
,
]
,
privateEndpoints:
{
Description: An array of references to private endpoints. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: An array of references to the network interface IP configurations using subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the IP configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
publicIPAddress:
{
Description: The reference to the public IP resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The provisioning state of the IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurationProfiles:
{
Description: Array of IP configuration profiles which reference this subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the IP configuration profile. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the IP configuration profile resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipAllocations:
{
Description: Array of IpAllocation which reference this subnet. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
resourceNavigationLinks:
{
Description: An array of references to the external resources using subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Resource navigation link properties format. ,
Required: False ,
}
{
linkedResourceType:
{
Description: Resource type of the linked resource. ,
Required: False ,
}
string ,
link:
{
Description: Link to the external resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource navigation link resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
id:
{
Description: Resource navigation link identifier. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
serviceAssociationLinks:
{
Description: An array of references to services injecting into this subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Resource navigation link properties format. ,
Required: False ,
}
{
linkedResourceType:
{
Description: Resource type of the linked resource. ,
Required: False ,
}
string ,
link:
{
Description: Link to the external resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the service association link resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
allowDelete:
{
Description: If true, the resource can be deleted. ,
Required: False ,
}
boolean ,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: Name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
delegations:
{
Description: An array of references to the delegations on the subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
serviceName:
{
Description: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). ,
Required: False ,
}
string ,
actions:
{
Description: The actions permitted to the service upon delegation. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service delegation resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a subnet. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
purpose:
{
Description: A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the subnet resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointNetworkPolicies:
{
Description: Enable or Disable apply network policies on private end point in the subnet. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NetworkSecurityGroupEnabled: No description available. ,
RouteTableEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceNetworkPolicies:
{
Description: Enable or Disable apply network policies on private link service in the subnet. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayIPConfigurations:
{
Description: Application gateway IP configurations of virtual network resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway IP configuration. ,
Required: False ,
}
{
subnet:
{
Description: Reference to the subnet resource. A subnet from where application gateway gets its private address. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application gateway IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
sharingScope:
{
Description: 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. ,
Enum:
{
Tenant: No description available. ,
DelegatedServices: No description available. ,
}
,
Required: False ,
}
enum ,
defaultOutboundAccess:
{
Description: Set this property to false to disable default outbound connectivity for all VMs in the subnet. ,
Required: False ,
}
boolean ,
ipamPoolPrefixAllocations:
{
Description: A list of IPAM Pools for allocating IP address prefixes. ,
Required: False ,
}
[
{
pool:
{
Required: False ,
}
{
id:
{
Description: Resource id of the associated Azure IpamPool resource. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
numberOfIpAddresses:
{
Description: Number of IP addresses to allocate. ,
Required: False ,
}
string ,
allocatedAddressPrefixes:
{
Description: List of assigned IP address prefixes in the IpamPool of the associated resource. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
publicIPAddress:
{
Description: The reference to the Public IP resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
publicIPPrefix:
{
Description: The reference to the Public IP Prefix resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
gatewayLoadBalancer:
{
Description: The reference to gateway load balancer frontend IP. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the frontend IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationPort:
{
Description: The VXLAN destination port that will receive the tapped traffic. ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: The reference to ApplicationGatewayBackendAddressPool resource. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: Name of the backend address pool that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: The reference to LoadBalancerBackendAddressPool resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of load balancer backend address pool. ,
Required: False ,
}
{
location:
{
Description: The location of the backend address pool. ,
Required: False ,
}
string ,
tunnelInterfaces:
{
Description: An array of gateway load balancer tunnel interfaces. ,
Required: False ,
}
[
{
port:
{
Description: Port of gateway load balancer tunnel interface. ,
Format: int32 ,
Required: False ,
}
integer ,
identifier:
{
Description: Identifier of gateway load balancer tunnel interface. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: Protocol of gateway load balancer tunnel interface. ,
Enum:
{
None: No description available. ,
Native: No description available. ,
VXLAN: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Traffic type of gateway load balancer tunnel interface. ,
Enum:
{
None: No description available. ,
Internal: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
loadBalancerBackendAddresses:
{
Description: An array of backend addresses. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of load balancer backend address pool. ,
Required: False ,
}
{
virtualNetwork:
{
Description: Reference to an existing virtual network. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: Reference to an existing subnet. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
ipAddress:
{
Description: IP Address belonging to the referenced virtual network. ,
Required: False ,
}
string ,
networkInterfaceIPConfiguration:
{
Description: Reference to IP address defined in network interfaces. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
loadBalancerFrontendIPConfiguration:
{
Description: Reference to the frontend ip address configuration defined in regional loadbalancer. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
inboundNatRulesPortMapping:
{
Description: Collection of inbound NAT rule port mappings. ,
Required: False ,
}
[
{
inboundNatRuleName:
{
Description: Name of inbound NAT rule. ,
Required: False ,
}
string ,
frontendPort:
{
Description: Frontend port. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: Backend port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
adminState:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Up: No description available. ,
Down: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the backend address. ,
Required: False ,
}
string ,
}
,
]
,
backendIPConfigurations:
{
Description: An array of references to IP addresses defined in network interfaces. ,
Required: False ,
}
[
string ,
]
,
loadBalancingRules:
{
Description: An array of references to load balancing rules that use this backend address pool. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
outboundRule:
{
Description: A reference to an outbound rule that uses this backend address pool. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
outboundRules:
{
Description: An array of references to outbound rules that use this backend address pool. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
inboundNatRules:
{
Description: An array of references to inbound NAT rules that use this backend address pool. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the backend address pool resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
drainPeriodInSeconds:
{
Description: Amount of seconds Load Balancer waits for before sending RESET to client and backend address. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualNetwork:
{
Description: A reference to a virtual network. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
syncMode:
{
Description: Backend address synchronous mode for the backend pool ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: 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. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatRules:
{
Description: A list of references of LoadBalancerInboundNatRules. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of load balancer inbound NAT rule. ,
Required: False ,
}
{
frontendIPConfiguration:
{
Description: A reference to frontend IP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
backendIPConfiguration:
{
Required: False ,
}
string ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
Udp: No description available. ,
Tcp: No description available. ,
All: No description available. ,
Quic: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port used for the internal endpoint. Acceptable values range from 1 to 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
idleTimeoutInMinutes:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
enableFloatingIP:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableTcpReset:
{
Description: 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. ,
Required: False ,
}
boolean ,
frontendPortRangeStart:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeEnd:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
backendAddressPool:
{
Description: A reference to backendAddressPool resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the inbound NAT rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
privateIPAddress:
{
Description: Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format
/. ,
Required: False ,
}
string ,
privateIPAddressPrefixLength:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet bound to the IP configuration. ,
Required: False ,
}
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
networkSecurityGroup:
{
Description: The reference to the NetworkSecurityGroup resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the network security group. ,
Required: False ,
}
{
flushConnection:
{
Description: When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. ,
Required: False ,
}
boolean ,
securityRules:
{
Description: A collection of security rules of the network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
defaultSecurityRules:
{
Description: The default security rules of network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
networkInterfaces:
{
Description: A collection of references to network interfaces. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the network interface. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the network interface. ,
Required: False ,
}
{
virtualMachine:
{
Description: The reference to a virtual machine. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
networkSecurityGroup:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: A reference to the private endpoint to which the network interface is linked. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
tapConfigurations:
{
Description: A list of TapConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
dnsSettings:
{
Description: The DNS settings in network interface. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. ,
Required: False ,
}
[
string ,
]
,
appliedDnsServers:
{
Description: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. ,
Required: False ,
}
[
string ,
]
,
internalDnsNameLabel:
{
Description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalFqdn:
{
Description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalDomainNameSuffix:
{
Description: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address of the network interface. ,
Required: False ,
}
string ,
primary:
{
Description: Whether this is a primary network interface on a virtual machine. ,
Required: False ,
}
boolean ,
vnetEncryptionSupported:
{
Description: Whether the virtual machine this nic is attached to supports encryption. ,
Required: False ,
}
boolean ,
defaultOutboundConnectivityEnabled:
{
Description: Whether default outbound connectivity for nic was configured or not. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Indicates whether to disable tcp state tracking. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Indicates whether IP forwarding is enabled on this network interface. ,
Required: False ,
}
boolean ,
hostedWorkloads:
{
Description: A list of references to linked BareMetal resources. ,
Required: False ,
}
[
string ,
]
,
dscpConfiguration:
{
Description: A reference to the dscp configuration to which the network interface is linked. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the network interface resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: WorkloadType of the NetworkInterface for BareMetal resources ,
Required: False ,
}
string ,
nicType:
{
Description: Type of Network Interface resource. ,
Enum:
{
Standard: No description available. ,
Elastic: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkService:
{
Description: Privatelinkservice of the network interface resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private link service. ,
Required: False ,
}
{
loadBalancerFrontendIpConfigurations:
{
Description: An array of references to the load balancer IP configurations. ,
Required: False ,
}
[
string ,
]
,
ipConfigurations:
{
Description: An array of private link service IP configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the private link service IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of private link service ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
destinationIPAddress:
{
Description: The destination IP address of the private link service. ,
Required: False ,
}
string ,
accessMode:
{
Description: The access mode of the private link service. ,
Enum:
{
Default: Allows unrestricted access to the private link service. ,
Restricted: Limits access to subscriptions which are inside visibility list only. ,
}
,
Required: False ,
}
enum ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private link service. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private link service resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: An array of list about connections to the private endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private end point connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
privateEndpointLocation:
{
Description: The location of the private endpoint. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
visibility:
{
Description: The visibility list of the private link service. ,
Required: False ,
}
string ,
autoApproval:
{
Description: The auto-approval list of the private link service. ,
Required: False ,
}
string ,
fqdns:
{
Description: The list of Fqdn. ,
Required: False ,
}
[
string ,
]
,
alias:
{
Description: The alias of the private link service. ,
Required: False ,
}
string ,
enableProxyProtocol:
{
Description: Whether the private link service is enabled for proxy protocol or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Network Interface resource. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Auxiliary mode of Network Interface resource. ,
Enum:
{
None: No description available. ,
MaxConnections: No description available. ,
Floating: No description available. ,
AcceleratedConnections: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Auxiliary sku of Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
flowLogs:
{
Description: A collection of references to flow log resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the flow log. ,
Required: False ,
}
{
targetResourceId:
{
Description: ID of network security group to which flow log will be applied. ,
Required: True ,
}
string ,
targetResourceGuid:
{
Description: Guid of network security group to which flow log will be applied. ,
Required: False ,
}
string ,
storageId:
{
Description: ID of the storage account which is used to store the flow log. ,
Required: True ,
}
string ,
enabledFilteringCriteria:
{
Description: 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. ,
Required: False ,
}
string ,
recordTypes:
{
Description: Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged. ,
Required: False ,
}
string ,
enabled:
{
Description: Flag to enable/disable flow logging. ,
Required: False ,
}
boolean ,
retentionPolicy:
{
Description: Parameters that define the retention policy for flow log. ,
Required: False ,
}
{
days:
{
Description: Number of days to retain flow log records. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: Flag to enable/disable retention. ,
Required: False ,
}
boolean ,
}
,
format:
{
Description: Parameters that define the flow log format. ,
Required: False ,
}
{
type:
{
Description: The file type of flow log. ,
Enum:
{
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version (revision) of the flow log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
flowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
networkWatcherFlowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
enabled:
{
Description: Flag to enable/disable traffic analytics. ,
Required: False ,
}
boolean ,
workspaceId:
{
Description: The resource guid of the attached workspace. ,
Required: False ,
}
string ,
workspaceRegion:
{
Description: The location of the attached workspace. ,
Required: False ,
}
string ,
workspaceResourceId:
{
Description: Resource Id of the attached workspace. ,
Required: False ,
}
string ,
trafficAnalyticsInterval:
{
Description: The interval in minutes which would decide how frequently TA service should do flow analytics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the flow log. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
identity:
{
Description: FlowLog resource Managed Identity ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the network security group resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: The reference to the RouteTable resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopType:
{
Description: The type of Azure hop the packet should be sent to. ,
Enum:
{
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
Internet: No description available. ,
VirtualAppliance: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the route resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
hasBgpOverride:
{
Description: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
disableBgpRoutePropagation:
{
Description: Whether to disable the routes learned by BGP on that route table. True means disable. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the route table resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resource GUID property of the route table. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
natGateway:
{
Description: Nat gateway associated with this subnet. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceEndpoints:
{
Description: An array of service endpoints. ,
Required: False ,
}
[
{
service:
{
Description: The type of the endpoint service. ,
Required: False ,
}
string ,
networkIdentifier:
{
Description: SubResource as network identifier. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serviceEndpointPolicies:
{
Description: An array of service endpoint policies. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the service end point policy. ,
Required: False ,
}
{
serviceEndpointPolicyDefinitions:
{
Description: A collection of service endpoint policy definitions of the service endpoint policy. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the service endpoint policy definition. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
service:
{
Description: Service endpoint name. ,
Required: False ,
}
string ,
serviceResources:
{
Description: A list of service resources. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service endpoint policy definition resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
resourceGuid:
{
Description: The resource GUID property of the service endpoint policy resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the service endpoint policy resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
serviceAlias:
{
Description: The alias indicating if the policy belongs to a service ,
Required: False ,
}
string ,
contextualServiceEndpointPolicies:
{
Description: A collection of contextual service endpoint policy. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of service endpoint policy. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
}
,
]
,
privateEndpoints:
{
Description: An array of references to private endpoints. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: An array of references to the network interface IP configurations using subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the IP configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
publicIPAddress:
{
Description: The reference to the public IP resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The provisioning state of the IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurationProfiles:
{
Description: Array of IP configuration profiles which reference this subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the IP configuration profile. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the IP configuration profile resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipAllocations:
{
Description: Array of IpAllocation which reference this subnet. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
resourceNavigationLinks:
{
Description: An array of references to the external resources using subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Resource navigation link properties format. ,
Required: False ,
}
{
linkedResourceType:
{
Description: Resource type of the linked resource. ,
Required: False ,
}
string ,
link:
{
Description: Link to the external resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource navigation link resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
id:
{
Description: Resource navigation link identifier. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
serviceAssociationLinks:
{
Description: An array of references to services injecting into this subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Resource navigation link properties format. ,
Required: False ,
}
{
linkedResourceType:
{
Description: Resource type of the linked resource. ,
Required: False ,
}
string ,
link:
{
Description: Link to the external resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the service association link resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
allowDelete:
{
Description: If true, the resource can be deleted. ,
Required: False ,
}
boolean ,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: Name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
delegations:
{
Description: An array of references to the delegations on the subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
serviceName:
{
Description: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). ,
Required: False ,
}
string ,
actions:
{
Description: The actions permitted to the service upon delegation. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service delegation resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a subnet. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
purpose:
{
Description: A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the subnet resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointNetworkPolicies:
{
Description: Enable or Disable apply network policies on private end point in the subnet. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NetworkSecurityGroupEnabled: No description available. ,
RouteTableEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceNetworkPolicies:
{
Description: Enable or Disable apply network policies on private link service in the subnet. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayIPConfigurations:
{
Description: Application gateway IP configurations of virtual network resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway IP configuration. ,
Required: False ,
}
{
subnet:
{
Description: Reference to the subnet resource. A subnet from where application gateway gets its private address. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application gateway IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
sharingScope:
{
Description: 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. ,
Enum:
{
Tenant: No description available. ,
DelegatedServices: No description available. ,
}
,
Required: False ,
}
enum ,
defaultOutboundAccess:
{
Description: Set this property to false to disable default outbound connectivity for all VMs in the subnet. ,
Required: False ,
}
boolean ,
ipamPoolPrefixAllocations:
{
Description: A list of IPAM Pools for allocating IP address prefixes. ,
Required: False ,
}
[
{
pool:
{
Required: False ,
}
{
id:
{
Description: Resource id of the associated Azure IpamPool resource. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
numberOfIpAddresses:
{
Description: Number of IP addresses to allocate. ,
Required: False ,
}
string ,
allocatedAddressPrefixes:
{
Description: List of assigned IP address prefixes in the IpamPool of the associated resource. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Whether this is a primary customer address on the network interface. ,
Required: False ,
}
boolean ,
publicIPAddress:
{
Description: Public IP address bound to the IP configuration. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
applicationSecurityGroups:
{
Description: Application security groups in which the IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the network interface IP configuration. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkConnectionProperties:
{
Description: PrivateLinkConnection properties for the network interface. ,
Required: False ,
}
{
groupId:
{
Description: The group ID for current private link connection. ,
Required: False ,
}
string ,
requiredMemberName:
{
Description: The required member name for current private link connection. ,
Required: False ,
}
string ,
fqdns:
{
Description: List of FQDNs for current private link connection. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
backendAddresses:
{
Description: Backend addresses. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fully qualified domain name (FQDN). ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the backend address pool resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the backend address pool that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
backendHttpSettingsCollection:
{
Description: Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway backend HTTP settings. ,
Required: False ,
}
{
port:
{
Description: The destination port on the backend. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol used to communicate with the backend. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
cookieBasedAffinity:
{
Description: Cookie based affinity. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requestTimeout:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
probe:
{
Description: Probe resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
authenticationCertificates:
{
Description: Array of references to application gateway authentication certificates. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trustedRootCertificates:
{
Description: Array of references to application gateway trusted root certificates. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
connectionDraining:
{
Description: Connection draining of the backend http settings resource. ,
Required: False ,
}
{
enabled:
{
Description: Whether connection draining is enabled or not. ,
Required: True ,
}
boolean ,
drainTimeoutInSec:
{
Description: The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
hostName:
{
Description: Host header to be sent to the backend servers. ,
Required: False ,
}
string ,
pickHostNameFromBackendAddress:
{
Description: Whether to pick host header should be picked from the host name of the backend server. Default value is false. ,
Required: False ,
}
boolean ,
affinityCookieName:
{
Description: Cookie name to use for the affinity cookie. ,
Required: False ,
}
string ,
probeEnabled:
{
Description: Whether the probe is enabled. Default value is false. ,
Required: False ,
}
boolean ,
path:
{
Description: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. ,
Required: False ,
}
string ,
dedicatedBackendConnection:
{
Description: Enable or disable dedicated connection per backend server. Default is set to false. ,
Required: False ,
}
boolean ,
validateCertChainAndExpiry:
{
Description: Verify or skip both chain and expiry validations of the certificate on the backend server. Default is set to true. ,
Required: False ,
}
boolean ,
validateSNI:
{
Description: When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value. Default value is true. ,
Required: False ,
}
boolean ,
sniName:
{
Description: Specify an SNI value to match the common name of the certificate on the backend. By default, the application gateway uses the incoming request’s host header as the SNI. Default value is null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the backend HTTP settings resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the backend http settings that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
backendSettingsCollection:
{
Description: Backend settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway backend settings. ,
Required: False ,
}
{
port:
{
Description: The destination port on the backend. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol used to communicate with the backend. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
timeout:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
probe:
{
Description: Probe resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
trustedRootCertificates:
{
Description: Array of references to application gateway trusted root certificates. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
hostName:
{
Description: Server name indication to be sent to the backend servers for Tls protocol. ,
Required: False ,
}
string ,
pickHostNameFromBackendAddress:
{
Description: Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false. ,
Required: False ,
}
boolean ,
enableL4ClientIpPreservation:
{
Description: Whether to send Proxy Protocol header to backend servers over TCP or TLS protocols. Default value is false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the backend HTTP settings resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the backend settings that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
httpListeners:
{
Description: Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway HTTP listener. ,
Required: False ,
}
{
frontendIPConfiguration:
{
Description: Frontend IP configuration resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
frontendPort:
{
Description: Frontend port resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
protocol:
{
Description: Protocol of the HTTP listener. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: Host name of HTTP listener. ,
Required: False ,
}
string ,
sslCertificate:
{
Description: SSL certificate resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
sslProfile:
{
Description: SSL profile resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
requireServerNameIndication:
{
Description: Applicable only if protocol is https. Enables SNI for multi-hosting. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the HTTP listener resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customErrorConfigurations:
{
Description: Custom error configurations of the HTTP listener. ,
Required: False ,
}
[
{
statusCode:
{
Description: Status code of the application gateway custom error. ,
Enum:
{
HttpStatus400: No description available. ,
HttpStatus403: No description available. ,
HttpStatus404: No description available. ,
HttpStatus405: No description available. ,
HttpStatus408: No description available. ,
HttpStatus500: No description available. ,
HttpStatus502: No description available. ,
HttpStatus503: No description available. ,
HttpStatus504: No description available. ,
}
,
Required: False ,
}
enum ,
customErrorPageUrl:
{
Description: Error page URL of the application gateway custom error. ,
Required: False ,
}
string ,
}
,
]
,
firewallPolicy:
{
Description: Reference to the FirewallPolicy resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
hostNames:
{
Description: List of Host names for HTTP Listener that allows special wildcard characters as well. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: Name of the HTTP listener that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
listeners:
{
Description: Listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway listener. ,
Required: False ,
}
{
frontendIPConfiguration:
{
Description: Frontend IP configuration resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
frontendPort:
{
Description: Frontend port resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
protocol:
{
Description: Protocol of the listener. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
sslCertificate:
{
Description: SSL certificate resource of an application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
sslProfile:
{
Description: SSL profile resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the listener resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
hostNames:
{
Description: List of Server Name Indications(SNI) for TLS Multi-site Listener that allows special wildcard characters as well. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: Name of the listener that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
sslProfiles:
{
Description: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway SSL profile. ,
Required: False ,
}
{
trustedClientCertificates:
{
Description: Array of references to application gateway trusted client certificates. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sslPolicy:
{
Description: SSL policy of the application gateway resource. ,
Required: False ,
}
{
disabledSslProtocols:
{
Description: Ssl protocols to be disabled on application gateway. ,
Required: False ,
}
[
string ,
]
,
policyType:
{
Description: Type of Ssl Policy. ,
Enum:
{
Predefined: No description available. ,
Custom: No description available. ,
CustomV2: No description available. ,
}
,
Required: False ,
}
enum ,
policyName:
{
Description: Name of Ssl predefined policy. ,
Enum:
{
AppGwSslPolicy20150501: No description available. ,
AppGwSslPolicy20170401: No description available. ,
AppGwSslPolicy20170401S: No description available. ,
AppGwSslPolicy20220101: No description available. ,
AppGwSslPolicy20220101S: No description available. ,
}
,
Required: False ,
}
enum ,
cipherSuites:
{
Description: Ssl cipher suites to be enabled in the specified order to application gateway. ,
Required: False ,
}
[
string ,
]
,
minProtocolVersion:
{
Description: Minimum version of Ssl protocol to be supported on application gateway. ,
Enum:
{
TLSv1_0: No description available. ,
TLSv1_1: No description available. ,
TLSv1_2: No description available. ,
TLSv1_3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientAuthConfiguration:
{
Description: Client authentication configuration of the application gateway resource. ,
Required: False ,
}
{
verifyClientCertIssuerDN:
{
Description: Verify client certificate issuer name on the application gateway. ,
Required: False ,
}
boolean ,
verifyClientRevocation:
{
Description: Verify client certificate revocation status. ,
Enum:
{
None: No description available. ,
OCSP: No description available. ,
}
,
Required: False ,
}
enum ,
verifyClientAuthMode:
{
Description: Verify client Authentication mode. ,
Enum:
{
Strict: No description available. ,
Passthrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of the HTTP listener resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the SSL profile that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
urlPathMaps:
{
Description: URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway URL path map. ,
Required: False ,
}
{
defaultBackendAddressPool:
{
Description: Default backend address pool resource of URL path map. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
defaultBackendHttpSettings:
{
Description: Default backend http settings resource of URL path map. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
defaultRewriteRuleSet:
{
Description: Default Rewrite rule set resource of URL path map. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
defaultRedirectConfiguration:
{
Description: Default redirect configuration resource of URL path map. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
defaultLoadDistributionPolicy:
{
Description: Default Load Distribution Policy resource of URL path map. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
pathRules:
{
Description: Path rule of URL path map resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway path rule. ,
Required: False ,
}
{
paths:
{
Description: Path rules of URL path map. ,
Required: False ,
}
[
string ,
]
,
backendAddressPool:
{
Description: Backend address pool resource of URL path map path rule. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
backendHttpSettings:
{
Description: Backend http settings resource of URL path map path rule. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
redirectConfiguration:
{
Description: Redirect configuration resource of URL path map path rule. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
rewriteRuleSet:
{
Description: Rewrite rule set resource of URL path map path rule. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
loadDistributionPolicy:
{
Description: Load Distribution Policy resource of URL path map path rule. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the path rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
firewallPolicy:
{
Description: Reference to the FirewallPolicy resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Name of the path rule that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the URL path map resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the URL path map that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
requestRoutingRules:
{
Description: Request routing rules of the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway request routing rule. ,
Required: False ,
}
{
ruleType:
{
Description: Rule type. ,
Enum:
{
Basic: No description available. ,
PathBasedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of the request routing rule. ,
Format: int32 ,
Required: False ,
}
integer ,
backendAddressPool:
{
Description: Backend address pool resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
backendHttpSettings:
{
Description: Backend http settings resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
httpListener:
{
Description: Http listener resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
urlPathMap:
{
Description: URL path map resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
rewriteRuleSet:
{
Description: Rewrite Rule Set resource in Basic rule of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
redirectConfiguration:
{
Description: Redirect configuration resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
loadDistributionPolicy:
{
Description: Load Distribution Policy resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
entraJWTValidationConfig:
{
Description: Entra JWT validation configuration resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the request routing rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the request routing rule that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
routingRules:
{
Description: Routing rules of the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway routing rule. ,
Required: False ,
}
{
ruleType:
{
Description: Rule type. ,
Enum:
{
Basic: No description available. ,
PathBasedRouting: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of the routing rule. ,
Format: int32 ,
Required: True ,
}
integer ,
backendAddressPool:
{
Description: Backend address pool resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
backendSettings:
{
Description: Backend settings resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
listener:
{
Description: Listener resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the request routing rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the routing rule that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
rewriteRuleSets:
{
Description: Rewrite rules for the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway rewrite rule set. ,
Required: False ,
}
{
rewriteRules:
{
Description: Rewrite rules in the rewrite rule set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the rewrite rule that is unique within an Application Gateway. ,
Required: False ,
}
string ,
ruleSequence:
{
Description: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. ,
Required: False ,
}
integer ,
conditions:
{
Description: Conditions based on which the action set execution will be evaluated. ,
Required: False ,
}
[
{
variable:
{
Description: The condition parameter of the RewriteRuleCondition. ,
Required: False ,
}
string ,
pattern:
{
Description: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. ,
Required: False ,
}
string ,
ignoreCase:
{
Description: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. ,
Required: False ,
}
boolean ,
negate:
{
Description: Setting this value as truth will force to check the negation of the condition given by the user. ,
Required: False ,
}
boolean ,
}
,
]
,
actionSet:
{
Description: Set of actions to be done as part of the rewrite Rule. ,
Required: False ,
}
{
requestHeaderConfigurations:
{
Description: Request Header Actions in the Action Set. ,
Required: False ,
}
[
{
headerName:
{
Description: Header name of the header configuration. ,
Required: False ,
}
string ,
headerValueMatcher:
{
Description: 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 ,
Required: False ,
}
{
pattern:
{
Description: The pattern, either fixed string or regular expression, that evaluates if a header value should be selected for rewrite. ,
Required: False ,
}
string ,
ignoreCase:
{
Description: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. ,
Required: False ,
}
boolean ,
negate:
{
Description: Setting this value as truth will force to check the negation of the condition given by the user in the pattern field. ,
Required: False ,
}
boolean ,
}
,
headerValue:
{
Description: Header value of the header configuration. ,
Required: False ,
}
string ,
}
,
]
,
responseHeaderConfigurations:
{
Description: Response Header Actions in the Action Set. ,
Required: False ,
}
[
{
headerName:
{
Description: Header name of the header configuration. ,
Required: False ,
}
string ,
headerValueMatcher:
{
Description: 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 ,
Required: False ,
}
{
pattern:
{
Description: The pattern, either fixed string or regular expression, that evaluates if a header value should be selected for rewrite. ,
Required: False ,
}
string ,
ignoreCase:
{
Description: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. ,
Required: False ,
}
boolean ,
negate:
{
Description: Setting this value as truth will force to check the negation of the condition given by the user in the pattern field. ,
Required: False ,
}
boolean ,
}
,
headerValue:
{
Description: Header value of the header configuration. ,
Required: False ,
}
string ,
}
,
]
,
urlConfiguration:
{
Description: Url Configuration Action in the Action Set. ,
Required: False ,
}
{
modifiedPath:
{
Description: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. ,
Required: False ,
}
string ,
modifiedQueryString:
{
Description: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. ,
Required: False ,
}
string ,
reroute:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the rewrite rule set resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the rewrite rule set that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
redirectConfigurations:
{
Description: Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway redirect configuration. ,
Required: False ,
}
{
redirectType:
{
Description: HTTP redirection type. ,
Enum:
{
Permanent: No description available. ,
Found: No description available. ,
SeeOther: No description available. ,
Temporary: No description available. ,
}
,
Required: False ,
}
enum ,
targetListener:
{
Description: Reference to a listener to redirect the request to. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
targetUrl:
{
Description: Url to redirect the request to. ,
Required: False ,
}
string ,
includePath:
{
Description: Include path in the redirected url. ,
Required: False ,
}
boolean ,
includeQueryString:
{
Description: Include query string in the redirected url. ,
Required: False ,
}
boolean ,
requestRoutingRules:
{
Description: Request routing specifying redirect configuration. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
urlPathMaps:
{
Description: Url path maps specifying default redirect configuration. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
pathRules:
{
Description: Path rules specifying redirect configuration. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
name:
{
Description: Name of the redirect configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
webApplicationFirewallConfiguration:
{
Description: Web application firewall configuration. ,
Required: False ,
}
{
enabled:
{
Description: Whether the web application firewall is enabled or not. ,
Required: True ,
}
boolean ,
firewallMode:
{
Description: Web application firewall mode. ,
Enum:
{
Detection: No description available. ,
Prevention: No description available. ,
}
,
Required: True ,
}
enum ,
ruleSetType:
{
Description: The type of the web application firewall rule set. Possible values are: 'OWASP'. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: The version of the rule set type. ,
Required: True ,
}
string ,
disabledRuleGroups:
{
Description: The disabled rule groups. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: The name of the rule group that will be disabled. ,
Required: True ,
}
string ,
rules:
{
Description: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. ,
Required: False ,
}
[
integer ,
]
,
}
,
]
,
requestBodyCheck:
{
Description: Whether allow WAF to check request Body. ,
Required: False ,
}
boolean ,
maxRequestBodySize:
{
Description: Maximum request body size for WAF. ,
Format: int32 ,
Required: False ,
}
integer ,
maxRequestBodySizeInKb:
{
Description: Maximum request body size in Kb for WAF. ,
Format: int32 ,
Required: False ,
}
integer ,
fileUploadLimitInMb:
{
Description: Maximum file upload size in Mb for WAF. ,
Format: int32 ,
Required: False ,
}
integer ,
exclusions:
{
Description: The exclusion list. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be excluded. ,
Required: True ,
}
string ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
firewallPolicy:
{
Description: Reference to the FirewallPolicy resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
enableHttp2:
{
Description: Whether HTTP2 is enabled on the application gateway resource. ,
Required: False ,
}
boolean ,
enableFips:
{
Description: Whether FIPS is enabled on the application gateway resource. ,
Required: False ,
}
boolean ,
autoscaleConfiguration:
{
Description: Autoscale Configuration. ,
Required: False ,
}
{
minCapacity:
{
Description: Lower bound on number of Application Gateway capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
maxCapacity:
{
Description: Upper bound on number of Application Gateway capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
privateLinkConfigurations:
{
Description: PrivateLink configurations on application gateway. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway private link configuration. ,
Required: False ,
}
{
ipConfigurations:
{
Description: An array of application gateway private link ip configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an application gateway private link ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Reference to the subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the application gateway private link IP configuration. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of application gateway private link ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the application gateway private link configuration. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the private link configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
privateEndpointConnections:
{
Description: Private Endpoint connections on application gateway. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application gateway private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name of the private endpoint connection on an application gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the application gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customErrorConfigurations:
{
Description: Custom error configurations of the application gateway resource. ,
Required: False ,
}
[
{
statusCode:
{
Description: Status code of the application gateway custom error. ,
Enum:
{
HttpStatus400: No description available. ,
HttpStatus403: No description available. ,
HttpStatus404: No description available. ,
HttpStatus405: No description available. ,
HttpStatus408: No description available. ,
HttpStatus500: No description available. ,
HttpStatus502: No description available. ,
HttpStatus503: No description available. ,
HttpStatus504: No description available. ,
}
,
Required: False ,
}
enum ,
customErrorPageUrl:
{
Description: Error page URL of the application gateway custom error. ,
Required: False ,
}
string ,
}
,
]
,
forceFirewallPolicyAssociation:
{
Description: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. ,
Required: False ,
}
boolean ,
loadDistributionPolicies:
{
Description: Load distribution policies of the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway load distribution policy. ,
Required: False ,
}
{
loadDistributionTargets:
{
Description: Load Distribution Targets resource of an application gateway. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway load distribution target. ,
Required: False ,
}
{
weightPerServer:
{
Description: Weight per server. Range between 1 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
backendAddressPool:
{
Description: Backend address pool resource of the application gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Name of the load distribution policy that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
loadDistributionAlgorithm:
{
Description: Load Distribution Targets resource of an application gateway. ,
Enum:
{
RoundRobin: No description available. ,
LeastConnections: No description available. ,
IpHash: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the Load Distribution Policy resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the load distribution policy that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
entraJWTValidationConfigs:
{
Description: Entra JWT validation configurations for the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway entra jwt validation configuration. ,
Required: False ,
}
{
unAuthorizedRequestAction:
{
Description: Unauthorized request action. ,
Enum:
{
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Tenant ID of the Microsoft Entra ID application. ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of the Microsoft Entra ID application. ,
Required: False ,
}
string ,
audiences:
{
Description: List of acceptable audience claims that can be present in the token (aud claim). A maximum of 5 audiences are permitted. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the entra jwt validation configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the entra jwt validation configuration that is unique within an application gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
globalConfiguration:
{
Description: Global Configuration. ,
Required: False ,
}
{
enableRequestBuffering:
{
Description: Enable request buffering. ,
Required: False ,
}
boolean ,
enableResponseBuffering:
{
Description: Enable response buffering. ,
Required: False ,
}
boolean ,
}
,
defaultPredefinedSslPolicy:
{
Description: The default predefined SSL Policy applied on the application gateway resource. ,
Enum:
{
AppGwSslPolicy20150501: No description available. ,
AppGwSslPolicy20170401: No description available. ,
AppGwSslPolicy20170401S: No description available. ,
AppGwSslPolicy20220101: No description available. ,
AppGwSslPolicy20220101S: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting where the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the application gateway, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the application gateway. ,
Required: False ,
}
{
sku:
{
Description: SKU of the application gateway resource. ,
Required: False ,
}
{
name:
{
Description: Name of an application gateway SKU. ,
Enum:
{
Standard_Small: No description available. ,
Standard_Medium: No description available. ,
Standard_Large: No description available. ,
WAF_Medium: No description available. ,
WAF_Large: No description available. ,
Standard_v2: No description available. ,
WAF_v2: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of an application gateway. ,
Enum:
{
Standard: No description available. ,
WAF: No description available. ,
Standard_v2: No description available. ,
WAF_v2: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Capacity (instance count) of an application gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
family:
{
Description: Family of an application gateway SKU. ,
Enum:
{
Generation_1: No description available. ,
Generation_2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sslPolicy:
{
Description: SSL policy of the application gateway resource. ,
Required: False ,
}
{
disabledSslProtocols:
{
Description: Ssl protocols to be disabled on application gateway. ,
Required: False ,
}
[
string ,
]
,
policyType:
{
Description: Type of Ssl Policy. ,
Enum:
{
Predefined: No description available. ,
Custom: No description available. ,
CustomV2: No description available. ,
}
,
Required: False ,
}
enum ,
policyName:
{
Description: Name of Ssl predefined policy. ,
Enum:
{
AppGwSslPolicy20150501: No description available. ,
AppGwSslPolicy20170401: No description available. ,
AppGwSslPolicy20170401S: No description available. ,
AppGwSslPolicy20220101: No description available. ,
AppGwSslPolicy20220101S: No description available. ,
}
,
Required: False ,
}
enum ,
cipherSuites:
{
Description: Ssl cipher suites to be enabled in the specified order to application gateway. ,
Required: False ,
}
[
string ,
]
,
minProtocolVersion:
{
Description: Minimum version of Ssl protocol to be supported on application gateway. ,
Enum:
{
TLSv1_0: No description available. ,
TLSv1_1: No description available. ,
TLSv1_2: No description available. ,
TLSv1_3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
operationalState:
{
Description: Operational state of the application gateway resource. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayIPConfigurations:
{
Description: Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway IP configuration. ,
Required: False ,
}
{
subnet:
{
Description: Reference to the subnet resource. A subnet from where application gateway gets its private address. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application gateway IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
authenticationCertificates:
{
Description: Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway authentication certificate. ,
Required: False ,
}
{
data:
{
Description: Certificate public data. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the authentication certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the authentication certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
trustedRootCertificates:
{
Description: Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway trusted root certificate. ,
Required: False ,
}
{
data:
{
Description: Certificate public data. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the trusted root certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the trusted root certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
trustedClientCertificates:
{
Description: Trusted client certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway trusted client certificate. ,
Required: False ,
}
{
data:
{
Description: Certificate public data. ,
Required: False ,
}
string ,
validatedCertData:
{
Description: Validated certificate data. ,
Required: False ,
}
string ,
clientCertIssuerDN:
{
Description: Distinguished name of client certificate issuer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the trusted client certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the trusted client certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
sslCertificates:
{
Description: SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway SSL certificate. ,
Required: False ,
}
{
data:
{
Description: Base-64 encoded pfx certificate. Only applicable in PUT Request. ,
Required: False ,
}
string ,
password:
{
Description: Password for the pfx file specified in data. Only applicable in PUT request. ,
Required: False ,
}
string ,
publicCertData:
{
Description: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the SSL certificate resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the SSL certificate that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
frontendIPConfigurations:
{
Description: Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway frontend IP configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: PrivateIPAddress of the network interface IP Configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Reference to the subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
publicIPAddress:
{
Description: Reference to the PublicIP resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkConfiguration:
{
Description: Reference to the application gateway private link configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the frontend IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the frontend IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
frontendPorts:
{
Description: Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway frontend port. ,
Required: False ,
}
{
port:
{
Description: Frontend port. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the frontend port resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the frontend port that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
probes:
{
Description: Probes of the application gateway resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway probe. ,
Required: False ,
}
{
protocol:
{
Description: The protocol used for the probe. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
host:
{
Description: Host name to send the probe to. ,
Required: False ,
}
string ,
path:
{
Description: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. ,
Required: False ,
}
string ,
interval:
{
Description: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
unhealthyThreshold:
{
Description: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. ,
Format: int32 ,
Required: False ,
}
integer ,
pickHostNameFromBackendHttpSettings:
{
Description: Whether the host header should be picked from the backend http settings. Default value is false. ,
Required: False ,
}
boolean ,
pickHostNameFromBackendSettings:
{
Description: Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false. ,
Required: False ,
}
boolean ,
minServers:
{
Description: Minimum number of servers that are always marked healthy. Default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
match:
{
Description: Criterion for classifying a healthy probe response. ,
Required: False ,
}
{
body:
{
Description: Body that must be contained in the health response. Default value is empty. ,
Required: False ,
}
string ,
statusCodes:
{
Description: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. ,
Required: False ,
}
[
string ,
]
,
}
,
enableProbeProxyProtocolHeader:
{
Description: Whether to send Proxy Protocol header along with the Health Probe over TCP or TLS protocol. Default value is false. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the probe resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Name of the probe that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
backendAddressPools:
{
Description: Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway backend address pool. ,
Required: False ,
}
{
backendIPConfigurations:
{
Description: Collection of references to IPs defined in network interfaces. ,
Required: False ,
}
[
{
properties:
{
Description: Network interface IP configuration properties. ,
Required: False ,
}
{
gatewayLoadBalancer:
{
Description: The reference to gateway load balancer frontend IP. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
virtualNetworkTaps:
{
Description: The reference to Virtual Network Taps. ,
Required: False ,
}
[
{
properties:
{
Description: Virtual Network Tap Properties. ,
Required: False ,
}
{
networkInterfaceTapConfigurations:
{
Description: Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the virtual network tap resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the virtual network tap resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
destinationNetworkInterfaceIPConfiguration:
{
Required: False ,
}
string ,
destinationLoadBalancerFrontEndIPConfiguration:
{
Description: The reference to the private IP address on the internal Load Balancer that will receive the tap. ,
Required: False ,
}
{
properties:
{
Description: Properties of the load balancer probe. ,
Required: False ,
}
{
inboundNatRules:
{
Description: An array of references to inbound rules that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
inboundNatPools:
{
Description: An array of references to inbound pools that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
outboundRules:
{
Description: An array of references to outbound rules that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancingRules:
{
Description: An array of references to load balancing rules that use this frontend IP. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The Private IP allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: The reference to the subnet resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
networkSecurityGroup:
{
Description: The reference to the NetworkSecurityGroup resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the network security group. ,
Required: False ,
}
{
flushConnection:
{
Description: When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. ,
Required: False ,
}
boolean ,
securityRules:
{
Description: A collection of security rules of the network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
defaultSecurityRules:
{
Description: The default security rules of network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
networkInterfaces:
{
Description: A collection of references to network interfaces. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the network interface. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the network interface. ,
Required: False ,
}
{
virtualMachine:
{
Description: The reference to a virtual machine. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
networkSecurityGroup:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: A reference to the private endpoint to which the network interface is linked. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
tapConfigurations:
{
Description: A list of TapConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
dnsSettings:
{
Description: The DNS settings in network interface. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. ,
Required: False ,
}
[
string ,
]
,
appliedDnsServers:
{
Description: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. ,
Required: False ,
}
[
string ,
]
,
internalDnsNameLabel:
{
Description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalFqdn:
{
Description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalDomainNameSuffix:
{
Description: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address of the network interface. ,
Required: False ,
}
string ,
primary:
{
Description: Whether this is a primary network interface on a virtual machine. ,
Required: False ,
}
boolean ,
vnetEncryptionSupported:
{
Description: Whether the virtual machine this nic is attached to supports encryption. ,
Required: False ,
}
boolean ,
defaultOutboundConnectivityEnabled:
{
Description: Whether default outbound connectivity for nic was configured or not. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Indicates whether to disable tcp state tracking. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Indicates whether IP forwarding is enabled on this network interface. ,
Required: False ,
}
boolean ,
hostedWorkloads:
{
Description: A list of references to linked BareMetal resources. ,
Required: False ,
}
[
string ,
]
,
dscpConfiguration:
{
Description: A reference to the dscp configuration to which the network interface is linked. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the network interface resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: WorkloadType of the NetworkInterface for BareMetal resources ,
Required: False ,
}
string ,
nicType:
{
Description: Type of Network Interface resource. ,
Enum:
{
Standard: No description available. ,
Elastic: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkService:
{
Description: Privatelinkservice of the network interface resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private link service. ,
Required: False ,
}
{
loadBalancerFrontendIpConfigurations:
{
Description: An array of references to the load balancer IP configurations. ,
Required: False ,
}
[
string ,
]
,
ipConfigurations:
{
Description: An array of private link service IP configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the private link service IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of private link service ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
destinationIPAddress:
{
Description: The destination IP address of the private link service. ,
Required: False ,
}
string ,
accessMode:
{
Description: The access mode of the private link service. ,
Enum:
{
Default: Allows unrestricted access to the private link service. ,
Restricted: Limits access to subscriptions which are inside visibility list only. ,
}
,
Required: False ,
}
enum ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private link service. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private link service resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: An array of list about connections to the private endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private end point connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
privateEndpointLocation:
{
Description: The location of the private endpoint. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
visibility:
{
Description: The visibility list of the private link service. ,
Required: False ,
}
string ,
autoApproval:
{
Description: The auto-approval list of the private link service. ,
Required: False ,
}
string ,
fqdns:
{
Description: The list of Fqdn. ,
Required: False ,
}
[
string ,
]
,
alias:
{
Description: The alias of the private link service. ,
Required: False ,
}
string ,
enableProxyProtocol:
{
Description: Whether the private link service is enabled for proxy protocol or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Network Interface resource. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Auxiliary mode of Network Interface resource. ,
Enum:
{
None: No description available. ,
MaxConnections: No description available. ,
Floating: No description available. ,
AcceleratedConnections: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Auxiliary sku of Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
flowLogs:
{
Description: A collection of references to flow log resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the flow log. ,
Required: False ,
}
{
targetResourceId:
{
Description: ID of network security group to which flow log will be applied. ,
Required: True ,
}
string ,
targetResourceGuid:
{
Description: Guid of network security group to which flow log will be applied. ,
Required: False ,
}
string ,
storageId:
{
Description: ID of the storage account which is used to store the flow log. ,
Required: True ,
}
string ,
enabledFilteringCriteria:
{
Description: 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. ,
Required: False ,
}
string ,
recordTypes:
{
Description: Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged. ,
Required: False ,
}
string ,
enabled:
{
Description: Flag to enable/disable flow logging. ,
Required: False ,
}
boolean ,
retentionPolicy:
{
Description: Parameters that define the retention policy for flow log. ,
Required: False ,
}
{
days:
{
Description: Number of days to retain flow log records. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: Flag to enable/disable retention. ,
Required: False ,
}
boolean ,
}
,
format:
{
Description: Parameters that define the flow log format. ,
Required: False ,
}
{
type:
{
Description: The file type of flow log. ,
Enum:
{
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version (revision) of the flow log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
flowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
networkWatcherFlowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
enabled:
{
Description: Flag to enable/disable traffic analytics. ,
Required: False ,
}
boolean ,
workspaceId:
{
Description: The resource guid of the attached workspace. ,
Required: False ,
}
string ,
workspaceRegion:
{
Description: The location of the attached workspace. ,
Required: False ,
}
string ,
workspaceResourceId:
{
Description: Resource Id of the attached workspace. ,
Required: False ,
}
string ,
trafficAnalyticsInterval:
{
Description: The interval in minutes which would decide how frequently TA service should do flow analytics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the flow log. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
identity:
{
Description: FlowLog resource Managed Identity ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the network security group resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: The reference to the RouteTable resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopType:
{
Description: The type of Azure hop the packet should be sent to. ,
Enum:
{
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
Internet: No description available. ,
VirtualAppliance: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the route resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
hasBgpOverride:
{
Description: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
disableBgpRoutePropagation:
{
Description: Whether to disable the routes learned by BGP on that route table. True means disable. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the route table resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resource GUID property of the route table. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
natGateway:
{
Description: Nat gateway associated with this subnet. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceEndpoints:
{
Description: An array of service endpoints. ,
Required: False ,
}
[
{
service:
{
Description: The type of the endpoint service. ,
Required: False ,
}
string ,
networkIdentifier:
{
Description: SubResource as network identifier. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serviceEndpointPolicies:
{
Description: An array of service endpoint policies. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the service end point policy. ,
Required: False ,
}
{
serviceEndpointPolicyDefinitions:
{
Description: A collection of service endpoint policy definitions of the service endpoint policy. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the service endpoint policy definition. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
service:
{
Description: Service endpoint name. ,
Required: False ,
}
string ,
serviceResources:
{
Description: A list of service resources. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service endpoint policy definition resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
resourceGuid:
{
Description: The resource GUID property of the service endpoint policy resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the service endpoint policy resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
serviceAlias:
{
Description: The alias indicating if the policy belongs to a service ,
Required: False ,
}
string ,
contextualServiceEndpointPolicies:
{
Description: A collection of contextual service endpoint policy. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of service endpoint policy. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
}
,
]
,
privateEndpoints:
{
Description: An array of references to private endpoints. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: An array of references to the network interface IP configurations using subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the IP configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
publicIPAddress:
{
Description: The reference to the public IP resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The provisioning state of the IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurationProfiles:
{
Description: Array of IP configuration profiles which reference this subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the IP configuration profile. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the IP configuration profile resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipAllocations:
{
Description: Array of IpAllocation which reference this subnet. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
resourceNavigationLinks:
{
Description: An array of references to the external resources using subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Resource navigation link properties format. ,
Required: False ,
}
{
linkedResourceType:
{
Description: Resource type of the linked resource. ,
Required: False ,
}
string ,
link:
{
Description: Link to the external resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource navigation link resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
id:
{
Description: Resource navigation link identifier. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
serviceAssociationLinks:
{
Description: An array of references to services injecting into this subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Resource navigation link properties format. ,
Required: False ,
}
{
linkedResourceType:
{
Description: Resource type of the linked resource. ,
Required: False ,
}
string ,
link:
{
Description: Link to the external resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the service association link resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
allowDelete:
{
Description: If true, the resource can be deleted. ,
Required: False ,
}
boolean ,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: Name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
delegations:
{
Description: An array of references to the delegations on the subnet. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
serviceName:
{
Description: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). ,
Required: False ,
}
string ,
actions:
{
Description: The actions permitted to the service upon delegation. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the service delegation resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a subnet. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
purpose:
{
Description: A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the subnet resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointNetworkPolicies:
{
Description: Enable or Disable apply network policies on private end point in the subnet. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NetworkSecurityGroupEnabled: No description available. ,
RouteTableEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceNetworkPolicies:
{
Description: Enable or Disable apply network policies on private link service in the subnet. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayIPConfigurations:
{
Description: Application gateway IP configurations of virtual network resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application gateway IP configuration. ,
Required: False ,
}
{
subnet:
{
Description: Reference to the subnet resource. A subnet from where application gateway gets its private address. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application gateway IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the IP configuration that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
sharingScope:
{
Description: 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. ,
Enum:
{
Tenant: No description available. ,
DelegatedServices: No description available. ,
}
,
Required: False ,
}
enum ,
defaultOutboundAccess:
{
Description: Set this property to false to disable default outbound connectivity for all VMs in the subnet. ,
Required: False ,
}
boolean ,
ipamPoolPrefixAllocations:
{
Description: A list of IPAM Pools for allocating IP address prefixes. ,
Required: False ,
}
[
{
pool:
{
Required: False ,
}
{
id:
{
Description: Resource id of the associated Azure IpamPool resource. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
numberOfIpAddresses:
{
Description: Number of IP addresses to allocate. ,
Required: False ,
}
string ,
allocatedAddressPrefixes:
{
Description: List of assigned IP address prefixes in the IpamPool of the associated resource. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
publicIPAddress:
{
Description: The reference to the Public IP resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Public IP address properties. ,
Required: False ,
}
{
publicIPAllocationMethod:
{
Description: The public IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAddressVersion:
{
Description: The public IP address version. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
ipConfiguration:
{
Required: False ,
}
string ,
dnsSettings:
{
Description: The FQDN of the DNS record associated with the public IP address. ,
Required: False ,
}
{
domainNameLabel:
{
Description: The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. ,
Required: False ,
}
string ,
domainNameLabelScope:
{
Description: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
fqdn:
{
Description: The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. ,
Required: False ,
}
string ,
reverseFqdn:
{
Description: The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ,
Required: False ,
}
string ,
}
,
ddosSettings:
{
Description: The DDoS protection custom policy associated with the public IP address. ,
Required: False ,
}
{
protectionMode:
{
Description: The DDoS protection mode of the public IP ,
Enum:
{
VirtualNetworkInherited: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
ddosProtectionPlan:
{
Description: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipTags:
{
Description: The list of tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
ipAddress:
{
Description: The IP address associated with the public IP address resource. ,
Required: False ,
}
string ,
publicIPPrefix:
{
Description: The Public IP Prefix this Public IP Address should be allocated from. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuid:
{
Description: The resource GUID property of the public IP address resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the public IP address resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
servicePublicIPAddress:
{
Description: The service public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
natGateway:
{
Description: The NatGateway for the Public IP address. ,
Required: False ,
}
{
sku:
{
Description: The nat gateway SKU. ,
Required: False ,
}
{
name:
{
Description: Name of Nat Gateway SKU. ,
Enum:
{
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Nat Gateway properties. ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the nat gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
publicIpAddresses:
{
Description: An array of public ip addresses V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpAddressesV6:
{
Description: An array of public ip addresses V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixes:
{
Description: An array of public ip prefixes V4 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
publicIpPrefixesV6:
{
Description: An array of public ip prefixes V6 associated with the nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: An array of references to the subnets using this nat gateway resource. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
sourceVirtualNetwork:
{
Description: A reference to the source virtual network using this nat gateway resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceGateway:
{
Description: Reference to an existing service gateway. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the NAT gateway resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the NAT gateway resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: A list of availability zones denoting the zone in which Nat Gateway should be deployed. ,
Required: False ,
}
[
string ,
]
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Public IP Address. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
linkedPublicIPAddress:
{
Description: The linked public IP address of the public IP address resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the public ip address. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The public IP address SKU. ,
Required: False ,
}
{
name:
{
Description: Name of a public IP address SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
StandardV2: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Tier of a public IP address SKU. ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM using it is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
publicIPPrefix:
{
Description: The reference to the Public IP Prefix resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
gatewayLoadBalancer:
{
Description: The reference to gateway load balancer frontend IP. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the frontend IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
zones:
{
Description: A list of availability zones denoting the IP allocated for the resource needs to come from. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationPort:
{
Description: The VXLAN destination port that will receive the tapped traffic. ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: The reference to ApplicationGatewayBackendAddressPool resource. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: Name of the backend address pool that is unique within an Application Gateway. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: The reference to LoadBalancerBackendAddressPool resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of load balancer backend address pool. ,
Required: False ,
}
{
location:
{
Description: The location of the backend address pool. ,
Required: False ,
}
string ,
tunnelInterfaces:
{
Description: An array of gateway load balancer tunnel interfaces. ,
Required: False ,
}
[
{
port:
{
Description: Port of gateway load balancer tunnel interface. ,
Format: int32 ,
Required: False ,
}
integer ,
identifier:
{
Description: Identifier of gateway load balancer tunnel interface. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: Protocol of gateway load balancer tunnel interface. ,
Enum:
{
None: No description available. ,
Native: No description available. ,
VXLAN: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Traffic type of gateway load balancer tunnel interface. ,
Enum:
{
None: No description available. ,
Internal: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
loadBalancerBackendAddresses:
{
Description: An array of backend addresses. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of load balancer backend address pool. ,
Required: False ,
}
{
virtualNetwork:
{
Description: Reference to an existing virtual network. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: Reference to an existing subnet. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
ipAddress:
{
Description: IP Address belonging to the referenced virtual network. ,
Required: False ,
}
string ,
networkInterfaceIPConfiguration:
{
Description: Reference to IP address defined in network interfaces. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
loadBalancerFrontendIPConfiguration:
{
Description: Reference to the frontend ip address configuration defined in regional loadbalancer. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
inboundNatRulesPortMapping:
{
Description: Collection of inbound NAT rule port mappings. ,
Required: False ,
}
[
{
inboundNatRuleName:
{
Description: Name of inbound NAT rule. ,
Required: False ,
}
string ,
frontendPort:
{
Description: Frontend port. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: Backend port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
adminState:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Up: No description available. ,
Down: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the backend address. ,
Required: False ,
}
string ,
}
,
]
,
backendIPConfigurations:
{
Description: An array of references to IP addresses defined in network interfaces. ,
Required: False ,
}
[
string ,
]
,
loadBalancingRules:
{
Description: An array of references to load balancing rules that use this backend address pool. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
outboundRule:
{
Description: A reference to an outbound rule that uses this backend address pool. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
outboundRules:
{
Description: An array of references to outbound rules that use this backend address pool. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
inboundNatRules:
{
Description: An array of references to inbound NAT rules that use this backend address pool. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the backend address pool resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
drainPeriodInSeconds:
{
Description: Amount of seconds Load Balancer waits for before sending RESET to client and backend address. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualNetwork:
{
Description: A reference to a virtual network. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
syncMode:
{
Description: Backend address synchronous mode for the backend pool ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: 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. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatRules:
{
Description: A list of references of LoadBalancerInboundNatRules. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of load balancer inbound NAT rule. ,
Required: False ,
}
{
frontendIPConfiguration:
{
Description: A reference to frontend IP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
backendIPConfiguration:
{
Required: False ,
}
string ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
Udp: No description available. ,
Tcp: No description available. ,
All: No description available. ,
Quic: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port used for the internal endpoint. Acceptable values range from 1 to 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
idleTimeoutInMinutes:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
enableFloatingIP:
{
Description: 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. ,
Required: False ,
}
boolean ,
enableTcpReset:
{
Description: 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. ,
Required: False ,
}
boolean ,
frontendPortRangeStart:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeEnd:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
backendAddressPool:
{
Description: A reference to backendAddressPool resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the inbound NAT rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
privateIPAddress:
{
Description: Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format
/. ,
Required: False ,
}
string ,
privateIPAddressPrefixLength:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet bound to the IP configuration. ,
Required: False ,
}
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
networkSecurityGroup:
{
Description: The reference to the NetworkSecurityGroup resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the network security group. ,
Required: False ,
}
{
flushConnection:
{
Description: When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. ,
Required: False ,
}
boolean ,
securityRules:
{
Description: A collection of security rules of the network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
defaultSecurityRules:
{
Description: The default security rules of network security group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the security rule. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
Icmp: No description available. ,
Esp: No description available. ,
*: No description available. ,
Ah: No description available. ,
}
,
Required: True ,
}
enum ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
sourceAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourceApplicationSecurityGroups:
{
Description: The application security group specified as source. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
destinationAddressPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationApplicationSecurityGroups:
{
Description: The application security group specified as destination. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the security rule resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
networkInterfaces:
{
Description: A collection of references to network interfaces. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the network interface. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the network interface. ,
Required: False ,
}
{
virtualMachine:
{
Description: The reference to a virtual machine. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
networkSecurityGroup:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: A reference to the private endpoint to which the network interface is linked. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
tapConfigurations:
{
Description: A list of TapConfigurations of the network interface. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Virtual Network Tap configuration. ,
Required: False ,
}
{
virtualNetworkTap:
{
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface tap configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: Sub Resource type. ,
Required: False ,
}
string ,
}
,
]
,
dnsSettings:
{
Description: The DNS settings in network interface. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. ,
Required: False ,
}
[
string ,
]
,
appliedDnsServers:
{
Description: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. ,
Required: False ,
}
[
string ,
]
,
internalDnsNameLabel:
{
Description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalFqdn:
{
Description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. ,
Required: False ,
}
string ,
internalDomainNameSuffix:
{
Description: Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address of the network interface. ,
Required: False ,
}
string ,
primary:
{
Description: Whether this is a primary network interface on a virtual machine. ,
Required: False ,
}
boolean ,
vnetEncryptionSupported:
{
Description: Whether the virtual machine this nic is attached to supports encryption. ,
Required: False ,
}
boolean ,
defaultOutboundConnectivityEnabled:
{
Description: Whether default outbound connectivity for nic was configured or not. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Indicates whether to disable tcp state tracking. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Indicates whether IP forwarding is enabled on this network interface. ,
Required: False ,
}
boolean ,
hostedWorkloads:
{
Description: A list of references to linked BareMetal resources. ,
Required: False ,
}
[
string ,
]
,
dscpConfiguration:
{
Description: A reference to the dscp configuration to which the network interface is linked. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
resourceGuid:
{
Description: The resource GUID property of the network interface resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network interface resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: WorkloadType of the NetworkInterface for BareMetal resources ,
Required: False ,
}
string ,
nicType:
{
Description: Type of Network Interface resource. ,
Enum:
{
Standard: No description available. ,
Elastic: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkService:
{
Description: Privatelinkservice of the network interface resource. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private link service. ,
Required: False ,
}
{
loadBalancerFrontendIpConfigurations:
{
Description: An array of references to the load balancer IP configurations. ,
Required: False ,
}
[
string ,
]
,
ipConfigurations:
{
Description: An array of private link service IP configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service ip configuration. ,
Required: False ,
}
{
privateIPAddress:
{
Description: The private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Description: The private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Required: False ,
}
string ,
primary:
{
Description: Whether the ip configuration is primary or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the private link service IP configuration resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateIPAddressVersion:
{
Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of private link service ip configuration. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
]
,
destinationIPAddress:
{
Description: The destination IP address of the private link service. ,
Required: False ,
}
string ,
accessMode:
{
Description: The access mode of the private link service. ,
Enum:
{
Default: Allows unrestricted access to the private link service. ,
Restricted: Limits access to subscriptions which are inside visibility list only. ,
}
,
Required: False ,
}
enum ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private link service. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private link service resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: An array of list about connections to the private endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private end point connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
extendedLocation:
{
Description: The extended location of the load balancer. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the private endpoint. ,
Required: False ,
}
{
subnet:
{
Required: False ,
}
string ,
networkInterfaces:
{
Description: An array of references to the network interfaces created for this private endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the private endpoint resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
ipVersionType:
{
Description: Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. ,
Enum:
{
IPv4: Indicates that the Private IPs of the private endpoint will be IPv4 only. ,
IPv6: Indicates that the Private IPs of the private endpoint will be IPv6 only. ,
DualStack: Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
manualPrivateLinkServiceConnections:
{
Description: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link service connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the private link service connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceId:
{
Description: The resource id of private link service. ,
Required: False ,
}
string ,
groupIds:
{
Description: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
[
string ,
]
,
requestMessage:
{
Description: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. ,
Required: False ,
}
string ,
privateLinkServiceConnectionState:
{
Description: A collection of read-only information about the state of the connection to the remote resource. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customDnsConfigs:
{
Description: An array of custom dns configurations. ,
Required: False ,
}
[
{
fqdn:
{
Description: Fqdn that resolves to private endpoint ip address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: A list of private ip addresses of the private endpoint. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
applicationSecurityGroups:
{
Description: Application security groups in which the private endpoint IP configuration is included. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the application security group. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the application security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
ipConfigurations:
{
Description: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of private endpoint IP configurations. ,
Required: False ,
}
{
groupId:
{
Description: The ID of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
memberName:
{
Description: The member name of a group obtained from the remote resource that this private endpoint should connect to. ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: A private ip address obtained from the private endpoint's subnet. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
customNetworkInterfaceName:
{
Description: The custom name of the network interface attached to the private endpoint. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Required: False ,
}
string ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
linkIdentifier:
{
Description: The consumer link id. ,
Required: False ,
}
string ,
privateEndpointLocation:
{
Description: The location of the private endpoint. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
visibility:
{
Description: The visibility list of the private link service. ,
Required: False ,
}
string ,
autoApproval:
{
Description: The auto-approval list of the private link service. ,
Required: False ,
}
string ,
fqdns:
{
Description: The list of Fqdn. ,
Required: False ,
}
[
string ,
]
,
alias:
{
Description: The alias of the private link service. ,
Required: False ,
}
string ,
enableProxyProtocol:
{
Description: Whether the private link service is enabled for proxy protocol or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
migrationPhase:
{
Description: Migration phase of Network Interface resource. ,
Enum:
{
None: No description available. ,
Prepare: No description available. ,
Commit: No description available. ,
Abort: No description available. ,
Committed: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Auxiliary mode of Network Interface resource. ,
Enum:
{
None: No description available. ,
MaxConnections: No description available. ,
Floating: No description available. ,
AcceleratedConnections: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Auxiliary sku of Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
flowLogs:
{
Description: A collection of references to flow log resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the flow log. ,
Required: False ,
}
{
targetResourceId:
{
Description: ID of network security group to which flow log will be applied. ,
Required: True ,
}
string ,
targetResourceGuid:
{
Description: Guid of network security group to which flow log will be applied. ,
Required: False ,
}
string ,
storageId:
{
Description: ID of the storage account which is used to store the flow log. ,
Required: True ,
}
string ,
enabledFilteringCriteria:
{
Description: 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. ,
Required: False ,
}
string ,
recordTypes:
{
Description: Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged. ,
Required: False ,
}
string ,
enabled:
{
Description: Flag to enable/disable flow logging. ,
Required: False ,
}
boolean ,
retentionPolicy:
{
Description: Parameters that define the retention policy for flow log. ,
Required: False ,
}
{
days:
{
Description: Number of days to retain flow log records. ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: Flag to enable/disable retention. ,
Required: False ,
}
boolean ,
}
,
format:
{
Description: Parameters that define the flow log format. ,
Required: False ,
}
{
type:
{
Description: The file type of flow log. ,
Enum:
{
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version (revision) of the flow log. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
flowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
networkWatcherFlowAnalyticsConfiguration:
{
Description: Parameters that define the configuration of traffic analytics. ,
Required: False ,
}
{
enabled:
{
Description: Flag to enable/disable traffic analytics. ,
Required: False ,
}
boolean ,
workspaceId:
{
Description: The resource guid of the attached workspace. ,
Required: False ,
}
string ,
workspaceRegion:
{
Description: The location of the attached workspace. ,
Required: False ,
}
string ,
workspaceResourceId:
{
Description: Resource Id of the attached workspace. ,
Required: False ,
}
string ,
trafficAnalyticsInterval:
{
Description: The interval in minutes which would decide how frequently TA service should do flow analytics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
provisioningState:
{
Description: The provisioning state of the flow log. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
identity:
{
Description: FlowLog resource Managed Identity ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
resourceGuid:
{
Description: The resource GUID property of the network security group resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: The reference to the RouteTable resource. ,
Required: False ,
}
{
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopType:
{
Description: The type of Azure hop the packet should be sent to. ,
Enum:
{
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
Internet: No description available. ,
VirtualAppliance: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the route resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
hasBgpOverride:
{
Description: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to subnets. ,
Required: False ,
}
[
string ,
]
,
disableBgpRoutePropagation:
{
Description: Whether to disable the routes learned by BGP on that route table. True means disable. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the route table resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resource GUID property of the route table. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
natGateway:
{
Description: Nat gateway associated with this subnet. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
serviceEndpoints:
{
Description: An array of service endpoints. ,
Required: False ,
}
[
{
service:
{