├── .github └── FUNDING.yml ├── .gitignore ├── LICENSE ├── README.md ├── examples ├── README.md ├── keyvault_private_end_point_with_existing_VNet_Subnet │ ├── README.md │ ├── main.tf │ ├── output.tf │ └── variables.tf ├── keyvault_with_private_end_point │ ├── README.md │ ├── main.tf │ ├── output.tf │ └── variables.tf └── simple_keyvault │ ├── README.md │ ├── main.tf │ ├── output.tf │ └── variables.tf ├── graph.png ├── main.tf ├── output.tf ├── variables.tf └── versions.tf /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # repo:     https://github.com/kumarvna/terraform-azurerm-key-vault/ 2 | # filename: FUNDING.YML 3 | 4 | github: https://github.com/kumarvna 5 | 6 | # These are supported funding model platforms 7 | 8 | # github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 9 | # patreon: # Replace with a single Patreon username 10 | # open_collective: # Replace with a single Open Collective username 11 | # ko_fi: # Replace with a single Ko-fi username 12 | # tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 13 | # community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 14 | # liberapay: # Replace with a single Liberapay username 15 | # issuehunt: # Replace with a single IssueHunt username 16 | # otechie: # Replace with a single Otechie username 17 | # lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 18 | # custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 19 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Local .terraform directories 2 | **/.terraform/* 3 | 4 | # .tfstate files 5 | *.tfstate 6 | *.tfstate.* 7 | *.terraform.lock.hcl 8 | 9 | # Crash log files 10 | crash.log 11 | 12 | # Ignore any .tfvars files that are generated automatically for each Terraform run. Most 13 | # .tfvars files are managed as part of configuration and so should be included in 14 | # version control. 15 | # 16 | # example.tfvars 17 | 18 | # Ignore override files as they are usually used to override resources locally and so 19 | # are not checked in 20 | override.tf 21 | override.tf.json 22 | *_override.tf 23 | *_override.tf.json 24 | 25 | # Include override files you do wish to add to version control using negated pattern 26 | # 27 | # !example_override.tf 28 | 29 | # Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan 30 | # example: *tfplan* 31 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Azure Key Vault Terraform Module 2 | 3 | Azure Key Vault is a tool for securely storing and accessing secrets. A secret is anything that you want to tightly control access to, such as API keys, passwords, or certificates. A vault is a logical group of secrets. 4 | 5 | This Terraform Module creates a Key Vault also adds required access policies for azure AD users, groups and azure AD service principals. This also enables private endpoint and sends all logs to log analytic workspace or storage. 6 | 7 | ## Resources Supported 8 | 9 | * [Acess Polices for AD users, groups and SPN](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_access_policy) 10 | * [Secrets](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_secret) 11 | * [Certifiate Contacts](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault#contact) 12 | * [Private Endpoints](https://www.terraform.io/docs/providers/azurerm/r/private_endpoint.html) 13 | * [Private DNS zone for `privatelink` A records](https://www.terraform.io/docs/providers/azurerm/r/private_dns_zone.html) 14 | * [Azure Log Dignostics](https://www.terraform.io/docs/providers/azurerm/r/network_security_group.html) 15 | 16 | ## Module Usage 17 | 18 | ```terraform 19 | # Azurerm Provider configuration 20 | provider "azurerm" { 21 | features {} 22 | } 23 | 24 | module "key-vault" { 25 | source = "kumarvna/key-vault/azurerm" 26 | version = "2.2.0" 27 | 28 | # By default, this module will not create a resource group and expect to provide 29 | # a existing RG name to use an existing resource group. Location will be same as existing RG. 30 | # set the argument to `create_resource_group = true` to create new resrouce. 31 | resource_group_name = "rg-shared-westeurope-01" 32 | key_vault_name = "demo-project-shard" 33 | key_vault_sku_pricing_tier = "premium" 34 | 35 | # Once `Purge Protection` has been Enabled it's not possible to Disable it 36 | # Deleting the Key Vault with `Purge Protection` enabled will schedule the Key Vault to be deleted 37 | # The default retention period is 90 days, possible values are from 7 to 90 days 38 | # use `soft_delete_retention_days` to set the retention period 39 | enable_purge_protection = false 40 | # soft_delete_retention_days = 90 41 | 42 | # Access policies for users, you can provide list of Azure AD users and set permissions. 43 | # Make sure to use list of user principal names of Azure AD users. 44 | access_policies = [ 45 | { 46 | azure_ad_user_principal_names = ["user1@example.com", "user2@example.com"] 47 | key_permissions = ["get", "list"] 48 | secret_permissions = ["get", "list"] 49 | certificate_permissions = ["get", "import", "list"] 50 | storage_permissions = ["backup", "get", "list", "recover"] 51 | }, 52 | 53 | # Access policies for AD Groups 54 | # to enable this feature, provide a list of Azure AD groups and set permissions as required. 55 | { 56 | azure_ad_group_names = ["ADGroupName1", "ADGroupName2"] 57 | key_permissions = ["get", "list"] 58 | secret_permissions = ["get", "list"] 59 | certificate_permissions = ["get", "import", "list"] 60 | storage_permissions = ["backup", "get", "list", "recover"] 61 | }, 62 | 63 | # Access policies for Azure AD Service Principlas 64 | # To enable this feature, provide a list of Azure AD SPN and set permissions as required. 65 | { 66 | azure_ad_service_principal_names = ["azure-ad-dev-sp1", "azure-ad-dev-sp2"] 67 | key_permissions = ["get", "list"] 68 | secret_permissions = ["get", "list"] 69 | certificate_permissions = ["get", "import", "list"] 70 | storage_permissions = ["backup", "get", "list", "recover"] 71 | } 72 | ] 73 | 74 | # Create a required Secrets as per your need. 75 | # When you Add `usernames` with empty password this module creates a strong random password 76 | # use .tfvars file to manage the secrets as variables to avoid security issues. 77 | secrets = { 78 | "message" = "Hello, world!" 79 | "vmpass" = "" 80 | } 81 | 82 | # (Optional) To enable Azure Monitoring for Azure Application Gateway 83 | # (Optional) Specify `storage_account_id` to save monitoring logs to storage. 84 | log_analytics_workspace_id = var.log_analytics_workspace_id 85 | #storage_account_id = var.storage_account_id 86 | 87 | # Adding additional TAG's to your Azure resources 88 | tags = { 89 | ProjectName = "demo-project" 90 | Env = "dev" 91 | Owner = "user@example.com" 92 | BusinessUnit = "CORP" 93 | ServiceClass = "Gold" 94 | } 95 | } 96 | ``` 97 | 98 | ## Key Vault Advanced features 99 | 100 | ### `enabled_for_deployment` 101 | 102 | To use Key Vault with Azure Resource Manager virtual machines, the `enabled_for_deployment` property on Key Vault must be set to `true`. This access is enabled by default for this module. Incase you want to disable it set the argument `enabled_for_deployment = "false"`. 103 | 104 | ### `enabled_for_disk_encryption` 105 | 106 | We can configure Azure Disk Encryption to use Azure Key Vault to control and manage disk encryption keys and secrets. This access is enabled by default for this module. Incase you want to disable it set the argument `enabled_for_disk_encryption = "false"`. 107 | 108 | > Warning: The key vault and VMs must be in the same subscription. Also, to ensure that encryption secrets don't cross regional boundaries, Azure Disk Encryption requires the Key Vault and the VMs to be co-located in the same region. Create and use a Key Vault that is in the same subscription and region as the VMs to be encrypted. 109 | 110 | ### `enabled_for_template_deployment` 111 | 112 | When you need to pass a secure value (like a password) as a parameter during deployment, you can retrieve the value from an Azure Key Vault. To access the Key Vault when deploying Managed Applications, you must grant access to the Appliance Resource Provider service principal. This access is enabled by default for this module. Incase you want to disable it set the argument `enabled_for_template_deployment = "false"`. 113 | 114 | ### Soft-Delete and Purge Protection 115 | 116 | Soft-delete is enabled by default. When enabled, resources marked as deleted resources are retained for a specified period (90 days by default). The service further provides a mechanism for recovering the deleted object, essentially undoing the deletion. 117 | 118 | Purge protection is an optional Key Vault behavior and is not enabled by default. Purge protection can only be enabled once soft-delete is enabled. It can be turned on using this module by setting the argument `enable_purge_protection = true`. 119 | 120 | When purge protection is on, a vault or an object in the deleted state cannot be purged until the retention period has passed. Soft-deleted vaults and objects can still be recovered, ensuring that the retention policy will be followed. Soft delete retention can be updated using `soft_delete_retention_days` argument with a valid days. 121 | 122 | > The default retention period is 90 days for the soft-delete and the purge protection retention policy uses the same interval. Once set, the retention policy interval cannot be changed. 123 | 124 | ## Configure Azure Key Vault firewalls and virtual networks 125 | 126 | Configure Azure Key Vault firewalls and virtual networks to restrict access to the key vault. The virtual network service endpoints for Key Vault (Microsoft.KeyVault) allow you to restrict access to a specified virtual network and set of IPv4 address ranges. 127 | 128 | Default action is set to `Allow` when no network rules matched. A `virtual_network_subnet_ids` or `ip_rules` can be added to `network_acls` block to allow request that is not Azure Services. 129 | 130 | ```hcl 131 | module "key-vault" { 132 | source = "kumarvna/key-vault/azurerm" 133 | version = "2.2.0" 134 | 135 | # .... omitted 136 | 137 | network_acls = { 138 | bypass = "AzureServices" 139 | default_action = "Deny" 140 | 141 | # One or more IP Addresses, or CIDR Blocks to access this Key Vault. 142 | ip_rules = ["123.201.18.148"] 143 | 144 | # One or more Subnet ID's to access this Key Vault. 145 | virtual_network_subnet_ids = [] 146 | } 147 | 148 | # ....omitted 149 | 150 | } 151 | ``` 152 | 153 | ## Certificate contacts 154 | 155 | Certificate contacts contain contact information to send notifications triggered by certificate lifetime events. The contacts information is shared by all the certificates in the key vault. A notification is sent to all the specified contacts for an event for any certificate in the key vault. 156 | 157 | ```terraform 158 | module "key-vault" { 159 | source = "kumarvna/key-vault/azurerm" 160 | version = "2.2.0" 161 | 162 | # .... omitted 163 | 164 | # The contacts information is shared by all the certificates in the key vault. 165 | # A notification is sent to all the specified contacts for any certificate event in the key vault. 166 | # This field can only be set once user has `managecontacts` certificate permission. 167 | certificate_contacts = [ 168 | { 169 | email = "user1@example.com" 170 | name = "User1" 171 | phone = "1010101010" 172 | }, 173 | { 174 | email = "user2@example.com" 175 | name = "User2" 176 | phone = "2020202020" 177 | }, 178 | ] 179 | 180 | # ....omitted 181 | 182 | } 183 | ``` 184 | 185 | ## Private Endpoint - Integrate Key Vault with Azure Private Link 186 | 187 | Azure Private Endpoint is a network interface that connects you privately and securely to a service powered by Azure Private Link. Private Endpoint uses a private IP address from your VNet, effectively bringing the service into your VNet. 188 | 189 | With Private Link, Microsoft offering the ability to associate a logical server to a specific private IP address (also known as private endpoint) within the VNet. Clients can connect to the Private endpoint from the same VNet, peered VNet in same region, or via VNet-to-VNet connection across regions. Additionally, clients can connect from on-premises using ExpressRoute, private peering, or VPN tunneling. 190 | 191 | By default, this feature not enabled on this module. To create private link with private endpoints set the variable `enable_private_endpoint` to `true` and provide `virtual_network_name`, `private_subnet_address_prefix` with a valid values. You can also use the existing private DNS zone to create DNS records. To use this feature, set the `existing_private_dns_zone` with a valid existing private DNS zone name. 192 | 193 | ```terraform 194 | module "key-vault" { 195 | source = "kumarvna/key-vault/azurerm" 196 | version = "2.2.0" 197 | 198 | # .... omitted 199 | 200 | # Creating Private Endpoint requires, VNet name and address prefix to create a subnet 201 | # By default this will create a `privatelink.vaultcore.azure.net` DNS zone. 202 | # To use existing private DNS zone specify `existing_private_dns_zone` with valid zone name 203 | enable_private_endpoint = true 204 | virtual_network_name = "vnet-shared-hub-westeurope-001" 205 | private_subnet_address_prefix = ["10.1.5.0/27"] 206 | # existing_private_dns_zone = "demo.example.com" 207 | 208 | # ....omitted 209 | 210 | } 211 | ``` 212 | 213 | If you want to use eixsting VNet and Subnet to create a private endpoints, set a variable `enable_private_endpoint` to `true` and provide `existing_vnet_id`, `existing_subnet_id` with a valid resource ids. You can also use the existing private DNS zone to create DNS records. To use this feature, set the `existing_private_dns_zone` with a valid existing private DNS zone name. 214 | 215 | ```terraform 216 | module "key-vault" { 217 | source = "kumarvna/key-vault/azurerm" 218 | version = "2.2.0" 219 | 220 | # .... omitted 221 | 222 | # Creating Private Endpoint requires, VNet name and address prefix to create a subnet 223 | # By default this will create a `privatelink.vaultcore.azure.net` DNS zone. 224 | # To use existing private DNS zone specify `existing_private_dns_zone` with valid zone name 225 | enable_private_endpoint = true 226 | existing_vnet_id = data.azurerm_virtual_network.example.id 227 | existing_subnet_id = data.azurerm_subnet.example.id 228 | # existing_private_dns_zone = "demo.example.com" 229 | 230 | # ....omitted 231 | 232 | } 233 | ``` 234 | 235 | For more details: [Integrate Key Vault with Azure Private Link](https://docs.microsoft.com/en-us/azure/key-vault/general/private-link-service?tabs=portal) 236 | 237 | ## Recommended naming and tagging conventions 238 | 239 | Applying tags to your Azure resources, resource groups, and subscriptions to logically organize them into a taxonomy. Each tag consists of a name and a value pair. For example, you can apply the name `Environment` and the value `Production` to all the resources in production. 240 | For recommendations on how to implement a tagging strategy, see Resource naming and tagging decision guide. 241 | 242 | >**Important** : 243 | Tag names are case-insensitive for operations. A tag with a tag name, regardless of the casing, is updated or retrieved. However, the resource provider might keep the casing you provide for the tag name. You'll see that casing in cost reports. **Tag values are case-sensitive.** 244 | 245 | An effective naming convention assembles resource names by using important resource information as parts of a resource's name. For example, using these [recommended naming conventions](https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/naming-and-tagging#example-names), a public IP resource for a production SharePoint workload is named like this: `pip-sharepoint-prod-westus-001`. 246 | 247 | ## Requirements 248 | 249 | Name | Version 250 | -----|-------- 251 | terraform | >= 0.13 252 | azurerm | >= 2.59.0 253 | 254 | ## Providers 255 | 256 | | Name | Version | 257 | |------|---------| 258 | azurerm | >= 2.59.0 259 | random | >= 3.1.0 260 | azuread | >= 2.7.0 261 | 262 | ## Inputs 263 | 264 | Name | Description | Type | Default 265 | ---- | ----------- | ---- | ------- 266 | `create_resource_group`|Whether to create resource group and use it for all networking resources|string|`false` 267 | `resource_group_name` | The name of the resource group in which resources are created | string | `""` 268 | `location`|The location/region to keep all your network resources|string|`""` 269 | `key_vault_name`|The name of the key vault|string|`""` 270 | `key_vault_sku_pricing_tier`|The name of the SKU used for the Key Vault. The options are: `standard`, `premium`.|string|`"standard"` 271 | `enabled_for_deployment`|Allow Virtual Machines to retrieve certificates stored as secrets from the Key Vault|string|`"false"` 272 | `enabled_for_disk_encryption`|Allow Disk Encryption to retrieve secrets from the vault and unwrap keys|string|`"false"` 273 | `enabled_for_template_deployment`|Allow Resource Manager to retrieve secrets from the Key Vault|string|`"false"` 274 | `enable_rbac_authorization`|Specify whether Azure Key Vault uses Role Based Access Control (RBAC) for authorization of data actions|string|`false` 275 | `enable_purge_protection`|Is Purge Protection enabled for this Key Vault?|string|`"false"` 276 | `soft_delete_retention_days`|The number of days that items should be retained for once soft-deleted. The valid value can be between 7 and 90 days|string|`90` 277 | `access_policies`|List of access policies for the Key Vault|list|`{}` 278 | `azure_ad_user_principal_names`|List of user principal names of Azure AD users|list| `[]` 279 | `azure_ad_group_names`|List of names of Azure AD groups|list|`[]` 280 | `azure_ad_service_principal_names`|List of names of Azure AD service principals|list|`[]` 281 | `key_permissions`|List of key permissions, must be one or more from the following: `backup`, `create`, `decrypt`, `delete`, `encrypt`, `get`, `import`, `list`, `purge`, `recover`, `restore`, `sign`, `unwrapKey`, `update`, `verify` and `wrapKey`.|list|`[]` 282 | `secret_permissions`|List of secret permissions, must be one or more from the following: `backup`, `delete`, `get`, `list`, `purge`, `recover`, `restore` and `set`. |list|`[]` 283 | `certificate_permissions`|List of certificate permissions, must be one or more from the following: `backup`, `create`, `delete`, `deleteissuers`, `get`, `getissuers`, `import`, `list`, `listissuers`, `managecontacts`, `manageissuers`, `purge`, `recover`, `restore`, `setissuers` and `update`.|list|`[]` 284 | `storage_permissions`|List of storage permissions, must be one or more from the following: `backup`, `delete`, `deletesas`, `get`, `getsas`, `list`, `listsas`, `purge`, `recover`, `regeneratekey`, `restore`, `set`, `setsas` and `update`. |list|`[]` 285 | `network_acls`|Configure Azure Key Vault firewalls and virtual networks|list| `{}` 286 | `secrets`|A map of secrets for the Key Vault|map| `{}` 287 | `random_password_length`|The desired length of random password created by this module|number|`32` 288 | `certificate_contacts`|Contact information to send notifications triggered by certificate lifetime events|list|`[]` 289 | `enable_private_endpoint`|Manages a Private Endpoint to Azure Container Registry|string|`false` 290 | `virtual_network_name`|The name of the virtual network for the private endpoint creation. conflicts with `existing_vnet_id`and shouldn't use both.|string|`""` 291 | `private_subnet_address_prefix`|Address prefix of the subnet for private endpoint creation. conflicts with `existing_subnet_id` and shouldn't use both|list(string)|`null` 292 | `existing_vnet_id`|The resoruce id of existing Virtual network for private endpoint creation. Conflicts with `virtual_network_name`and shouldn't use both|string|`null` 293 | `existing_subnet_id`|The resource id of existing subnet for private endpoint creation. Conflicts with `private_subnet_address_prefix` and shouldn't use both|string|`null` 294 | `existing_private_dns_zone`|The name of exisging private DNS zone|string|`null` 295 | `log_analytics_workspace_id`|The id of log analytic workspace to send logs and metrics.|string|`"null"` 296 | `storage_account_id`|The id of storage account to send logs and metrics|string|`"null"` 297 | `Tags`|A map of tags to add to all resources|map|`{}` 298 | 299 | ## Outputs 300 | 301 | Name | Description 302 | ---- | ----------- 303 | `key_vault_id`|The ID of the Key Vault 304 | `key_vault_name`|Name of key vault created 305 | `key_vault_uri`|The URI of the Key Vault, used for performing operations on keys and secrets 306 | `secrets`|A mapping of secret names and URIs 307 | `Key_vault_references`|A mapping of Key Vault references for App Service and Azure Functions 308 | `key_vault_private_endpoint`|The ID of the Key Vault Private Endpoint 309 | `key_vault_private_dns_zone_domain`|DNS zone name for Key Vault Private endpoints dns name records 310 | `key_vault_private_endpoint_ip_addresses`|Key Vault private endpoint IPv4 Addresses 311 | `key_vault_private_endpoint_fqdn`|Key Vault private endpoint FQDN Addresses 312 | 313 | ## Resource Graph 314 | 315 | ![Resource Graph](graph.png) 316 | 317 | ## Authors 318 | 319 | Originally created by [Kumaraswamy Vithanala](mailto:kumarvna@gmail.com) 320 | 321 | ## Other resources 322 | 323 | * [Azure Key Vault documentation (Azure Documentation)](https://docs.microsoft.com/en-us/azure/key-vault/) 324 | * [Terraform AzureRM Provider Documentation](https://www.terraform.io/docs/providers/azurerm/index.html) 325 | -------------------------------------------------------------------------------- /examples/README.md: -------------------------------------------------------------------------------- 1 | # Azure Key Vault Terraform Module 2 | 3 | Terraform Module to create a Key Vault also adds required access policies for azure AD users, groups and azure AD service principals. This module also creates private endpoint and sends all logs to log analytic workspace or storage. 4 | 5 | ## Module Usage for 6 | 7 | * [Simple Key Vault Creation](simple_keyvault/) 8 | * [Key Vault with Private Endpoint](keyvault_with_private_end_point/) 9 | * [Key Vault with Private Endpoiont using existing VNet and Subnet](keyvault_private_end_point_with_existing_VNet_Subnet/) 10 | 11 | ## Terraform Usage 12 | 13 | To run this example you need to execute following Terraform commands 14 | 15 | ```hcl 16 | terraform init 17 | terraform plan 18 | terraform apply 19 | ``` 20 | 21 | Run `terraform destroy` when you don't need these resources. 22 | -------------------------------------------------------------------------------- /examples/keyvault_private_end_point_with_existing_VNet_Subnet/README.md: -------------------------------------------------------------------------------- 1 | # Azure Key Vault Terraform Module 2 | 3 | Terraform Module to create a Key Vault also adds required access policies for azure AD users, groups and azure AD service principals. This module also creates private endpoint and sends all logs to log analytic workspace or storage. 4 | 5 | ## Module Usage to enable privaite endpoint using existing VNet and Subnet 6 | 7 | ```hcl 8 | # Azurerm Provider configuration 9 | provider "azurerm" { 10 | features {} 11 | } 12 | 13 | data "azurerm_virtual_network" "example" { 14 | name = "vnet-shared-hub-westeurope-001" 15 | resource_group_name = "rg-shared-westeurope-01" 16 | } 17 | 18 | data "azurerm_subnet" "example" { 19 | name = "snet-private-ep" 20 | virtual_network_name = data.azurerm_virtual_network.example.name 21 | resource_group_name = data.azurerm_virtual_network.example.resource_group_name 22 | } 23 | 24 | module "key-vault" { 25 | source = "kumarvna/key-vault/azurerm" 26 | version = "2.2.0" 27 | 28 | # By default, this module will not create a resource group and expect to provide 29 | # a existing RG name to use an existing resource group. Location will be same as existing RG. 30 | # set the argument to `create_resource_group = true` to create new resrouce. 31 | resource_group_name = "rg-shared-westeurope-01" 32 | key_vault_name = "demo-project-shard" 33 | key_vault_sku_pricing_tier = "premium" 34 | 35 | # Once `Purge Protection` has been Enabled it's not possible to Disable it 36 | # Deleting the Key Vault with `Purge Protection` enabled will schedule the Key Vault to be deleted 37 | # The default retention period is 90 days, possible values are from 7 to 90 days 38 | # use `soft_delete_retention_days` to set the retention period 39 | enable_purge_protection = false 40 | # soft_delete_retention_days = 90 41 | 42 | # Access policies for users, you can provide list of Azure AD users and set permissions. 43 | # Make sure to use list of user principal names of Azure AD users. 44 | access_policies = [ 45 | { 46 | azure_ad_user_principal_names = ["user1@example.com", "user2@example.com"] 47 | key_permissions = ["get", "list"] 48 | secret_permissions = ["get", "list"] 49 | certificate_permissions = ["get", "import", "list"] 50 | storage_permissions = ["backup", "get", "list", "recover"] 51 | }, 52 | 53 | # Access policies for AD Groups 54 | # to enable this feature, provide a list of Azure AD groups and set permissions as required. 55 | { 56 | azure_ad_group_names = ["ADGroupName1", "ADGroupName2"] 57 | key_permissions = ["get", "list"] 58 | secret_permissions = ["get", "list"] 59 | certificate_permissions = ["get", "import", "list"] 60 | storage_permissions = ["backup", "get", "list", "recover"] 61 | }, 62 | 63 | # Access policies for Azure AD Service Principlas 64 | # To enable this feature, provide a list of Azure AD SPN and set permissions as required. 65 | { 66 | azure_ad_service_principal_names = ["azure-ad-dev-sp1", "azure-ad-dev-sp2"] 67 | key_permissions = ["get", "list"] 68 | secret_permissions = ["get", "list"] 69 | certificate_permissions = ["get", "import", "list"] 70 | storage_permissions = ["backup", "get", "list", "recover"] 71 | } 72 | ] 73 | 74 | # Create a required Secrets as per your need. 75 | # When you Add `usernames` with empty password this module creates a strong random password 76 | # use .tfvars file to manage the secrets as variables to avoid security issues. 77 | secrets = { 78 | "message" = "Hello, world!" 79 | "vmpass" = "" 80 | } 81 | 82 | # Creating Private Endpoint requires, VNet name and address prefix to create a subnet 83 | # By default this will create a `privatelink.vaultcore.azure.net` DNS zone. 84 | # To use existing private DNS zone specify `existing_private_dns_zone` with valid zone name 85 | enable_private_endpoint = true 86 | existing_vnet_id = data.azurerm_virtual_network.example.id 87 | existing_subnet_id = data.azurerm_subnet.example.id 88 | # existing_private_dns_zone = "demo.example.com" 89 | 90 | # (Optional) To enable Azure Monitoring for Azure Application Gateway 91 | # (Optional) Specify `storage_account_id` to save monitoring logs to storage. 92 | log_analytics_workspace_id = var.log_analytics_workspace_id 93 | #storage_account_id = var.storage_account_id 94 | 95 | # Adding additional TAG's to your Azure resources 96 | tags = { 97 | ProjectName = "demo-project" 98 | Env = "dev" 99 | Owner = "user@example.com" 100 | BusinessUnit = "CORP" 101 | ServiceClass = "Gold" 102 | } 103 | } 104 | ``` 105 | 106 | ## Terraform Usage 107 | 108 | To run this example you need to execute following Terraform commands 109 | 110 | ```hcl 111 | terraform init 112 | terraform plan 113 | terraform apply 114 | ``` 115 | 116 | Run `terraform destroy` when you don't need these resources. 117 | -------------------------------------------------------------------------------- /examples/keyvault_private_end_point_with_existing_VNet_Subnet/main.tf: -------------------------------------------------------------------------------- 1 | # Azurerm Provider configuration 2 | provider "azurerm" { 3 | features {} 4 | } 5 | 6 | data "azurerm_virtual_network" "example" { 7 | name = "vnet-shared-hub-westeurope-001" 8 | resource_group_name = "rg-shared-westeurope-01" 9 | } 10 | 11 | data "azurerm_subnet" "example" { 12 | name = "snet-private-ep" 13 | virtual_network_name = data.azurerm_virtual_network.example.name 14 | resource_group_name = data.azurerm_virtual_network.example.resource_group_name 15 | } 16 | 17 | module "key-vault" { 18 | source = "kumarvna/key-vault/azurerm" 19 | version = "2.2.0" 20 | 21 | # By default, this module will not create a resource group and expect to provide 22 | # a existing RG name to use an existing resource group. Location will be same as existing RG. 23 | # set the argument to `create_resource_group = true` to create new resrouce. 24 | resource_group_name = "rg-shared-westeurope-01" 25 | key_vault_name = "demo-project-shard" 26 | key_vault_sku_pricing_tier = "premium" 27 | 28 | # Once `Purge Protection` has been Enabled it's not possible to Disable it 29 | # Deleting the Key Vault with `Purge Protection` enabled will schedule the Key Vault to be deleted 30 | # The default retention period is 90 days, possible values are from 7 to 90 days 31 | # use `soft_delete_retention_days` to set the retention period 32 | enable_purge_protection = false 33 | # soft_delete_retention_days = 90 34 | 35 | # Access policies for users, you can provide list of Azure AD users and set permissions. 36 | # Make sure to use list of user principal names of Azure AD users. 37 | access_policies = [ 38 | { 39 | azure_ad_user_principal_names = ["user1@example.com", "user2@example.com"] 40 | key_permissions = ["get", "list"] 41 | secret_permissions = ["get", "list"] 42 | certificate_permissions = ["get", "import", "list"] 43 | storage_permissions = ["backup", "get", "list", "recover"] 44 | }, 45 | 46 | # Access policies for AD Groups 47 | # to enable this feature, provide a list of Azure AD groups and set permissions as required. 48 | { 49 | azure_ad_group_names = ["ADGroupName1", "ADGroupName2"] 50 | key_permissions = ["get", "list"] 51 | secret_permissions = ["get", "list"] 52 | certificate_permissions = ["get", "import", "list"] 53 | storage_permissions = ["backup", "get", "list", "recover"] 54 | }, 55 | 56 | # Access policies for Azure AD Service Principlas 57 | # To enable this feature, provide a list of Azure AD SPN and set permissions as required. 58 | { 59 | azure_ad_service_principal_names = ["azure-ad-dev-sp1", "azure-ad-dev-sp2"] 60 | key_permissions = ["get", "list"] 61 | secret_permissions = ["get", "list"] 62 | certificate_permissions = ["get", "import", "list"] 63 | storage_permissions = ["backup", "get", "list", "recover"] 64 | } 65 | ] 66 | 67 | # Create a required Secrets as per your need. 68 | # When you Add `usernames` with empty password this module creates a strong random password 69 | # use .tfvars file to manage the secrets as variables to avoid security issues. 70 | secrets = { 71 | "message" = "Hello, world!" 72 | "vmpass" = "" 73 | } 74 | 75 | # Creating Private Endpoint requires, VNet name and address prefix to create a subnet 76 | # By default this will create a `privatelink.vaultcore.azure.net` DNS zone. 77 | # To use existing private DNS zone specify `existing_private_dns_zone` with valid zone name 78 | enable_private_endpoint = true 79 | existing_vnet_id = data.azurerm_virtual_network.example.id 80 | existing_subnet_id = data.azurerm_subnet.example.id 81 | # existing_private_dns_zone = "demo.example.com" 82 | 83 | # (Optional) To enable Azure Monitoring for Azure Application Gateway 84 | # (Optional) Specify `storage_account_id` to save monitoring logs to storage. 85 | log_analytics_workspace_id = var.log_analytics_workspace_id 86 | #storage_account_id = var.storage_account_id 87 | 88 | # Adding additional TAG's to your Azure resources 89 | tags = { 90 | ProjectName = "demo-project" 91 | Env = "dev" 92 | Owner = "user@example.com" 93 | BusinessUnit = "CORP" 94 | ServiceClass = "Gold" 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /examples/keyvault_private_end_point_with_existing_VNet_Subnet/output.tf: -------------------------------------------------------------------------------- 1 | output "key_vault_id" { 2 | description = "The ID of the Key Vault." 3 | value = module.key-vault.key_vault_id 4 | } 5 | 6 | output "key_vault_name" { 7 | description = "Name of key vault created." 8 | value = module.key-vault.key_vault_name 9 | } 10 | 11 | output "key_vault_uri" { 12 | description = "The URI of the Key Vault, used for performing operations on keys and secrets." 13 | value = module.key-vault.key_vault_uri 14 | } 15 | 16 | output "secrets" { 17 | description = "A mapping of secret names and URIs." 18 | value = module.key-vault.secrets 19 | } 20 | 21 | output "Key_vault_references" { 22 | description = "A mapping of Key Vault references for App Service and Azure Functions." 23 | value = module.key-vault.Key_vault_references 24 | } 25 | 26 | output "key_vault_private_endpoint" { 27 | description = "The ID of the Key Vault Private Endpoint" 28 | value = module.key-vault.key_vault_private_endpoint 29 | } 30 | 31 | output "key_vault_private_dns_zone_domain" { 32 | description = "DNS zone name for Key Vault Private endpoints dns name records" 33 | value = module.key-vault.key_vault_private_dns_zone_domain 34 | } 35 | 36 | output "key_vault_private_endpoint_ip_addresses" { 37 | description = "Key Vault private endpoint IPv4 Addresses" 38 | value = module.key-vault.key_vault_private_endpoint_ip_addresses 39 | } 40 | 41 | output "key_vault_private_endpoint_fqdn" { 42 | description = "Key Vault private endpoint FQDN Addresses" 43 | value = module.key-vault.key_vault_private_endpoint_fqdn 44 | } 45 | -------------------------------------------------------------------------------- /examples/keyvault_private_end_point_with_existing_VNet_Subnet/variables.tf: -------------------------------------------------------------------------------- 1 | variable "log_analytics_workspace_id" { 2 | description = "Specifies the ID of a Log Analytics Workspace where Diagnostics Data to be sent" 3 | default = null 4 | } 5 | 6 | variable "storage_account_id" { 7 | description = "The name of the storage account to store the all monitoring logs" 8 | default = null 9 | } 10 | -------------------------------------------------------------------------------- /examples/keyvault_with_private_end_point/README.md: -------------------------------------------------------------------------------- 1 | # Azure Key Vault Terraform Module 2 | 3 | Terraform Module to create a Key Vault also adds required access policies for azure AD users, groups and azure AD service principals. This module also creates private endpoint and sends all logs to log analytic workspace or storage. 4 | 5 | ## Module Usage to enable privaite endpoint 6 | 7 | ```hcl 8 | # Azurerm Provider configuration 9 | provider "azurerm" { 10 | features {} 11 | } 12 | 13 | module "key-vault" { 14 | source = "kumarvna/key-vault/azurerm" 15 | version = "2.2.0" 16 | 17 | # By default, this module will not create a resource group and expect to provide 18 | # a existing RG name to use an existing resource group. Location will be same as existing RG. 19 | # set the argument to `create_resource_group = true` to create new resrouce. 20 | resource_group_name = "rg-shared-westeurope-01" 21 | key_vault_name = "demo-project-shard" 22 | key_vault_sku_pricing_tier = "premium" 23 | 24 | # Once `Purge Protection` has been Enabled it's not possible to Disable it 25 | # Deleting the Key Vault with `Purge Protection` enabled will schedule the Key Vault to be deleted 26 | # The default retention period is 90 days, possible values are from 7 to 90 days 27 | # use `soft_delete_retention_days` to set the retention period 28 | enable_purge_protection = false 29 | # soft_delete_retention_days = 90 30 | 31 | # Access policies for users, you can provide list of Azure AD users and set permissions. 32 | # Make sure to use list of user principal names of Azure AD users. 33 | access_policies = [ 34 | { 35 | azure_ad_user_principal_names = ["user1@example.com", "user2@example.com"] 36 | key_permissions = ["get", "list"] 37 | secret_permissions = ["get", "list"] 38 | certificate_permissions = ["get", "import", "list"] 39 | storage_permissions = ["backup", "get", "list", "recover"] 40 | }, 41 | 42 | # Access policies for AD Groups 43 | # to enable this feature, provide a list of Azure AD groups and set permissions as required. 44 | { 45 | azure_ad_group_names = ["ADGroupName1", "ADGroupName2"] 46 | key_permissions = ["get", "list"] 47 | secret_permissions = ["get", "list"] 48 | certificate_permissions = ["get", "import", "list"] 49 | storage_permissions = ["backup", "get", "list", "recover"] 50 | }, 51 | 52 | # Access policies for Azure AD Service Principlas 53 | # To enable this feature, provide a list of Azure AD SPN and set permissions as required. 54 | { 55 | azure_ad_service_principal_names = ["azure-ad-dev-sp1", "azure-ad-dev-sp2"] 56 | key_permissions = ["get", "list"] 57 | secret_permissions = ["get", "list"] 58 | certificate_permissions = ["get", "import", "list"] 59 | storage_permissions = ["backup", "get", "list", "recover"] 60 | } 61 | ] 62 | 63 | # Create a required Secrets as per your need. 64 | # When you Add `usernames` with empty password this module creates a strong random password 65 | # use .tfvars file to manage the secrets as variables to avoid security issues. 66 | secrets = { 67 | "message" = "Hello, world!" 68 | "vmpass" = "" 69 | } 70 | 71 | # Creating Private Endpoint requires, VNet name and address prefix to create a subnet 72 | # By default this will create a `privatelink.vaultcore.azure.net` DNS zone. 73 | # To use existing private DNS zone specify `existing_private_dns_zone` with valid zone name 74 | enable_private_endpoint = true 75 | virtual_network_name = "vnet-shared-hub-westeurope-001" 76 | private_subnet_address_prefix = ["10.1.5.0/27"] 77 | # existing_private_dns_zone = "demo.example.com" 78 | 79 | # (Optional) To enable Azure Monitoring for Azure Application Gateway 80 | # (Optional) Specify `storage_account_id` to save monitoring logs to storage. 81 | log_analytics_workspace_id = var.log_analytics_workspace_id 82 | #storage_account_id = var.storage_account_id 83 | 84 | # Adding additional TAG's to your Azure resources 85 | tags = { 86 | ProjectName = "demo-project" 87 | Env = "dev" 88 | Owner = "user@example.com" 89 | BusinessUnit = "CORP" 90 | ServiceClass = "Gold" 91 | } 92 | } 93 | ``` 94 | 95 | ## Terraform Usage 96 | 97 | To run this example you need to execute following Terraform commands 98 | 99 | ```hcl 100 | terraform init 101 | terraform plan 102 | terraform apply 103 | ``` 104 | 105 | Run `terraform destroy` when you don't need these resources. 106 | -------------------------------------------------------------------------------- /examples/keyvault_with_private_end_point/main.tf: -------------------------------------------------------------------------------- 1 | # Azurerm Provider configuration 2 | provider "azurerm" { 3 | features {} 4 | } 5 | 6 | module "key-vault" { 7 | source = "kumarvna/key-vault/azurerm" 8 | version = "2.2.0" 9 | 10 | # By default, this module will not create a resource group and expect to provide 11 | # a existing RG name to use an existing resource group. Location will be same as existing RG. 12 | # set the argument to `create_resource_group = true` to create new resrouce. 13 | resource_group_name = "rg-shared-westeurope-01" 14 | key_vault_name = "demo-project-shard" 15 | key_vault_sku_pricing_tier = "premium" 16 | 17 | # Once `Purge Protection` has been Enabled it's not possible to Disable it 18 | # Deleting the Key Vault with `Purge Protection` enabled will schedule the Key Vault to be deleted 19 | # The default retention period is 90 days, possible values are from 7 to 90 days 20 | # use `soft_delete_retention_days` to set the retention period 21 | enable_purge_protection = false 22 | # soft_delete_retention_days = 90 23 | 24 | # Access policies for users, you can provide list of Azure AD users and set permissions. 25 | # Make sure to use list of user principal names of Azure AD users. 26 | access_policies = [ 27 | { 28 | azure_ad_user_principal_names = ["user1@example.com", "user2@example.com"] 29 | key_permissions = ["get", "list"] 30 | secret_permissions = ["get", "list"] 31 | certificate_permissions = ["get", "import", "list"] 32 | storage_permissions = ["backup", "get", "list", "recover"] 33 | }, 34 | 35 | # Access policies for AD Groups 36 | # to enable this feature, provide a list of Azure AD groups and set permissions as required. 37 | { 38 | azure_ad_group_names = ["ADGroupName1", "ADGroupName2"] 39 | key_permissions = ["get", "list"] 40 | secret_permissions = ["get", "list"] 41 | certificate_permissions = ["get", "import", "list"] 42 | storage_permissions = ["backup", "get", "list", "recover"] 43 | }, 44 | 45 | # Access policies for Azure AD Service Principlas 46 | # To enable this feature, provide a list of Azure AD SPN and set permissions as required. 47 | { 48 | azure_ad_service_principal_names = ["azure-ad-dev-sp1", "azure-ad-dev-sp2"] 49 | key_permissions = ["get", "list"] 50 | secret_permissions = ["get", "list"] 51 | certificate_permissions = ["get", "import", "list"] 52 | storage_permissions = ["backup", "get", "list", "recover"] 53 | } 54 | ] 55 | 56 | # Create a required Secrets as per your need. 57 | # When you Add `usernames` with empty password this module creates a strong random password 58 | # use .tfvars file to manage the secrets as variables to avoid security issues. 59 | secrets = { 60 | "message" = "Hello, world!" 61 | "vmpass" = "" 62 | } 63 | 64 | # Creating Private Endpoint requires, VNet name and address prefix to create a subnet 65 | # By default this will create a `privatelink.vaultcore.azure.net` DNS zone. 66 | # To use existing private DNS zone specify `existing_private_dns_zone` with valid zone name 67 | enable_private_endpoint = true 68 | virtual_network_name = "vnet-shared-hub-westeurope-001" 69 | private_subnet_address_prefix = ["10.1.5.0/27"] 70 | # existing_private_dns_zone = "demo.example.com" 71 | 72 | # (Optional) To enable Azure Monitoring for Azure Application Gateway 73 | # (Optional) Specify `storage_account_id` to save monitoring logs to storage. 74 | log_analytics_workspace_id = var.log_analytics_workspace_id 75 | #storage_account_id = var.storage_account_id 76 | 77 | # Adding additional TAG's to your Azure resources 78 | tags = { 79 | ProjectName = "demo-project" 80 | Env = "dev" 81 | Owner = "user@example.com" 82 | BusinessUnit = "CORP" 83 | ServiceClass = "Gold" 84 | } 85 | } 86 | -------------------------------------------------------------------------------- /examples/keyvault_with_private_end_point/output.tf: -------------------------------------------------------------------------------- 1 | output "key_vault_id" { 2 | description = "The ID of the Key Vault." 3 | value = module.key-vault.key_vault_id 4 | } 5 | 6 | output "key_vault_name" { 7 | description = "Name of key vault created." 8 | value = module.key-vault.key_vault_name 9 | } 10 | 11 | output "key_vault_uri" { 12 | description = "The URI of the Key Vault, used for performing operations on keys and secrets." 13 | value = module.key-vault.key_vault_uri 14 | } 15 | 16 | output "secrets" { 17 | description = "A mapping of secret names and URIs." 18 | value = module.key-vault.secrets 19 | } 20 | 21 | output "Key_vault_references" { 22 | description = "A mapping of Key Vault references for App Service and Azure Functions." 23 | value = module.key-vault.Key_vault_references 24 | } 25 | 26 | output "key_vault_private_endpoint" { 27 | description = "The ID of the Key Vault Private Endpoint" 28 | value = module.key-vault.key_vault_private_endpoint 29 | } 30 | 31 | output "key_vault_private_dns_zone_domain" { 32 | description = "DNS zone name for Key Vault Private endpoints dns name records" 33 | value = module.key-vault.key_vault_private_dns_zone_domain 34 | } 35 | 36 | output "key_vault_private_endpoint_ip_addresses" { 37 | description = "Key Vault private endpoint IPv4 Addresses" 38 | value = module.key-vault.key_vault_private_endpoint_ip_addresses 39 | } 40 | 41 | output "key_vault_private_endpoint_fqdn" { 42 | description = "Key Vault private endpoint FQDN Addresses" 43 | value = module.key-vault.key_vault_private_endpoint_fqdn 44 | } 45 | -------------------------------------------------------------------------------- /examples/keyvault_with_private_end_point/variables.tf: -------------------------------------------------------------------------------- 1 | variable "log_analytics_workspace_id" { 2 | description = "Specifies the ID of a Log Analytics Workspace where Diagnostics Data to be sent" 3 | default = null 4 | } 5 | 6 | variable "storage_account_id" { 7 | description = "The name of the storage account to store the all monitoring logs" 8 | default = null 9 | } 10 | -------------------------------------------------------------------------------- /examples/simple_keyvault/README.md: -------------------------------------------------------------------------------- 1 | # Azure Key Vault Terraform Module 2 | 3 | Terraform Module to create a Key Vault also adds required access policies for azure AD users, groups and azure AD service principals. This module also creates private endpoint and sends all logs to log analytic workspace or storage. 4 | 5 | ## Module Usage 6 | 7 | ```hcl 8 | # Azurerm Provider configuration 9 | provider "azurerm" { 10 | features {} 11 | } 12 | 13 | module "key-vault" { 14 | source = "kumarvna/key-vault/azurerm" 15 | version = "2.2.0" 16 | 17 | # By default, this module will not create a resource group and expect to provide 18 | # a existing RG name to use an existing resource group. Location will be same as existing RG. 19 | # set the argument to `create_resource_group = true` to create new resrouce. 20 | resource_group_name = "rg-shared-westeurope-01" 21 | key_vault_name = "demo-project-shard" 22 | key_vault_sku_pricing_tier = "premium" 23 | 24 | # Once `Purge Protection` has been Enabled it's not possible to Disable it 25 | # Deleting the Key Vault with `Purge Protection` enabled will schedule the Key Vault to be deleted 26 | # The default retention period is 90 days, possible values are from 7 to 90 days 27 | # use `soft_delete_retention_days` to set the retention period 28 | enable_purge_protection = false 29 | # soft_delete_retention_days = 90 30 | 31 | # Access policies for users, you can provide list of Azure AD users and set permissions. 32 | # Make sure to use list of user principal names of Azure AD users. 33 | access_policies = [ 34 | { 35 | azure_ad_user_principal_names = ["user1@example.com", "user2@example.com"] 36 | key_permissions = ["get", "list"] 37 | secret_permissions = ["get", "list"] 38 | certificate_permissions = ["get", "import", "list"] 39 | storage_permissions = ["backup", "get", "list", "recover"] 40 | }, 41 | 42 | # Access policies for AD Groups 43 | # to enable this feature, provide a list of Azure AD groups and set permissions as required. 44 | { 45 | azure_ad_group_names = ["ADGroupName1", "ADGroupName2"] 46 | key_permissions = ["get", "list"] 47 | secret_permissions = ["get", "list"] 48 | certificate_permissions = ["get", "import", "list"] 49 | storage_permissions = ["backup", "get", "list", "recover"] 50 | }, 51 | 52 | # Access policies for Azure AD Service Principlas 53 | # To enable this feature, provide a list of Azure AD SPN and set permissions as required. 54 | { 55 | azure_ad_service_principal_names = ["azure-ad-dev-sp1", "azure-ad-dev-sp2"] 56 | key_permissions = ["get", "list"] 57 | secret_permissions = ["get", "list"] 58 | certificate_permissions = ["get", "import", "list"] 59 | storage_permissions = ["backup", "get", "list", "recover"] 60 | } 61 | ] 62 | 63 | # Create a required Secrets as per your need. 64 | # When you Add `usernames` with empty password this module creates a strong random password 65 | # use .tfvars file to manage the secrets as variables to avoid security issues. 66 | secrets = { 67 | "message" = "Hello, world!" 68 | "vmpass" = "" 69 | } 70 | 71 | # (Optional) To enable Azure Monitoring for Azure Application Gateway 72 | # (Optional) Specify `storage_account_id` to save monitoring logs to storage. 73 | log_analytics_workspace_id = var.log_analytics_workspace_id 74 | #storage_account_id = var.storage_account_id 75 | 76 | # Adding additional TAG's to your Azure resources 77 | tags = { 78 | ProjectName = "demo-project" 79 | Env = "dev" 80 | Owner = "user@example.com" 81 | BusinessUnit = "CORP" 82 | ServiceClass = "Gold" 83 | } 84 | } 85 | ``` 86 | 87 | ## Terraform Usage 88 | 89 | To run this example you need to execute following Terraform commands 90 | 91 | ```hcl 92 | terraform init 93 | terraform plan 94 | terraform apply 95 | ``` 96 | 97 | Run `terraform destroy` when you don't need these resources. 98 | -------------------------------------------------------------------------------- /examples/simple_keyvault/main.tf: -------------------------------------------------------------------------------- 1 | # Azurerm Provider configuration 2 | provider "azurerm" { 3 | features {} 4 | } 5 | 6 | module "key-vault" { 7 | source = "kumarvna/key-vault/azurerm" 8 | version = "2.2.0" 9 | 10 | # By default, this module will not create a resource group and expect to provide 11 | # a existing RG name to use an existing resource group. Location will be same as existing RG. 12 | # set the argument to `create_resource_group = true` to create new resrouce. 13 | resource_group_name = "rg-shared-westeurope-01" 14 | key_vault_name = "demo-project-shard" 15 | key_vault_sku_pricing_tier = "premium" 16 | 17 | # Once `Purge Protection` has been Enabled it's not possible to Disable it 18 | # Deleting the Key Vault with `Purge Protection` enabled will schedule the Key Vault to be deleted 19 | # The default retention period is 90 days, possible values are from 7 to 90 days 20 | # use `soft_delete_retention_days` to set the retention period 21 | enable_purge_protection = false 22 | # soft_delete_retention_days = 90 23 | 24 | # Access policies for users, you can provide list of Azure AD users and set permissions. 25 | # Make sure to use list of user principal names of Azure AD users. 26 | access_policies = [ 27 | { 28 | azure_ad_user_principal_names = ["user1@example.com", "user2@example.com"] 29 | key_permissions = ["get", "list"] 30 | secret_permissions = ["get", "list"] 31 | certificate_permissions = ["get", "import", "list"] 32 | storage_permissions = ["backup", "get", "list", "recover"] 33 | }, 34 | 35 | # Access policies for AD Groups 36 | # to enable this feature, provide a list of Azure AD groups and set permissions as required. 37 | { 38 | azure_ad_group_names = ["ADGroupName1", "ADGroupName2"] 39 | key_permissions = ["get", "list"] 40 | secret_permissions = ["get", "list"] 41 | certificate_permissions = ["get", "import", "list"] 42 | storage_permissions = ["backup", "get", "list", "recover"] 43 | }, 44 | 45 | # Access policies for Azure AD Service Principlas 46 | # To enable this feature, provide a list of Azure AD SPN and set permissions as required. 47 | { 48 | azure_ad_service_principal_names = ["azure-ad-dev-sp1", "azure-ad-dev-sp2"] 49 | key_permissions = ["get", "list"] 50 | secret_permissions = ["get", "list"] 51 | certificate_permissions = ["get", "import", "list"] 52 | storage_permissions = ["backup", "get", "list", "recover"] 53 | } 54 | ] 55 | 56 | # Create a required Secrets as per your need. 57 | # When you Add `usernames` with empty password this module creates a strong random password 58 | # use .tfvars file to manage the secrets as variables to avoid security issues. 59 | secrets = { 60 | "message" = "Hello, world!" 61 | "vmpass" = "" 62 | } 63 | 64 | # (Optional) To enable Azure Monitoring for Azure Application Gateway 65 | # (Optional) Specify `storage_account_id` to save monitoring logs to storage. 66 | log_analytics_workspace_id = var.log_analytics_workspace_id 67 | #storage_account_id = var.storage_account_id 68 | 69 | # Adding additional TAG's to your Azure resources 70 | tags = { 71 | ProjectName = "demo-project" 72 | Env = "dev" 73 | Owner = "user@example.com" 74 | BusinessUnit = "CORP" 75 | ServiceClass = "Gold" 76 | } 77 | } 78 | -------------------------------------------------------------------------------- /examples/simple_keyvault/output.tf: -------------------------------------------------------------------------------- 1 | output "key_vault_id" { 2 | description = "The ID of the Key Vault." 3 | value = module.key-vault.key_vault_id 4 | } 5 | 6 | output "key_vault_name" { 7 | description = "Name of key vault created." 8 | value = module.key-vault.key_vault_name 9 | } 10 | 11 | output "key_vault_uri" { 12 | description = "The URI of the Key Vault, used for performing operations on keys and secrets." 13 | value = module.key-vault.key_vault_uri 14 | } 15 | 16 | output "secrets" { 17 | description = "A mapping of secret names and URIs." 18 | value = module.key-vault.secrets 19 | } 20 | 21 | output "Key_vault_references" { 22 | description = "A mapping of Key Vault references for App Service and Azure Functions." 23 | value = module.key-vault.Key_vault_references 24 | } 25 | 26 | output "key_vault_private_endpoint" { 27 | description = "The ID of the Key Vault Private Endpoint" 28 | value = module.key-vault.key_vault_private_endpoint 29 | } 30 | 31 | output "key_vault_private_dns_zone_domain" { 32 | description = "DNS zone name for Key Vault Private endpoints dns name records" 33 | value = module.key-vault.key_vault_private_dns_zone_domain 34 | } 35 | 36 | output "key_vault_private_endpoint_ip_addresses" { 37 | description = "Key Vault private endpoint IPv4 Addresses" 38 | value = module.key-vault.key_vault_private_endpoint_ip_addresses 39 | } 40 | 41 | output "key_vault_private_endpoint_fqdn" { 42 | description = "Key Vault private endpoint FQDN Addresses" 43 | value = module.key-vault.key_vault_private_endpoint_fqdn 44 | } 45 | -------------------------------------------------------------------------------- /examples/simple_keyvault/variables.tf: -------------------------------------------------------------------------------- 1 | variable "log_analytics_workspace_id" { 2 | description = "Specifies the ID of a Log Analytics Workspace where Diagnostics Data to be sent" 3 | default = null 4 | } 5 | 6 | variable "storage_account_id" { 7 | description = "The name of the storage account to store the all monitoring logs" 8 | default = null 9 | } 10 | -------------------------------------------------------------------------------- /graph.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kumarvna/terraform-azurerm-key-vault/5129a81954c113e088c533f30fb399d2f4e0e4e9/graph.png -------------------------------------------------------------------------------- /main.tf: -------------------------------------------------------------------------------- 1 | 2 | locals { 3 | resource_group_name = element(coalescelist(data.azurerm_resource_group.rgrp.*.name, azurerm_resource_group.rg.*.name, [""]), 0) 4 | location = element(coalescelist(data.azurerm_resource_group.rgrp.*.location, azurerm_resource_group.rg.*.location, [""]), 0) 5 | 6 | access_policies = [ 7 | for p in var.access_policies : merge({ 8 | azure_ad_group_names = [] 9 | object_ids = [] 10 | azure_ad_user_principal_names = [] 11 | certificate_permissions = [] 12 | key_permissions = [] 13 | secret_permissions = [] 14 | storage_permissions = [] 15 | azure_ad_service_principal_names = [] 16 | }, p) 17 | ] 18 | 19 | azure_ad_group_names = distinct(flatten(local.access_policies[*].azure_ad_group_names)) 20 | azure_ad_user_principal_names = distinct(flatten(local.access_policies[*].azure_ad_user_principal_names)) 21 | azure_ad_service_principal_names = distinct(flatten(local.access_policies[*].azure_ad_service_principal_names)) 22 | 23 | group_object_ids = { for g in data.azuread_group.adgrp : lower(g.display_name) => g.id } 24 | user_object_ids = { for u in data.azuread_user.adusr : lower(u.user_principal_name) => u.id } 25 | spn_object_ids = { for s in data.azuread_service_principal.adspn : lower(s.display_name) => s.id } 26 | 27 | flattened_access_policies = concat( 28 | flatten([ 29 | for p in local.access_policies : flatten([ 30 | for i in p.object_ids : { 31 | object_id = i 32 | certificate_permissions = p.certificate_permissions 33 | key_permissions = p.key_permissions 34 | secret_permissions = p.secret_permissions 35 | storage_permissions = p.storage_permissions 36 | } 37 | ]) 38 | ]), 39 | flatten([ 40 | for p in local.access_policies : flatten([ 41 | for n in p.azure_ad_group_names : { 42 | object_id = local.group_object_ids[lower(n)] 43 | certificate_permissions = p.certificate_permissions 44 | key_permissions = p.key_permissions 45 | secret_permissions = p.secret_permissions 46 | storage_permissions = p.storage_permissions 47 | } 48 | ]) 49 | ]), 50 | flatten([ 51 | for p in local.access_policies : flatten([ 52 | for n in p.azure_ad_user_principal_names : { 53 | object_id = local.user_object_ids[lower(n)] 54 | certificate_permissions = p.certificate_permissions 55 | key_permissions = p.key_permissions 56 | secret_permissions = p.secret_permissions 57 | storage_permissions = p.storage_permissions 58 | } 59 | ]) 60 | ]), 61 | flatten([ 62 | for p in local.access_policies : flatten([ 63 | for n in p.azure_ad_service_principal_names : { 64 | object_id = local.spn_object_ids[lower(n)] 65 | certificate_permissions = p.certificate_permissions 66 | key_permissions = p.key_permissions 67 | secret_permissions = p.secret_permissions 68 | storage_permissions = p.storage_permissions 69 | } 70 | ]) 71 | ]) 72 | ) 73 | 74 | grouped_access_policies = { for p in local.flattened_access_policies : p.object_id => p... } 75 | 76 | combined_access_policies = [ 77 | for k, v in local.grouped_access_policies : { 78 | object_id = k 79 | certificate_permissions = distinct(flatten(v[*].certificate_permissions)) 80 | key_permissions = distinct(flatten(v[*].key_permissions)) 81 | secret_permissions = distinct(flatten(v[*].secret_permissions)) 82 | storage_permissions = distinct(flatten(v[*].storage_permissions)) 83 | } 84 | ] 85 | 86 | service_principal_object_id = data.azurerm_client_config.current.object_id 87 | 88 | self_permissions = { 89 | object_id = local.service_principal_object_id 90 | tenant_id = data.azurerm_client_config.current.tenant_id 91 | key_permissions = ["create", "delete", "get", "backup", "decrypt", "encrypt", "import", "list", "purge", "recover", "restore", "sign", "update", "verify"] 92 | secret_permissions = ["backup", "delete", "get", "list", "purge", "recover", "restore", "set"] 93 | certificate_permissions = ["backup", "create", "delete", "deleteissuers", "get", "getissuers", "import", "list", "listissuers", "managecontacts", "manageissuers", "purge", "recover", "restore", "setissuers", "update"] 94 | storage_permissions = ["backup", "delete", "deletesas", "get", "getsas", "list", "listsas", "purge", "recover", "regeneratekey", "restore", "set", "setsas", "update"] 95 | } 96 | } 97 | 98 | data "azuread_group" "adgrp" { 99 | count = length(local.azure_ad_group_names) 100 | display_name = local.azure_ad_group_names[count.index] 101 | } 102 | 103 | data "azuread_user" "adusr" { 104 | count = length(local.azure_ad_user_principal_names) 105 | user_principal_name = local.azure_ad_user_principal_names[count.index] 106 | } 107 | 108 | data "azuread_service_principal" "adspn" { 109 | count = length(local.azure_ad_service_principal_names) 110 | display_name = local.azure_ad_service_principal_names[count.index] 111 | } 112 | 113 | #---------------------------------------------------------- 114 | # Resource Group Creation or selection - Default is "true" 115 | #---------------------------------------------------------- 116 | data "azurerm_resource_group" "rgrp" { 117 | count = var.create_resource_group ? 0 : 1 118 | name = var.resource_group_name 119 | } 120 | 121 | resource "azurerm_resource_group" "rg" { 122 | count = var.create_resource_group ? 1 : 0 123 | name = lower(var.resource_group_name) 124 | location = var.location 125 | tags = merge({ "ResourceName" = format("%s", var.resource_group_name) }, var.tags, ) 126 | } 127 | 128 | data "azurerm_client_config" "current" {} 129 | 130 | #------------------------------------------------- 131 | # Keyvault Creation - Default is "true" 132 | #------------------------------------------------- 133 | resource "azurerm_key_vault" "main" { 134 | name = lower("kv-${var.key_vault_name}") 135 | location = local.location 136 | resource_group_name = local.resource_group_name 137 | tenant_id = data.azurerm_client_config.current.tenant_id 138 | sku_name = var.key_vault_sku_pricing_tier 139 | enabled_for_deployment = var.enabled_for_deployment 140 | enabled_for_disk_encryption = var.enabled_for_disk_encryption 141 | enabled_for_template_deployment = var.enabled_for_template_deployment 142 | soft_delete_retention_days = var.soft_delete_retention_days 143 | enable_rbac_authorization = var.enable_rbac_authorization 144 | purge_protection_enabled = var.enable_purge_protection 145 | tags = merge({ "ResourceName" = lower("kv-${var.key_vault_name}") }, var.tags, ) 146 | 147 | dynamic "network_acls" { 148 | for_each = var.network_acls != null ? [true] : [] 149 | content { 150 | bypass = var.network_acls.bypass 151 | default_action = var.network_acls.default_action 152 | ip_rules = var.network_acls.ip_rules 153 | virtual_network_subnet_ids = var.network_acls.virtual_network_subnet_ids 154 | } 155 | } 156 | 157 | dynamic "access_policy" { 158 | for_each = local.combined_access_policies 159 | content { 160 | tenant_id = data.azurerm_client_config.current.tenant_id 161 | object_id = access_policy.value.object_id 162 | certificate_permissions = access_policy.value.certificate_permissions 163 | key_permissions = access_policy.value.key_permissions 164 | secret_permissions = access_policy.value.secret_permissions 165 | storage_permissions = access_policy.value.storage_permissions 166 | } 167 | } 168 | 169 | dynamic "access_policy" { 170 | for_each = local.service_principal_object_id != "" ? [local.self_permissions] : [] 171 | content { 172 | tenant_id = data.azurerm_client_config.current.tenant_id 173 | object_id = access_policy.value.object_id 174 | certificate_permissions = access_policy.value.certificate_permissions 175 | key_permissions = access_policy.value.key_permissions 176 | secret_permissions = access_policy.value.secret_permissions 177 | storage_permissions = access_policy.value.storage_permissions 178 | } 179 | } 180 | 181 | dynamic "contact" { 182 | for_each = var.certificate_contacts 183 | content { 184 | email = contact.value.email 185 | name = contact.value.name 186 | phone = contact.value.phone 187 | } 188 | } 189 | 190 | lifecycle { 191 | ignore_changes = [ 192 | tags, 193 | ] 194 | } 195 | } 196 | 197 | #----------------------------------------------------------------------------------- 198 | # Keyvault Secret - Random password Creation if value is empty - Default is "false" 199 | #----------------------------------------------------------------------------------- 200 | 201 | resource "random_password" "passwd" { 202 | for_each = { for k, v in var.secrets : k => v if v == "" } 203 | length = var.random_password_length 204 | min_upper = 4 205 | min_lower = 2 206 | min_numeric = 4 207 | min_special = 4 208 | 209 | keepers = { 210 | name = each.key 211 | } 212 | } 213 | 214 | resource "azurerm_key_vault_secret" "keys" { 215 | for_each = var.secrets 216 | name = each.key 217 | value = each.value != "" ? each.value : random_password.passwd[each.key].result 218 | key_vault_id = azurerm_key_vault.main.id 219 | 220 | lifecycle { 221 | ignore_changes = [ 222 | tags, 223 | value, 224 | ] 225 | } 226 | } 227 | 228 | #--------------------------------------------------------- 229 | # Private Link for Keyvault - Default is "false" 230 | #--------------------------------------------------------- 231 | data "azurerm_virtual_network" "vnet01" { 232 | count = var.enable_private_endpoint && var.existing_vnet_id == null ? 1 : 0 233 | name = var.virtual_network_name 234 | resource_group_name = local.resource_group_name 235 | } 236 | 237 | resource "azurerm_subnet" "snet-ep" { 238 | count = var.enable_private_endpoint && var.existing_subnet_id == null ? 1 : 0 239 | name = "snet-endpoint-${local.location}" 240 | resource_group_name = var.existing_vnet_id == null ? data.azurerm_virtual_network.vnet01.0.resource_group_name : element(split("/", var.existing_vnet_id), 4) 241 | virtual_network_name = var.existing_vnet_id == null ? data.azurerm_virtual_network.vnet01.0.name : element(split("/", var.existing_vnet_id), 8) 242 | address_prefixes = var.private_subnet_address_prefix 243 | enforce_private_link_endpoint_network_policies = true 244 | } 245 | 246 | resource "azurerm_private_endpoint" "pep1" { 247 | count = var.enable_private_endpoint ? 1 : 0 248 | name = format("%s-private-endpoint", var.key_vault_name) 249 | location = local.location 250 | resource_group_name = local.resource_group_name 251 | subnet_id = var.existing_subnet_id == null ? azurerm_subnet.snet-ep.0.id : var.existing_subnet_id 252 | tags = merge({ "Name" = format("%s-private-endpoint", var.key_vault_name) }, var.tags, ) 253 | 254 | private_service_connection { 255 | name = "keyvault-privatelink" 256 | is_manual_connection = false 257 | private_connection_resource_id = azurerm_key_vault.main.id 258 | subresource_names = ["vault"] 259 | } 260 | 261 | lifecycle { 262 | ignore_changes = [ 263 | tags, 264 | ] 265 | } 266 | } 267 | 268 | data "azurerm_private_endpoint_connection" "private-ip1" { 269 | count = var.enable_private_endpoint ? 1 : 0 270 | name = azurerm_private_endpoint.pep1.0.name 271 | resource_group_name = local.resource_group_name 272 | depends_on = [azurerm_key_vault.main] 273 | } 274 | 275 | resource "azurerm_private_dns_zone" "dnszone1" { 276 | count = var.existing_private_dns_zone == null && var.enable_private_endpoint ? 1 : 0 277 | name = "privatelink.vaultcore.azure.net" 278 | resource_group_name = local.resource_group_name 279 | tags = merge({ "Name" = format("%s", "KeyVault-Private-DNS-Zone") }, var.tags, ) 280 | } 281 | 282 | resource "azurerm_private_dns_zone_virtual_network_link" "vent-link1" { 283 | count = var.enable_private_endpoint ? 1 : 0 284 | name = "vnet-private-zone-link" 285 | resource_group_name = local.resource_group_name 286 | private_dns_zone_name = var.existing_private_dns_zone == null ? azurerm_private_dns_zone.dnszone1.0.name : var.existing_private_dns_zone 287 | virtual_network_id = var.existing_vnet_id == null ? data.azurerm_virtual_network.vnet01.0.id : var.existing_vnet_id 288 | registration_enabled = true 289 | tags = merge({ "Name" = format("%s", "vnet-private-zone-link") }, var.tags, ) 290 | 291 | lifecycle { 292 | ignore_changes = [ 293 | tags, 294 | ] 295 | } 296 | } 297 | 298 | resource "azurerm_private_dns_a_record" "arecord1" { 299 | count = var.enable_private_endpoint ? 1 : 0 300 | name = azurerm_key_vault.main.name 301 | zone_name = var.existing_private_dns_zone == null ? azurerm_private_dns_zone.dnszone1.0.name : var.existing_private_dns_zone 302 | resource_group_name = local.resource_group_name 303 | ttl = 300 304 | records = [data.azurerm_private_endpoint_connection.private-ip1.0.private_service_connection.0.private_ip_address] 305 | } 306 | 307 | #--------------------------------------------------- 308 | # azurerm monitoring diagnostics - KeyVault 309 | #--------------------------------------------------- 310 | resource "azurerm_monitor_diagnostic_setting" "diag" { 311 | count = var.log_analytics_workspace_id != null ? 1 : 0 312 | name = lower(format("%s-diag", azurerm_key_vault.main.name)) 313 | target_resource_id = azurerm_key_vault.main.id 314 | log_analytics_workspace_id = var.log_analytics_workspace_id 315 | storage_account_id = var.storage_account_id != null ? var.storage_account_id : null 316 | 317 | dynamic "log" { 318 | for_each = var.kv_diag_logs 319 | content { 320 | category = log.value 321 | enabled = true 322 | 323 | retention_policy { 324 | enabled = false 325 | days = 0 326 | } 327 | } 328 | } 329 | 330 | metric { 331 | category = "AllMetrics" 332 | enabled = true 333 | 334 | retention_policy { 335 | enabled = false 336 | } 337 | } 338 | } 339 | -------------------------------------------------------------------------------- /output.tf: -------------------------------------------------------------------------------- 1 | output "key_vault_id" { 2 | description = "The ID of the Key Vault." 3 | value = azurerm_key_vault.main.id 4 | } 5 | 6 | output "key_vault_name" { 7 | description = "Name of key vault created." 8 | value = azurerm_key_vault.main.name 9 | } 10 | 11 | output "key_vault_uri" { 12 | description = "The URI of the Key Vault, used for performing operations on keys and secrets." 13 | value = azurerm_key_vault.main.vault_uri 14 | } 15 | 16 | output "secrets" { 17 | description = "A mapping of secret names and URIs." 18 | value = { for k, v in azurerm_key_vault_secret.keys : v.name => v.id } 19 | } 20 | 21 | output "Key_vault_references" { 22 | description = "A mapping of Key Vault references for App Service and Azure Functions." 23 | value = { 24 | for k, v in azurerm_key_vault_secret.keys : 25 | v.name => format("@Microsoft.KeyVault(SecretUri=%s)", v.id) 26 | } 27 | } 28 | 29 | output "key_vault_private_endpoint" { 30 | description = "The ID of the Key Vault Private Endpoint" 31 | value = var.enable_private_endpoint ? element(concat(azurerm_private_endpoint.pep1.*.id, [""]), 0) : null 32 | } 33 | 34 | output "key_vault_private_dns_zone_domain" { 35 | description = "DNS zone name for Key Vault Private endpoints dns name records" 36 | value = var.existing_private_dns_zone == null && var.enable_private_endpoint ? element(concat(azurerm_private_dns_zone.dnszone1.*.name, [""]), 0) : var.existing_private_dns_zone 37 | } 38 | 39 | output "key_vault_private_endpoint_ip_addresses" { 40 | description = "Key Vault private endpoint IPv4 Addresses" 41 | value = var.enable_private_endpoint ? flatten(azurerm_private_endpoint.pep1.0.custom_dns_configs.*.ip_addresses) : null 42 | } 43 | 44 | output "key_vault_private_endpoint_fqdn" { 45 | description = "Key Vault private endpoint FQDN Addresses" 46 | value = var.enable_private_endpoint ? flatten(azurerm_private_endpoint.pep1.0.custom_dns_configs.*.fqdn) : null 47 | } -------------------------------------------------------------------------------- /variables.tf: -------------------------------------------------------------------------------- 1 | variable "create_resource_group" { 2 | description = "Whether to create resource group and use it for all networking resources" 3 | default = false 4 | } 5 | 6 | variable "resource_group_name" { 7 | description = "A container that holds related resources for an Azure solution" 8 | default = "" 9 | } 10 | 11 | variable "location" { 12 | description = "The location/region to keep all your network resources. To get the list of all locations with table format from azure cli, run 'az account list-locations -o table'" 13 | default = "" 14 | } 15 | 16 | variable "key_vault_name" { 17 | description = "The Name of the key vault" 18 | default = "" 19 | } 20 | 21 | variable "key_vault_sku_pricing_tier" { 22 | description = "The name of the SKU used for the Key Vault. The options are: `standard`, `premium`." 23 | default = "standard" 24 | } 25 | 26 | variable "enabled_for_deployment" { 27 | description = "Allow Virtual Machines to retrieve certificates stored as secrets from the key vault." 28 | default = true 29 | } 30 | 31 | variable "enabled_for_disk_encryption" { 32 | description = "Allow Disk Encryption to retrieve secrets from the vault and unwrap keys." 33 | default = true 34 | } 35 | 36 | variable "enabled_for_template_deployment" { 37 | description = "Allow Resource Manager to retrieve secrets from the key vault." 38 | default = true 39 | } 40 | 41 | variable "enable_rbac_authorization" { 42 | description = "Specify whether Azure Key Vault uses Role Based Access Control (RBAC) for authorization of data actions" 43 | default = false 44 | } 45 | 46 | variable "enable_purge_protection" { 47 | description = "Is Purge Protection enabled for this Key Vault?" 48 | default = false 49 | } 50 | 51 | variable "soft_delete_retention_days" { 52 | description = "The number of days that items should be retained for once soft-deleted. The valid value can be between 7 and 90 days" 53 | default = 90 54 | } 55 | 56 | variable "access_policies" { 57 | description = "List of access policies for the Key Vault." 58 | default = [] 59 | } 60 | 61 | variable "network_acls" { 62 | description = "Network rules to apply to key vault." 63 | type = object({ 64 | bypass = string 65 | default_action = string 66 | ip_rules = list(string) 67 | virtual_network_subnet_ids = list(string) 68 | }) 69 | default = null 70 | } 71 | 72 | variable "secrets" { 73 | type = map(string) 74 | description = "A map of secrets for the Key Vault." 75 | default = {} 76 | } 77 | 78 | variable "random_password_length" { 79 | description = "The desired length of random password created by this module" 80 | default = 32 81 | } 82 | 83 | variable "certificate_contacts" { 84 | description = "Contact information to send notifications triggered by certificate lifetime events" 85 | type = list(object({ 86 | email = string 87 | name = optional(string) 88 | phone = optional(string) 89 | })) 90 | default = [] 91 | } 92 | 93 | variable "enable_private_endpoint" { 94 | description = "Manages a Private Endpoint to Azure Container Registry" 95 | default = false 96 | } 97 | 98 | variable "virtual_network_name" { 99 | description = "The name of the virtual network" 100 | default = "" 101 | } 102 | 103 | variable "existing_vnet_id" { 104 | description = "The resoruce id of existing Virtual network" 105 | default = null 106 | } 107 | 108 | variable "existing_subnet_id" { 109 | description = "The resource id of existing subnet" 110 | default = null 111 | } 112 | 113 | variable "existing_private_dns_zone" { 114 | description = "Name of the existing private DNS zone" 115 | default = null 116 | } 117 | 118 | variable "private_subnet_address_prefix" { 119 | description = "address prefix of the subnet for private endpoints" 120 | default = null 121 | } 122 | 123 | variable "log_analytics_workspace_id" { 124 | description = "Specifies the ID of a Log Analytics Workspace where Diagnostics Data to be sent" 125 | default = null 126 | } 127 | 128 | variable "storage_account_id" { 129 | description = "The name of the storage account to store the all monitoring logs" 130 | default = null 131 | } 132 | 133 | variable "kv_diag_logs" { 134 | description = "Keyvault Monitoring Category details for Azure Diagnostic setting" 135 | default = ["AuditEvent", "AzurePolicyEvaluationDetails"] 136 | } 137 | 138 | variable "tags" { 139 | description = "A map of tags to add to all resources" 140 | type = map(string) 141 | default = {} 142 | } 143 | -------------------------------------------------------------------------------- /versions.tf: -------------------------------------------------------------------------------- 1 | terraform { 2 | experiments = [module_variable_optional_attrs] 3 | required_providers { 4 | azuread = { 5 | source = "hashicorp/azuread" 6 | version = ">= 2.7.0" 7 | } 8 | azurerm = { 9 | source = "hashicorp/azurerm" 10 | version = ">= 2.59.0" 11 | } 12 | random = { 13 | source = "hashicorp/random" 14 | version = ">= 3.1.0" 15 | } 16 | } 17 | required_version = ">= 0.13" 18 | } 19 | --------------------------------------------------------------------------------