fleets

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

Overview

Name	fleets
Type	Resource
Id	azure.azure_fleet.fleets

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
plan	object	Details of the resource plan.
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.
zones	array	Zones in which the Compute Fleet is available

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
plan	object	Details of the resource plan.
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.
zones	array	Zones in which the Compute Fleet is available

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
plan	object	Details of the resource plan.
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.
zones	array	Zones in which the Compute Fleet is available

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, fleetName		Get a Fleet
list_by_resource_group	select	subscriptionId, resourceGroupName		List Fleet resources by resource group
list_by_subscription	select	subscriptionId		List Fleet resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, fleetName		Create a Fleet
update	update	subscriptionId, resourceGroupName, fleetName		Update a Fleet
delete	delete	subscriptionId, resourceGroupName, fleetName		Delete a 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
fleetName	string	The name of the Compute Fleet
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a Fleet

SELECT
identity,
location,
plan,
properties,
tags,
zones
FROM azure.azure_fleet.fleets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND fleetName = '{{ fleetName }}' -- required
;

list_by_resource_group

List Fleet resources by resource group

SELECT
identity,
location,
plan,
properties,
tags,
zones
FROM azure.azure_fleet.fleets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List Fleet resources by subscription ID

SELECT
identity,
location,
plan,
properties,
tags,
zones
FROM azure.azure_fleet.fleets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a Fleet

INSERT INTO azure.azure_fleet.fleets (
data__properties,
data__zones,
data__identity,
data__plan,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
fleetName
)
SELECT 
'{{ properties }}',
'{{ zones }}',
'{{ identity }}',
'{{ plan }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ fleetName }}'
RETURNING
identity,
location,
plan,
properties,
tags,
zones
;

Manifest

# Description fields are for documentation purposes
- name: fleets
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the fleets resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the fleets resource.
    - name: fleetName
      value: string
      description: Required parameter for the fleets resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: zones
      value: array
      description: |
        Zones in which the Compute Fleet is available
    - name: identity
      value: object
      description: |
        The managed service identities assigned to this resource.
    - name: plan
      value: object
      description: |
        Details of the resource plan.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a Fleet

UPDATE azure.azure_fleet.fleets
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}',
data__plan = '{{ plan }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND fleetName = '{{ fleetName }}' --required
RETURNING
identity,
location,
plan,
properties,
tags,
zones;

DELETE examples

delete

Delete a Fleet

DELETE FROM azure.azure_fleet.fleets
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND fleetName = '{{ fleetName }}' --required
;