fleetspace_account

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

Overview

Name	fleetspace_account
Type	Resource
Id	azure.cosmosdb.fleetspace_account

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.
globalDatabaseAccountProperties	object	Configuration for fleetspace Account in the fleetspace.
provisioningState	string	A provisioning state of the Fleetspace Account. 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.
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.
globalDatabaseAccountProperties	object	Configuration for fleetspace Account in the fleetspace.
provisioningState	string	A provisioning state of the Fleetspace Account. 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.
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, fleetspace_account_name, subscription_id		Retrieves the properties of an existing Azure Cosmos DB fleetspace account under a fleetspace.
list	select	resource_group_name, fleet_name, fleetspace_name, subscription_id		Lists all the fleetspaces accounts under a fleetspace.
create	insert	resource_group_name, fleet_name, fleetspace_name, fleetspace_account_name, subscription_id		Creates an Azure Cosmos DB fleetspace account under a fleetspace.
delete	delete	resource_group_name, fleet_name, fleetspace_name, fleetspace_account_name, subscription_id		Removes an existing Azure Cosmos DB fleetspace account from a 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_account_name	string	Cosmos DB fleetspace account name. 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 account under a fleetspace.

SELECT
id,
name,
globalDatabaseAccountProperties,
provisioningState,
systemData,
type
FROM azure.cosmosdb.fleetspace_account
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND fleetspace_name = '{{ fleetspace_name }}' -- required
AND fleetspace_account_name = '{{ fleetspace_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the fleetspaces accounts under a fleetspace.

SELECT
id,
name,
globalDatabaseAccountProperties,
provisioningState,
systemData,
type
FROM azure.cosmosdb.fleetspace_account
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
;

INSERT examples

create

Creates an Azure Cosmos DB fleetspace account under a fleetspace.

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

Manifest

# Description fields are for documentation purposes
- name: fleetspace_account
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the fleetspace_account resource.
  - name: fleet_name
    value: "{{ fleet_name }}"
    description: Required parameter for the fleetspace_account resource.
  - name: fleetspace_name
    value: "{{ fleetspace_name }}"
    description: Required parameter for the fleetspace_account resource.
  - name: fleetspace_account_name
    value: "{{ fleetspace_account_name }}"
    description: Required parameter for the fleetspace_account resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fleetspace_account resource.
  - name: properties
    description: |
      An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account.
    value:
      provisioningState: "{{ provisioningState }}"
      globalDatabaseAccountProperties:
        resourceId: "{{ resourceId }}"
        armLocation: "{{ armLocation }}"

DELETE examples

delete

Removes an existing Azure Cosmos DB fleetspace account from a fleetspace.

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