--- title: Microsoft Azure Key Vault slug: connectors/microsoft-azure-key-vault docTags: createdAt: 2026-06-09T16:29:40.850Z --- The Microsoft Azure Key Vault connector facilitates secure management and retrieval of secrets, keys, and certificates within the Azure ecosystem. Microsoft Azure Key Vault is a cloud service for securely storing and accessing secrets, keys, and certificates. The Azure Key Vault Turbine Connector enables Swimlane Turbine users to manage vaults, secrets, and access policies directly within their security workflows. By integrating with Azure Key Vault, users can automate the process of checking vault name availability, managing vaults, and updating access policies, ensuring secure and efficient secret management in their security operations. ### Limitations None to date. ### Supported Versions This connector supports the latest version of the Microsoft Azure Key Vault REST API. ## Additional Docs - [Microsoft Azure Key Vault Authentication Link](https://learn.microsoft.com/en-us/rest/api/azure/?view=rest-keyvault-keyvault-2022-07-01#how-to-call-azure-rest-apis-with-curl) - [Microsoft Azure Key Vault REST API Docs](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/check-name-availability) - [Microsoft Azure Key Vault Other Informative Docs](https://learn.microsoft.com/en-us/rest/api/authorization/?view=rest-keyvault-keyvault-2022-07-01) ### Configuration ## Prerequisites Before you can use the Microsoft Azure Key Vault connector for Turbine, ensure you have the following prerequisites: - OAuth 2.0 client credentials authentication with the following parameters: - URL: The endpoint URL for Azure Key Vault services - Client ID: The application (client) ID registered in Azure AD - Client Secret: The secret key generated for the registered application in Azure AD - Scope: The scope of the access request, which determines the resources that the access token should be valid for ## Authentication Methods To effectively utilize the Microsoft Azure Key Vault connector within Swimlane Turbine, ensure you have the following prerequisites: - OAuth 2.0 Client Credentials for authentication with these parameters: - URL: Endpoint for Microsoft Azure Key Vault API access. - Client ID: Unique identifier for the application making the request. - Client Secret: A secret known only to the application and the authorization server. - Scopes: Permissions the application needs to function correctly. ## Capabilities This Connector provides the following capabilities: - Check Vault Name Availability - Delete Vault - Get Deleted Vault - Get Deleted Vaults List by Subscription ID - Get Vaults List - Get Vaults List By Subscription - Purge Deleted Vault - Update Access Policy - Update Vault - Vaults Create Or Update - Vaults Get - Vaults List by Resource Group ### Check Vault Name Availability Checks that the vault name is valid and is not already in use. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/check-name-availability). ### Delete Vault Deletes the specified Azure key vault. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/delete). ### Get Deleted Vault Gets the deleted Azure key vault. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/get-deleted). ### Get Deleted Vaults List by Subscription ID Gets information about the deleted vaults in a subscription. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/list-deleted). ### Get Vaults List The List operation gets information about the vaults associated with the subscription. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/list). ### Get Vaults List By Subscription The List operation gets information about the vaults associated with the subscription. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/list-by-subscription). ### Purge Deleted Vault Permanently deletes the specified vault. aka Purges the deleted Azure key vault. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/purge-deleted). ### Update Access Policy Update access policies in a key vault in the specified subscription. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/update-access-policy). ### Update Vault Update a key vault in the specified subscription. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/update). ### Vaults Create Or Update Create or update a key vault in the specified subscription. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/create-or-update). ### Vaults Get Gets the specified Azure key vault. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/get). ### Vaults List by Resource Group The List operation gets information about the vaults associated with the subscription and within the specified resource group. Microsoft Azure Key Vault's Documentation for this action can be found [here](https://learn.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/list-by-resource-group). # Configurations ## Microsoft Key Vault Oauth 2.0 Client Credentials Authenticates using oauth 2.0 client credentials ### Configuration Parameters | **Parameter** | **Description** | **Type** | **Required** | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------ | | url | A URL to the target host. | string | Required | | tenant\_id | The Tenant ID. | string | Optional | | token\_url | Must start with [https://login.microsoftonline.com/](https://login.microsoftonline.com/) and then continue with the tenant\_id, and then be prepended with /oauth2/v2.0/token | string | Optional | | client\_id | The client ID | string | Required | | client\_secret | The client secret. | string | Required | | scope | List of permission scopes for this action. | array | Required | | verify\_ssl | Verify SSL certificate | boolean | Optional | | http\_proxy | A proxy to route requests through. | string | Optional | # Actions ## Check Vault Name Availability Verifies the validity and availability of a vault name in Microsoft Azure Key Vault, requiring subscription ID, API version, and vault details. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/providers/Microsoft.KeyVault/checkNameAvailability` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `parameters.api-version` | string | Required | Client Api Version. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | | `name` | string | Optional | The vault name. | | `type` | string | Optional | The type of resource, Microsoft.KeyVault/vaults. | ### Input Example `{"parameters":{"api-version":"2022-07-01"},"json_body":{"name":"sample-vault","type":"Microsoft.KeyVault/vaults"},"path_parameters":{"subscriptionId":"00000000-0000-0000-0000-000000000000"}}` ### Output | **Parameter** | **Type** | **Description** | | --------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `nameAvailable` | boolean | Name of the resource | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{"nameAvailable":true}}` ## Delete Vault Removes a specified Azure Key Vault, requiring subscription ID, resource group name, vault name, and API version. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.KeyVault/vaults/{{vaultName}}` - **Method:** `DELETE` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `parameters.api-version` | string | Required | Client Api Version. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | | `path_parameters.resourceGroupName` | string | Required | The name of the Resource Group to which the server belongs. | | `path_parameters.vaultName` | string | Required | The name of the vault to delete. | ### Input Example `{"parameters":{"api-version":"2022-07-01"},"path_parameters":{"subscriptionId":"00000000-0000-0000-0000-000000000000","resourceGroupName":"sample-resource-group","vaultName":"sample-vault"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{}}` ## Get Deleted Vault Retrieves a deleted Microsoft Azure Key Vault using location, subscription ID, vault name, and API version. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/providers/Microsoft.KeyVault/locations/{{location}}/deletedVaults/{{vaultName}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `parameters.api-version` | string | Required | Client Api Version. | | `path_parameters.location` | string | Required | The location of the deleted vault. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | | `path_parameters.vaultName` | string | Required | The name of the vault. | ### Input Example `{"parameters":{"api-version":"2022-07-01"},"path_parameters":{"location":"westus","subscriptionId":"00000000-0000-0000-0000-000000000000","vaultName":"sample-vault"}}` ### Output | **Parameter** | **Type** | **Description** | | ----------------------------------- | -------- | ----------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `properties` | object | Output field: properties | | `properties.vaultId` | string | Unique identifier | | `properties.location` | string | Output field: properties.location | | `properties.tags` | object | Output field: properties.tags | | `properties.deletionDate` | string | Date value | | `properties.scheduledPurgeDate` | string | Date value | | `properties.purgeProtectionEnabled` | boolean | Output field: properties.purgeProtectionEnabled | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault...","name":"sample-vault","type":"Microsoft.KeyVault/deletedVaults","properties":{"vaultId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/...","location":...` ## Get Deleted Vaults List by Subscription ID Retrieve a list of deleted vaults within a specified Azure subscription, requiring the subscription ID and API version. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/providers/Microsoft.KeyVault/deletedVaults` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `parameters.api-version` | string | Required | Client Api Version. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | ### Input Example `{"parameters":{"api-version":"2022-07-01"},"path_parameters":{"subscriptionId":"00000000-0000-0000-0000-000000000000"}}` ### Output | **Parameter** | **Type** | **Description** | | ----------------------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `value` | array | Value for the parameter | | `value.id` | string | Unique identifier | | `value.name` | string | Name of the resource | | `value.type` | string | Type of the resource | | `value.properties` | object | Value for the parameter | | `value.properties.vaultId` | string | Unique identifier | | `value.properties.location` | string | Value for the parameter | | `value.properties.tags` | object | Value for the parameter | | `value.properties.deletionDate` | string | Value for the parameter | | `value.properties.scheduledPurgeDate` | string | Value for the parameter | | `value.properties.purgeProtectionEnabled` | boolean | Value for the parameter | | `nextLink` | string | Output field: nextLink | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{"value":[{}],"nextLink":"https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/..."}}` ## Get Vaults List Retrieves a list of vaults associated with the Azure subscription, allowing filtering and API version specification. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/resources` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `parameters.$filter` | string | Required | The filter to apply on the operation. | | `parameters.api-version` | string | Required | Azure Resource Manager Api Version. | | `parameters.$top` | number | Optional | Maximum number of results to return. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azuresubscription. The subscription ID forms part of the URI for every service call. | ### Input Example `{"parameters":{"$filter":"resourceType eq 'Microsoft.KeyVault/vaults'","api-version":"2022-07-01","$top":1},"path_parameters":{"subscriptionId":"00000000-0000-0000-0000-000000000000"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `value` | array | Value for the parameter | | `value.id` | string | Unique identifier | | `value.name` | string | Name of the resource | | `value.type` | string | Type of the resource | | `value.location` | string | Value for the parameter | | `value.tags` | object | Value for the parameter | | `nextLink` | string | Output field: nextLink | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{"value":[{}],"nextLink":"https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/..."}}` ## Get Vaults List By Subscription Retrieve information about all Azure Key Vault vaults within a specified subscription, requiring the subscription ID and API version. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/providers/Microsoft.KeyVault/vaults` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `parameters.api-version` | string | Required | Client Api Version. | | `parameters.$top` | number | Optional | Maximum number of results to return. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | ### Input Example `{"parameters":{"api-version":"2022-07-01","$top":1},"path_parameters":{"subscriptionId":"00000000-0000-0000-0000-000000000000"}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `value` | array | Value for the parameter | | `value.id` | string | Unique identifier | | `value.name` | string | Name of the resource | | `value.type` | string | Type of the resource | | `value.location` | string | Value for the parameter | | `value.tags` | object | Value for the parameter | | `value.systemData` | object | Response data | | `value.systemData.createdBy` | string | Response data | | `value.systemData.createdByType` | string | Response data | | `value.systemData.createdAt` | string | Response data | | `value.systemData.lastModifiedBy` | string | Response data | | `value.systemData.lastModifiedByType` | string | Response data | | `value.systemData.lastModifiedAt` | string | Response data | | `value.properties` | object | Value for the parameter | | `value.properties.sku` | object | Value for the parameter | | `value.properties.sku.family` | string | Value for the parameter | | `value.properties.sku.name` | string | Name of the resource | | `value.properties.tenantId` | string | Unique identifier | | `value.properties.accessPolicies` | array | Value for the parameter | | `value.properties.accessPolicies.tenantId` | string | Unique identifier | | `value.properties.accessPolicies.objectId` | string | Unique identifier | | `value.properties.accessPolicies.permissions` | object | Value for the parameter | | `value.properties.accessPolicies.permissions.keys` | array | Value for the parameter | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{"value":[{}],"nextLink":"https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/..."}}` ## Purge Deleted Vault Permanently removes a specified Azure Key Vault from the deleted vaults, requiring location, subscription ID, vault name, and API version. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/providers/Microsoft.KeyVault/locations/{{location}}/deletedVaults/{{vaultName}}/purge` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `parameters.api-version` | string | Required | Client Api Version. | | `path_parameters.location` | string | Required | The location of the deleted vault. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | | `path_parameters.vaultName` | string | Required | The name of the vault. | ### Input Example `{"parameters":{"api-version":"2022-07-01"},"path_parameters":{"location":"westus","subscriptionId":"00000000-0000-0000-0000-000000000000","vaultName":"sample-vault"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{}}` ## Update Access Policy Updates the access policies of a specified Azure Key Vault, requiring operation kind, resource group, subscription ID, vault name, API version, and policy properties. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.KeyVault/vaults/{{vaultName}}/accessPolicies/{{operationKind}}` - **Method:** `PUT` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `parameters.api-version` | string | Required | Client Api Version. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | | `path_parameters.resourceGroupName` | string | Required | The name of the Resource Group to which the vault belongs. | | `path_parameters.vaultName` | string | Required | Name of the vault. | | `path_parameters.operationKind` | string | Required | Name of the operation. | | `properties` | object | Optional | Properties of the access policy | | `properties.accessPolicies` | array | Optional | Access Policies. | | `properties.accessPolicies.tenantId` | string | Optional | The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. | | `properties.accessPolicies.objectId` | string | Optional | The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies. | | `properties.accessPolicies.permissions` | object | Optional | Permissions to certificates. | | `properties.accessPolicies.permissions.keys` | array | Optional | Keys. | | `properties.accessPolicies.permissions.secrets` | array | Optional | Secrets. | | `properties.accessPolicies.permissions.certificates` | array | Optional | Certificates. | ### Input Example `{"parameters":{"api-version":"2022-07-01"},"json_body":{"properties":{"accessPolicies":[{"tenantId":"00000000-0000-0000-0000-000000000000","objectId":"00000000-0000-0000-0000-000000000000","permissions":{"keys":["encrypt"],"secrets":["get"],"certificates":["get"]}}]}},"path_parameters":{"subscriptionId":"00000000-0000-0000-0000-000000000000","resourceGroupName":"sample-group","vaultName":"sample-vault","operationKind":"add"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------------------------- | -------- | ---------------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | string | Unique identifier | | `type` | string | Type of the resource | | `properties` | object | Output field: properties | | `properties.accessPolicies` | array | Output field: properties.accessPolicies | | `properties.accessPolicies.tenantId` | string | Unique identifier | | `properties.accessPolicies.objectId` | string | Unique identifier | | `properties.accessPolicies.permissions` | object | Output field: properties.accessPolicies.permissions | | `properties.accessPolicies.permissions.keys` | array | Output field: properties.accessPolicies.permissions.keys | | `properties.accessPolicies.permissions.secrets` | array | Output field: properties.accessPolicies.permissions.secrets | | `properties.accessPolicies.permissions.certificates` | array | Output field: properties.accessPolicies.permissions.certificates | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/...","type":"Microsoft.KeyVault/vaults/accessPolicies","properties":{"accessPolicies":[]}}}` ## Update Vault Updates a specified Microsoft Azure Key Vault's properties within the given subscription, resource group, and vault name. Requires subscriptionId, resourceGroupName, vaultName, and api-version. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.KeyVault/vaults/{{vaultName}}` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------------------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `parameters.api-version` | string | Required | Client Api Version. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | | `path_parameters.resourceGroupName` | string | Required | The name of the Resource Group to which the server belongs. | | `path_parameters.vaultName` | string | Required | Name of the vault. | | `properties` | object | Optional | Properties of the vault. | | `properties.tenantId` | string | Optional | The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. | | `properties.sku` | object | Optional | SKU details. | | `properties.sku.family` | string | Optional | SKU family name. | | `properties.sku.name` | string | Optional | SKU name to specify whether the key vault is a standard vault or a premium vault. | | `properties.accessPolicies` | array | Optional | Parameter for Update Vault | | `properties.accessPolicies.tenantId` | string | Optional | The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. | | `properties.accessPolicies.objectId` | string | Optional | The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies. | | `properties.accessPolicies.permissions` | object | Optional | Permissions the identity has for keys, secrets and certificates. | | `properties.accessPolicies.permissions.keys` | array | Optional | Permissions to keys. | | `properties.accessPolicies.permissions.secrets` | array | Optional | Permissions to secrets. | | `properties.accessPolicies.permissions.certificates` | array | Optional | Permissions to certificates. | | `properties.enabledForDeployment` | boolean | Optional | Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. | | `properties.enabledForDiskEncryption` | boolean | Optional | Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. | | `properties.enabledForTemplateDeployment` | boolean | Optional | Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. | | `properties.publicNetworkAccess` | string | Optional | Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. | | `tags` | object | Optional | The tags that will be assigned to the key vault. | ### Input Example `{"parameters":{"api-version":"2022-07-01"},"json_body":{"properties":{"tenantId":"00000000-0000-0000-0000-000000000000","sku":{"family":"A","name":"standard"},"accessPolicies":[{"tenantId":"00000000-0000-0000-0000-000000000000","objectId":"00000000-0000-0000-0000-000000000000","permissions":{"keys":["encrypt","decrypt","wrapKey","unwrapKey","sign","verify","get","list","create","update","import","delete","backup","restore","recover","purge"],"secrets":["get","list","set","delete","backup","restore","recover","purge"],"certificates":["get","list","delete","create","import","update","managecontacts","getissuers","listissuers","setissuers","deleteissuers","manageissuers","recover","purge"]}}],"enabledForDeployment":true,"enabledForDiskEncryption":true,"enabledForTemplateDeployment":true,"publicNetworkAccess":"Enabled"},"tags":{}},"path_parameters":{"subscriptionId":"00000000-0000-0000-0000-000000000000","resourceGroupName":"sample-resource-group","vaultName":"sample-vault"}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------------------- | -------- | -------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `location` | string | Output field: location | | `tags` | object | Output field: tags | | `systemData` | object | Response data | | `systemData.createdBy` | string | Response data | | `systemData.createdByType` | string | Response data | | `systemData.createdAt` | string | Response data | | `systemData.lastModifiedBy` | string | Response data | | `systemData.lastModifiedByType` | string | Response data | | `systemData.lastModifiedAt` | string | Response data | | `properties` | object | Output field: properties | | `properties.sku` | object | Output field: properties.sku | | `properties.sku.family` | string | Output field: properties.sku.family | | `properties.sku.name` | string | Name of the resource | | `properties.tenantId` | string | Unique identifier | | `properties.networkAcls` | object | Output field: properties.networkAcls | | `properties.networkAcls.bypass` | string | Output field: properties.networkAcls.bypass | | `properties.networkAcls.defaultAction` | string | Output field: properties.networkAcls.defaultAction | | `properties.networkAcls.ipRules` | array | Output field: properties.networkAcls.ipRules | | `properties.networkAcls.ipRules.value` | string | Value for the parameter | | `properties.networkAcls.virtualNetworkRules` | array | Output field: properties.networkAcls.virtualNetworkRules | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resour...","name":"sample-vault","type":"Microsoft.KeyVault/vaults","location":"westus","tags":{},"systemData":{"createdBy":"keyVaultUser1","createdByType":"User","createdAt":"2020-01-01T12:00:00....` ## Vaults Create Or Update Create or update a Microsoft Azure Key Vault within a specified subscription, requiring details like location and properties. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.KeyVault/vaults/{{vaultName}}` - **Method:** `PUT` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------------------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `parameters.api-version` | string | Required | Client Api Version. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | | `path_parameters.resourceGroupName` | string | Required | The name of the Resource Group to which the server belongs. | | `path_parameters.vaultName` | string | Required | Name of the vault. | | `location` | string | Optional | The supported Azure location where the key vault should be created. | | `tags` | object | Optional | The tags that will be assigned to the key vault. | | `properties` | object | Optional | Properties of the vault. | | `properties.tenantId` | string | Optional | The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. | | `properties.sku` | object | Optional | SKU details. | | `properties.sku.family` | string | Optional | SKU family name. | | `properties.sku.name` | string | Optional | SKU name to specify whether the key vault is a standard vault or a premium vault. | | `properties.accessPolicies` | array | Optional | Parameter for Vaults Create Or Update | | `properties.accessPolicies.tenantId` | string | Optional | The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. | | `properties.accessPolicies.objectId` | string | Optional | Object ID. | | `properties.accessPolicies.permissions` | object | Optional | Permissions. | | `properties.accessPolicies.permissions.keys` | array | Optional | Permissions to keys. | | `properties.accessPolicies.permissions.secrets` | array | Optional | Permissions to secrets. | | `properties.accessPolicies.permissions.certificates` | array | Optional | Permissions to certificates. | | `properties.enabledForDeployment` | boolean | Optional | Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. | | `properties.enabledForDiskEncryption` | boolean | Optional | Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. | | `properties.enabledForTemplateDeployment` | boolean | Optional | Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. | | `properties.publicNetworkAccess` | string | Optional | Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. | ### Input Example `{"parameters":{"api-version":"2022-07-01"},"json_body":{"location":"westus","tags":{},"properties":{"tenantId":"00000000-0000-0000-0000-000000000000","sku":{"family":"A","name":"standard"},"accessPolicies":[{"tenantId":"00000000-0000-0000-0000-000000000000","objectId":"00000000-0000-0000-0000-000000000000","permissions":{"keys":["encrypt","decrypt","wrapKey","unwrapKey","sign","verify","get","list","create","update","import","delete","backup","restore","recover","purge"],"secrets":["get","list","set","delete","backup","restore","recover","purge"],"certificates":["get","list","delete","create","import","update","managecontacts","getissuers","listissuers","setissuers","deleteissuers","manageissuers","recover","purge"]}}],"enabledForDeployment":true,"enabledForDiskEncryption":true,"enabledForTemplateDeployment":true,"publicNetworkAccess":"Enabled"}},"path_parameters":{"subscriptionId":"00000000-0000-0000-0000-000000000000","resourceGroupName":"sample-resource-group","vaultName":"sample-vault"}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------------------- | -------- | -------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `location` | string | Output field: location | | `tags` | object | Output field: tags | | `systemData` | object | Response data | | `systemData.createdBy` | string | Response data | | `systemData.createdByType` | string | Response data | | `systemData.createdAt` | string | Response data | | `systemData.lastModifiedBy` | string | Response data | | `systemData.lastModifiedByType` | string | Response data | | `systemData.lastModifiedAt` | string | Response data | | `properties` | object | Output field: properties | | `properties.sku` | object | Output field: properties.sku | | `properties.sku.family` | string | Output field: properties.sku.family | | `properties.sku.name` | string | Name of the resource | | `properties.tenantId` | string | Unique identifier | | `properties.networkAcls` | object | Output field: properties.networkAcls | | `properties.networkAcls.bypass` | string | Output field: properties.networkAcls.bypass | | `properties.networkAcls.defaultAction` | string | Output field: properties.networkAcls.defaultAction | | `properties.networkAcls.ipRules` | array | Output field: properties.networkAcls.ipRules | | `properties.networkAcls.ipRules.value` | string | Value for the parameter | | `properties.networkAcls.virtualNetworkRules` | array | Output field: properties.networkAcls.virtualNetworkRules | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resour...","name":"sample-vault","type":"Microsoft.KeyVault/vaults","location":"westus","tags":{},"systemData":{"createdBy":"keyVaultUser1","createdByType":"User","createdAt":"2020-01-01T12:00:00....` ## Vaults Get Retrieves the specified Azure Key Vault using subscription ID, resource group name, and vault name. An 'api-version' parameter is required. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.KeyVault/vaults/{{vaultName}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `parameters.api-version` | string | Required | Client Api Version. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | | `path_parameters.resourceGroupName` | string | Required | The name of the Resource Group to which the vault belongs. | | `path_parameters.vaultName` | string | Required | The name of the vault. | ### Input Example `{"parameters":{"api-version":"2022-07-01"},"path_parameters":{"subscriptionId":"00000000-0000-0000-0000-000000000000","resourceGroupName":"sample-resource-group","vaultName":"sample-vault"}}` ### Output | **Parameter** | **Type** | **Description** | | ----------------------------------------------- | -------- | ----------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `location` | string | Output field: location | | `tags` | object | Output field: tags | | `systemData` | object | Response data | | `systemData.createdBy` | string | Response data | | `systemData.createdByType` | string | Response data | | `systemData.createdAt` | string | Response data | | `systemData.lastModifiedBy` | string | Response data | | `systemData.lastModifiedByType` | string | Response data | | `systemData.lastModifiedAt` | string | Response data | | `properties` | object | Output field: properties | | `properties.sku` | object | Output field: properties.sku | | `properties.sku.family` | string | Output field: properties.sku.family | | `properties.sku.name` | string | Name of the resource | | `properties.tenantId` | string | Unique identifier | | `properties.accessPolicies` | array | Output field: properties.accessPolicies | | `properties.accessPolicies.tenantId` | string | Unique identifier | | `properties.accessPolicies.objectId` | string | Unique identifier | | `properties.accessPolicies.permissions` | object | Output field: properties.accessPolicies.permissions | | `properties.accessPolicies.permissions.keys` | array | Output field: properties.accessPolicies.permissions.keys | | `properties.accessPolicies.permissions.secrets` | array | Output field: properties.accessPolicies.permissions.secrets | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resour...","name":"sample-vault","type":"Microsoft.KeyVault/vaults","location":"westus","tags":{},"systemData":{"createdBy":"keyVaultUser1","createdByType":"User","createdAt":"2020-01-01T12:00:00....` ## Vaults List by Resource Group Retrieves information about Azure Key Vault vaults within a specified resource group and subscription. ### Endpoint - **URL:** `/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.KeyVault/vaults` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `parameters.api-version` | string | Required | The name of the Resource Group to which the vault belongs. | | `parameters.$top` | number | Optional | Maximum number of results to return. | | `path_parameters.subscriptionId` | string | Required | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | | `path_parameters.resourceGroupName` | string | Required | The name of the Resource Group to which the vault belongs. | ### Input Example `{"parameters":{"api-version":"2022-07-01","$top":1},"path_parameters":{"subscriptionId":"00000000-0000-0000-0000-000000000000","resourceGroupName":"sample-group"}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `value` | array | Value for the parameter | | `value.id` | string | Unique identifier | | `value.name` | string | Name of the resource | | `value.type` | string | Type of the resource | | `value.location` | string | Value for the parameter | | `value.tags` | object | Value for the parameter | | `value.systemData` | object | Response data | | `value.systemData.createdBy` | string | Response data | | `value.systemData.createdByType` | string | Response data | | `value.systemData.createdAt` | string | Response data | | `value.systemData.lastModifiedBy` | string | Response data | | `value.systemData.lastModifiedByType` | string | Response data | | `value.systemData.lastModifiedAt` | string | Response data | | `value.properties` | object | Value for the parameter | | `value.properties.sku` | object | Value for the parameter | | `value.properties.sku.family` | string | Value for the parameter | | `value.properties.sku.name` | string | Name of the resource | | `value.properties.tenantId` | string | Unique identifier | | `value.properties.accessPolicies` | array | Value for the parameter | | `value.properties.accessPolicies.tenantId` | string | Unique identifier | | `value.properties.accessPolicies.objectId` | string | Unique identifier | | `value.properties.accessPolicies.permissions` | object | Value for the parameter | | `value.properties.accessPolicies.permissions.keys` | array | Value for the parameter | ### Output Example `{"status_code":200,"response_headers":{"Content-Type":"text/html; charset=utf-8","x-hsci-cache-time":"2024-12-18T12:01:22.328Z","Content-Encoding":"gzip","Expires":"Mon, 18 Dec 2024 12:08:57 GMT"},"reason":"OK","json_body":{"value":[{}],"nextLink":"https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/..."}}` # Response Headers | **Header** | **Description** | **Example** | | ----------------- | ---------------------------------------------------------- | ----------------------------- | | Content-Encoding | HTTP response header: Content-Encoding | gzip | | Content-Type | The media type of the resource | text/html; charset=utf-8 | | Expires | The date/time after which the response is considered stale | Mon, 18 Dec 2024 12:08:57 GMT | | x-hsci-cache-time | HTTP response header: x-hsci-cache-time | 2024-12-18T12:01:22.328Z |