Azure Key Vault Connection

Overview
Quick Start
Configuration
Knowledge Base
Related scripts
What's New

Overview

Amazon Redshift

Configuration is provided for establishing connections with the Azure Key Vault service. The configuration is used in the REST Connection Manager.

Setup

Press icon to get more information about the connection parameters.

Obtain data

Use REST Source component to read data from Azure Key Vault.

Insert data

Use REST Destination component to insert/update/delete rows in a Azure Key Vault table.

Quick Start

Establish connection

No votes yet

In this QS, we will show you step-by-step how to create a connection to an Azure Key Vault REST API using COZYROC's REST Connection Manager.

Step 1. Run "Visual Studio" and right click on Connection Managers tab and select New Connection.

Step 2. Then "Add SSIS Connection Manager" popup window opens, scroll down and select "Connection managers for REST Connection" then click Add.

Step 3. From the Configuration drop down menu select Amazon Redshift.

Step 4. Replace the [keyvault-name] placeholder with your Key Vault name.

Step 5. Click on the new token button and input the Tenant ID, the Application ID and the Application Secret.

Consume data from service

No votes yet

In this guide, we will show you how to read data from the Azure Key Vault API resource using the COZYROC REST Source component.

Step 1. Select an existing or create a new "Data Flow Task".

Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.

Step 3. Double click on the "REST Source" component and select an Azure Key Vault connection from the list. Select from available Azure Key Vault resources listed in the second list below.

Step 4. Click on the "Columns" tab and select the Azure Key Vault columns you want to read.

Step 5. Click the "Preview" tab to make sure all necessary resource columns are included.

Bravo! You have now learned how to read data from the Azure Key Vault API service.

Push data to service

No votes yet

In this guide, we will show how to write data to the Azure Key Vault service resource using the COZYROC REST Destination component.

Step 1. Select an existing or create a new "Data Flow Task".

Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.

Step 3. Double click on the "REST Destination" component and select the Azure Key Vault connection from the list. After that select the action you will be performing with your data and select the target Resource.

Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.

Done. You have now learned how to write data into the Azure Key Vault API resource.

Configure Azure Key Vault Access policy

No votes yet

To access the Azure Key Vault resources, you need to have an access policy that gives you permission in place.

DISCLAIMER: This is not official Microsoft documentation, click here for the official page.

Step 1. Navigate to the Access Policy menu inside your Key Vault and click on Create.

Step 2. Check the desired access boxes.

Step 3. Select a principal, this is most likely the user that created the application intended for Azure Key Vault access

Step 4. Select the application that will be used during token generation.

Step 5. Review the Access Policy carefully and create it.

That's it. You should now be able to generate a token and access Azure Key Vault resources.

Contribute

Configuration

Service

Base URL address: https://[keyvault-name].vault.azure.net/.

Authentication

OAuth 2

The authentication uses an authorized token. The token will be refreshed with the following expression: {{=Date.now() + (response.expires_in - 300) * 1000}}.

The authentication has the following user-defined parameters:

tenant: Required. Specify tenant GUID.
application_id: Required. Identifier of an application that is associated with the authentication token.
client_secret: Required. An application secret value.

The following request parameters will be automatically processed during the authentication process:

Authorization: Bearer {{=token.Access}}
api-version: 7.4

Documentation: https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.1.

Resources

Key

Based on resource template BasePaginated.

[Read] action

Endpoint URL address: /keys.
The result is extracted from: {{=response.value}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/get-keys/get-keys.

[Read Version] action

Endpoint URL address: /keys/{{=parameters['key-name']}}.
The result is extracted from: {{=response.value}}.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/get-key-versions/get-key-versions.

[Read Deleted] action

Endpoint URL address: /deletedkeys.
The result is extracted from: {{=response.value}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/get-deleted-keys/get-deleted-keys.

[Read Single] action

Endpoint URL address: /keys/{{=parameters['key-name'] + '/' + parameters.get('key-version','')}}.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.
key-version: Adding the version parameter retrieves a specific version of a key. Optional.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/get-key/get-key.

[Read Deleted single] action

Endpoint URL address: /deletedkeys/{{=parameters['key-name']}}.
The result is extracted from: {{=response.value}}.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/delete-key/delete-key.

[Create] action

Endpoint URL address: /keys/{{=item.keyName}}/create.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/create-key/create-key.

[Update] action

Endpoint URL address: /keys/{{=item.keyName + item.keyVersion ? '/' + item.keyVersion : ''}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/update-key/update-key.

[Delete] action

Endpoint URL address: /keys/{{=item.keyName}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/delete-key/delete-key.

The resource includes the fields from the T_KeyValue template.

Fields

action

Field components:

Uses template: ActionT.
Contains the following components: import.

Key rotation policy

Based on resource template Base.

[Read Single] action

Endpoint URL address: /keys/{{=parameters['key-name']}}/rotationpolicy.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/get-key-rotation-policy/get-key-rotation-policy.

[Update] action

Endpoint URL address: /keys/{{=item.keyName}}/rotationpolicy.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/update-key-rotation-policy/update-key-rotation-policy.

The resource includes the fields from the T_RotationPolicy template.

Key miscellaneous

Based on resource template Base.

[Read Backup] action

Endpoint URL address: /keys/{{=parameters['key-name']}}/backup.
The result is extracted from: {{=[response]}}.
The action uses POST method.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/recover-deleted-key/recover-deleted-key.

[Read Decrypt] action

Endpoint URL address: /keys/{{=parameters['key-name']}}/{{=parameters['key-version']}}/decrypt.
The result is extracted from: {{=[response]}}.
The action uses POST method.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.
key-version: Required. The version of the key.
alg: Required. Algorithm identifier.
value: Required. The value for decryption (base64).
aad: Additional data to authenticate but not encrypt/decrypt when using authenticated crypto algorithms (base64). Optional.
iv: Cryptographically random, non-repeating initialization vector for symmetric algorithms (base64). Optional.
tag: The tag to authenticate when performing decryption with an authenticated algorithm (base64). Optional.

The following request parameters will be automatically processed:

application/json: {{=parameters}}

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/decrypt/decrypt.

[Read Encrypt] action

Endpoint URL address: /keys/{{=parameters['key-name']}}/{{=parameters['key-version']}}/encrypt.
The result is extracted from: {{=[response]}}.
The action uses POST method.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.
key-version: Required. The version of the key.
alg: Required. Algorithm identifier.
value: Required. The value for decryption (base64).
aad: Additional data to authenticate but not encrypt/decrypt when using authenticated crypto algorithms (base64). Optional.
iv: Cryptographically random, non-repeating initialization vector for symmetric algorithms (base64). Optional.
tag: The tag to authenticate when performing decryption with an authenticated algorithm (base64). Optional.

The following request parameters will be automatically processed:

application/json: {{=parameters}}

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/encrypt/encrypt.

[Read Sign] action

Endpoint URL address: /keys/{{=parameters['key-name']}}/{{=parameters['key-version']}}/sign.
The result is extracted from: {{=[response]}}.
The action uses POST method.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.
key-version: Required. The version of the key.
alg: Required. The signing/verification algorithm identifier.
value: Required. The value for decryption (base64).

The following request parameters will be automatically processed:

application/json: {{=parameters}}

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/sign/sign.

[Read Unwrap] action

Endpoint URL address: /keys/{{=parameters['key-name']}}/{{=parameters['key-version']}}/unwrap.
The result is extracted from: {{=[response]}}.
The action uses POST method.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.
key-version: Required. The version of the key.
alg: Required. Algorithm identifier.
value: Required. The value for decryption (base64).
aad: Additional data to authenticate but not encrypt/decrypt when using authenticated crypto algorithms (base64). Optional.
iv: Cryptographically random, non-repeating initialization vector for symmetric algorithms (base64). Optional.
tag: The tag to authenticate when performing decryption with an authenticated algorithm (base64). Optional.

The following request parameters will be automatically processed:

application/json: {{=parameters}}

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/unwrap-key/unwrap-key.

[Read Verify] action

Endpoint URL address: /keys/{{=parameters['key-name']}}/{{=parameters['key-version']}}/verify.
The result is extracted from: {{=[response]}}.
The action uses POST method.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.
key-version: Required. The version of the key.
alg: Required. Algorithm identifier.
value: Required. The value for decryption (base64).
digest: Required. The digest used for signing.

The following request parameters will be automatically processed:

application/json: {{=parameters}}

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/verify/verify.

[Read Wrap] action

Endpoint URL address: /keys/{{=parameters['key-name']}}/{{=parameters['key-version']}}/wrapkey.
The result is extracted from: {{=[response]}}.
The action uses POST method.

The action has the following user-defined parameters:

key-name: Required. The name of the key to get.
key-version: Required. The version of the key.
alg: Required. Algorithm identifier.
value: Required. The value for decryption (base64).
aad: Additional data to authenticate but not encrypt/decrypt when using authenticated crypto algorithms (base64). Optional.
iv: Cryptographically random, non-repeating initialization vector for symmetric algorithms (base64). Optional.
tag: The tag to authenticate when performing decryption with an authenticated algorithm (base64). Optional.

The following request parameters will be automatically processed:

application/json: {{=parameters}}

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/wrap-key/wrap-key.

[Create] action

Endpoint URL address: /.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/update-key-rotation-policy/update-key-rotation-policy.

The resource includes the fields from the T_KeyValue template.

Fields

value

Template: LongText. A read-only field.

kid

Template: LongText. A read-only field.

action

Field components:

Uses template: ActionT.
Contains the following components: purgeDeleted, recoverDeleted, restore, rotate, release.

Secret

Based on resource template BasePaginated.

[Read] action

Endpoint URL address: /secrets.
The result is extracted from: {{=response.value}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/get-secrets/get-secrets.

[Read Deleted] action

Endpoint URL address: /deletedsecrets/{{=parameters['secret-name']}}.
The result is extracted from: {{=response.value}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/get-deleted-secret/get-deleted-secret.

[Read Single] action

Endpoint URL address: /secrets/{{=parameters['secret-name'] + '/' + parameters.get('secret-version','')}}.

The action has the following user-defined parameters:

secret-name: Required. The name of the secret.
secret-version: The version of the secret. Optional.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/get-secret/get-secret.

[Read Deleted single] action

Endpoint URL address: /deletedsecrets/{{=parameters['secret-name']}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

secret-name: Required. The name of the secret.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/get-deleted-secret/get-deleted-secret.

[Create] action

Endpoint URL address: /secrets/{{=item.secretName}}.
The action uses PUT method.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/set-secret/set-secret.

[Update] action

Endpoint URL address: /secrets/{{=item.secretName}}/{{=item.secretVersion}}.
The action uses PATCH method.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/update-secret/update-secret.

[Delete] action

Endpoint URL address: /secrets/{{=item.secretName}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/delete-secret/delete-secret.

The resource includes the fields from the T_Secret template.

Secret miscellaneous

Based on resource template Base.

[Read Backup] action

Endpoint URL address: /secrets/{{=parameters['secret-name']}}/backup.
The result is extracted from: {{=[response]}}.
The action uses POST method.

The action has the following user-defined parameters:

secret-name: Required. The name of the secret.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/backup-secret/backup-secret.

[Create] action

Endpoint URL address: /.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault#secret-operations-key-vault-only.

The resource includes the fields from the T_KeyValue template.

Fields

value

Template: LongText. A read-only field.

action

Field components:

Uses template: ActionT.
Contains the following components: purgeDeleted, recoverDeleted, restore.

Storage account

Based on resource template BasePaginated.

[Read] action

Endpoint URL address: /storage.
The result is extracted from: {{=response.value}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/get-storage-accounts/get-storage-accounts.

[Read Deleted] action

Endpoint URL address: /deletedstorage.
The result is extracted from: {{=response.value}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/get-deleted-storage-accounts/get-deleted-storage-accounts.

[Read Single] action

Endpoint URL address: /storage/{{=parameters['storage-account-name']}}.

The action has the following user-defined parameters:

storage-account-name: Required. The name of the storage account.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/get-storage-account/get-storage-account.

[Read Deleted single] action

Endpoint URL address: /deletedstorage/{{=parameters['storage-account-name']}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

storage-account-name: Required. The name of the storage account.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/get-deleted-storage-account/get-deleted-storage-account.

[Create] action

Endpoint URL address: /storage/{{=item.storageAccountName}}.
The action uses PUT method.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/set-storage-account/set-storage-account.

[Update] action

Endpoint URL address: /storage/{{=item.storageAccountName}}.
The action uses PATCH method.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/update-storage-account/update-storage-account.

[Delete] action

Endpoint URL address: /storage/{{=item.storageAccountName}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/delete-storage-account/delete-storage-account.

The resource includes the fields from the T_StorageAccountOperation template.

Storage account miscellaneous

Based on resource template Base.

[Read Backup] action

Endpoint URL address: /storage/{{=parameters['storage-account-name']}}/backup.
The result is extracted from: {{=[response]}}.
The action uses POST method.

The action has the following user-defined parameters:

storage-account-name: Required. The name of the storage account.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/backup-storage-account/backup-storage-account.

[Create] action

Endpoint URL address: /.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault#storage-account-configuration-operations.

Fields

value

Template: LongText. A read-only field.

action

Field components:

Uses template: ActionT.
Contains the following components: purgeDeleted, recoverDeleted, restore, regenerate.

Storage account SAS

Based on resource template BasePaginated.

[Read] action

Endpoint URL address: /storage/{{=parameters['storage-account-name']}}/sas.
The result is extracted from: {{=response.value}}.

The action has the following user-defined parameters:

storage-account-name: Required. The name of the storage account.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/get-sas-definitions/get-sas-definitions.

[Read Deleted] action

Endpoint URL address: /deletedstorage/{{=parameters['storage-account-name']}}/sas}}.
The result is extracted from: {{=response.value}}.

The action has the following user-defined parameters:

storage-account-name: Required. The name of the storage account.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/get-deleted-sas-definitions/get-deleted-sas-definitions.

[Read Single] action

Endpoint URL address: /storage/{{=parameters['storage-account-name']}}/sas/{{=parameters['sas-definition-name']}}.

The action has the following user-defined parameters:

storage-account-name: Required. The name of the storage account.
sas-definition-name: Required. The name of the SAS definition.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/get-sas-definition/get-sas-definition.

[Read Deleted single] action

Endpoint URL address: /deletedstorage/{{=parameters['storage-account-name']}}/sas/{{=parameters['sas-definition-name']}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

storage-account-name: Required. The name of the storage account.
sas-definition-name: Required. The name of the SAS definition.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/get-deleted-sas-definition/get-deleted-sas-definition.

[Create] action

Endpoint URL address: /storage/{{=item.storageAccountName}}/sas/{{=item.sasName}}.
The action uses PUT method.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/set-sas-definition/set-sas-definition.

[Update] action

Endpoint URL address: /storage/{{=item.storageAccountName}}/sas/{{=item.sasName}}.
The action uses PATCH method.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/update-sas-definition/update-sas-definition.

[Delete] action

Endpoint URL address: /storage/{{=item.storageAccountName}}/sas/{{=item.sasName}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/delete-sas-definition/delete-sas-definition.

The resource includes the fields from the T_StorageAccountSAS template.

Fields

action

Field components:

Uses template: ActionT.
Contains the following components: recoverDeleted.

Certificate

Based on resource template BasePaginated.

[Read] action

Endpoint URL address: /certificates.
The result is extracted from: {{=response.value}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificates/get-certificates.

[Read Single] action

Endpoint URL address: /certificates/{{=parameters['certificate-name'] + '/' + parameters.get('certificate-version','')}}.

The action has the following user-defined parameters:

certificate-name: Required. The name of the certificate in the given vault.
certificate-version: The version of the certificate. Opional.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificate/get-certificate.

[Read Version] action

Endpoint URL address: /certificates/{{=parameters['certificate-name']}}/versions.
The result is extracted from: {{=response.value}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificate-versions/get-certificate-versions.

[Read Deleted] action

Endpoint URL address: /deletedcertificates.
The result is extracted from: {{=response.value}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-deleted-certificates/get-deleted-certificates.

[Read Deleted single] action

Endpoint URL address: /deletedcertificates/{{=parameters['certificate-name']}}/{{=parameters['certificate-version']}}}}.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

certificate-name: Required. The name of the certificate in the given vault.
certificate-version: The version of the certificate. Opional.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-deleted-certificate/get-deleted-certificate.

[Create] action

Endpoint URL address: /certificates/{{=item.certificateName}}/create.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/create-certificate/create-certificate.

[Update] action

Endpoint URL address: /certificates/{{=item.certificateName}}/{{=item.certificateVersion}}.
The action uses PATCH method.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/update-certificate/update-certificate.

[Delete] action

Endpoint URL address: /certificates/{{=item.certificateName}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/delete-certificate/delete-certificate.

The resource includes the fields from the T_Certificate template.

Fields

action

Field components:

Uses template: ActionT.
Contains the following components: import, merge.

Certificate operation

Based on resource template Base.

[Read Single] action

Endpoint URL address: /certificates/{{=parameters['certificate-name']}}/pending.

The action has the following user-defined parameters:

certificate-name: Required. The name of the certificate.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificate-operation/get-certificate-operation.

[Update] action

Endpoint URL address: /certificates/{{=item.certificateName}}/pending.
The action uses PATCH method.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/update-certificate-operation/update-certificate-operation.

[Delete] action

Endpoint URL address: /certificates/{{=item.certificateName}}/pending.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/delete-certificate-operation/delete-certificate-operation.

The resource includes the fields from the T_CertificateOperation template.

Certificate miscellaneous

Based on resource template Base.

[Read Backup] action

Endpoint URL address: /certificates/{{=parameters['certificate-name']}}/backup.
The result is extracted from: {{=[response]}}.
The action uses POST method.

The action has the following user-defined parameters:

certificate-name: Required. The name of the certificate.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/backup-certificate/backup-certificate.

[Create] action

Endpoint URL address: /.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/#certificate-operations-key-vault-only.

Fields

value

Template: LongText. A read-only field.

action

Field components:

Uses template: ActionT.
Contains the following components: purgeDeleted, recoverDeleted, restore.

Certificate policy

Based on resource template Base.

[Read Single] action

Endpoint URL address: /certificates/{{=parameters['certificate-name']}}/policy.

The action has the following user-defined parameters:

certificate-name: Required. The name of the certificate.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificate-policy/get-certificate-policy.

[Update] action

Endpoint URL address: /certificates/{{=item.certificateName}}/policy.
The action uses PATCH method.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/update-certificate-policy/update-certificate-policy.

The resource includes the fields from the T_CertificatePolicy template.

Fields

certificateName: Template: ShortText.

Certificate contact

Based on resource template Base.

[Read] action

Endpoint URL address: /certificates/contacts.
The result is extracted from: {{=response.contacts}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificate-contacts/get-certificate-contacts.

[Create] action

Endpoint URL address: /certificates/contacts.
The action uses PUT method.

The following request parameters will be automatically processed:

application/json: {{={ contacts: batch } }}

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/set-certificate-contacts/set-certificate-contacts.

[Delete] action

Endpoint URL address: /certificates/contacts.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/delete-certificate-contacts/delete-certificate-contacts.

Fields

email: Template: ShortText.
name: Template: ShortText.
phone: Template: ShortText.

Certificate issuer

Based on resource template BasePaginated.

[Read] action

Endpoint URL address: /certificates/issuers.
The result is extracted from: {{=response.value}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificate-issuers.

[Read Single] action

Endpoint URL address: /certificates/issuers/{{=parameters['issuer-name']}}.

The action has the following user-defined parameters:

issuer-name: Required. The name of the issuer.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificate-issuer/get-certificate-issuer.

[Create] action

Endpoint URL address: /certificates/issuers/{{=item.issuerName}}.
The action uses PUT method.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/set-certificate-contacts/set-certificate-contacts.

[Update] action

Endpoint URL address: /certificates/issuers/{{=item.issuerName}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/update-certificate-issuer/update-certificate-issuer.

[Delete] action

Endpoint URL address: /certificates/issuers/{{=item.issuerName}}.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/delete-certificate-issuer/delete-certificate-issuer.

The resource includes the fields from the T_CertificateIssuer template.

Fields

issuerName: A key field. Template: ShortText.

Referenced Resource Definitions

Base

[Read] action

The following request parameters will be automatically processed:

_includeUserParameters: {{=parameters}}

[Read Single] action

The result is extracted from: {{=[response]}}.

[Create] action

The action uses POST method.

The following request parameters will be automatically processed:

_includeUserParameters: {{=parameters}}
application/json: {{=item}}

[Update] action

The action uses PUT method.

The following request parameters will be automatically processed:

_includeUserParameters: {{=parameters}}
application/json: {{=item}}

[Delete] action: The action uses DELETE method.

BasePaginated

Based on resource template Base.

[Read] action

The result is paginated.

The following request parameters will be automatically processed:

maxresults: {{=parameters.batchSize}}
$skiptoken: {{=parameters.iterator}}

Referenced Fields Definitions

ShortText

Data type: DT_WSTR ( length 250 )

LongText

Data type: DT_WSTR ( length 1000 )

DateTime

Data type: DT_DBTIMESTAMP

Date

Data type: DT_DBDATE

Unixdate

Data type: DT_DBTIMESTAMP The gathered value is processed with {{=value && new Date(value * 1000).toISOString() }} expression.

Bool

Data type: DT_BOOL

Int

Data type: DT_I4

Byte

Data type: DT_IMAGE Before setting, the value is processed with {{=!_.isUndefined(value) && getClrType('System.Convert').ToBase64String(value.readAll())}} expression.

T_KeyValue

Field components:

Uses template: ShortText.
Contains the following components: kid, attributes, managed, tags, release_policy, key, kty, crv, key_ops, key_size, keyName, keyVersion, public_exponent, deletedDate, recoveryId, scheduledPurgeDate.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/get-key/get-key#keybundle.

T_AttributesBase

Field components:

Uses template: Bool.
Contains the following components: enabled, created, updated, recoverableDays, recoveryLevel.

T_ReleasePolicy

Field components:

Uses template: ShortText.
Contains the following components: contentType, data, immutable.

T_Attributes

Field components:

Uses template: Bool.
Contains the following components: exportable, nbf, enabled, created, updated, recoverableDays, recoveryLevel.

T_JsonWebKey

Field components:

Uses template: ShortText.
Contains the following components: crv, d, dp, dq, e, k, key_hsm, key_ops, kid, kty, n, p, q, qi, x, y, immutable.

T_RotationPolicy

Field components:

Uses template: ShortText.
Contains the following components: keyName, id, lifetimeActions, attributes.

T_LifetimeActions

Field components:

An array.
Contains the following components: trigger, action.

T_RotationPolicyAttributes

Field components:

Uses template: ShortText.
Contains the following components: expiryTime, created, updated.

T_SecretAttributes

Template: T_Attributes. Field components:

Uses template: Unixdate.
Contains the following components: exp.

T_Deleted

Field components:

Uses template: LongText.
Contains the following components: recoveryId, deletedDate, scheduledPurgeDate.

T_Secret

Template: T_Deleted. Field components:

Uses template: ShortText.
Contains the following components: secretName, secretVersion, id, kid, attributes, managed, tags, contentType, value.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/get-secret/get-secret#secretbundle.

T_StorageAccountOperation

Template: T_Deleted. Field components:

Uses template: ShortText.
Contains the following components: storageAccountName, activeKeyName, autoRegenerateKey, attributes, id, regenerationPeriod, resourceId, tags.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/get-storage-account/get-storage-account#storagebundle.

T_StorageAccountSAS

Template: T_Deleted. Field components:

Uses template: T_AttributesBase.
Contains the following components: attributes, id, sasType, sid, tags, validityPeriod, templateUri, storageAccountName, sasName.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets-storageaccounts/get-sas-definition/get-sas-definition#sasdefinitionbundle.

T_Certificate

Template: T_Deleted. Field components:

Uses template: ShortText.
Contains the following components: certificateName, certificateVersion, id, kid, sid, x5t, cer, attributes, policy.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificate/get-certificate.

T_CertificatePolicy

Field components:

Uses template: LongText.
Contains the following components: id, key_props, secret_props, x509_props, lifetime_actions, issuer, attributes.

T_Error

Field components:

Uses template: ShortText.
Contains the following components: code, innererror, message.

T_CertificateOperation

Field components:

Uses template: ShortText.
Contains the following components: certificateName, cancellation_requested, error, id, issuer, request_id, status, status_details, target.

Documentation: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificate-operation/get-certificate-operation#certificateoperation.

T_CertificateIssuer