Skip to content

Commit c158fe7

Browse files
Release prep v3.1.0 (#100)
Co-authored-by: GitHub Action <[email protected]>
1 parent 3745e0b commit c158fe7

File tree

3 files changed

+45
-7
lines changed

3 files changed

+45
-7
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
44

5+
## [v3.1.0](https://github.com/tragiccode/tragiccode-azure_key_vault/tree/v3.1.0) (2022-09-23)
6+
7+
[Full Changelog](https://github.com/tragiccode/tragiccode-azure_key_vault/compare/v3.0.0...v3.1.0)
8+
9+
### Added
10+
11+
- \(GH-94\) Support for service principal authentication [\#93](https://github.com/TraGicCode/tragiccode-azure_key_vault/pull/93) ([kev-in-shu](https://github.com/kev-in-shu))
12+
513
## [v3.0.0](https://github.com/tragiccode/tragiccode-azure_key_vault/tree/v3.0.0) (2022-08-14)
614

715
[Full Changelog](https://github.com/tragiccode/tragiccode-azure_key_vault/compare/v2.1.0...v3.0.0)

REFERENCE.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@ Type: Ruby 4.x API
1717

1818
The azure_key_vault::lookup function.
1919

20-
#### `azure_key_vault::lookup(Variant[String, Numeric] $secret_name, Struct[{vault_name => String, vault_api_version => String, metadata_api_version => String, confine_to_keys => Array[String], Optional[key_replacement_token] => String}] $options, Puppet::LookupContext $context)`
20+
#### `azure_key_vault::lookup(Variant[String, Numeric] $secret_name, Struct[{
21+
vault_name => String,
22+
vault_api_version => String,
23+
Optional[metadata_api_version] => String,
24+
confine_to_keys => Array[String],
25+
Optional[key_replacement_token] => String,
26+
Optional[service_principal_credentials] => String
27+
}] $options, Puppet::LookupContext $context)`
2128

2229
The azure_key_vault::lookup function.
2330

@@ -31,7 +38,14 @@ Data type: `Variant[String, Numeric]`
3138

3239
##### `options`
3340

34-
Data type: `Struct[{vault_name => String, vault_api_version => String, metadata_api_version => String, confine_to_keys => Array[String], Optional[key_replacement_token] => String}]`
41+
Data type: `Struct[{
42+
vault_name => String,
43+
vault_api_version => String,
44+
Optional[metadata_api_version] => String,
45+
confine_to_keys => Array[String],
46+
Optional[key_replacement_token] => String,
47+
Optional[service_principal_credentials] => String
48+
}]`
3549

3650

3751

@@ -47,7 +61,15 @@ Type: Ruby 4.x API
4761

4862
Retrieves secrets from Azure's Key Vault.
4963

50-
#### `azure_key_vault::secret(String $vault_name, String $secret_name, Hash $api_versions_hash, Optional[String] $secret_version)`
64+
#### `azure_key_vault::secret(String $vault_name, String $secret_name, Struct[{
65+
vault_api_version => String,
66+
Optional[metadata_api_version] => String,
67+
Optional[service_principal_credentials] => Struct[{
68+
tenant_id => String,
69+
client_id => String,
70+
client_secret => String
71+
}]
72+
}] $api_endpoint_hash, Optional[String] $secret_version)`
5173

5274
Retrieves secrets from Azure's Key Vault.
5375

@@ -65,11 +87,19 @@ Data type: `String`
6587

6688
Name of the secret to be retrieved.
6789

68-
##### `api_versions_hash`
90+
##### `api_endpoint_hash`
6991

70-
Data type: `Hash`
92+
Data type: `Struct[{
93+
vault_api_version => String,
94+
Optional[metadata_api_version] => String,
95+
Optional[service_principal_credentials] => Struct[{
96+
tenant_id => String,
97+
client_id => String,
98+
client_secret => String
99+
}]
100+
}]`
71101

72-
A Hash of the exact versions of the metadata_api_version and vault_api_version to use.
102+
A Hash with API endpoint and authentication information
73103

74104
##### `secret_version`
75105

metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "tragiccode-azure_key_vault",
3-
"version": "3.0.0",
3+
"version": "3.1.0",
44
"author": "tragiccode",
55
"summary": "The azure_key_vault module allows you to easily fetch secrets securely within your puppet manifests.",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)