services

Creates, updates, deletes, gets or lists a services resource.

Overview

Name	services
Type	Resource
Id	azure.search.services

Fields

vw_services

Name	Datatype	Description
auth_options	text	field from the properties object
disable_local_auth	text	field from the properties object
disabled_data_exfiltration_options	text	field from the properties object
e_tag	text	field from the properties object
encryption_with_cmk	text	field from the properties object
hosting_mode	text	field from the properties object
identity	text	Details about the search service identity. A null value indicates that the search service has no identity assigned.
location	text	The geo-location where the resource lives
network_rule_set	text	field from the properties object
partition_count	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
replica_count	text	field from the properties object
resourceGroupName	text	field from the properties object
searchServiceName	text	field from the properties object
semantic_search	text	field from the properties object
shared_private_link_resources	text	field from the properties object
sku	text	Defines the SKU of a search service, which determines billing rate and capacity limits.
status	text	field from the properties object
status_details	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

services

Name	Datatype	Description
identity	object	Details about the search service identity. A null value indicates that the search service has no identity assigned.
location	string	The geo-location where the resource lives
properties	object	Properties of the search service.
sku	object	Defines the SKU of a search service, which determines billing rate and capacity limits.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, searchServiceName, subscriptionId	Gets the search service with the given name in the given resource group.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets a list of all Search services in the given resource group.
list_by_subscription	SELECT	subscriptionId	Gets a list of all Search services in the given subscription.
create_or_update	INSERT	resourceGroupName, searchServiceName, subscriptionId	Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
delete	DELETE	resourceGroupName, searchServiceName, subscriptionId	Deletes a search service in the given resource group, along with its associated resources.
update	UPDATE	resourceGroupName, searchServiceName, subscriptionId	Updates an existing search service in the given resource group.
check_name_availability	EXEC	subscriptionId, data__name, data__type	Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://name.search.windows.net).

SELECT examples

Gets a list of all Search services in the given subscription.

vw_services

SELECT
auth_options,
disable_local_auth,
disabled_data_exfiltration_options,
e_tag,
encryption_with_cmk,
hosting_mode,
identity,
location,
network_rule_set,
partition_count,
private_endpoint_connections,
provisioning_state,
public_network_access,
replica_count,
resourceGroupName,
searchServiceName,
semantic_search,
shared_private_link_resources,
sku,
status,
status_details,
subscriptionId,
tags
FROM azure.search.vw_services
WHERE subscriptionId = '{{ subscriptionId }}';

services

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.search.services
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new services resource.

All Properties

/*+ create */
INSERT INTO azure.search.services (
resourceGroupName,
searchServiceName,
subscriptionId,
properties,
sku,
identity,
tags,
location
)
SELECT 
'{{ resourceGroupName }}',
'{{ searchServiceName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ sku }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: replicaCount
          value: integer
        - name: partitionCount
          value: integer
        - name: hostingMode
          value: string
        - name: publicNetworkAccess
          value: string
        - name: status
          value: string
        - name: statusDetails
          value: string
        - name: provisioningState
          value: string
        - name: networkRuleSet
          value:
            - name: ipRules
              value:
                - - name: value
                    value: string
            - name: bypass
              value: string
        - name: disabledDataExfiltrationOptions
          value:
            - []
        - name: encryptionWithCmk
          value:
            - name: enforcement
              value: string
            - name: encryptionComplianceStatus
              value: string
        - name: disableLocalAuth
          value: boolean
        - name: authOptions
          value:
            - name: apiKeyOnly
              value: []
            - name: aadOrApiKey
              value:
                - name: aadAuthFailureMode
                  value: string
        - name: semanticSearch
          value: []
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: privateEndpoint
                    value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: string
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: groupId
                    value: string
                  - name: provisioningState
                    value: string
              - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
        - name: sharedPrivateLinkResources
          value:
            - - name: properties
                value:
                  - name: privateLinkResourceId
                    value: string
                  - name: groupId
                    value: string
                  - name: requestMessage
                    value: string
                  - name: resourceRegion
                    value: string
                  - name: status
                    value: string
                  - name: provisioningState
                    value: string
              - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
        - name: eTag
          value: string
    - name: sku
      value:
        - name: name
          value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a services resource.

/*+ update */
UPDATE azure.search.services
SET 
properties = '{{ properties }}',
sku = '{{ sku }}',
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND searchServiceName = '{{ searchServiceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified services resource.

/*+ delete */
DELETE FROM azure.search.services
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND searchServiceName = '{{ searchServiceName }}'
AND subscriptionId = '{{ subscriptionId }}';