lib/fog/azurerm/docs/key_vault.md in fog-azure-rm-temp-0.0.4 vs lib/fog/azurerm/docs/key_vault.md in fog-azure-rm-temp-0.0.5

- old
+ new

@@ -1,8 +1,8 @@ # Key Vault -This document explains how to get started using Azure Key Vault Service with Fog to manage Vault. With this gem you can create/list/delete Vault. +This document explains how to get started using Azure Key Vault Service with Fog to manage Vault. With this gem you can create, list or delete Vault. ## Usage First of all, you need to require the Fog library by executing: @@ -12,77 +12,80 @@ ## Create Connection Next, create a connection to the Key Vault Service: ```ruby - azure_key_vault_service = Fog::KeyVault::AzureRM.new( - tenant_id: '<Tenantid>', # Tenant id of Azure Active Directory Application - client_id: '<Clientid>', # Client id of Azure Active Directory Application - client_secret: '<ClientSecret>', # Client Secret of Azure Active Directory Application - subscription_id: '<Subscriptionid>' # Subscription id of an Azure Account +fog_key_vault_service = Fog::KeyVault::AzureRM.new( + tenant_id: '<Tenant Id>', # Tenant Id of Azure Active Directory Application + client_id: '<Client Id>', # Client Id of Azure Active Directory Application + client_secret: '<Client Secret>', # Client Secret of Azure Active Directory Application + subscription_id: '<Subscription Id>' # Subscription Id of an Azure Account ) ``` ## Check Vault Existence ```ruby - azure_key_vault_service.vaults.check_vault_exists(<Resource Group name>, <Vault Name>) + fog_key_vault_service.vaults.check_vault_exists('<Resource Group Name>', '<Vault Name>') ``` ## Create Vault Create a new Vault. ```ruby - vault = azure_key_vault_service.vaults.create( +vault = fog_key_vault_service.vaults.create( name: '<Vault Name>', - location: 'eastus', - resource_group: '<Resource Group name>', - tenant_id: <Tenantid>, - sku_family: 'A', - sku_name: 'standard', + location: '<Location>', + resource_group: '<Resource Group Name>', + tenant_id: '<Tenant Id>', + sku_family: '<SKU Family>', + sku_name: '<SKU Name>', access_policies: [ { - tenant_id: <Tenantid>, - object_id: <Tenantid>, + tenant_id: '<Tenant Id>', + object_id: '<Tenant Id>', permissions: { - keys: ['all'], - secrets: ['all'] + keys: ['<Key Permissions>'], + secrets: ['<Secret Permissions>'] } } - ] + ], + tags: { + key: 'value' # [Optional] + } - ) +) ``` ## List Vaults List all vaults in a resource group ```ruby - vaults = azure_key_vault_service.vaults(resource_group: '<Resource Group Name>') - vaults.each do |vault| - puts "#{vault.name}" - end +vaults = fog_key_vault_service.vaults(resource_group: '<Resource Group Name>') +vaults.each do |vault| + puts "#{vault.name}" +end ``` ## Retrieve a single Vault Get a single record of Vault ```ruby - vault = azure_key_vault_service - .vaults - .get('<Resource Group name>', '<Vault Name>') - puts "#{vault.name}" +vault = fog_key_vault_service + .vaults + .get('<Resource Group Name>', '<Vault Name>') +puts "#{vault.name}" ``` ## Destroy a single Vault Get a vault object from the get method and then destroy that vault. ```ruby - vault.destroy +vault.destroy ``` ## Support and Feedback Your feedback is highly appreciated! If you have specific issues with the fog ARM, you should file an issue via Github.