ansible / ansible.builtin / v2.9.17 / module / azure_rm_containerregistry Manage an Azure Container Registry | "added in version" 2.5 of ansible.builtin" Authors: Yawei Wang (@yaweiw) preview | supported by communityansible.builtin.azure_rm_containerregistry (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Create, update and delete an Azure Container Registry.
- name: Create an azure container registry azure_rm_containerregistry: name: myRegistry location: eastus resource_group: myResourceGroup admin_user_enabled: true sku: Premium tags: Release: beta1 Environment: Production
- name: Remove an azure container registry azure_rm_containerregistry: name: myRegistry resource_group: myResourceGroup state: absent
sku: choices: - Basic - Standard - Premium default: Standard description: - Specifies the SKU to use. Currently can be either C(Basic), C(Standard) or C(Premium). name: description: - Name of the Container Registry. required: true tags: description: - 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. type: dict state: choices: - absent - present default: present description: - Assert the state of the container registry. Use C(present) to create or update an container registry and C(absent) to delete it. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str location: description: - Valid azure location. Defaults to location of the resource group. password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - 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. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. - When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. - The C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection resource_group: description: - Name of a resource group where the Container Registry exists or will be created. required: true subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection admin_user_enabled: default: false description: - If enabled, you can use the registry name as username and admin user access key as password to docker login to your container registry. type: bool cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection
admin_user_enabled: description: - Is admin user enabled. returned: always sample: true type: bool credentials: contains: password: description: - password value. returned: when registry exists and C(admin_user_enabled) is set sample: pass1value type: str password2: description: - password2 value. returned: when registry exists and C(admin_user_enabled) is set sample: pass2value type: str description: - Passwords defined for the registry. returned: always type: complex id: description: - Resource ID. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry type: str location: description: - Resource location. returned: always sample: westus type: str login_server: description: - Registry login server. returned: always sample: myregistry.azurecr.io type: str name: description: - Registry name. returned: always sample: myregistry type: str provisioning_state: description: - Provisioning state. returned: always sample: Succeeded type: str sku: description: - The SKU name of the container registry. returned: always sample: Standard type: str tags: description: - Tags assigned to the resource. Dictionary of string:string pairs. returned: always type: dict