azure.azcollection.azure_rm_manageddisk_info (2.3.0) — module

Get managed disk facts

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

Authors: Bruno Medina (@brusMX), Paul Aiton (@paultaiton)

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 a specific managed disk or all managed disks.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get facts for one managed disk
  azure_rm_manageddisk_info:
    name: Testing
    resource_group: myResourceGroup
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get facts for all managed disks
  azure_rm_manageddisk_info:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get facts for all managed disks managed by a specific vm
  azure_rm_manageddisk_info:
    managed_by: '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rgName/Microsoft.Compute/virtualMachines/vmName'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get facts by tags
  azure_rm_manageddisk_info:
    tags:
      - testing

Inputs

    
name:
    description:
    - Limit results to a specific managed disk.
    type: str

tags:
    description:
    - 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

managed_by:
    description:
    - Limit results to disks managed by the given VM fqid.
    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:
    - Limit results to a specific resource group.
    - Required if I(name) is set
    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

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

azure_managed_disk:
  contains:
    create_option:
      description:
      - Create option of the disk.
      sample: copy
      type: str
    disk_size_gb:
      description:
      - Size in GB of the managed disk to be created.
      type: str
    id:
      description:
      - Resource id.
      type: str
    location:
      description:
      - Valid Azure location.
      type: str
    managed_by:
      description:
      - Name of an existing virtual machine with which the disk is or will be associated,
        this VM should be in the same resource group.
      sample: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachines/testVM
      type: str
    managed_by_extended:
      description:
      - List ID of an existing virtual machine with which the disk is or will be associated.
      sample:
      - /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachines/testVM
      type: list
    max_shares:
      description:
      - The maximum number of VMs that can attach to the disk at the same time.
      - Value greater than one indicates a disk that can be mounted on multiple VMs
        at the same time.
      sample: 3
      type: int
    name:
      description:
      - Name of the managed disk.
      type: str
    os_type:
      choices:
      - linux
      - windows
      description:
      - Type of Operating System.
      type: str
    source_uri:
      description:
      - URI to a valid VHD file to be used or the resource ID of the managed disk
        to copy.
      type: str
    storage_account_type:
      description:
      - Type of storage for the managed disk.
      - See U(https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types)
        for more information about this type.
      sample: Standard_LRS
      type: str
    tags:
      description:
      - Tags to assign to the managed disk.
      sample:
        tag: value
      type: dict
  description:
  - List of managed disk dicts.
  returned: always
  type: list

See also