diff options
Diffstat (limited to 'collections-debian-merged/ansible_collections/azure/azcollection/README.md')
| -rw-r--r-- | collections-debian-merged/ansible_collections/azure/azcollection/README.md | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/collections-debian-merged/ansible_collections/azure/azcollection/README.md b/collections-debian-merged/ansible_collections/azure/azcollection/README.md new file mode 100644 index 00000000..98874709 --- /dev/null +++ b/collections-debian-merged/ansible_collections/azure/azcollection/README.md @@ -0,0 +1,94 @@ +# 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) + +## Requirements + +- ansible version >= 2.9 + +## Installation + +To install Azure dependencies: + +```bash +pip install -r requirements-azure.txt +``` + +To install Azure collection hosted in Galaxy: + +```bash +ansible-galaxy collection install azure.azcollection +``` + +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 collecton 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 pluign 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. |