AdminRule interface

Package:

@azure/arm-network

Network admin rule.

Extends

BaseAdminRule

Properties

access	Indicates the access allowed for this particular rule
description	A description for this rule. Restricted to 140 chars.
destinationPortRanges	The destination port ranges.
destinations	The destination address prefixes. CIDR or destination IP ranges.
direction	Indicates if the traffic matched against the rule in inbound or outbound.
kind	Polymorphic discriminator, which specifies the different types this object can be
priority	The priority of the rule. The value can be between 1 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.
protocol	Network protocol this rule applies to.
provisioningState	The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGuid	Unique identifier for this resource. NOTE: This property will not be serialized. It can only be populated by the server.
sourcePortRanges	The source port ranges.
sources	The CIDR or source IP ranges.

Inherited Properties

etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
id	Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
systemData	The system metadata related to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

access

Indicates the access allowed for this particular rule

access?: string

Property Value

string

description

A description for this rule. Restricted to 140 chars.

description?: string

Property Value

string

destinationPortRanges

The destination port ranges.

destinationPortRanges?: string[]

Property Value

string[]

destinations

The destination address prefixes. CIDR or destination IP ranges.

destinations?: AddressPrefixItem[]

Property Value

AddressPrefixItem[]

direction

Indicates if the traffic matched against the rule in inbound or outbound.

direction?: string

Property Value

string

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "Custom"

Property Value

"Custom"

priority

The priority of the rule. The value can be between 1 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.

priority?: number

Property Value

number

protocol

Network protocol this rule applies to.

protocol?: string

Property Value

string

provisioningState

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourceGuid

Unique identifier for this resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGuid?: string

Property Value

string

sourcePortRanges

The source port ranges.

sourcePortRanges?: string[]

Property Value

string[]

sources

The CIDR or source IP ranges.

sources?: AddressPrefixItem[]

Property Value

AddressPrefixItem[]

Inherited Property Details

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From BaseAdminRule.etag

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From BaseAdminRule.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From BaseAdminRule.name

systemData

The system metadata related to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From BaseAdminRule.systemData

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From BaseAdminRule.type