Try SpotterManage Azure Cognitive Search service
| "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.0Create, update or delete Azure Cognitive Search service.
- name: Create Azure Cognitive Search
azure_rm_cognitivesearch:
resource_group: myResourceGroup
name: myAzureSearch
sku:
choices:
- free
- basic
- standard
- standard2
- standard3
- storage_optimized_l1
- storage_optimized_l2
default: basic
description:
- The SKU of the Search Service, which determines price tier and capacity limits.
- This property is required when creating a new Search Service.
type: str
name:
description:
- The name of the Azure Cognitive Search service.
- Search service names must only contain lowercase letters, digits or dashes.
- Cannot use dash as the first two or last one characters.
- Cannot contain consecutive dashes.
- Must be between 2 and 60 characters in length.
- Search service names must be globally unique.
- You cannot change the service name after the service is created.
required: true
type: str
tags:
description:
- Dictionary of string:string pairs to assign as metadata to the object.
- Metadata tags on the object will be updated with any provided values.
- To remove tags set append_tags option to false.
- Currently, Azure DNS zones and Traffic Manager services also don't allow the use
of spaces in the tag.
- Azure Front Door doesn't support the use of
- Azure Automation and Azure CDN only support 15 tags on resources.
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the search instance. Set to C(present) to create or update a
search instance. Set to C(absent) to remove a search instance.
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
identity:
choices:
- None
- SystemAssigned
default: None
description:
- The identity for the resource.
type: str
location:
description:
- Valid azure location. Defaults to location of the resource group.
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
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
append_tags:
default: true
description:
- Use to control if tags field is canonical or just appends to existing tags.
- When canonical, any tags not found in the tags parameter will be removed from the
object's metadata.
type: bool
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
hosting_mode:
choices:
- default
- highDensity
default: default
description:
- Applicable only for the standard3 SKU.
- You can set this property to enable up to 3 high density partitions that allow up
to 1000 indexes.
- For the standard3 SKU, the value is either 'default' or 'highDensity'.
- For all other SKUs, this value must be 'default'.
type: str
replica_count:
default: 1
description:
- The number of replicas in the search service.
- It must be a value between 1 and 12 inclusive for I(sku=standard).
- It must be a value between 1 and 3 inclusive for I(sku=basic).
type: int
resource_group:
description:
- The name of the resource group within the current subscription.
required: true
type: str
partition_count:
default: 1
description:
- The number of partitions in the search service.
- It can be C(1), C(2), C(3), C(4), C(6), or C(12).
- Values greater than 1 are only valid for standard SKUs.
- For 'standard3' services with hostingMode set to 'highDensity', the allowed values
are between 1 and 3.
type: int
subscription_id:
description:
- Your Azure subscription Id.
type: str
network_rule_set:
description:
- Network specific rules that determine how the Azure Cognitive Search service may
be reached.
elements: str
type: list
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
public_network_access:
choices:
- enabled
- disabled
default: enabled
description:
- This value can be set to C(enabled) to avoid breaking changes on existing customer
resources and templates.
- If set to C(enabled), traffic over public interface is not allowed, and private
endpoint connections would be the exclusive access method.
type: str
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
state:
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
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: dict