accounts
Creates, updates, deletes, gets or lists an accounts
resource.
Overview
Name | accounts |
Type | Resource |
Id | azure_isv.netapp.accounts |
Fields
The following fields are returned by SELECT
queries:
- get
- list
- list_by_subscription
Name | Datatype | Description |
---|---|---|
etag | string | A unique read-only string that changes whenever the resource is updated. |
identity | object | The identity used for the resource. |
location | string | The geo-location where the resource lives |
properties | object | NetApp Account properties |
tags | object | Resource tags. |
Name | Datatype | Description |
---|---|---|
etag | string | A unique read-only string that changes whenever the resource is updated. |
identity | object | The identity used for the resource. |
location | string | The geo-location where the resource lives |
properties | object | NetApp Account properties |
tags | object | Resource tags. |
Name | Datatype | Description |
---|---|---|
etag | string | A unique read-only string that changes whenever the resource is updated. |
identity | object | The identity used for the resource. |
location | string | The geo-location where the resource lives |
properties | object | NetApp Account properties |
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 , accountName | Get the NetApp account | |
list | select | subscriptionId , resourceGroupName | List and describe all NetApp accounts in the resource group. | |
list_by_subscription | select | subscriptionId | List and describe all NetApp accounts in the subscription. | |
create_or_update | insert | subscriptionId , resourceGroupName , accountName , data__location | Create or update the specified NetApp account within the resource group | |
update | update | subscriptionId , resourceGroupName , accountName | Patch the specified NetApp account | |
delete | delete | subscriptionId , resourceGroupName , accountName | Delete the specified NetApp account | |
renew_credentials | exec | subscriptionId , resourceGroupName , accountName | Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it. |
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 NetApp account |
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. |
SELECT
examples
- get
- list
- list_by_subscription
Get the NetApp account
SELECT
etag,
identity,
location,
properties,
tags
FROM azure_isv.netapp.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;
List and describe all NetApp accounts in the resource group.
SELECT
etag,
identity,
location,
properties,
tags
FROM azure_isv.netapp.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;
List and describe all NetApp accounts in the subscription.
SELECT
etag,
identity,
location,
properties,
tags
FROM azure_isv.netapp.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;
INSERT
examples
- create_or_update
- Manifest
Create or update the specified NetApp account within the resource group
INSERT INTO azure_isv.netapp.accounts (
data__tags,
data__location,
data__properties,
data__identity,
subscriptionId,
resourceGroupName,
accountName
)
SELECT
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}'
RETURNING
etag,
identity,
location,
properties,
tags
;
# Description fields are for documentation purposes
- name: accounts
props:
- name: subscriptionId
value: string (uuid)
description: Required parameter for the accounts resource.
- name: resourceGroupName
value: string
description: Required parameter for the accounts resource.
- name: accountName
value: string
description: Required parameter for the accounts resource.
- name: tags
value: object
description: |
Resource tags.
- name: location
value: string
description: |
The geo-location where the resource lives
- name: properties
value: object
description: |
NetApp Account properties
- name: identity
value: object
description: |
The identity used for the resource.
UPDATE
examples
- update
Patch the specified NetApp account
UPDATE azure_isv.netapp.accounts
SET
data__location = '{{ location }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}',
data__identity = '{{ identity }}'
WHERE
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
RETURNING
etag,
identity,
location,
properties,
tags;
DELETE
examples
- delete
Delete the specified NetApp account
DELETE FROM azure_isv.netapp.accounts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
;
Lifecycle Methods
- renew_credentials
Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.
EXEC azure_isv.netapp.accounts.renew_credentials
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@accountName='{{ accountName }}' --required
;