azure.azcollection.azure_rm_cognitivesearch_info module – Get Azure Cognitive Search service info

Note

This module is part of the azure.azcollection collection (version 3.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_cognitivesearch_info.

New in azure.azcollection 1.4.0

Synopsis

• Get info for a specific Azure Cognitive Search service or all Azure Cognitive Search service within a resource group.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7

• The host that executes this module must have the azure.azcollection collection installed via galaxy

• All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection

• Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter	Comments
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in azure.azcollection 0.0.1	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in azure.azcollection 0.0.1	Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack. Default: "latest"
auth_source string added in azure.azcollection 0.0.1	Controls the source of the credentials to use for authentication. Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable. When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli. When set to env, the credentials will be read from the environment variables When set to credential_file, it will read the profile from ~/.azure/credentials. When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable 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 msi was added in Ansible 2.6. Choices: "auto" ← (default) "cli" "credential_file" "env" "msi"
cert_validation_mode string added in azure.azcollection 0.0.1	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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. Choices: "ignore" "validate"
client_id string	Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the AZURE_CLIENT_ID environment variable.
cloud_environment string added in azure.azcollection 0.0.1	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable. Default: "AzureCloud"
disable_instance_discovery boolean added in azure.azcollection 2.3.0	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 AZURE_DISABLE_INSTANCE_DISCOVERY environment variable. Choices: false ← (default) true
log_mode string	Parent argument.
log_path string	Parent argument.
name string	The name of the Azure Cognitive Search service.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string	The name of the Azure resource group.
secret string	Azure client secret. Use when authenticating with a Service Principal.
show_keys boolean	Retrieve admin and query keys. Choices: false ← (default) true
subscription_id string	Your Azure subscription Id.
tenant string	Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint string added in azure.azcollection 1.14.0	The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined.
x509_certificate_path path added in azure.azcollection 1.14.0	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.

Notes

Note

• For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

• Authentication is also possible using a service principal or Active Directory user.

• To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

• To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

• Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Get Azure Cognitive Search info from resource group 'myResourceGroup' and name 'myAzureSearch'
  azure_rm_cognitivesearch_info:
    resource_group: myResourceGroup
    name: myAzureSearch

- name: Get Azure Cognitive Search info from resource group 'myResourceGroup'
  azure_rm_cognitivesearch_info:
    resource_group: myResourceGroup

- name: Get all Azure Cognitive Search info
  azure_rm_cognitivesearch_info:

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
search list / elements=string	Info for Azure Cognitive Search. Returned: always
hosting_mode string	Type of hosting mode selected. Returned: always Sample: "default"
id string	The unique identifier associated with this Azure Cognitive Search. Returned: always Sample: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity dictionary	The identity of the Azure Cognitive Search Service. Returned: always Sample: {"principal_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "type": "SystemAssigned"}
principal_id string	Identifier assigned. Returned: success Sample: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
type string	Identity type. Returned: always Sample: "SystemAssigned"
keys dictionary	Admin and query keys for Azure Cognitive Search Service. Returned: success
admin_primary string	Primary admin key for Azure Cognitive Search Service. Returned: success Sample: "12345ABCDE67890FGHIJ123ABC456DEF"
admin_secondary string	Secondary admin key for Azure Cognitive Search Service. Returned: success Sample: "12345ABCDE67890FGHIJ123ABC456DEF"
query list / elements=string	List of query keys for Azure Cognitive Search Service. Returned: success Sample: [{"key": "12345ABCDE67890FGHIJ123ABC456DEF", "name": "Query key"}]
location string	The geo-location where the Azure Cognitive Search Service lives. Returned: always Sample: "West Europe"
name string	The name of the Azure Cognitive Search Service. Returned: always Sample: "myazuresearch"
network_rule_set list / elements=string	Network specific rules that determine how the Azure Cognitive Search service may be reached. Returned: always Sample: ["1.1.1.1", "8.8.8.8/31"]
partition_count integer	The number of partitions in the Azure Cognitive Search Service. Returned: always Sample: 3
provisioning_state string	The state of the provisioning state of Azure Cognitive Search Service. Returned: always Sample: "succeeded"
public_network_access string	If it’s allowed traffic over public interface. Returned: always Sample: "enabled"
replica_count integer	The number of replicas in the Azure Cognitive Search Service. Returned: always Sample: 3
sku string	The SKU of the Azure Cognitive Search Service. Returned: always Sample: "standard"
status string	The state of the Azure Cognitive Search. Returned: always Sample: "Active running"
tags dictionary	The resource tags. Returned: always Sample: {"tag1": "abc"}

Authors

• David Duque Hernández (@next-davidduquehernandez)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)