alias

Creates, updates, deletes, gets or lists an alias resource.

Overview

Name	alias
Type	Resource
Id	azure.search_documents.alias

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_alias	insert	search_service_name		Creates a new search alias.
get_alias	exec	alias_name, search_service_name		Retrieves an alias definition.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
alias_name	string	The name of the alias. Required.
search_service_name	string	Search service name. (default: )

INSERT examples

create_alias

Creates a new search alias.

INSERT INTO azure.search_documents.alias (
search_service_name
)
SELECT 
'{{ search_service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: alias
props:
  - name: search_service_name
    value: "{{ search_service_name }}"
    description: Required parameter for the alias resource.

Lifecycle Methods

get_alias

Retrieves an alias definition.

EXEC azure.search_documents.alias.get_alias 
@alias_name='{{ alias_name }}' --required, 
@search_service_name='{{ search_service_name }}' --required
;