resource_anchors

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

Overview

Name	resource_anchors
Type	Resource
Id	azure_isv.oracledatabase.resource_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.
linkedCompartmentId	string	Oracle Cloud Infrastructure compartment Id (ocid) which was created or linked by customer with resource anchor. This compartmentId is different from where resource Anchor lives.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	ResourceAnchor provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
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".

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.
linkedCompartmentId	string	Oracle Cloud Infrastructure compartment Id (ocid) which was created or linked by customer with resource anchor. This compartmentId is different from where resource Anchor lives.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	ResourceAnchor provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
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".

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.
linkedCompartmentId	string	Oracle Cloud Infrastructure compartment Id (ocid) which was created or linked by customer with resource anchor. This compartmentId is different from where resource Anchor lives.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	ResourceAnchor provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
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".

Methods

The following methods are available for this resource:

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

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
resource_anchor_name	string	The name of the ResourceAnchor. 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 ResourceAnchor.

SELECT
id,
name,
linkedCompartmentId,
location,
provisioningState,
systemData,
tags,
type
FROM azure_isv.oracledatabase.resource_anchors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_anchor_name = '{{ resource_anchor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List ResourceAnchor resources by resource group.

SELECT
id,
name,
linkedCompartmentId,
location,
provisioningState,
systemData,
tags,
type
FROM azure_isv.oracledatabase.resource_anchors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List ResourceAnchor resources by subscription ID.

SELECT
id,
name,
linkedCompartmentId,
location,
provisioningState,
systemData,
tags,
type
FROM azure_isv.oracledatabase.resource_anchors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a ResourceAnchor.

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

Manifest

# Description fields are for documentation purposes
- name: resource_anchors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the resource_anchors resource.
  - name: resource_anchor_name
    value: "{{ resource_anchor_name }}"
    description: Required parameter for the resource_anchors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the resource_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:
      provisioningState: "{{ provisioningState }}"
      linkedCompartmentId: "{{ linkedCompartmentId }}"

UPDATE examples

update

Update a ResourceAnchor.

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

REPLACE examples

create_or_update

Create a ResourceAnchor.

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

DELETE examples

delete

Delete a ResourceAnchor.

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