ansible / ansible.builtin / v2.7.16 / module / azure_rm_virtualmachine_scaleset_facts Get Virtual Machine Scale Set facts | "added in version" 2.4 of ansible.builtin" Authors: Sertac Ozercan (@sozercan) preview | supported by communityansible.builtin.azure_rm_virtualmachine_scaleset_facts (v2.7.16) — module
pip
Install with pip install ansible==2.7.16
Get facts for a virtual machine scale set
- name: Get facts for a virtual machine scale set azure_rm_virtualmachine_scaleset_facts: resource_group: Testing name: testvmss001 format: curated
- name: Get facts for all virtual networks azure_rm_virtualmachine_scaleset_facts: resource_group: Testing
- name: Get facts by tags azure_rm_virtualmachine_scaleset_facts: resource_group: Testing tags: - testing
name: description: - Limit results to a specific virtual machine scale set tags: description: - List of tags to be matched format: choices: - curated - raw default: raw description: - Format of the data returned. - If C(raw) is selected information will be returned in raw format from Azure Python SDK. - If C(curated) is selected the structure will be identical to input parameters of azure_rm_virtualmachine_scaleset module. - In Ansible 2.5 and lower facts are always returned in raw format. - Please note that this option will be deprecated in 2.10 when curated format will become the only supported format. version_added: '2.6' version_added_collection: ansible.builtin 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. 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: - The resource group to search for the desired virtual machine scale set 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
vmss: contains: admin_username: description: - Admin username used to access the host after it is created. returned: always sample: adminuser type: str capacity: description: - Capacity of VMSS. returned: always sample: 2 type: int data_disks: contains: caching: description: - Type of data disk caching. sample: ReadOnly type: str disk_size_gb: description: - The initial disk size in GB for blank data disks sample: 64 type: int lun: description: - The logical unit number for data disk sample: 0 type: int managed_disk_type: description: - Managed data disk type sample: Standard_LRS type: str description: - List of attached data disks. returned: always type: complex image: contains: offer: description: - Offer. sample: RHEL type: str publisher: description: - Publisher name. sample: RedHat type: str sku: description: - SKU name. sample: 7-RAW type: str version: description: - Image version. sample: 7.5.2018050901 type: str description: - Image specification returned: always type: complex load_balancer: description: - Load balancer name. returned: always sample: testlb type: str location: description: - Resource location. returned: always sample: japaneast type: str managed_disk_type: description: - Managed data disk type returned: always sample: Standard_LRS type: str name: description: - Resource name. returned: always sample: myvmss type: str os_disk_caching: description: - Type of OS disk caching. returned: always sample: ReadOnly type: str os_type: description: - Base type of operating system. returned: always sample: Linux type: str resource_group: description: - Resource group. returned: always sample: testrg type: str ssh_password_enabled: description: - Is SSH password authentication enabled. Valid only for Linux. returned: always sample: true type: bool subnet_name: description: - Subnet name. returned: always sample: testsubnet type: str tier: description: - SKU Tier. returned: always sample: Basic type: str upgrade_policy: description: - Upgrade policy. returned: always sample: Manual type: str virtual_network_name: description: - Associated virtual network name. returned: always sample: testvn type: str vm_size: description: - Virtual machine size. returned: always sample: Standard_D4 type: str description: List of virtual machine scale sets returned: always type: complex