Try SpotterGet Azure Cognitive Search service info
| "added in version" 1.4.0 of azure.azcollection"
Authors: David Duque Hernández (@next-davidduquehernandez)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Get info for a specific Azure Cognitive Search service or all Azure Cognitive Search service within a resource group.
- 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:
name:
description:
- The name of the Azure Cognitive Search service.
type: str
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
show_keys:
default: false
description:
- Retrieve admin and query keys.
type: bool
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 name of the Azure resource group.
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
search:
contains:
hosting_mode:
description:
- Type of hosting mode selected.
returned: always
sample: default
type: str
id:
description:
- The unique identifier associated with this Azure Cognitive Search.
returned: always
sample: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
type: str
identity:
contains:
principal_id:
description:
- Identifier assigned.
sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
type: str
type:
description:
- Identity type.
returned: always
sample: SystemAssigned
type: str
description:
- The identity of the Azure Cognitive Search Service.
returned: always
sample:
principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
type: SystemAssigned
type: dict
keys:
contains:
admin_primary:
description:
- Primary admin key for Azure Cognitive Search Service.
sample: 12345ABCDE67890FGHIJ123ABC456DEF
type: str
admin_secondary:
description:
- Secondary admin key for Azure Cognitive Search Service.
sample: 12345ABCDE67890FGHIJ123ABC456DEF
type: str
query:
description:
- List of query keys for Azure Cognitive Search Service.
sample:
- key: 12345ABCDE67890FGHIJ123ABC456DEF
name: Query key
type: list
description:
- Admin and query keys for Azure Cognitive Search Service.
type: dict
location:
description:
- The geo-location where the Azure Cognitive Search Service lives.
returned: always
sample: West Europe
type: str
name:
description:
- The name of the Azure Cognitive Search Service.
returned: always
sample: myazuresearch
type: str
network_rule_set:
description:
- 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
type: list
partition_count:
description:
- The number of partitions in the Azure Cognitive Search Service.
returned: always
sample: 3
type: int
provisioning_state:
description:
- The state of the provisioning state of Azure Cognitive Search Service.
returned: always
sample: succeeded
type: str
public_network_access:
description:
- If it's allowed traffic over public interface.
returned: always
sample: enabled
type: str
replica_count:
description:
- The number of replicas in the Azure Cognitive Search Service.
returned: always
sample: 3
type: int
sku:
description:
- The SKU of the Azure Cognitive Search Service.
returned: always
sample: standard
type: str
status:
description:
- The state of the Azure Cognitive Search.
returned: always
sample: Active running
type: str
tags:
description:
- The resource tags.
returned: always
sample:
tag1: abc
type: dict
description:
- Info for Azure Cognitive Search.
returned: always
type: list