gates

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

Overview

Name	gates
Type	Resource
Id	azure.container_service_fleet.gates

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.
displayName	string	The human-readable display name of the Gate.
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.
gateType	string	The type of the Gate determines how it is completed. Required. "Approval" (Approval)
provisioningState	string	The provisioning state of the Gate resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
state	string	The state of the Gate. Required. Known values are: "Pending", "Skipped", and "Completed". (Pending, Skipped, Completed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
target	object	The target that the Gate is controlling, e.g. an Update Run. Required.
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.
displayName	string	The human-readable display name of the Gate.
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.
gateType	string	The type of the Gate determines how it is completed. Required. "Approval" (Approval)
provisioningState	string	The provisioning state of the Gate resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
state	string	The state of the Gate. Required. Known values are: "Pending", "Skipped", and "Completed". (Pending, Skipped, Completed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
target	object	The target that the Gate is controlling, e.g. an Update Run. Required.
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, gate_name, subscription_id		Get a Gate.
list_by_fleet	select	resource_group_name, fleet_name, subscription_id	$filter, $top, $skipToken	List Gate resources by Fleet.
update	update	resource_group_name, fleet_name, gate_name, subscription_id, properties		Update a Gate.

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.
gate_name	string	The name of the Gate resource, a GUID. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	Filter the result list using the given expression. Default value is None.
$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 Gate.

SELECT
id,
name,
displayName,
eTag,
gateType,
provisioningState,
state,
systemData,
target,
type
FROM azure.container_service_fleet.gates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND gate_name = '{{ gate_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_fleet

List Gate resources by Fleet.

SELECT
id,
name,
displayName,
eTag,
gateType,
provisioningState,
state,
systemData,
target,
type
FROM azure.container_service_fleet.gates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

UPDATE examples

update

Update a Gate.

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