Share via


Accounts interface

Interface representing a Accounts.

Methods

beginChangeKeyVault(string, string, AccountsChangeKeyVaultOptionalParams)

Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.

beginChangeKeyVaultAndWait(string, string, AccountsChangeKeyVaultOptionalParams)

Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.

beginCreateOrUpdate(string, string, NetAppAccount, AccountsCreateOrUpdateOptionalParams)

Create or update the specified NetApp account within the resource group

beginCreateOrUpdateAndWait(string, string, NetAppAccount, AccountsCreateOrUpdateOptionalParams)

Create or update the specified NetApp account within the resource group

beginDelete(string, string, AccountsDeleteOptionalParams)

Delete the specified NetApp account

beginDeleteAndWait(string, string, AccountsDeleteOptionalParams)

Delete the specified NetApp account

beginGetChangeKeyVaultInformation(string, string, AccountsGetChangeKeyVaultInformationOptionalParams)

Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.

beginGetChangeKeyVaultInformationAndWait(string, string, AccountsGetChangeKeyVaultInformationOptionalParams)

Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.

beginRenewCredentials(string, string, AccountsRenewCredentialsOptionalParams)

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.

beginRenewCredentialsAndWait(string, string, AccountsRenewCredentialsOptionalParams)

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.

beginTransitionToCmk(string, string, AccountsTransitionToCmkOptionalParams)

Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.

beginTransitionToCmkAndWait(string, string, AccountsTransitionToCmkOptionalParams)

Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.

beginUpdate(string, string, NetAppAccountPatch, AccountsUpdateOptionalParams)

Patch the specified NetApp account

beginUpdateAndWait(string, string, NetAppAccountPatch, AccountsUpdateOptionalParams)

Patch the specified NetApp account

get(string, string, AccountsGetOptionalParams)

Get the NetApp account

list(string, AccountsListOptionalParams)

List and describe all NetApp accounts in the resource group.

listBySubscription(AccountsListBySubscriptionOptionalParams)

List and describe all NetApp accounts in the subscription.

Method Details

beginChangeKeyVault(string, string, AccountsChangeKeyVaultOptionalParams)

Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.

function beginChangeKeyVault(resourceGroupName: string, accountName: string, options?: AccountsChangeKeyVaultOptionalParams): Promise<SimplePollerLike<OperationState<AccountsChangeKeyVaultHeaders>, AccountsChangeKeyVaultHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsChangeKeyVaultOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<AccountsChangeKeyVaultHeaders>, AccountsChangeKeyVaultHeaders>>

beginChangeKeyVaultAndWait(string, string, AccountsChangeKeyVaultOptionalParams)

Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.

function beginChangeKeyVaultAndWait(resourceGroupName: string, accountName: string, options?: AccountsChangeKeyVaultOptionalParams): Promise<AccountsChangeKeyVaultHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsChangeKeyVaultOptionalParams

The options parameters.

Returns

beginCreateOrUpdate(string, string, NetAppAccount, AccountsCreateOrUpdateOptionalParams)

Create or update the specified NetApp account within the resource group

function beginCreateOrUpdate(resourceGroupName: string, accountName: string, body: NetAppAccount, options?: AccountsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

body
NetAppAccount

NetApp Account object supplied in the body of the operation.

options
AccountsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>

beginCreateOrUpdateAndWait(string, string, NetAppAccount, AccountsCreateOrUpdateOptionalParams)

Create or update the specified NetApp account within the resource group

function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, body: NetAppAccount, options?: AccountsCreateOrUpdateOptionalParams): Promise<NetAppAccount>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

body
NetAppAccount

NetApp Account object supplied in the body of the operation.

options
AccountsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NetAppAccount>

beginDelete(string, string, AccountsDeleteOptionalParams)

Delete the specified NetApp account

function beginDelete(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, AccountsDeleteOptionalParams)

Delete the specified NetApp account

function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginGetChangeKeyVaultInformation(string, string, AccountsGetChangeKeyVaultInformationOptionalParams)

Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.

function beginGetChangeKeyVaultInformation(resourceGroupName: string, accountName: string, options?: AccountsGetChangeKeyVaultInformationOptionalParams): Promise<SimplePollerLike<OperationState<GetKeyVaultStatusResponse>, GetKeyVaultStatusResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsGetChangeKeyVaultInformationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GetKeyVaultStatusResponse>, GetKeyVaultStatusResponse>>

beginGetChangeKeyVaultInformationAndWait(string, string, AccountsGetChangeKeyVaultInformationOptionalParams)

Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.

function beginGetChangeKeyVaultInformationAndWait(resourceGroupName: string, accountName: string, options?: AccountsGetChangeKeyVaultInformationOptionalParams): Promise<GetKeyVaultStatusResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsGetChangeKeyVaultInformationOptionalParams

The options parameters.

Returns

beginRenewCredentials(string, string, AccountsRenewCredentialsOptionalParams)

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.

function beginRenewCredentials(resourceGroupName: string, accountName: string, options?: AccountsRenewCredentialsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsRenewCredentialsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRenewCredentialsAndWait(string, string, AccountsRenewCredentialsOptionalParams)

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.

function beginRenewCredentialsAndWait(resourceGroupName: string, accountName: string, options?: AccountsRenewCredentialsOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsRenewCredentialsOptionalParams

The options parameters.

Returns

Promise<void>

beginTransitionToCmk(string, string, AccountsTransitionToCmkOptionalParams)

Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.

function beginTransitionToCmk(resourceGroupName: string, accountName: string, options?: AccountsTransitionToCmkOptionalParams): Promise<SimplePollerLike<OperationState<AccountsTransitionToCmkHeaders>, AccountsTransitionToCmkHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsTransitionToCmkOptionalParams

The options parameters.

Returns

beginTransitionToCmkAndWait(string, string, AccountsTransitionToCmkOptionalParams)

Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.

function beginTransitionToCmkAndWait(resourceGroupName: string, accountName: string, options?: AccountsTransitionToCmkOptionalParams): Promise<AccountsTransitionToCmkHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsTransitionToCmkOptionalParams

The options parameters.

Returns

beginUpdate(string, string, NetAppAccountPatch, AccountsUpdateOptionalParams)

Patch the specified NetApp account

function beginUpdate(resourceGroupName: string, accountName: string, body: NetAppAccountPatch, options?: AccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

body
NetAppAccountPatch

NetApp Account object supplied in the body of the operation.

options
AccountsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>

beginUpdateAndWait(string, string, NetAppAccountPatch, AccountsUpdateOptionalParams)

Patch the specified NetApp account

function beginUpdateAndWait(resourceGroupName: string, accountName: string, body: NetAppAccountPatch, options?: AccountsUpdateOptionalParams): Promise<NetAppAccount>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

body
NetAppAccountPatch

NetApp Account object supplied in the body of the operation.

options
AccountsUpdateOptionalParams

The options parameters.

Returns

Promise<NetAppAccount>

get(string, string, AccountsGetOptionalParams)

Get the NetApp account

function get(resourceGroupName: string, accountName: string, options?: AccountsGetOptionalParams): Promise<NetAppAccount>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of the NetApp account

options
AccountsGetOptionalParams

The options parameters.

Returns

Promise<NetAppAccount>

list(string, AccountsListOptionalParams)

List and describe all NetApp accounts in the resource group.

function list(resourceGroupName: string, options?: AccountsListOptionalParams): PagedAsyncIterableIterator<NetAppAccount, NetAppAccount[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
AccountsListOptionalParams

The options parameters.

Returns

listBySubscription(AccountsListBySubscriptionOptionalParams)

List and describe all NetApp accounts in the subscription.

function listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<NetAppAccount, NetAppAccount[], PageSettings>

Parameters

options
AccountsListBySubscriptionOptionalParams

The options parameters.

Returns