dns_private_zones

Creates, updates, deletes, gets or lists a dns_private_zones resource.

Overview

Name	dns_private_zones
Type	Resource
Id	azure_isv.oracledatabase.dns_private_zones

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
isProtected	boolean	A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. Required.
lifecycleState	string	Zones lifecycleState. Required. Known values are: "Active", "Creating", "Deleted", "Deleting", and "Updating". (Active, Creating, Deleted, Deleting, Updating)
ocid	string	The OCID of the Zone. Required.
provisioningState	string	Azure resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
self	string	The canonical absolute URL of the resource. Required.
serial	integer	The current serial of the zone. As seen in the zone's SOA record. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated	string (date-time)	Zones timeCreated. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
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. Required.
viewId	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	string	The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones. Required. Known values are: "Primary" and "Secondary". (Primary, Secondary)

list_by_location

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
isProtected	boolean	A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. Required.
lifecycleState	string	Zones lifecycleState. Required. Known values are: "Active", "Creating", "Deleted", "Deleting", and "Updating". (Active, Creating, Deleted, Deleting, Updating)
ocid	string	The OCID of the Zone. Required.
provisioningState	string	Azure resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
self	string	The canonical absolute URL of the resource. Required.
serial	integer	The current serial of the zone. As seen in the zone's SOA record. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated	string (date-time)	Zones timeCreated. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
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. Required.
viewId	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	string	The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones. Required. Known values are: "Primary" and "Secondary". (Primary, Secondary)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, dnsprivatezonename, subscription_id		Get a DnsPrivateZone.
list_by_location	select	location, subscription_id		List DnsPrivateZone resources by SubscriptionLocationResource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dnsprivatezonename	string	DnsPrivateZone name. Required.
location	string	The name of the Azure region. Required.
subscription_id	string

SELECT examples

get

Get a DnsPrivateZone.

SELECT
id,
name,
isProtected,
lifecycleState,
ocid,
provisioningState,
self,
serial,
systemData,
timeCreated,
type,
version,
viewId,
zoneType
FROM azure_isv.oracledatabase.dns_private_zones
WHERE location = '{{ location }}' -- required
AND dnsprivatezonename = '{{ dnsprivatezonename }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_location

List DnsPrivateZone resources by SubscriptionLocationResource.

SELECT
id,
name,
isProtected,
lifecycleState,
ocid,
provisioningState,
self,
serial,
systemData,
timeCreated,
type,
version,
viewId,
zoneType
FROM azure_isv.oracledatabase.dns_private_zones
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;