azure_rm_containerregistry – Manage an Azure Container Registry.
azure_rm_containerregistry – Manage an Azure Container Registry.
New in version 2.5.
Synopsis
- Create, update and delete an Azure Container Registry.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
ad_user - |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
adfs_authority_url - added in 2.6 |
Default: null |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
admin_user_enabled boolean |
|
If enabled, you can use the registry name as username and admin user access key as password to docker login to your container registry. |
api_profile - added in 2.5 |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of |
append_tags boolean |
|
Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. |
auth_source - added in 2.5 |
|
Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to
When set to Can also be set via the When set to The |
cert_validation_mode - added in 2.5 |
|
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing |
client_id - |
Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment - added in 2.4 |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, |
location - |
Valid azure location. Defaults to location of the resource group. | |
name - / required |
Name of the Container Registry. | |
password - |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
profile - |
Security profile found in ~/.azure/credentials file. | |
resource_group - / required |
Name of a resource group where the Container Registry exists or will be created. | |
secret - |
Azure client secret. Use when authenticating with a Service Principal. | |
sku - |
|
Specifies the SKU to use. Currently can be either Basic, Standard or Premium. |
state - |
|
Assert the state of the container registry. Use 'present' to create or update an container registry and 'absent' to delete it. |
subscription_id - |
Your Azure subscription Id. | |
tags - |
Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. | |
tenant - |
Azure tenant ID. Use when authenticating with a Service Principal. |
Notes
Note
- For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is possible using a service principal or Active Directory user. To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
- To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
- Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
Examples
- name: Create an azure container registry
azure_rm_containerregistry:
name: testacr1
location: eastus
resource_group: testrg
state: present
admin_user_enabled: true
sku: Premium
tags:
Release: beta1
Environment: Production
- name: Remove an azure container registry
azure_rm_containerregistry:
name: testacr2
resource_group: testrg
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
admin_user_enabled boolean |
always |
Is admin user enabled
Sample: True | |
credentials complex |
always |
Passwords defined for the registry
| |
password string |
when registry exists and admin_user_enabled is set
|
password value
Sample: pass1value | |
password2 string |
when registry exists and admin_user_enabled is set
|
password2 value
Sample: pass2value | |
id string |
always |
Resource ID
Sample: /subscriptions/00000000-0000-0000-0000-000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry | |
location string |
always |
Resource location
Sample: westus | |
login_server string |
always |
Registry login server
Sample: myregistry.azurecr.io | |
name string |
always |
Registry name
Sample: myregistry | |
provisioning_state string |
always |
Provisioning state
Sample: Succeeded | |
sku string |
always |
SKU
Sample: Standard | |
tags dictionary |
always |
Tags
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Yawei Wang (@yaweiw)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_containerregistry_module.html