fleet_update_strategies

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

Overview

Name	fleet_update_strategies
Type	Resource
Id	azure.container_service_fleet.fleet_update_strategies

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.
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.
provisioningState	string	The provisioning state of the UpdateStrategy resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
strategy	object	Defines the update sequence of the clusters. Required.
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_by_fleet

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.
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.
provisioningState	string	The provisioning state of the UpdateStrategy resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
strategy	object	Defines the update sequence of the clusters. Required.
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, update_strategy_name, subscription_id		Get a FleetUpdateStrategy.
list_by_fleet	select	resource_group_name, fleet_name, subscription_id	$top, $skipToken	List FleetUpdateStrategy resources by Fleet.
create_or_update	insert	resource_group_name, fleet_name, update_strategy_name, subscription_id		Create a FleetUpdateStrategy.
create_or_update	replace	resource_group_name, fleet_name, update_strategy_name, subscription_id		Create a FleetUpdateStrategy.
delete	delete	resource_group_name, fleet_name, update_strategy_name, subscription_id		Delete a FleetUpdateStrategy.

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	The name of the Fleet resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
update_strategy_name	string	The name of the UpdateStrategy resource. Required.
$skipToken	string	The page-continuation token to use with a paged version of this API. Default value is None.
$top	integer	The number of result items to return. Default value is None.

SELECT examples

get

Get a FleetUpdateStrategy.

SELECT
id,
name,
eTag,
provisioningState,
strategy,
systemData,
type
FROM azure.container_service_fleet.fleet_update_strategies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND update_strategy_name = '{{ update_strategy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_fleet

List FleetUpdateStrategy resources by Fleet.

SELECT
id,
name,
eTag,
provisioningState,
strategy,
systemData,
type
FROM azure.container_service_fleet.fleet_update_strategies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create a FleetUpdateStrategy.

INSERT INTO azure.container_service_fleet.fleet_update_strategies (
properties,
resource_group_name,
fleet_name,
update_strategy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ fleet_name }}',
'{{ update_strategy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: fleet_update_strategies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the fleet_update_strategies resource.
  - name: fleet_name
    value: "{{ fleet_name }}"
    description: Required parameter for the fleet_update_strategies resource.
  - name: update_strategy_name
    value: "{{ update_strategy_name }}"
    description: Required parameter for the fleet_update_strategies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fleet_update_strategies resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      strategy:
        stages:
          - name: "{{ name }}"
            groups: "{{ groups }}"
            afterStageWaitInSeconds: {{ afterStageWaitInSeconds }}
            maxConcurrency: "{{ maxConcurrency }}"
            beforeGates: "{{ beforeGates }}"
            afterGates: "{{ afterGates }}"

REPLACE examples

create_or_update

Create a FleetUpdateStrategy.

REPLACE azure.container_service_fleet.fleet_update_strategies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND update_strategy_name = '{{ update_strategy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
properties,
systemData,
type;

DELETE examples

delete

Delete a FleetUpdateStrategy.

DELETE FROM azure.container_service_fleet.fleet_update_strategies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND update_strategy_name = '{{ update_strategy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;