ansible.builtin.azure_rm_devtestlabartifactsource_info (v2.9.17) — module

Get Azure DevTest Lab Artifact Source facts

| "added in version" 2.9 of ansible.builtin"

Authors: Zim Kalinowski (@zikalino)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Get facts of Azure DevTest Lab Artifact Source.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get instance of DevTest Lab Artifact Source
    azure_rm_devtestlabartifactsource_info:
      resource_group: myResourceGroup
      lab_name: myLab
      name: myArtifactSource

Inputs

    
name:
    description:
    - The name of DevTest Lab Artifact Source.
    type: str

tags:
    description:
    - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
    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

lab_name:
    description:
    - The name of DevTest Lab.
    required: true
    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: 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.
    required: true
    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

Outputs

artifactsources:
  contains:
    arm_template_folder_path:
      description:
      - The folder containing Azure Resource Manager templates.
      returned: always
      sample: /Environments
      type: str
    display_name:
      description:
      - The artifact source's display name.
      returned: always
      sample: Public Artifact Repo
      type: str
    folder_path:
      description:
      - The folder containing artifacts.
      returned: always
      sample: /Artifacts
      type: str
    id:
      description:
      - The identifier of the artifact source.
      returned: always
      sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/ar
        tifactSources/myArtifactSource
      type: str
    is_enabled:
      description:
      - Is the artifact source enabled.
      returned: always
      sample: true
      type: str
    lab_name:
      description:
      - Name of the lab.
      returned: always
      sample: myLab
      type: str
    name:
      description:
      - The name of the artifact source.
      returned: always
      sample: myArtifactSource
      type: str
    provisioning_state:
      description:
      - Provisioning state of artifact source.
      returned: always
      sample: Succeeded
      type: str
    resource_group:
      description:
      - Name of the resource group.
      returned: always
      sample: myResourceGroup
      type: str
    source_type:
      description:
      - The artifact source's type.
      returned: always
      sample: github
      type: str
    tags:
      description:
      - The tags of the resource.
      returned: always
      sample: '{ ''MyTag'': ''MyValue'' }'
      type: complex
    uri:
      description:
      - URI of the artifact source.
      returned: always
      sample: https://github.com/Azure/azure-devtestlab.git
      type: str
  description:
  - A list of dictionaries containing facts for DevTest Lab Artifact Source.
  returned: always
  type: complex

See also