community.azure.azure_rm_devtestlabartifact_facts (0.1.0) — module

Get Azure DevTest Lab Artifact facts

Authors: Zim Kalinowski (@zikalino)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.azure:==0.1.0


Add to requirements.yml

  collections:
    - name: community.azure
      version: 0.1.0

Description

Get facts of Azure DevTest Lab Artifact.


Requirements

Usage examples

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

Inputs

    
name:
    description:
    - The name of the artifact.
    type: str

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 the 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: '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

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: '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

artifact_source_name:
    description:
    - The name of the artifact source.
    required: true
    type: str

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

artifacts:
  contains:
    artifact_source_name:
      description:
      - The name of the artifact source.
      returned: always
      sample: myArtifactSource
      type: str
    description:
      description:
      - Description of the artifact.
      returned: always
      sample: Installs My Software
      type: str
    file_path:
      description:
      - Artifact's path in the repo.
      returned: always
      sample: Artifacts/myArtifact
      type: str
    id:
      description:
      - The identifier of the artifact.
      returned: always
      sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/ar
        tifactSources/myArtifactSource/artifacts/myArtifact
      type: str
    lab_name:
      description:
      - Name of the lab.
      returned: always
      sample: myLab
      type: str
    name:
      description:
      - The name of the artifact.
      returned: always
      sample: myArtifact
      type: str
    parameters:
      description:
      - A dictionary containing parameters definition of the artifact.
      returned: always
      sample: {}
      type: complex
    publisher:
      description:
      - Publisher name.
      returned: always
      sample: MyPublisher
      type: str
    resource_group:
      description:
      - Name of the resource group.
      returned: always
      sample: myResourceGroup
      type: str
    target_os_type:
      description:
      - Target OS type.
      returned: always
      sample: Linux
      type: str
    title:
      description:
      - Title of the artifact.
      returned: always
      sample: My Software
      type: str
  description:
  - A list of dictionaries containing facts for DevTest Lab Artifact.
  returned: always
  type: complex

See also