azure_rm_cognitivesearch

Manage Azure Cognitive Search service

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_cognitivesearch

Synopsis

Manage Azure Cognitive Search service

Parameters

Name	Type	Required	Default	Description
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile	string		`latest`	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.
append_tags	bool		`true`	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.
auth_source	string		`auto`	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.
cert_validation_mode	string			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.
client_id	string			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.
cloud_environment	string		`AzureCloud`	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.
disable_instance_discovery	bool		`false`	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.
hosting_mode	string		`default`	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’.
identity	string		`None`	The identity for the resource.
location	string			Valid azure location. Defaults to location of the resource group.
log_mode	string			Parent argument.
log_path	string			Parent argument.
name	string	yes		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.
network_rule_set	list			Network specific rules that determine how the Azure Cognitive Search service may be reached.
oidc_token	string			Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
partition_count	int		`1`	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.
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.
public_network_access	string		`enabled`	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.
replica_count	int		`1`	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).
resource_group	string	yes		The name of the resource group within the current subscription.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
sku	string		`basic`	The SKU of the Search Service, which determines price tier and capacity limits.
This property is required when creating a new Search Service.
state	string		`present`	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.
subscription_id	string			Your Azure subscription Id.
tags	dict			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.
tenant	string			Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint	string			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.
x509_certificate_path	string			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.

Example

yaml

- name: Create Azure Cognitive Search
  azure.azcollection.azure_rm_cognitivesearch:
    resource_group: myResourceGroup
    name: myAzureSearch