azure.azcollection.azure_rm_containerregistry_info (2.3.0) — module

Get Azure Container Registry facts

| "added in version" 0.1.2 of azure.azcollection"

Authors: Zim Kalinowski (@zikalino)

Install collection

Install with ansible-galaxy collection install azure.azcollection:==2.3.0


Add to requirements.yml

  collections:
    - name: azure.azcollection
      version: 2.3.0

Description

Get facts for Container Registry.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get instance of Registry
  azure_rm_containerregistry_info:
    resource_group: myResourceGroup
    name: myRegistry
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List instances of Registry
  azure_rm_containerregistry_info:
    resource_group: myResourceGroup
    tags:
      - key
      - key:value

Inputs

    
name:
    description:
    - The name of the container registry.
    type: str

tags:
    description:
    - List of tags to be matched.
    - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
    elements: str
    type: list

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

log_mode:
    description:
    - Parent argument.
    type: str

log_path:
    description:
    - Parent argument.
    type: str

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 or Managed Identity
      (msi).
    - Can also be set via the C(AZURE_CLIENT_ID) environment variable.
    type: str

thumbprint:
    description:
    - The thumbprint of the private key specified in I(x509_certificate_path).
    - Use when authenticating with a Service Principal.
    - Required if I(x509_certificate_path) is defined.
    type: str
    version_added: 1.14.0
    version_added_collection: azure.azcollection

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

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:
    - The name of the resource group to which the container registry belongs.
    type: str

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

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

retrieve_credentials:
    default: false
    description:
    - Retrieve credentials for container registry.
    type: bool

x509_certificate_path:
    description:
    - Path to the X509 certificate used to create the service principal in PEM format.
    - The certificate must be appended to the private key.
    - Use when authenticating with a Service Principal.
    type: path
    version_added: 1.14.0
    version_added_collection: azure.azcollection

disable_instance_discovery:
    default: false
    description:
    - Determines whether or not instance discovery is performed when attempting to authenticate.
      Setting this to true will completely disable both instance discovery and authority
      validation. This functionality is intended for use in scenarios where the metadata
      endpoint cannot be reached such as in private clouds or Azure Stack. The process
      of instance discovery entails retrieving authority metadata from https://login.microsoft.com/
      to validate the authority. By setting this to **True**, the validation of the authority
      is disabled. As a result, it is crucial to ensure that the configured authority
      host is valid and trustworthy.
    - Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
      variable.
    type: bool
    version_added: 2.3.0
    version_added_collection: azure.azcollection

Outputs

registries:
  contains:
    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
        username:
          description:
          - The user name for container registry.
          returned: when registry exists and C(admin_user_enabled) is set
          sample: zim
          type: str
      description:
      - Credentials, fields will be empty if admin user is not enabled for ACR.
      returned: when C(retrieve_credentials) is set and C(admin_user_enabled) is set
        on ACR
      type: complex
    id:
      description:
      - The resource ID.
      returned: always
      sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registr
        ies/myRegistry
      type: str
    location:
      description:
      - The location of the resource. This cannot be changed after the resource is
        created.
      returned: always
      sample: westus
      type: str
    login_server:
      description:
      - Login server for the registry.
      returned: always
      sample: acrd08521b.azurecr.io
      type: str
    name:
      description:
      - The name of the resource.
      returned: always
      sample: myRegistry
      type: str
    provisioning_state:
      description:
      - Provisioning state of the container registry.
      returned: always
      sample: Succeeded
      type: str
    sku:
      description:
      - The SKU name of the container registry.
      returned: always
      sample: Premium
      type: str
    tags:
      description:
      - Tags assigned to the resource. Dictionary of string:string pairs.
      sample:
        tag1: abc
      type: dict
  description:
  - A list of dictionaries containing facts for registries.
  returned: always
  type: complex

See also