@azure/arm-secretsstoreextension package

Classes

SecretsStoreExtensionManagementClient

Interfaces

AzureKeyVaultSecretProviderClass	The AzureKeyVaultSecretProviderClass resource.
AzureKeyVaultSecretProviderClassProperties	The properties of the AzureKeyVaultSecretProviderClass.
AzureKeyVaultSecretProviderClassUpdate	The type used for update operations of the AzureKeyVaultSecretProviderClass.
AzureKeyVaultSecretProviderClassUpdateProperties	The updatable properties of the AzureKeyVaultSecretProviderClass.
AzureKeyVaultSecretProviderClassesCreateOrUpdateOptionalParams	Optional parameters.
AzureKeyVaultSecretProviderClassesDeleteOptionalParams	Optional parameters.
AzureKeyVaultSecretProviderClassesGetOptionalParams	Optional parameters.
AzureKeyVaultSecretProviderClassesListByResourceGroupOptionalParams	Optional parameters.
AzureKeyVaultSecretProviderClassesListBySubscriptionOptionalParams	Optional parameters.
AzureKeyVaultSecretProviderClassesOperations	Interface representing a AzureKeyVaultSecretProviderClasses operations.
AzureKeyVaultSecretProviderClassesUpdateOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExtendedLocation	The complex type of the extended location.
KubernetesSecretObjectMapping	Properties defining the mapping between a cloud secret store object and a Kubernetes Secret.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SecretSync	The SecretSync resource.
SecretSyncCondition	A condition represents the status of the secret create and update processes.
SecretSyncProperties	The properties of the SecretSync instance.
SecretSyncStatus	SecretSyncStatus defines the observed state of the secret synchronization process.
SecretSyncUpdate	The type used for update operations of the SecretSync.
SecretSyncUpdateProperties	The updatable properties of the SecretSync.
SecretSyncsCreateOrUpdateOptionalParams	Optional parameters.
SecretSyncsDeleteOptionalParams	Optional parameters.
SecretSyncsGetOptionalParams	Optional parameters.
SecretSyncsListByResourceGroupOptionalParams	Optional parameters.
SecretSyncsListBySubscriptionOptionalParams	Optional parameters.
SecretSyncsOperations	Interface representing a SecretSyncs operations.
SecretSyncsUpdateOptionalParams	Optional parameters.
SecretsStoreExtensionManagementClientOptionalParams	Optional parameters for the client.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureCloudName	Azure clouds for the in-cluster Azure Key Vault provider. KnownAzureCloudName can be used interchangeably with AzureCloudName, this enum contains the known values that the service supports. Known values supported by the service AzurePublicCloud: Azure public cloud. AzureUSGovernmentCloud: Azure US Government cloud. AzureChinaCloud: Azure China cloud. AzureGermanCloud: Azure Germany cloud. AzureStackCloud: Azure Stack cloud.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
ExtendedLocationType	The supported ExtendedLocation types. KnownExtendedLocationType can be used interchangeably with ExtendedLocationType, this enum contains the known values that the service supports. Known values supported by the service EdgeZone: Azure Edge Zones location type CustomLocation: Azure Custom Locations type
KubernetesSecretType	Supported Kubernetes secret types. KnownKubernetesSecretType can be used interchangeably with KubernetesSecretType, this enum contains the known values that the service supports. Known values supported by the service Opaque: Opaque is the default secret type. kubernetes.io/tls: The kubernetes.io/tls secret type is for storing a certificate and its associated key that are typically used for TLS.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ProvisioningState	Provisioning state of the resource. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled.
StatusConditionType	Status conditions types KnownStatusConditionType can be used interchangeably with StatusConditionType, this enum contains the known values that the service supports. Known values supported by the service True: The status is true False: The status is false Unknown: The status is unknown

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAzureCloudName	Azure clouds for the in-cluster Azure Key Vault provider.
KnownCreatedByType	The kind of entity that created the resource.
KnownExtendedLocationType	The supported ExtendedLocation types.
KnownKubernetesSecretType	Supported Kubernetes secret types.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	Provisioning state of the resource.
KnownStatusConditionType	Status conditions types
KnownVersions	Supported API versions for the Microsoft.SecretSyncController resource provider.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(SecretsStoreExtensionManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

restorePoller<TResponse, TResult>(SecretsStoreExtensionManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: SecretsStoreExtensionManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

SecretsStoreExtensionManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor