@azure/arm-keyvault-profile-2020-09-01-hybrid package

Classes

KeyVaultManagementClient

Interfaces

AccessPolicyEntry

An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.

Attributes

The object attributes managed by the KeyVault service.

CheckNameAvailabilityResult

The CheckNameAvailability operation response.

CloudError

An error response from Key Vault resource provider

CloudErrorBody

An error response from Key Vault resource provider

DeletedVault

Deleted vault information with extended details.

DeletedVaultListResult

List of vaults

DeletedVaultProperties

Properties of the deleted vault.

DimensionProperties

Type of operation: get, read, delete, etc.

IPRule

A rule governing the accessibility of a vault from a specific ip address or ip range.

KeyVaultManagementClientOptionalParams

Optional parameters.

LogSpecification

Log specification of operation.

MetricSpecification

Metric specification of operation.

NetworkRuleSet

A set of rules governing the network accessibility of a vault.

Operation

Key Vault REST API operation definition.

OperationDisplay

Display metadata associated with the operation.

OperationListResult

Result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

Permissions

Permissions the identity has for keys, secrets, certificates and storage.

PrivateEndpoint

Private endpoint object properties.

PrivateEndpointConnection

Private endpoint connection resource.

PrivateEndpointConnectionItem

Private endpoint connection item.

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsDeleteHeaders

Defines headers for PrivateEndpointConnections_delete operation.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsPutHeaders

Defines headers for PrivateEndpointConnections_put operation.

PrivateEndpointConnectionsPutOptionalParams

Optional parameters.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesListByVaultOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

An object that represents the approval state of the private link connection.

Resource

Key Vault resource

ResourceListResult

List of vault resources.

Secret

Resource information with extended details.

SecretAttributes

The secret management attributes.

SecretCreateOrUpdateParameters

Parameters for creating or updating a secret

SecretListResult

List of secrets

SecretPatchParameters

Parameters for patching a secret

SecretPatchProperties

Properties of the secret

SecretProperties

Properties of the secret

Secrets

Interface representing a Secrets.

SecretsCreateOrUpdateOptionalParams

Optional parameters.

SecretsGetOptionalParams

Optional parameters.

SecretsListNextOptionalParams

Optional parameters.

SecretsListOptionalParams

Optional parameters.

SecretsUpdateOptionalParams

Optional parameters.

ServiceSpecification

One property of operation, include log specifications.

Sku

SKU details

Vault

Resource information with extended details.

VaultAccessPolicyParameters

Parameters for updating the access policy in a vault

VaultAccessPolicyProperties

Properties of the vault access policy

VaultCheckNameAvailabilityParameters

The parameters used to check the availability of the vault name.

VaultCreateOrUpdateParameters

Parameters for creating or updating a vault

VaultListResult

List of vaults

VaultPatchParameters

Parameters for creating or updating a vault

VaultPatchProperties

Properties of the vault

VaultProperties

Properties of the vault

Vaults

Interface representing a Vaults.

VaultsCheckNameAvailabilityOptionalParams

Optional parameters.

VaultsCreateOrUpdateOptionalParams

Optional parameters.

VaultsDeleteOptionalParams

Optional parameters.

VaultsGetDeletedOptionalParams

Optional parameters.

VaultsGetOptionalParams

Optional parameters.

VaultsListByResourceGroupNextOptionalParams

Optional parameters.

VaultsListByResourceGroupOptionalParams

Optional parameters.

VaultsListBySubscriptionNextOptionalParams

Optional parameters.

VaultsListBySubscriptionOptionalParams

Optional parameters.

VaultsListDeletedNextOptionalParams

Optional parameters.

VaultsListDeletedOptionalParams

Optional parameters.

VaultsListNextOptionalParams

Optional parameters.

VaultsListOptionalParams

Optional parameters.

VaultsPurgeDeletedOptionalParams

Optional parameters.

VaultsUpdateAccessPolicyOptionalParams

Optional parameters.

VaultsUpdateOptionalParams

Optional parameters.

VirtualNetworkRule

A rule governing the accessibility of a vault from a specific virtual network.

Type Aliases

AccessPolicyUpdateKind

Defines values for AccessPolicyUpdateKind.

CertificatePermissions

Defines values for CertificatePermissions.
KnownCertificatePermissions can be used interchangeably with CertificatePermissions, this enum contains the known values that the service supports.

Known values supported by the service

all
get
list
delete
create
import
update
managecontacts
getissuers
listissuers
setissuers
deleteissuers
manageissuers
recover
purge
backup
restore

CreateMode

Defines values for CreateMode.

KeyPermissions

Defines values for KeyPermissions.
KnownKeyPermissions can be used interchangeably with KeyPermissions, this enum contains the known values that the service supports.

Known values supported by the service

all
encrypt
decrypt
wrapKey
unwrapKey
sign
verify
get
list
create
update
import
delete
backup
restore
recover
purge

NetworkRuleAction

Defines values for NetworkRuleAction.
KnownNetworkRuleAction can be used interchangeably with NetworkRuleAction, this enum contains the known values that the service supports.

Known values supported by the service

Allow
Deny

NetworkRuleBypassOptions

Defines values for NetworkRuleBypassOptions.
KnownNetworkRuleBypassOptions can be used interchangeably with NetworkRuleBypassOptions, this enum contains the known values that the service supports.

Known values supported by the service

AzureServices
None

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Updating
Deleting
Failed
Disconnected

PrivateEndpointConnectionsDeleteResponse

Contains response data for the delete operation.

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsPutResponse

Contains response data for the put operation.

PrivateEndpointServiceConnectionStatus

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected
Disconnected

PrivateLinkResourcesListByVaultResponse

Contains response data for the listByVault operation.

Reason

Defines values for Reason.

SecretPermissions

Defines values for SecretPermissions.
KnownSecretPermissions can be used interchangeably with SecretPermissions, this enum contains the known values that the service supports.

Known values supported by the service

all
get
list
set
delete
backup
restore
recover
purge

SecretsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

SecretsGetResponse

Contains response data for the get operation.

SecretsListNextResponse

Contains response data for the listNext operation.

SecretsListResponse

Contains response data for the list operation.

SecretsUpdateResponse

Contains response data for the update operation.

SkuFamily

Defines values for SkuFamily.
KnownSkuFamily can be used interchangeably with SkuFamily, this enum contains the known values that the service supports.

Known values supported by the service

A

SkuName

Defines values for SkuName.

StoragePermissions

Defines values for StoragePermissions.
KnownStoragePermissions can be used interchangeably with StoragePermissions, this enum contains the known values that the service supports.

Known values supported by the service

all
get
list
delete
set
update
regeneratekey
recover
purge
backup
restore
setsas
listsas
getsas
deletesas

VaultProvisioningState

Defines values for VaultProvisioningState.
KnownVaultProvisioningState can be used interchangeably with VaultProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
RegisteringDns

VaultsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

VaultsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

VaultsGetDeletedResponse

Contains response data for the getDeleted operation.

VaultsGetResponse

Contains response data for the get operation.

VaultsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

VaultsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

VaultsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

VaultsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

VaultsListDeletedNextResponse

Contains response data for the listDeletedNext operation.

VaultsListDeletedResponse

Contains response data for the listDeleted operation.

VaultsListNextResponse

Contains response data for the listNext operation.

VaultsListResponse

Contains response data for the list operation.

VaultsUpdateAccessPolicyResponse

Contains response data for the updateAccessPolicy operation.

VaultsUpdateResponse

Contains response data for the update operation.

Enums

KnownCertificatePermissions

Known values of CertificatePermissions that the service accepts.

KnownKeyPermissions

Known values of KeyPermissions that the service accepts.

KnownNetworkRuleAction

Known values of NetworkRuleAction that the service accepts.

KnownNetworkRuleBypassOptions

Known values of NetworkRuleBypassOptions that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownSecretPermissions

Known values of SecretPermissions that the service accepts.

KnownSkuFamily

Known values of SkuFamily that the service accepts.

KnownStoragePermissions

Known values of StoragePermissions that the service accepts.

KnownVaultProvisioningState

Known values of VaultProvisioningState that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.