fleetspace

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

Overview

Name	fleetspace
Type	Resource
Id	azure.cosmosdb.fleetspace

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.
dataRegions	array	List of data regions assigned to the fleetspace. Eg [westus2].
fleetspaceApiKind	string	The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'. "NoSQL" (NoSQL)
provisioningState	string	A provisioning state of the Fleetspace. Known values are: "Uninitialized", "Initializing", "InternallyReady", "Online", "Deleting", "Succeeded", "Failed", "Canceled", "Updating", and "Creating". (Uninitialized, Initializing, InternallyReady, Online, Deleting, Succeeded, Failed, Canceled, Updating, Creating)
serviceTier	string	Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. Known values are: "GeneralPurpose" and "BusinessCritical". (GeneralPurpose, BusinessCritical)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
throughputPoolConfiguration	object	Configuration for throughput pool in the fleetspace.
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.
dataRegions	array	List of data regions assigned to the fleetspace. Eg [westus2].
fleetspaceApiKind	string	The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'. "NoSQL" (NoSQL)
provisioningState	string	A provisioning state of the Fleetspace. Known values are: "Uninitialized", "Initializing", "InternallyReady", "Online", "Deleting", "Succeeded", "Failed", "Canceled", "Updating", and "Creating". (Uninitialized, Initializing, InternallyReady, Online, Deleting, Succeeded, Failed, Canceled, Updating, Creating)
serviceTier	string	Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region. Known values are: "GeneralPurpose" and "BusinessCritical". (GeneralPurpose, BusinessCritical)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
throughputPoolConfiguration	object	Configuration for throughput pool in the fleetspace.
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, fleet_name, fleetspace_name, subscription_id		Retrieves the properties of an existing Azure Cosmos DB fleetspace under a fleet.
list	select	resource_group_name, fleet_name, subscription_id		Lists all the fleetspaces under a fleet.
create	insert	resource_group_name, fleet_name, fleetspace_name, subscription_id		Creates an Azure Cosmos DB fleetspace under a fleet.
update	update	resource_group_name, fleet_name, fleetspace_name, subscription_id		Update the properties of an existing Azure Cosmos DB fleetspace under a fleet.
delete	delete	resource_group_name, fleet_name, fleetspace_name, subscription_id		Deletes an existing Azure Cosmos DB Fleetspace.

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
fleet_name	string	Cosmos DB fleet name. Needs to be unique under a subscription. Required.
fleetspace_name	string	Cosmos DB fleetspace name. Needs to be unique under a fleet. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieves the properties of an existing Azure Cosmos DB fleetspace under a fleet.

SELECT
id,
name,
dataRegions,
fleetspaceApiKind,
provisioningState,
serviceTier,
systemData,
throughputPoolConfiguration,
type
FROM azure.cosmosdb.fleetspace
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND fleetspace_name = '{{ fleetspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the fleetspaces under a fleet.

SELECT
id,
name,
dataRegions,
fleetspaceApiKind,
provisioningState,
serviceTier,
systemData,
throughputPoolConfiguration,
type
FROM azure.cosmosdb.fleetspace
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates an Azure Cosmos DB fleetspace under a fleet.

INSERT INTO azure.cosmosdb.fleetspace (
properties,
resource_group_name,
fleet_name,
fleetspace_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ fleet_name }}',
'{{ fleetspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: fleetspace
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the fleetspace resource.
  - name: fleet_name
    value: "{{ fleet_name }}"
    description: Required parameter for the fleetspace resource.
  - name: fleetspace_name
    value: "{{ fleetspace_name }}"
    description: Required parameter for the fleetspace resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fleetspace resource.
  - name: properties
    description: |
      Properties to update Azure Cosmos DB Fleetspace.
    value:
      provisioningState: "{{ provisioningState }}"
      fleetspaceApiKind: "{{ fleetspaceApiKind }}"
      serviceTier: "{{ serviceTier }}"
      dataRegions:
        - "{{ dataRegions }}"
      throughputPoolConfiguration:
        minThroughput: {{ minThroughput }}
        maxThroughput: {{ maxThroughput }}
        dedicatedRUs: {{ dedicatedRUs }}
        maxConsumableRUs: {{ maxConsumableRUs }}

UPDATE examples

update

Update the properties of an existing Azure Cosmos DB fleetspace under a fleet.

UPDATE azure.cosmosdb.fleetspace
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND fleetspace_name = '{{ fleetspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an existing Azure Cosmos DB Fleetspace.

DELETE FROM azure.cosmosdb.fleetspace
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND fleetspace_name = '{{ fleetspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;