Share via

IpSecurityRestriction interface

  • Reference
Package:
@azure/arm-appservice

IP security restriction on an app.

Properties

action

Allow or Deny access for this IP range.
description

IP restriction rule description.
headers

IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is ..

  • If the property is null or empty (default), all hosts(or lack of) are allowed.
  • A value is compared using ordinal-ignore-case (excluding port number).
  • Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com
  • Unicode host names are allowed but are converted to Punycode for matching.

X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is ..

  • If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.
  • If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.

X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match.
ipAddress

IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.
name

IP restriction rule name.
priority

Priority of IP restriction rule.
subnetMask

Subnet mask for the range of IP addresses the restriction is valid for.
subnetTrafficTag

(internal) Subnet traffic tag
tag

Defines what this IP filter will be used for. This is to support IP filtering on proxies.
vnetSubnetResourceId

Virtual network resource id
vnetTrafficTag

(internal) Vnet traffic tag

Property Details

action

Allow or Deny access for this IP range.

action?: string

Property Value

string

description

IP restriction rule description.

description?: string

Property Value

string

headers

IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is ..

  • If the property is null or empty (default), all hosts(or lack of) are allowed.
  • A value is compared using ordinal-ignore-case (excluding port number).
  • Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com
  • Unicode host names are allowed but are converted to Punycode for matching.

X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is ..

  • If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.
  • If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.

X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match.

headers?: {[propertyName: string]: string[]}

Property Value

{[propertyName: string]: string[]}

ipAddress

IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.

ipAddress?: string

Property Value

string

name

IP restriction rule name.

name?: string

Property Value

string

priority

Priority of IP restriction rule.

priority?: number

Property Value

number

subnetMask

Subnet mask for the range of IP addresses the restriction is valid for.

subnetMask?: string

Property Value

string

subnetTrafficTag

(internal) Subnet traffic tag

subnetTrafficTag?: number

Property Value

number

tag

Defines what this IP filter will be used for. This is to support IP filtering on proxies.

tag?: string

Property Value

string

vnetSubnetResourceId

Virtual network resource id

vnetSubnetResourceId?: string

Property Value

string

vnetTrafficTag

(internal) Vnet traffic tag

vnetTrafficTag?: number

Property Value

number