task_assignments
Creates, updates, deletes, gets or lists a task_assignments
resource.
Overview
Name | task_assignments |
Type | Resource |
Id | azure.storage.task_assignments |
Fields
The following fields are returned by SELECT
queries:
- get
- list
OK -- properties retrieved successfully for the storage task assignment.
Name | Datatype | Description |
---|---|---|
id | string (arm-id) | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name | string | The name of the resource |
properties | object | Properties of the storage task assignment. |
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" |
OK -- list of storage task assignments was retrieved and returned successfully.
Name | Datatype | Description |
---|---|---|
id | string (arm-id) | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name | string | The name of the resource |
properties | object | Properties of the storage task assignment. |
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 | subscriptionId , resourceGroupName , accountName , storageTaskAssignmentName | Get the storage task assignment properties | |
list | select | subscriptionId , resourceGroupName , accountName | $maxpagesize | List all the storage task assignments in an account |
create | insert | subscriptionId , resourceGroupName , accountName , storageTaskAssignmentName , data__properties | Asynchronously creates a new storage task assignment sub-resource with the specified parameters. If a storage task assignment is already created and a subsequent create request is issued with different properties, the storage task assignment properties will be updated. If a storage task assignment is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed. | |
update | update | subscriptionId , resourceGroupName , accountName , storageTaskAssignmentName | Update storage task assignment properties | |
delete | delete | subscriptionId , resourceGroupName , accountName , storageTaskAssignmentName | Delete the storage task assignment sub-resource |
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 |
---|---|---|
accountName | string | The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
storageTaskAssignmentName | string | The name of the storage task assignment within the specified resource group. Storage task assignment names must be between 3 and 24 characters in length and use numbers and lower-case letters only. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
$maxpagesize | integer (int32) | Optional, specifies the maximum number of storage task assignment Ids to be included in the list response. |
SELECT
examples
- get
- list
Get the storage task assignment properties
SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.task_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND storageTaskAssignmentName = '{{ storageTaskAssignmentName }}' -- required
;
List all the storage task assignments in an account
SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.task_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND $maxpagesize = '{{ $maxpagesize }}'
;
INSERT
examples
- create
- Manifest
Asynchronously creates a new storage task assignment sub-resource with the specified parameters. If a storage task assignment is already created and a subsequent create request is issued with different properties, the storage task assignment properties will be updated. If a storage task assignment is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.
INSERT INTO azure.storage.task_assignments (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
storageTaskAssignmentName
)
SELECT
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ storageTaskAssignmentName }}'
RETURNING
id,
name,
properties,
systemData,
type
;
# Description fields are for documentation purposes
- name: task_assignments
props:
- name: subscriptionId
value: string (uuid)
description: Required parameter for the task_assignments resource.
- name: resourceGroupName
value: string
description: Required parameter for the task_assignments resource.
- name: accountName
value: string
description: Required parameter for the task_assignments resource.
- name: storageTaskAssignmentName
value: string
description: Required parameter for the task_assignments resource.
- name: properties
value: object
description: |
Properties of the storage task assignment.
UPDATE
examples
- update
Update storage task assignment properties
UPDATE azure.storage.task_assignments
SET
data__properties = '{{ properties }}'
WHERE
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND storageTaskAssignmentName = '{{ storageTaskAssignmentName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;
DELETE
examples
- delete
Delete the storage task assignment sub-resource
DELETE FROM azure.storage.task_assignments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND storageTaskAssignmentName = '{{ storageTaskAssignmentName }}' --required
;