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.
algorithm	string	Algorithm for Vault ExtendedInfo.
encryptionKey	string	Encryption key.
encryptionKeyThumbprint	string	Encryption key thumbprint.
etag	string	etag for the resource.
integrityKey	string	Integrity key.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, vault_name, subscription_id		Get the vault extended info.
create_or_update	insert	resource_group_name, vault_name, subscription_id		Create vault extended info.
update	update	resource_group_name, vault_name, subscription_id		Update vault extended info.
create_or_update	replace	resource_group_name, vault_name, subscription_id		Create 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The name of the recovery services vault. Required.

SELECT examples

get

Get the vault extended info.

SELECT
id,
name,
algorithm,
encryptionKey,
encryptionKeyThumbprint,
etag,
integrityKey,
systemData,
type
FROM azure.recovery_services.vault_extended_info
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create vault extended info.

INSERT INTO azure.recovery_services.vault_extended_info (
properties,
etag,
resource_group_name,
vault_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ resource_group_name }}',
'{{ vault_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: vault_extended_info
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the vault_extended_info resource.
  - name: vault_name
    value: "{{ vault_name }}"
    description: Required parameter for the vault_extended_info resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the vault_extended_info resource.
  - name: properties
    description: |
      Vault extended information.
    value:
      integrityKey: "{{ integrityKey }}"
      encryptionKey: "{{ encryptionKey }}"
      encryptionKeyThumbprint: "{{ encryptionKeyThumbprint }}"
      algorithm: "{{ algorithm }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      etag for the resource.

UPDATE examples

update

Update vault extended info.

UPDATE azure.recovery_services.vault_extended_info
SET 
properties = '{{ properties }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create vault extended info.

REPLACE azure.recovery_services.vault_extended_info
SET 
properties = '{{ properties }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;