Resource: NetworkPolicy
Represents a Network Policy resource.
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "trafficClassificationRules": [ { "kind": string, "ruleName": string, "description": string, "priority": integer, "match": { "srcIpRanges": [ string ], "destIpRanges": [ string ], "layer4Configs": [ { "ipProtocol": string, "ports": [ string ] } ] }, "action": { "type": string, "trafficClass": enum, "dscpMode": enum, "dscpValue": integer }, "ruleTupleCount": integer, "targetServiceAccounts": [ string ], "targetSecureTags": [ { "name": string, "state": enum } ], "disabled": boolean } ], "selfLink": string, "selfLinkWithId": string, "associations": [ { "name": string, "attachmentTarget": string } ], "ruleTupleCount": integer, "region": string } |
Fields | |
---|---|
kind |
[Output only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
Name of the resource. |
description |
An optional description of this resource. Provide this property when you create the resource. |
trafficClassificationRules[] |
[Output Only] A list of traffic classification rules that belong to this policy. |
trafficClassificationRules[].kind |
[Output only] Type of the resource. Always |
trafficClassificationRules[].ruleName |
An optional name for the rule. This field is not a unique identifier and can be updated. |
trafficClassificationRules[].description |
An optional description for this resource. |
trafficClassificationRules[].priority |
An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority. |
trafficClassificationRules[].match |
A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. |
trafficClassificationRules[].match.srcIpRanges[] |
CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. |
trafficClassificationRules[].match.destIpRanges[] |
CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. |
trafficClassificationRules[].match.layer4Configs[] |
Pairs of IP protocols and ports that the rule should match. |
trafficClassificationRules[].match.layer4Configs[].ipProtocol |
The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings ( |
trafficClassificationRules[].match.layer4Configs[].ports[] |
An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: |
trafficClassificationRules[].action |
The Action to perform when the client connection triggers the rule. |
trafficClassificationRules[].action.type |
Always "apply_traffic_classification" for traffic classification rules. |
trafficClassificationRules[].action.trafficClass |
The traffic class that should be applied to the matching packet. |
trafficClassificationRules[].action.dscpMode |
The traffic class that should be applied to the matching packet. |
trafficClassificationRules[].action.dscpValue |
Custom DSCP value from 0-63 range. |
trafficClassificationRules[].ruleTupleCount |
[Output Only] Calculation of the complexity of a single network policy rule. |
trafficClassificationRules[].targetServiceAccounts[] |
A list of service accounts indicating the sets of instances that are applied with this rule. |
trafficClassificationRules[].targetSecureTags[] |
A list of secure tags that controls which instances the traffic classification rule applies to. If |
trafficClassificationRules[].targetSecureTags[].name |
Name of the secure tag, created with TagManager's TagValue API. |
trafficClassificationRules[].targetSecureTags[].state |
[Output Only] State of the secure tag, either |
trafficClassificationRules[].disabled |
Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled. |
selfLink |
[Output Only] Server-defined URL for the resource. |
selfLinkWithId |
[Output Only] Server-defined URL for this resource with the resource id. |
associations[] |
[Output Only] A list of associations that belong to this network policy. |
associations[].name |
The name for an association. |
associations[].attachmentTarget |
The target that the network policy is attached to. |
ruleTupleCount |
[Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples. |
region |
[Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
Methods |
|
---|---|
|
Inserts an association for the specified network policy. |
|
Inserts a rule into a network policy. |
|
Retrieves an aggregated list of network policies. |
|
Deletes the specified policy. |
|
Returns the specified network policy. |
|
Gets an association with the specified name. |
|
Gets a rule of the specified priority. |
|
Creates a new policy in the specified project using the data included in the request. |
|
Lists all the policies that have been configured for the specified project in the given region. |
|
Patches the specified policy with the data included in the request. |
|
Patches a rule of the specified priority. |
|
Removes an association for the specified network policy. |
|
Deletes a rule of the specified priority. |