vault_extended_info

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

Overview

Name	vault_extended_info
Type	Resource
Id	azure.recovery_services.vault_extended_info

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
properties	object	Vault extended information.
systemData	object	Metadata pertaining to creation and last modification of the resource.
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	subscriptionId, resourceGroupName, vaultName		Get the vault extended info.
create_or_update	insert	subscriptionId, resourceGroupName, vaultName		Create vault extended info.
update	update	subscriptionId, resourceGroupName, vaultName		Update vault extended info.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
vaultName	string	The name of the recovery services vault.

SELECT examples

get

Get the vault extended info.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.recovery_services.vault_extended_info
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

INSERT examples

create_or_update

Create vault extended info.

INSERT INTO azure.recovery_services.vault_extended_info (
data__properties,
subscriptionId,
resourceGroupName,
vaultName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: vault_extended_info
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the vault_extended_info resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the vault_extended_info resource.
    - name: vaultName
      value: string
      description: Required parameter for the vault_extended_info resource.
    - name: properties
      value: object
      description: |
        Vault extended information.

UPDATE examples

update

Update vault extended info.

UPDATE azure.recovery_services.vault_extended_info
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;