updates
Creates, updates, deletes, gets or lists a updates
resource.
Overview
Name | updates |
Type | Resource |
Id | azure_stack.azure_stack_hci.updates |
Fields
The following fields are returned by SELECT
queries:
- get
- list
Name | Datatype | Description |
---|---|---|
location | string | The geo-location where the resource lives |
properties | object | Update properties |
Name | Datatype | Description |
---|---|---|
location | string | The geo-location where the resource lives |
properties | object | Update properties |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | subscriptionId , resourceGroupName , clusterName , updateName | Get specified Update | |
list | select | subscriptionId , resourceGroupName , clusterName | List all Updates | |
put | replace | subscriptionId , resourceGroupName , clusterName , updateName | Put specified Update | |
delete | delete | subscriptionId , resourceGroupName , clusterName , updateName | Delete specified Update | |
post | exec | subscriptionId , resourceGroupName , clusterName , updateName | Apply Update |
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 |
---|---|---|
clusterName | string | The name of the cluster. |
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. |
updateName | string | The name of the Update |
SELECT
examples
- get
- list
Get specified Update
SELECT
location,
properties
FROM azure_stack.azure_stack_hci.updates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND updateName = '{{ updateName }}' -- required
;
List all Updates
SELECT
location,
properties
FROM azure_stack.azure_stack_hci.updates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;
REPLACE
examples
- put
Put specified Update
REPLACE azure_stack.azure_stack_hci.updates
SET
data__location = '{{ location }}',
data__properties = '{{ properties }}'
WHERE
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND updateName = '{{ updateName }}' --required
RETURNING
location,
properties;
DELETE
examples
- delete
Delete specified Update
DELETE FROM azure_stack.azure_stack_hci.updates
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND updateName = '{{ updateName }}' --required
;
Lifecycle Methods
- post
Apply Update
EXEC azure_stack.azure_stack_hci.updates.post
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@clusterName='{{ clusterName }}' --required,
@updateName='{{ updateName }}' --required
;