network_anchors

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

Overview

Name	network_anchors
Type	Resource
Id	azure_isv.oracledatabase.network_anchors

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.
cidrBlock	string	Delegated Azure subnet cidr block.
dnsForwardingEndpointIpAddress	string	DNS forwarding endpoint IP address.
dnsForwardingEndpointNsgRulesUrl	string	Deep link to OCI console DNS Forwarding endpoint NSG rules.
dnsForwardingRules	array	DNS forwarding rules.
dnsForwardingRulesUrl	string	Deep link to OCI console DNS Forwarding rules page.
dnsListeningEndpointAllowedCidrs	string	Comma-separated list of CIDRs that are allowed to send requests to the DNS listening endpoint.
dnsListeningEndpointIpAddress	string	DNS listening endpoint IP address.
dnsListeningEndpointNsgRulesUrl	string	Deep link to OCI console DNS Listening endpoint NSG rules.
isOracleDnsForwardingEndpointEnabled	boolean	Indicates whether the Oracle DNS forwarding endpoint is enabled.
isOracleDnsListeningEndpointEnabled	boolean	Indicates whether the Oracle DNS listening endpoint is enabled.
isOracleToAzureDnsZoneSyncEnabled	boolean	Indicates whether DNS zone sync from OCI to Azure is enabled.
location	string	The geo-location where the resource lives. Required.
ociBackupCidrBlock	string	OCI backup subnet cidr block.
ociSubnetId	string	Oracle Cloud Infrastructure subnet OCID.
ociVcnDnsLabel	string	OCI DNS label. This is optional if DNS config is provided.
ociVcnId	string	Oracle Cloud Infrastructure VCN OCID.
provisioningState	string	NetworkAnchor provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
resourceAnchorId	string	Corresponding resource anchor Azure ID. Required.
subnetId	string	Client subnet. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vnetId	string	VNET for network connectivity.
zones	array	The availability zones.

list_by_resource_group

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.
cidrBlock	string	Delegated Azure subnet cidr block.
dnsForwardingEndpointIpAddress	string	DNS forwarding endpoint IP address.
dnsForwardingEndpointNsgRulesUrl	string	Deep link to OCI console DNS Forwarding endpoint NSG rules.
dnsForwardingRules	array	DNS forwarding rules.
dnsForwardingRulesUrl	string	Deep link to OCI console DNS Forwarding rules page.
dnsListeningEndpointAllowedCidrs	string	Comma-separated list of CIDRs that are allowed to send requests to the DNS listening endpoint.
dnsListeningEndpointIpAddress	string	DNS listening endpoint IP address.
dnsListeningEndpointNsgRulesUrl	string	Deep link to OCI console DNS Listening endpoint NSG rules.
isOracleDnsForwardingEndpointEnabled	boolean	Indicates whether the Oracle DNS forwarding endpoint is enabled.
isOracleDnsListeningEndpointEnabled	boolean	Indicates whether the Oracle DNS listening endpoint is enabled.
isOracleToAzureDnsZoneSyncEnabled	boolean	Indicates whether DNS zone sync from OCI to Azure is enabled.
location	string	The geo-location where the resource lives. Required.
ociBackupCidrBlock	string	OCI backup subnet cidr block.
ociSubnetId	string	Oracle Cloud Infrastructure subnet OCID.
ociVcnDnsLabel	string	OCI DNS label. This is optional if DNS config is provided.
ociVcnId	string	Oracle Cloud Infrastructure VCN OCID.
provisioningState	string	NetworkAnchor provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
resourceAnchorId	string	Corresponding resource anchor Azure ID. Required.
subnetId	string	Client subnet. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vnetId	string	VNET for network connectivity.
zones	array	The availability zones.

list_by_subscription

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.
cidrBlock	string	Delegated Azure subnet cidr block.
dnsForwardingEndpointIpAddress	string	DNS forwarding endpoint IP address.
dnsForwardingEndpointNsgRulesUrl	string	Deep link to OCI console DNS Forwarding endpoint NSG rules.
dnsForwardingRules	array	DNS forwarding rules.
dnsForwardingRulesUrl	string	Deep link to OCI console DNS Forwarding rules page.
dnsListeningEndpointAllowedCidrs	string	Comma-separated list of CIDRs that are allowed to send requests to the DNS listening endpoint.
dnsListeningEndpointIpAddress	string	DNS listening endpoint IP address.
dnsListeningEndpointNsgRulesUrl	string	Deep link to OCI console DNS Listening endpoint NSG rules.
isOracleDnsForwardingEndpointEnabled	boolean	Indicates whether the Oracle DNS forwarding endpoint is enabled.
isOracleDnsListeningEndpointEnabled	boolean	Indicates whether the Oracle DNS listening endpoint is enabled.
isOracleToAzureDnsZoneSyncEnabled	boolean	Indicates whether DNS zone sync from OCI to Azure is enabled.
location	string	The geo-location where the resource lives. Required.
ociBackupCidrBlock	string	OCI backup subnet cidr block.
ociSubnetId	string	Oracle Cloud Infrastructure subnet OCID.
ociVcnDnsLabel	string	OCI DNS label. This is optional if DNS config is provided.
ociVcnId	string	Oracle Cloud Infrastructure VCN OCID.
provisioningState	string	NetworkAnchor provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
resourceAnchorId	string	Corresponding resource anchor Azure ID. Required.
subnetId	string	Client subnet. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vnetId	string	VNET for network connectivity.
zones	array	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_anchor_name, subscription_id		Get a NetworkAnchor.
list_by_resource_group	select	resource_group_name, subscription_id		List NetworkAnchor resources by resource group.
list_by_subscription	select	subscription_id		List NetworkAnchor resources by subscription ID.
create_or_update	insert	resource_group_name, network_anchor_name, subscription_id, location		Create a NetworkAnchor.
update	update	resource_group_name, network_anchor_name, subscription_id		Update a NetworkAnchor.
create_or_update	replace	resource_group_name, network_anchor_name, subscription_id, location		Create a NetworkAnchor.
delete	delete	resource_group_name, network_anchor_name, subscription_id		Delete a NetworkAnchor.

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
network_anchor_name	string	The name of the NetworkAnchor. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a NetworkAnchor.

SELECT
id,
name,
cidrBlock,
dnsForwardingEndpointIpAddress,
dnsForwardingEndpointNsgRulesUrl,
dnsForwardingRules,
dnsForwardingRulesUrl,
dnsListeningEndpointAllowedCidrs,
dnsListeningEndpointIpAddress,
dnsListeningEndpointNsgRulesUrl,
isOracleDnsForwardingEndpointEnabled,
isOracleDnsListeningEndpointEnabled,
isOracleToAzureDnsZoneSyncEnabled,
location,
ociBackupCidrBlock,
ociSubnetId,
ociVcnDnsLabel,
ociVcnId,
provisioningState,
resourceAnchorId,
subnetId,
systemData,
tags,
type,
vnetId,
zones
FROM azure_isv.oracledatabase.network_anchors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_anchor_name = '{{ network_anchor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List NetworkAnchor resources by resource group.

SELECT
id,
name,
cidrBlock,
dnsForwardingEndpointIpAddress,
dnsForwardingEndpointNsgRulesUrl,
dnsForwardingRules,
dnsForwardingRulesUrl,
dnsListeningEndpointAllowedCidrs,
dnsListeningEndpointIpAddress,
dnsListeningEndpointNsgRulesUrl,
isOracleDnsForwardingEndpointEnabled,
isOracleDnsListeningEndpointEnabled,
isOracleToAzureDnsZoneSyncEnabled,
location,
ociBackupCidrBlock,
ociSubnetId,
ociVcnDnsLabel,
ociVcnId,
provisioningState,
resourceAnchorId,
subnetId,
systemData,
tags,
type,
vnetId,
zones
FROM azure_isv.oracledatabase.network_anchors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List NetworkAnchor resources by subscription ID.

SELECT
id,
name,
cidrBlock,
dnsForwardingEndpointIpAddress,
dnsForwardingEndpointNsgRulesUrl,
dnsForwardingRules,
dnsForwardingRulesUrl,
dnsListeningEndpointAllowedCidrs,
dnsListeningEndpointIpAddress,
dnsListeningEndpointNsgRulesUrl,
isOracleDnsForwardingEndpointEnabled,
isOracleDnsListeningEndpointEnabled,
isOracleToAzureDnsZoneSyncEnabled,
location,
ociBackupCidrBlock,
ociSubnetId,
ociVcnDnsLabel,
ociVcnId,
provisioningState,
resourceAnchorId,
subnetId,
systemData,
tags,
type,
vnetId,
zones
FROM azure_isv.oracledatabase.network_anchors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a NetworkAnchor.

INSERT INTO azure_isv.oracledatabase.network_anchors (
tags,
location,
properties,
zones,
resource_group_name,
network_anchor_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ network_anchor_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: network_anchors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_anchors resource.
  - name: network_anchor_name
    value: "{{ network_anchor_name }}"
    description: Required parameter for the network_anchors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_anchors resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      resourceAnchorId: "{{ resourceAnchorId }}"
      provisioningState: "{{ provisioningState }}"
      vnetId: "{{ vnetId }}"
      subnetId: "{{ subnetId }}"
      cidrBlock: "{{ cidrBlock }}"
      ociVcnId: "{{ ociVcnId }}"
      ociVcnDnsLabel: "{{ ociVcnDnsLabel }}"
      ociSubnetId: "{{ ociSubnetId }}"
      ociBackupCidrBlock: "{{ ociBackupCidrBlock }}"
      isOracleToAzureDnsZoneSyncEnabled: {{ isOracleToAzureDnsZoneSyncEnabled }}
      isOracleDnsListeningEndpointEnabled: {{ isOracleDnsListeningEndpointEnabled }}
      isOracleDnsForwardingEndpointEnabled: {{ isOracleDnsForwardingEndpointEnabled }}
      dnsForwardingRules:
        - domainNames: "{{ domainNames }}"
          forwardingIpAddress: "{{ forwardingIpAddress }}"
      dnsListeningEndpointAllowedCidrs: "{{ dnsListeningEndpointAllowedCidrs }}"
      dnsListeningEndpointIpAddress: "{{ dnsListeningEndpointIpAddress }}"
      dnsForwardingEndpointIpAddress: "{{ dnsForwardingEndpointIpAddress }}"
      dnsForwardingRulesUrl: "{{ dnsForwardingRulesUrl }}"
      dnsListeningEndpointNsgRulesUrl: "{{ dnsListeningEndpointNsgRulesUrl }}"
      dnsForwardingEndpointNsgRulesUrl: "{{ dnsForwardingEndpointNsgRulesUrl }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.

UPDATE examples

update

Update a NetworkAnchor.

UPDATE azure_isv.oracledatabase.network_anchors
SET 
zones = '{{ zones }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_anchor_name = '{{ network_anchor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type,
zones;

REPLACE examples

create_or_update

Create a NetworkAnchor.

REPLACE azure_isv.oracledatabase.network_anchors
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_anchor_name = '{{ network_anchor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type,
zones;

DELETE examples

delete

Delete a NetworkAnchor.

DELETE FROM azure_isv.oracledatabase.network_anchors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_anchor_name = '{{ network_anchor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;