Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace NetworkFirewall

A network firewall is a security resource that exists in a subnet of your choice and controls incoming and outgoing network traffic based on a set of security rules. Each firewall is associated with a policy. Traffic is routed to and from the firewall from resources such as internet gateways and dynamic routing gateways (DRGs). For more information, see Overview of Network Firewall

Properties

Optional availabilityDomain

availabilityDomain: undefined | string

Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use the {@link #listAvailabilityDomains(ListAvailabilityDomainsRequest) listAvailabilityDomains} operation. Example: {@code kIdk:PHX-AD-1}

compartmentId

compartmentId: string

The OCID of the compartment containing the Network Firewall.

definedTags

definedTags: object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

displayName

displayName: string

A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags

freeformTags: object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {@code {"Department": "Finance"}}

Type declaration

  • [key: string]: string

id

id: string

The OCID of the Network Firewall resource.

Optional ipv4Address

ipv4Address: undefined | string

IPv4 address for the Network Firewall.

Optional ipv6Address

ipv6Address: undefined | string

IPv6 address for the Network Firewall.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.

lifecycleState

lifecycleState: LifecycleState

The current state of the Network Firewall.

networkFirewallPolicyId

networkFirewallPolicyId: string

The OCID of the Network Firewall Policy.

Optional networkSecurityGroupIds

networkSecurityGroupIds: Array<string>

An array of network security groups OCID associated with the Network Firewall.

subnetId

subnetId: string

The OCID of the subnet associated with the Network Firewall.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The time at which the Network Firewall was created in the format defined by RFC3339. Example: {@code 2016-08-25T21:10:29.600Z}

timeUpdated

timeUpdated: Date

The time at which the Network Firewall was updated in the format defined by RFC3339. Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj