azure / azure.azcollection / 0.3.0 / module / azure_rm_virtualmachinescalesetinstance Get Azure Virtual Machine Scale Set Instance facts | "added in version" 2.8 of azure.azcollection" Authors: Zim Kalinowski (@zikalino) preview | supported by communityazure.azcollection.azure_rm_virtualmachinescalesetinstance (0.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==0.3.0
collections: - name: azure.azcollection version: 0.3.0
Get facts of Azure Virtual Machine Scale Set VMs.
- name: Upgrade instance to the latest image azure_rm_virtualmachinescalesetinstance: resource_group: myResourceGroup vmss_name: myVMSS instance_id: "2" latest_model: yes
- name: Turn on protect from scale in azure_rm_virtualmachinescalesetinstance: resource_group: myResourceGroup vmss_name: myVMSS instance_id: "2" protect_from_scale_in: true
state: choices: - absent - present default: present description: - State of the VMSS instance. Use C(present) to update an instance and C(absent) to delete an instance. 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 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 vmss_name: description: - The name of the VM scale set. required: true 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 instance_id: description: - The instance ID of the virtual machine. required: true power_state: choices: - running - stopped - deallocated description: - Use this option to change power state of the instance. latest_model: description: - Set to C(yes) to upgrade to the latest model. type: bool resource_group: description: - The name of the resource group. required: true 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 protect_from_scale_in: description: - turn on/off instance protection from scale in type: bool version_added: '2.10' version_added_collection: azure.azcollection protect_from_scale_set_actions: description: - tun on/off instance protection from scale set actions type: bool version_added: '2.10' version_added_collection: azure.azcollection
instances: contains: id: description: - Instance resource ID. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.Compute/scalesets/myscaleset/vms/myvm type: str description: - A list of instances. returned: always type: complex