fleet

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

Overview

Name	fleet
Type	Resource
Id	azure.cosmosdb.fleet

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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	A provisioning state of the Fleet. Known values are: "Uninitialized", "Initializing", "InternallyReady", "Online", "Deleting", "Succeeded", "Failed", "Canceled", "Updating", and "Creating". (Uninitialized, Initializing, InternallyReady, Online, Deleting, Succeeded, Failed, Canceled, Updating, Creating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	A provisioning state of the Fleet. Known values are: "Uninitialized", "Initializing", "InternallyReady", "Online", "Deleting", "Succeeded", "Failed", "Canceled", "Updating", and "Creating". (Uninitialized, Initializing, InternallyReady, Online, Deleting, Succeeded, Failed, Canceled, Updating, Creating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	A provisioning state of the Fleet. Known values are: "Uninitialized", "Initializing", "InternallyReady", "Online", "Deleting", "Succeeded", "Failed", "Canceled", "Updating", and "Creating". (Uninitialized, Initializing, InternallyReady, Online, Deleting, Succeeded, Failed, Canceled, Updating, Creating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, subscription_id		Retrieves the properties of an existing Azure Cosmos DB fleet under a subscription.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the fleets under the specified subscription and resource group.
list	select	subscription_id		Lists all the fleets under the subscription.
create	insert	resource_group_name, fleet_name, subscription_id, location		Creates an Azure Cosmos DB fleet under a subscription.
update	update	resource_group_name, fleet_name, subscription_id		Updates the properties of an existing Azure Cosmos DB Fleet.
delete	delete	resource_group_name, fleet_name, subscription_id		Deletes an existing Azure Cosmos DB Fleet.

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.
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 fleet under a subscription.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
type
FROM azure.cosmosdb.fleet
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the fleets under the specified subscription and resource group.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
type
FROM azure.cosmosdb.fleet
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the fleets under the subscription.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
type
FROM azure.cosmosdb.fleet
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates an Azure Cosmos DB fleet under a subscription.

INSERT INTO azure.cosmosdb.fleet (
tags,
location,
properties,
resource_group_name,
fleet_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ fleet_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: fleet
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the fleet resource.
  - name: fleet_name
    value: "{{ fleet_name }}"
    description: Required parameter for the fleet resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fleet resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties to update Azure Cosmos DB fleet resource.
    value:
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates the properties of an existing Azure Cosmos DB Fleet.

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

DELETE examples

delete

Deletes an existing Azure Cosmos DB Fleet.

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