Introduction

Enzo Server
  Installation
  Quick Start

  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views

  Advanced Capabilities
    Change Data Capture

  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  Adapters
    Azure Bus
    Azure IoT Hub
    Azure Key Vault
    Azure Storage
    Couchbase
    CSV
    DB (RDBMS)
    Files
    Flight Aware
    FTP
    Geonames
    Insteon
    Loggly
    Messaging (SMS/SMTP)
    MongoDB
    Motus
    MSAD
    MSMQ
    Pipeline
    Pressero
    RabbitMQ
    SalesForce
    Shard
    SharePoint
    SQL Server
    Threading
    Twilio
    Twitter
    VellemanDMX
    Weather (Underground)
    Whiparound
    WMI
    Xls (Excel)
    ZIP


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Handler Columns

    Advanced SDK Concepts
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables

/adapters/azurekeyvault




Azure Key Vault


The Azure Key Vault adapter allows you to save and retrieve secrets from the Key Vault programmatically.


Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String ClientId The Enzo Unified Azure Active Directory Client ID
String ClientSecret The Enzo Unified Azure AD Client Secret
String KeyVaultName The name of the default Key Vault

Handlers



DeleteSecret Deletes a secret in the specified Azure Key Vault details 

Arguments

Name Description Default
name R The name of the secret
keyvault The optional name of the key vault (uses the default key vault if not provided)

SQL Call

exec AzureKeyVault.DeleteSecret 'mysecret', 'keyvault'


Http Call

/bsc/azurekeyvault/deletesecret

Output Columns

This call does not return data.

GetSecret Gets a secret from the specified Azure Key Vault details 

Arguments

Name Description Default
name R The name or identifier of the secret to retrieve
keyvault The optional name of the key vault (uses the default key vault if not provided)

SQL Call

exec AzureKeyVault.GetSecret 'secretname', 'keyvault'


Http Call

/bsc/azurekeyvault/getsecret

Output Columns

String nameThe name of the secret
String valueThe value stored in the key vault
String tagsThe list of tags for this secret
String contentTypeThe content type for this secret
String identifierThe secret version identifier
String createdCreate date
String updatedUpdate date
String notBeforeSecret not available before this date
String enabledEnable flag
GetSecrets Gets the list of secrets from the specified Azure Key Vault details 

Arguments

Name Description Default
keyvault The optional name of the key vault (uses the default key vault if not provided)

SQL Call

exec AzureKeyVault.GetSecrets 'keyvault'


Http Call

/bsc/azurekeyvault/getsecrets

Output Columns

String nameThe name of the secret
String tagsThe list of tags for this secret
String contentTypeThe content type for this secret
String identifierThe secret version identifier
String createdCreate date
String updatedUpdate date
String notBeforeSecret not available before this date
String enabledEnable flag
SetSecret Creates or updates a secret in the specified Azure Key Vault details 

Arguments

Name Description Default
name R The name of the secret
value R The value of the secret
contentType The content type of the secret
tags A semi-column separate list of key=value pairs (ex: country=usa;state=fl )
keyvault The optional name of the key vault (uses the default key vault if not provided)

SQL Call

exec AzureKeyVault.AddSecret 'mysecret', 'mysecretvalue', 'passwordfield', 'appid=1;country=usa', 'keyvault'


Http Call

/bsc/azurekeyvault/setsecret

Output Columns

This call does not return data.

SetSecretAttributes Updates secret attributes in the specified Azure Key Vault details 

Arguments

Name Description Default
name R The name of the secret
contentType The content type of the secret
tags A semi-column separate list of key=value pairs (ex: country=usa;state=fl )
keyvault The optional name of the key vault (uses the default key vault if not provided)

SQL Call

exec AzureKeyVault.SetSecretAttributes 'mysecret', 'passwordfield', 'appid=1;country=usa', 'keyvault'


Http Call

/bsc/azurekeyvault/setsecretattributes

Output Columns

This call does not return data.