azure.azcollection.azure_rm_adpassword (0.3.0) — module

Manage application password

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

Authors: haiyuan_zhang (@haiyuazhang) Fred-sun (@Fred-sun)

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

Manage application password.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: create ad password
      azure_rm_adpassword:
        app_id: "{{ app_id }}"
        state: present
        value: "$abc12345678"
        tenant: "{{ tenant_id }}"

Inputs

    
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 Active Dirctory Password.
    - Use C(present) to create or update a Password and use C(absent) to delete.
    - Update is not supported, if I(state=absent) and I(key_id=None), then all passwords
      of the application will be deleted.
    type: str

value:
    description:
    - The application password value.
    - Length greater than 18 characters.
    type: str

app_id:
    description:
    - The application ID.
    type: str

key_id:
    description:
    - The password key ID.
    type: str

secret:
    description:
    - Azure client secret. Use when authenticating with a Service Principal.
    type: str

tenant:
    description:
    - The tenant ID.
    required: true
    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

end_date:
    description:
    - Date or datemtime after which credentials expire.
    - Default value is one year after current time.
    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

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

app_object_id:
    description:
    - The application object ID.
    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

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

service_principal_object_id:
    description:
    - The service principal object ID.
    type: str

Outputs

end_date:
  description:
  - Date or datemtime after which credentials expire.
  - Default value is one year after current time.
  returned: always
  sample: '2021-06-28T06:00:32.637070+00:00'
  type: str
key_id:
  description:
  - The password key ID
  returned: always
  sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  type: str
start_date:
  description:
  - Date or datetime at which credentials become valid.
  - Default value is current time.
  returned: always
  sample: '2020-06-28T06:00:32.637070+00:00'
  type: str

See also