secret_syncs

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

Overview

Name	secret_syncs
Type	Resource
Id	azure.secrets_store_extension.secret_syncs

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.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.secretsstoreextension.models.ExtendedLocation
forceSynchronization	string	ForceSynchronization can be used to force the secret synchronization. The secret synchronization is triggered by changing the value in this field. This field is not used to resolve synchronization conflicts.
kubernetesSecretType	string	Type specifies the type of the Kubernetes secret object, e.g. "Opaque" or"kubernetes.io/tls". The controller must have permission to create secrets of the specified type. Required. Known values are: "Opaque" and "kubernetes.io/tls". (Opaque, kubernetes.io/tls)
location	string	The geo-location where the resource lives. Required.
objectSecretMapping	array	An array of SecretObjectData that maps secret data from the external secret provider to the Kubernetes secret. Each entry specifies the source secret in the external provider and the corresponding key in the Kubernetes secret. Required.
provisioningState	string	Provisioning state of the SecretSync instance. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
secretProviderClassName	string	SecretProviderClassName specifies the name of the SecretProviderClass resource, which contains the information needed to access the cloud provider secret store. Required.
serviceAccountName	string	ServiceAccountName specifies the name of the service account used to access the cloud provider secret store. The audience field in the service account token must be passed as parameter in the controller configuration. The audience is used when requesting a token from the API server for the service account; the supported audiences are defined by each provider. Required.
status	object	SecretSyncStatus defines the observed state of the secret synchronization process.
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.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.secretsstoreextension.models.ExtendedLocation
forceSynchronization	string	ForceSynchronization can be used to force the secret synchronization. The secret synchronization is triggered by changing the value in this field. This field is not used to resolve synchronization conflicts.
kubernetesSecretType	string	Type specifies the type of the Kubernetes secret object, e.g. "Opaque" or"kubernetes.io/tls". The controller must have permission to create secrets of the specified type. Required. Known values are: "Opaque" and "kubernetes.io/tls". (Opaque, kubernetes.io/tls)
location	string	The geo-location where the resource lives. Required.
objectSecretMapping	array	An array of SecretObjectData that maps secret data from the external secret provider to the Kubernetes secret. Each entry specifies the source secret in the external provider and the corresponding key in the Kubernetes secret. Required.
provisioningState	string	Provisioning state of the SecretSync instance. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
secretProviderClassName	string	SecretProviderClassName specifies the name of the SecretProviderClass resource, which contains the information needed to access the cloud provider secret store. Required.
serviceAccountName	string	ServiceAccountName specifies the name of the service account used to access the cloud provider secret store. The audience field in the service account token must be passed as parameter in the controller configuration. The audience is used when requesting a token from the API server for the service account; the supported audiences are defined by each provider. Required.
status	object	SecretSyncStatus defines the observed state of the secret synchronization process.
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.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.secretsstoreextension.models.ExtendedLocation
forceSynchronization	string	ForceSynchronization can be used to force the secret synchronization. The secret synchronization is triggered by changing the value in this field. This field is not used to resolve synchronization conflicts.
kubernetesSecretType	string	Type specifies the type of the Kubernetes secret object, e.g. "Opaque" or"kubernetes.io/tls". The controller must have permission to create secrets of the specified type. Required. Known values are: "Opaque" and "kubernetes.io/tls". (Opaque, kubernetes.io/tls)
location	string	The geo-location where the resource lives. Required.
objectSecretMapping	array	An array of SecretObjectData that maps secret data from the external secret provider to the Kubernetes secret. Each entry specifies the source secret in the external provider and the corresponding key in the Kubernetes secret. Required.
provisioningState	string	Provisioning state of the SecretSync instance. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
secretProviderClassName	string	SecretProviderClassName specifies the name of the SecretProviderClass resource, which contains the information needed to access the cloud provider secret store. Required.
serviceAccountName	string	ServiceAccountName specifies the name of the service account used to access the cloud provider secret store. The audience field in the service account token must be passed as parameter in the controller configuration. The audience is used when requesting a token from the API server for the service account; the supported audiences are defined by each provider. Required.
status	object	SecretSyncStatus defines the observed state of the secret synchronization process.
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, secret_sync_name, subscription_id		Gets the properties of a SecretSync instance.
list_by_resource_group	select	resource_group_name, subscription_id		Lists the SecretSync instances within a resource group.
list_by_subscription	select	subscription_id		Lists the SecretSync instances within an Azure subscription.
create_or_update	insert	resource_group_name, secret_sync_name, subscription_id, location		Creates new or updates a SecretSync instance.
update	update	resource_group_name, secret_sync_name, subscription_id		Updates a SecretSync instance.
create_or_update	replace	resource_group_name, secret_sync_name, subscription_id, location		Creates new or updates a SecretSync instance.
delete	delete	resource_group_name, secret_sync_name, subscription_id		Deletes a SecretSync 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
secret_sync_name	string	The name of the SecretSync. Required.
subscription_id	string

SELECT examples

get

Gets the properties of a SecretSync instance.

SELECT
id,
name,
extendedLocation,
forceSynchronization,
kubernetesSecretType,
location,
objectSecretMapping,
provisioningState,
secretProviderClassName,
serviceAccountName,
status,
systemData,
tags,
type
FROM azure.secrets_store_extension.secret_syncs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND secret_sync_name = '{{ secret_sync_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists the SecretSync instances within a resource group.

SELECT
id,
name,
extendedLocation,
forceSynchronization,
kubernetesSecretType,
location,
objectSecretMapping,
provisioningState,
secretProviderClassName,
serviceAccountName,
status,
systemData,
tags,
type
FROM azure.secrets_store_extension.secret_syncs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists the SecretSync instances within an Azure subscription.

SELECT
id,
name,
extendedLocation,
forceSynchronization,
kubernetesSecretType,
location,
objectSecretMapping,
provisioningState,
secretProviderClassName,
serviceAccountName,
status,
systemData,
tags,
type
FROM azure.secrets_store_extension.secret_syncs
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates new or updates a SecretSync instance.

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

Manifest

# Description fields are for documentation purposes
- name: secret_syncs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the secret_syncs resource.
  - name: secret_sync_name
    value: "{{ secret_sync_name }}"
    description: Required parameter for the secret_syncs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the secret_syncs 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:
      secretProviderClassName: "{{ secretProviderClassName }}"
      serviceAccountName: "{{ serviceAccountName }}"
      kubernetesSecretType: "{{ kubernetesSecretType }}"
      forceSynchronization: "{{ forceSynchronization }}"
      objectSecretMapping:
        - sourcePath: "{{ sourcePath }}"
          targetKey: "{{ targetKey }}"
      status:
        lastSuccessfulSyncTime: "{{ lastSuccessfulSyncTime }}"
        conditions:
          - lastTransitionTime: "{{ lastTransitionTime }}"
            message: "{{ message }}"
            observedGeneration: {{ observedGeneration }}
            reason: "{{ reason }}"
            status: "{{ status }}"
            type: "{{ type }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      :vartype extended_location: ~azure.mgmt.secretsstoreextension.models.ExtendedLocation
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Updates a SecretSync instance.

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

REPLACE examples

create_or_update

Creates new or updates a SecretSync instance.

REPLACE azure.secrets_store_extension.secret_syncs
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND secret_sync_name = '{{ secret_sync_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 a SecretSync instance.

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