azure.azcollection.azure_rm_containerregistryreplication_facts (0.3.0) — module

Get Replication facts.

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

Authors: Zim Kalinowski (@zikalino)

preview | supported by community

Install collection

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


Add to requirements.yml

  collections:
    - name: azure.azcollection
      version: 0.3.0

Description

Get facts of Replication.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get instance of Replication
    azure_rm_containerregistryreplication_facts:
      resource_group: resource_group_name
      registry_name: registry_name
      replication_name: replication_name

Inputs

    
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

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: '2.5'
    version_added_collection: azure.azcollection

auth_source:
    choices:
    - auto
    - cli
    - credential_file
    - env
    - msi
    description:
    - 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 C(auto) if variable is not defined.
    - C(auto) will follow the default precedence of module parameters -> environment variables
      -> default profile in credential file C(~/.azure/credentials).
    - When set to C(cli), the credentials will be sources from the default Azure CLI profile.
    - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
    - 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: '2.5'
    version_added_collection: azure.azcollection

registry_name:
    description:
    - The name of the container registry.
    required: true

resource_group:
    description:
    - The name of the resource group to which the container registry belongs.
    required: true

subscription_id:
    description:
    - Your Azure subscription Id.
    type: str

replication_name:
    description:
    - The name of the replication.
    required: true

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: '2.4'
    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: '2.6'
    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: '2.5'
    version_added_collection: azure.azcollection

Outputs

replications:
  contains:
    replication_name:
      contains:
        id:
          description:
          - The resource ID.
          returned: always
          sample: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registr
            ies/myRegistry/replications/myReplication
          type: str
        location:
          description:
          - The location of the resource. This cannot be changed after the resource
            is created.
          returned: always
          sample: eastus
          type: str
        name:
          description:
          - The name of the resource.
          returned: always
          sample: myReplication
          type: str
        status:
          contains:
            message:
              description:
              - The detailed message for the status, including alerts and error messages.
              returned: null
              sample: The replication is ready.
              type: str
            timestamp:
              description:
              - The timestamp when the status was changed to the current value.
              returned: always
              sample: '2017-03-01T23:15:37.0707808Z'
              type: datetime
          description:
          - The status of the replication at the time the operation was called.
          returned: always
          sample: status
          type: complex
        type:
          description:
          - The type of the resource.
          returned: always
          sample: Microsoft.ContainerRegistry/registries/replications
          type: str
      description: The key is the name of the server that the values relate to.
      type: complex
  description: A list of dict results where the key is the name of the Replication
    and the values are the facts for that Replication.
  returned: always
  type: complex

See also