Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ZoneSummary

A DNS zone.

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

compartmentId

compartmentId: string

The OCID of the compartment containing the zone.

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

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 zone.

isProtected

isProtected: boolean

A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.

lifecycleState

lifecycleState: LifecycleState

The current state of the zone resource.

name

name: string

The name of the zone.

scope

scope: Scope

The scope of the zone.

self

self: string

The canonical absolute URL of the resource.

serial

serial: number

The current serial of the zone. As seen in the zone's SOA record. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

timeCreated

timeCreated: Date

The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

*Example:** {@code 2016-07-22T17:23:59:60Z}

version

version: string

Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.

Optional viewId

viewId: undefined | string

The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.

zoneType

zoneType: ZoneType

The type of the zone. Must be either {@code PRIMARY} or {@code SECONDARY}. {@code SECONDARY} is only supported for GLOBAL zones.

Functions

getDeserializedJsonObj

getJsonObj