Package version:

Interface Accounts

Interface representing a Accounts.

interface Accounts {
    beginChangeKeyVault(resourceGroupName: string, accountName: string, options?: AccountsChangeKeyVaultOptionalParams): Promise<SimplePollerLike<OperationState<AccountsChangeKeyVaultHeaders>, AccountsChangeKeyVaultHeaders>>;
    beginChangeKeyVaultAndWait(resourceGroupName: string, accountName: string, options?: AccountsChangeKeyVaultOptionalParams): Promise<AccountsChangeKeyVaultHeaders>;
    beginCreateOrUpdate(resourceGroupName: string, accountName: string, body: NetAppAccount, options?: AccountsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, body: NetAppAccount, options?: AccountsCreateOrUpdateOptionalParams): Promise<NetAppAccount>;
    beginDelete(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<void>;
    beginGetChangeKeyVaultInformation(resourceGroupName: string, accountName: string, options?: AccountsGetChangeKeyVaultInformationOptionalParams): Promise<SimplePollerLike<OperationState<AccountsGetChangeKeyVaultInformationHeaders>, AccountsGetChangeKeyVaultInformationHeaders>>;
    beginGetChangeKeyVaultInformationAndWait(resourceGroupName: string, accountName: string, options?: AccountsGetChangeKeyVaultInformationOptionalParams): Promise<AccountsGetChangeKeyVaultInformationHeaders>;
    beginRenewCredentials(resourceGroupName: string, accountName: string, options?: AccountsRenewCredentialsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRenewCredentialsAndWait(resourceGroupName: string, accountName: string, options?: AccountsRenewCredentialsOptionalParams): Promise<void>;
    beginTransitionToCmk(resourceGroupName: string, accountName: string, options?: AccountsTransitionToCmkOptionalParams): Promise<SimplePollerLike<OperationState<AccountsTransitionToCmkHeaders>, AccountsTransitionToCmkHeaders>>;
    beginTransitionToCmkAndWait(resourceGroupName: string, accountName: string, options?: AccountsTransitionToCmkOptionalParams): Promise<AccountsTransitionToCmkHeaders>;
    beginUpdate(resourceGroupName: string, accountName: string, body: NetAppAccountPatch, options?: AccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>;
    beginUpdateAndWait(resourceGroupName: string, accountName: string, body: NetAppAccountPatch, options?: AccountsUpdateOptionalParams): Promise<NetAppAccount>;
    get(resourceGroupName: string, accountName: string, options?: AccountsGetOptionalParams): Promise<NetAppAccount>;
    list(resourceGroupName: string, options?: AccountsListOptionalParams): PagedAsyncIterableIterator<NetAppAccount>;
    listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<NetAppAccount>;
}

Index

Methods

beginChangeKeyVault beginChangeKeyVaultAndWait beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginGetChangeKeyVaultInformation beginGetChangeKeyVaultInformationAndWait beginRenewCredentials beginRenewCredentialsAndWait beginTransitionToCmk beginTransitionToCmkAndWait beginUpdate beginUpdateAndWait get list listBySubscription

Methods

beginChangeKeyVault

beginChangeKeyVault(resourceGroupName, accountName, options?): Promise<SimplePollerLike<OperationState<AccountsChangeKeyVaultHeaders>, AccountsChangeKeyVaultHeaders>>
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.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsChangeKeyVaultOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<AccountsChangeKeyVaultHeaders>, AccountsChangeKeyVaultHeaders>>
- Defined in operationsInterfaces/accounts.ts:241

beginChangeKeyVaultAndWait

beginChangeKeyVaultAndWait(resourceGroupName, accountName, options?): Promise<AccountsChangeKeyVaultHeaders>
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.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsChangeKeyVaultOptionalParams
  The options parameters.
Returns Promise<AccountsChangeKeyVaultHeaders>
- Defined in operationsInterfaces/accounts.ts:258

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, accountName, body, options?): Promise<SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>
Create or update the specified NetApp account within the resource group
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.
- Optionaloptions: AccountsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>
- Defined in operationsInterfaces/accounts.ts:69

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, accountName, body, options?): Promise<NetAppAccount>
Create or update the specified NetApp account within the resource group
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.
- Optionaloptions: AccountsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<NetAppAccount>
- Defined in operationsInterfaces/accounts.ts:87

beginDelete

beginDelete(resourceGroupName, accountName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Delete the specified NetApp account
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/accounts.ts:99

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, accountName, options?): Promise<void>
Delete the specified NetApp account
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/accounts.ts:110

beginGetChangeKeyVaultInformation

beginGetChangeKeyVaultInformation(resourceGroupName, accountName, options?): Promise<SimplePollerLike<OperationState<AccountsGetChangeKeyVaultInformationHeaders>, AccountsGetChangeKeyVaultInformationHeaders>>
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.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsGetChangeKeyVaultInformationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<AccountsGetChangeKeyVaultInformationHeaders>, AccountsGetChangeKeyVaultInformationHeaders>>
- Defined in operationsInterfaces/accounts.ts:211

beginGetChangeKeyVaultInformationAndWait

beginGetChangeKeyVaultInformationAndWait(resourceGroupName, accountName, options?): Promise<AccountsGetChangeKeyVaultInformationHeaders>
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.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsGetChangeKeyVaultInformationOptionalParams
  The options parameters.
Returns Promise<AccountsGetChangeKeyVaultInformationHeaders>
- Defined in operationsInterfaces/accounts.ts:229

beginRenewCredentials

beginRenewCredentials(resourceGroupName, accountName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsRenewCredentialsOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/accounts.ts:154

beginRenewCredentialsAndWait

beginRenewCredentialsAndWait(resourceGroupName, accountName, options?): Promise<void>
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
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsRenewCredentialsOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/accounts.ts:167

beginTransitionToCmk

beginTransitionToCmk(resourceGroupName, accountName, options?): Promise<SimplePollerLike<OperationState<AccountsTransitionToCmkHeaders>, AccountsTransitionToCmkHeaders>>
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.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsTransitionToCmkOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<AccountsTransitionToCmkHeaders>, AccountsTransitionToCmkHeaders>>
- Defined in operationsInterfaces/accounts.ts:180

beginTransitionToCmkAndWait

beginTransitionToCmkAndWait(resourceGroupName, accountName, options?): Promise<AccountsTransitionToCmkHeaders>
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.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsTransitionToCmkOptionalParams
  The options parameters.
Returns Promise<AccountsTransitionToCmkHeaders>
- Defined in operationsInterfaces/accounts.ts:198

beginUpdate

beginUpdate(resourceGroupName, accountName, body, options?): Promise<SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>
Patch the specified NetApp account
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.
- Optionaloptions: AccountsUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>
- Defined in operationsInterfaces/accounts.ts:122

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, accountName, body, options?): Promise<NetAppAccount>
Patch the specified NetApp account
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.
- Optionaloptions: AccountsUpdateOptionalParams
  The options parameters.
Returns Promise<NetAppAccount>
- Defined in operationsInterfaces/accounts.ts:140

get

get(resourceGroupName, accountName, options?): Promise<NetAppAccount>
Get the NetApp account
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: AccountsGetOptionalParams
  The options parameters.
Returns Promise<NetAppAccount>
- Defined in operationsInterfaces/accounts.ts:57

list

list(resourceGroupName, options?): PagedAsyncIterableIterator<NetAppAccount>
List and describe all NetApp accounts in the resource group.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- Optionaloptions: AccountsListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<NetAppAccount>
- Defined in operationsInterfaces/accounts.ts:47

listBySubscription

listBySubscription(options?): PagedAsyncIterableIterator<NetAppAccount>
List and describe all NetApp accounts in the subscription.
Parameters
- Optionaloptions: AccountsListBySubscriptionOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<NetAppAccount>
- Defined in operationsInterfaces/accounts.ts:39

Interface Accounts

Index

Methods

Methods

beginChangeKeyVault

Parameters

Returns Promise<SimplePollerLike<OperationState<AccountsChangeKeyVaultHeaders>, AccountsChangeKeyVaultHeaders>>

beginChangeKeyVaultAndWait

Parameters

Returns Promise<AccountsChangeKeyVaultHeaders>

beginCreateOrUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>

beginCreateOrUpdateAndWait

Parameters

Returns Promise<NetAppAccount>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

beginGetChangeKeyVaultInformation

Parameters

Returns Promise<SimplePollerLike<OperationState<AccountsGetChangeKeyVaultInformationHeaders>, AccountsGetChangeKeyVaultInformationHeaders>>

beginGetChangeKeyVaultInformationAndWait

Parameters

Returns Promise<AccountsGetChangeKeyVaultInformationHeaders>

beginRenewCredentials

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginRenewCredentialsAndWait

Parameters

Returns Promise<void>

beginTransitionToCmk

Parameters

Returns Promise<SimplePollerLike<OperationState<AccountsTransitionToCmkHeaders>, AccountsTransitionToCmkHeaders>>

beginTransitionToCmkAndWait

Parameters

Returns Promise<AccountsTransitionToCmkHeaders>

beginUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<NetAppAccount>, NetAppAccount>>

beginUpdateAndWait

Parameters

Returns Promise<NetAppAccount>

get

Parameters

Returns Promise<NetAppAccount>

list

Parameters

Returns PagedAsyncIterableIterator<NetAppAccount>

listBySubscription

Parameters

Returns PagedAsyncIterableIterator<NetAppAccount>

Settings