azure_key_vault_secret_provider_classes

Creates, updates, deletes, gets or lists an azure_key_vault_secret_provider_classes resource.

Overview

Name	azure_key_vault_secret_provider_classes
Type	Resource
Id	azure.secrets_store_extension.azure_key_vault_secret_provider_classes

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.
clientId	string	The user assigned managed identity client ID that should be used to access the Azure Key Vault. Required.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.secretsstoreextension.models.ExtendedLocation
keyvaultName	string	The name of the Azure Key Vault to sync secrets from. Required.
location	string	The geo-location where the resource lives. Required.
objects	string	Objects defines the desired state of synced K8s secret objects.
provisioningState	string	Provisioning state of the AzureKeyVaultSecretProviderClass instance. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tenantId	string	The Azure Active Directory tenant ID that should be used for authenticating requests to the Azure Key Vault. Required.
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.
clientId	string	The user assigned managed identity client ID that should be used to access the Azure Key Vault. Required.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.secretsstoreextension.models.ExtendedLocation
keyvaultName	string	The name of the Azure Key Vault to sync secrets from. Required.
location	string	The geo-location where the resource lives. Required.
objects	string	Objects defines the desired state of synced K8s secret objects.
provisioningState	string	Provisioning state of the AzureKeyVaultSecretProviderClass instance. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tenantId	string	The Azure Active Directory tenant ID that should be used for authenticating requests to the Azure Key Vault. Required.
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.
clientId	string	The user assigned managed identity client ID that should be used to access the Azure Key Vault. Required.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.secretsstoreextension.models.ExtendedLocation
keyvaultName	string	The name of the Azure Key Vault to sync secrets from. Required.
location	string	The geo-location where the resource lives. Required.
objects	string	Objects defines the desired state of synced K8s secret objects.
provisioningState	string	Provisioning state of the AzureKeyVaultSecretProviderClass instance. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tenantId	string	The Azure Active Directory tenant ID that should be used for authenticating requests to the Azure Key Vault. Required.
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, azure_key_vault_secret_provider_class_name, subscription_id		Gets the properties of an AzureKeyVaultSecretProviderClass instance.
list_by_resource_group	select	resource_group_name, subscription_id		Lists the AzureKeyVaultSecretProviderClass instances within a resource group.
list_by_subscription	select	subscription_id		Lists the AzureKeyVaultSecretProviderClass instances within an Azure subscription.
create_or_update	insert	resource_group_name, azure_key_vault_secret_provider_class_name, subscription_id, location		Creates, or updates, an AzureKeyVaultSecretProviderClass instance.
update	update	resource_group_name, azure_key_vault_secret_provider_class_name, subscription_id		Updates an AzureKeyVaultSecretProviderClass instance.
create_or_update	replace	resource_group_name, azure_key_vault_secret_provider_class_name, subscription_id, location		Creates, or updates, an AzureKeyVaultSecretProviderClass instance.
delete	delete	resource_group_name, azure_key_vault_secret_provider_class_name, subscription_id		Deletes an AzureKeyVaultSecretProviderClass instance.

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

SELECT examples

get

Gets the properties of an AzureKeyVaultSecretProviderClass instance.

SELECT
id,
name,
clientId,
extendedLocation,
keyvaultName,
location,
objects,
provisioningState,
systemData,
tags,
tenantId,
type
FROM azure.secrets_store_extension.azure_key_vault_secret_provider_classes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND azure_key_vault_secret_provider_class_name = '{{ azure_key_vault_secret_provider_class_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists the AzureKeyVaultSecretProviderClass instances within a resource group.

SELECT
id,
name,
clientId,
extendedLocation,
keyvaultName,
location,
objects,
provisioningState,
systemData,
tags,
tenantId,
type
FROM azure.secrets_store_extension.azure_key_vault_secret_provider_classes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists the AzureKeyVaultSecretProviderClass instances within an Azure subscription.

SELECT
id,
name,
clientId,
extendedLocation,
keyvaultName,
location,
objects,
provisioningState,
systemData,
tags,
tenantId,
type
FROM azure.secrets_store_extension.azure_key_vault_secret_provider_classes
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates, or updates, an AzureKeyVaultSecretProviderClass instance.

INSERT INTO azure.secrets_store_extension.azure_key_vault_secret_provider_classes (
tags,
location,
properties,
extendedLocation,
resource_group_name,
azure_key_vault_secret_provider_class_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ azure_key_vault_secret_provider_class_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: azure_key_vault_secret_provider_classes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the azure_key_vault_secret_provider_classes resource.
  - name: azure_key_vault_secret_provider_class_name
    value: "{{ azure_key_vault_secret_provider_class_name }}"
    description: Required parameter for the azure_key_vault_secret_provider_classes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the azure_key_vault_secret_provider_classes 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:
      keyvaultName: "{{ keyvaultName }}"
      clientId: "{{ clientId }}"
      tenantId: "{{ tenantId }}"
      objects: "{{ objects }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      :vartype extended_location: ~azure.mgmt.secretsstoreextension.models.ExtendedLocation
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Updates an AzureKeyVaultSecretProviderClass instance.

UPDATE azure.secrets_store_extension.azure_key_vault_secret_provider_classes
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_key_vault_secret_provider_class_name = '{{ azure_key_vault_secret_provider_class_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates, or updates, an AzureKeyVaultSecretProviderClass instance.

REPLACE azure.secrets_store_extension.azure_key_vault_secret_provider_classes
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_key_vault_secret_provider_class_name = '{{ azure_key_vault_secret_provider_class_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an AzureKeyVaultSecretProviderClass instance.

DELETE FROM azure.secrets_store_extension.azure_key_vault_secret_provider_classes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND azure_key_vault_secret_provider_class_name = '{{ azure_key_vault_secret_provider_class_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;