1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
# Ansible collection for Azure
[](https://docs.ansible.com/ansible/latest/modules/list_of_cloud_modules.html#azure)
[](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
[](LICENSE)
This collection provides a series of Ansible modules and plugins for interacting with the [Azure](https://azure.microsoft.com).
Documentation of individual modules is [available in the Ansible docs site](https://docs.ansible.com/ansible/latest/collections/azure/azcollection/index.html#plugins-in-azure-azcollection)
## Installation
It is recommended to run ansible in [Virtualenv](https://virtualenv.pypa.io/en/latest/)
## Requirements
- ansible version >= 2.9
To install Azure collection hosted in Galaxy:
```bash
ansible-galaxy collection install azure.azcollection
```
Install dependencies required by the collection (adjust path to collection if necessary):
```bash
pip3 install -r ~/.ansible/collections/ansible_collections/azure/azcollection/requirements-azure.txt
```
To upgrade to the latest version of Azure collection:
```bash
ansible-galaxy collection install azure.azcollection --force
```
## Usage
### Playbooks
To use a module from Azure collection, please reference the full namespace, collection name, and modules name that you want to use:
```yaml
---
- name: Using Azure collection
hosts: localhost
tasks:
- azure.azcollection.azure_rm_storageaccount:
resource_group: myResourceGroup
name: mystorageaccount
account_type: Standard_LRS
```
Or you can add full namepsace and collection name in the `collections` element:
```yaml
---
- name: Using Azure collection
hosts: localhost
collections:
- azure.azcollection
tasks:
- azure_rm_storageaccount:
resource_group: myResourceGroup
name: mystorageaccount
account_type: Standard_LRS
```
### Roles
For existing Ansible roles, please also reference the full namespace, collection name, and modules name which used in tasks instead of just modules name.
### Plugins
To use a plugin from Azure collection, please reference the full namespace, collection name, and plugins name that you want to use:
```yaml
---
plugin: azure.azcollection.azure_rm
include_vm_resource_groups:
- ansible-inventory-test-rg
auth_source: auto
```
## Contributing
There are many ways in which you can participate in the project, for example:
- Submit bugs and feature requests, and help us verify as they are checked in
- Review source code changes
- Review the documentation and make pull requests for anything from typos to new content
- If you are interested in fixing issues and contributing directly to the code base, please see the [CONTRIBUTING](CONTRIBUTING.md) document
## License
GNU General Public License v3.0
See [LICENSE](LICENSE) to see the full text.
|
