servers

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

Overview

Name	servers
Type	Resource
Id	azure.analysis_services.servers

Fields

The following fields are returned by SELECT queries:

list_by_resource_group

Name	Datatype	Description
id	string	An identifier that represents the Analysis Services resource.
name	string	The name of the Analysis Services resource.
location	string	Location of the Analysis Services resource.
properties	object	Properties of the provision operation request.
sku	object	The SKU of the Analysis Services resource.
tags	object	Key-value pairs of additional resource provisioning properties.
type	string	The type of the Analysis Services resource.

list

Name	Datatype	Description
id	string	An identifier that represents the Analysis Services resource.
name	string	The name of the Analysis Services resource.
location	string	Location of the Analysis Services resource.
properties	object	Properties of the provision operation request.
sku	object	The SKU of the Analysis Services resource.
tags	object	Key-value pairs of additional resource provisioning properties.
type	string	The type of the Analysis Services resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all the Analysis Services servers for the given resource group.
list	select	subscriptionId		Lists all the Analysis Services servers for the given subscription.
create	insert	resourceGroupName, serverName, subscriptionId		Provisions the specified Analysis Services server based on the configuration specified in the request.
update	update	resourceGroupName, serverName, subscriptionId		Updates the current state of the specified Analysis Services server.
delete	delete	resourceGroupName, serverName, subscriptionId		Deletes the specified Analysis Services server.
suspend	exec	resourceGroupName, serverName, subscriptionId		Suspends operation of the specified Analysis Services server instance.
resume	exec	resourceGroupName, serverName, subscriptionId		Resumes operation of the specified Analysis Services server instance.
dissociate_gateway	exec	resourceGroupName, serverName, subscriptionId		Dissociates a Unified Gateway associated with the server.
check_name_availability	exec	location, subscriptionId		Check the name availability in the target location.

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
location	string	The region name which the operation will lookup into.
resourceGroupName	string	The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90.
serverName	string	The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63.
subscriptionId	string	A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

list_by_resource_group

Gets all the Analysis Services servers for the given resource group.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.analysis_services.servers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all the Analysis Services servers for the given subscription.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.analysis_services.servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Provisions the specified Analysis Services server based on the configuration specified in the request.

INSERT INTO azure.analysis_services.servers (
data__properties,
data__location,
data__sku,
data__tags,
resourceGroupName,
serverName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ sku }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: servers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the servers resource.
    - name: serverName
      value: string
      description: Required parameter for the servers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the servers resource.
    - name: properties
      value: object
      description: |
        Properties of the provision operation request.
    - name: location
      value: string
      description: |
        Location of the Analysis Services resource.
    - name: sku
      value: object
      description: |
        The SKU of the Analysis Services resource.
    - name: tags
      value: object
      description: |
        Key-value pairs of additional resource provisioning properties.

UPDATE examples

update

Updates the current state of the specified Analysis Services server.

UPDATE azure.analysis_services.servers
SET 
data__sku = '{{ sku }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes the specified Analysis Services server.

DELETE FROM azure.analysis_services.servers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

suspend

Suspends operation of the specified Analysis Services server instance.

EXEC azure.analysis_services.servers.suspend 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

resume

Resumes operation of the specified Analysis Services server instance.

EXEC azure.analysis_services.servers.resume 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

dissociate_gateway

Dissociates a Unified Gateway associated with the server.

EXEC azure.analysis_services.servers.dissociate_gateway 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

check_name_availability

Check the name availability in the target location.

EXEC azure.analysis_services.servers.check_name_availability 
@location='{{ location }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;