fleets

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

Overview

Name	fleets
Type	Resource
Id	azure.fleet.fleets

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
identity	object	Managed identity.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
identity	object	Managed identity.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
identity	object	Managed identity.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, fleetName		Gets a Fleet.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists fleets in the specified subscription and resource group.
list_by_subscription	select	subscriptionId		Lists fleets in the specified subscription.
create_or_update	insert	subscriptionId, resourceGroupName, fleetName	If-Match, If-None-Match	Creates or updates a Fleet.
update	update	subscriptionId, resourceGroupName, fleetName	If-Match	Update a Fleet
delete	delete	subscriptionId, resourceGroupName, fleetName	If-Match	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 Fleet resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
If-Match	string	The request should only proceed if an entity matches this string.
If-None-Match	string	The request should only proceed if no entity matches this string.

SELECT examples

get

Gets a Fleet.

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

list_by_resource_group

Lists fleets in the specified subscription and resource group.

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

list_by_subscription

Lists fleets in the specified subscription.

SELECT
eTag,
identity,
location,
properties,
tags
FROM azure.fleet.fleets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Fleet.

INSERT INTO azure.fleet.fleets (
data__properties,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
fleetName,
If-Match,
If-None-Match
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ fleetName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
eTag,
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: fleets
  props:
    - name: subscriptionId
      value: string
      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: identity
      value: object
      description: |
        Managed identity.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: If-Match
      value: string
      description: The request should only proceed if an entity matches this string.
    - name: If-None-Match
      value: string
      description: The request should only proceed if no entity matches this string.

UPDATE examples

update

Update a Fleet

UPDATE azure.fleet.fleets
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND fleetName = '{{ fleetName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
eTag,
identity,
location,
properties,
tags;

DELETE examples

delete

Delete a Fleet

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