service

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

Overview

Name	service
Type	Resource
Id	azure.cosmosdb.service

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTime	string (date-time)	Time of the last state change (ISO-8601 format).
instanceCount	integer	Instance count for the service.
instanceSize	string	Instance type for the service. Known values are: "Cosmos.D4s", "Cosmos.D8s", and "Cosmos.D16s". (Cosmos.D4s, Cosmos.D8s, Cosmos.D16s)
serviceType	string	ServiceType for the service. Required. Known values are: "SqlDedicatedGateway", "DataTransfer", "GraphAPICompute", and "MaterializedViewsBuilder".
status	string	Describes the status of a service. Known values are: "Creating", "Running", "Updating", "Deleting", "Error", and "Stopped". (Creating, Running, Updating, Deleting, Error, Stopped)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTime	string (date-time)	Time of the last state change (ISO-8601 format).
instanceCount	integer	Instance count for the service.
instanceSize	string	Instance type for the service. Known values are: "Cosmos.D4s", "Cosmos.D8s", and "Cosmos.D16s". (Cosmos.D4s, Cosmos.D8s, Cosmos.D16s)
serviceType	string	ServiceType for the service. Required. Known values are: "SqlDedicatedGateway", "DataTransfer", "GraphAPICompute", and "MaterializedViewsBuilder".
status	string	Describes the status of a service. Known values are: "Creating", "Running", "Updating", "Deleting", "Error", and "Stopped". (Creating, Running, Updating, Deleting, Error, Stopped)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, service_name, subscription_id		Gets the status of service.
list	select	resource_group_name, account_name, subscription_id		Gets the status of service.
create	insert	resource_group_name, account_name, service_name, subscription_id		Creates a service.
delete	delete	resource_group_name, account_name, service_name, subscription_id		Deletes service with the given serviceName.

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
account_name	string	Cosmos DB database account name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	Cosmos DB service name. Required.
subscription_id	string

SELECT examples

get

Gets the status of service.

SELECT
id,
name,
creationTime,
instanceCount,
instanceSize,
serviceType,
status,
systemData,
type
FROM azure.cosmosdb.service
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the status of service.

SELECT
id,
name,
creationTime,
instanceCount,
instanceSize,
serviceType,
status,
systemData,
type
FROM azure.cosmosdb.service
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a service.

INSERT INTO azure.cosmosdb.service (
properties,
resource_group_name,
account_name,
service_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: service
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the service resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the service resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the service resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the service resource.
  - name: properties
    description: |
      Properties in ServiceResourceCreateUpdateParameters.
    value:
      instanceSize: "{{ instanceSize }}"
      instanceCount: {{ instanceCount }}
      serviceType: "{{ serviceType }}"

DELETE examples

delete

Deletes service with the given serviceName.

DELETE FROM azure.cosmosdb.service
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND service_name = '{{ service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;