keyvaultapi

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Index

• type KeysClientAPI
• type MHSMPrivateEndpointConnectionsClientAPI
• type MHSMPrivateLinkResourcesClientAPI
• type ManagedHsmsClientAPI
• type OperationsClientAPI
• type PrivateEndpointConnectionsClientAPI
• type PrivateLinkResourcesClientAPI
• type SecretsClientAPI
• type VaultsClientAPI

Types

type KeysClientAPI

type KeysClientAPI interface {
	CreateIfNotExist(ctx context.Context, resourceGroupName string, vaultName string, keyName string, parameters keyvault.KeyCreateParameters) (result keyvault.Key, err error)
	Get(ctx context.Context, resourceGroupName string, vaultName string, keyName string) (result keyvault.Key, err error)
	GetVersion(ctx context.Context, resourceGroupName string, vaultName string, keyName string, keyVersion string) (result keyvault.Key, err error)
	List(ctx context.Context, resourceGroupName string, vaultName string) (result keyvault.KeyListResultPage, err error)
	ListComplete(ctx context.Context, resourceGroupName string, vaultName string) (result keyvault.KeyListResultIterator, err error)
	ListVersions(ctx context.Context, resourceGroupName string, vaultName string, keyName string) (result keyvault.KeyListResultPage, err error)
	ListVersionsComplete(ctx context.Context, resourceGroupName string, vaultName string, keyName string) (result keyvault.KeyListResultIterator, err error)
}

KeysClientAPI contains the set of methods on the KeysClient type.

type MHSMPrivateEndpointConnectionsClientAPI

type MHSMPrivateEndpointConnectionsClientAPI interface {
	Delete(ctx context.Context, resourceGroupName string, name string, privateEndpointConnectionName string) (result keyvault.MHSMPrivateEndpointConnectionsDeleteFuture, err error)
	Get(ctx context.Context, resourceGroupName string, name string, privateEndpointConnectionName string) (result keyvault.MHSMPrivateEndpointConnection, err error)
	ListByResource(ctx context.Context, resourceGroupName string, name string) (result keyvault.MHSMPrivateEndpointConnectionsListResultPage, err error)
	ListByResourceComplete(ctx context.Context, resourceGroupName string, name string) (result keyvault.MHSMPrivateEndpointConnectionsListResultIterator, err error)
	Put(ctx context.Context, resourceGroupName string, name string, privateEndpointConnectionName string, properties keyvault.MHSMPrivateEndpointConnection) (result keyvault.MHSMPrivateEndpointConnection, err error)
}

MHSMPrivateEndpointConnectionsClientAPI contains the set of methods on the MHSMPrivateEndpointConnectionsClient type.

type MHSMPrivateLinkResourcesClientAPI

type MHSMPrivateLinkResourcesClientAPI interface {
	ListByMHSMResource(ctx context.Context, resourceGroupName string, name string) (result keyvault.MHSMPrivateLinkResourceListResult, err error)
}

MHSMPrivateLinkResourcesClientAPI contains the set of methods on the MHSMPrivateLinkResourcesClient type.

type ManagedHsmsClientAPI

type ManagedHsmsClientAPI interface {
	CheckMhsmNameAvailability(ctx context.Context, mhsmName keyvault.CheckMhsmNameAvailabilityParameters) (result keyvault.CheckMhsmNameAvailabilityResult, err error)
	CreateOrUpdate(ctx context.Context, resourceGroupName string, name string, parameters keyvault.ManagedHsm) (result keyvault.ManagedHsmsCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, resourceGroupName string, name string) (result keyvault.ManagedHsmsDeleteFuture, err error)
	Get(ctx context.Context, resourceGroupName string, name string) (result keyvault.ManagedHsm, err error)
	GetDeleted(ctx context.Context, name string, location string) (result keyvault.DeletedManagedHsm, err error)
	ListByResourceGroup(ctx context.Context, resourceGroupName string, top *int32) (result keyvault.ManagedHsmListResultPage, err error)
	ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, top *int32) (result keyvault.ManagedHsmListResultIterator, err error)
	ListBySubscription(ctx context.Context, top *int32) (result keyvault.ManagedHsmListResultPage, err error)
	ListBySubscriptionComplete(ctx context.Context, top *int32) (result keyvault.ManagedHsmListResultIterator, err error)
	ListDeleted(ctx context.Context) (result keyvault.DeletedManagedHsmListResultPage, err error)
	ListDeletedComplete(ctx context.Context) (result keyvault.DeletedManagedHsmListResultIterator, err error)
	PurgeDeleted(ctx context.Context, name string, location string) (result keyvault.ManagedHsmsPurgeDeletedFuture, err error)
	Update(ctx context.Context, resourceGroupName string, name string, parameters keyvault.ManagedHsm) (result keyvault.ManagedHsmsUpdateFuture, err error)
}

ManagedHsmsClientAPI contains the set of methods on the ManagedHsmsClient type.

type OperationsClientAPI

type OperationsClientAPI interface {
	List(ctx context.Context) (result keyvault.OperationListResultPage, err error)
	ListComplete(ctx context.Context) (result keyvault.OperationListResultIterator, err error)
}

OperationsClientAPI contains the set of methods on the OperationsClient type.

type PrivateEndpointConnectionsClientAPI

type PrivateEndpointConnectionsClientAPI interface {
	Delete(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string) (result keyvault.PrivateEndpointConnectionsDeleteFuture, err error)
	Get(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string) (result keyvault.PrivateEndpointConnection, err error)
	ListByResource(ctx context.Context, resourceGroupName string, vaultName string) (result keyvault.PrivateEndpointConnectionListResultPage, err error)
	ListByResourceComplete(ctx context.Context, resourceGroupName string, vaultName string) (result keyvault.PrivateEndpointConnectionListResultIterator, err error)
	Put(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string, properties keyvault.PrivateEndpointConnection) (result keyvault.PrivateEndpointConnection, err error)
}

PrivateEndpointConnectionsClientAPI contains the set of methods on the PrivateEndpointConnectionsClient type.

type PrivateLinkResourcesClientAPI

type PrivateLinkResourcesClientAPI interface {
	ListByVault(ctx context.Context, resourceGroupName string, vaultName string) (result keyvault.PrivateLinkResourceListResult, err error)
}

PrivateLinkResourcesClientAPI contains the set of methods on the PrivateLinkResourcesClient type.

type SecretsClientAPI

type SecretsClientAPI interface {
	CreateOrUpdate(ctx context.Context, resourceGroupName string, vaultName string, secretName string, parameters keyvault.SecretCreateOrUpdateParameters) (result keyvault.Secret, err error)
	Get(ctx context.Context, resourceGroupName string, vaultName string, secretName string) (result keyvault.Secret, err error)
	List(ctx context.Context, resourceGroupName string, vaultName string, top *int32) (result keyvault.SecretListResultPage, err error)
	ListComplete(ctx context.Context, resourceGroupName string, vaultName string, top *int32) (result keyvault.SecretListResultIterator, err error)
	Update(ctx context.Context, resourceGroupName string, vaultName string, secretName string, parameters keyvault.SecretPatchParameters) (result keyvault.Secret, err error)
}

SecretsClientAPI contains the set of methods on the SecretsClient type.

type VaultsClientAPI

type VaultsClientAPI interface {
	CheckNameAvailability(ctx context.Context, vaultName keyvault.VaultCheckNameAvailabilityParameters) (result keyvault.CheckNameAvailabilityResult, err error)
	CreateOrUpdate(ctx context.Context, resourceGroupName string, vaultName string, parameters keyvault.VaultCreateOrUpdateParameters) (result keyvault.VaultsCreateOrUpdateFuture, err error)
	Delete(ctx context.Context, resourceGroupName string, vaultName string) (result autorest.Response, err error)
	Get(ctx context.Context, resourceGroupName string, vaultName string) (result keyvault.Vault, err error)
	GetDeleted(ctx context.Context, vaultName string, location string) (result keyvault.DeletedVault, err error)
	List(ctx context.Context, top *int32) (result keyvault.ResourceListResultPage, err error)
	ListComplete(ctx context.Context, top *int32) (result keyvault.ResourceListResultIterator, err error)
	ListByResourceGroup(ctx context.Context, resourceGroupName string, top *int32) (result keyvault.VaultListResultPage, err error)
	ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, top *int32) (result keyvault.VaultListResultIterator, err error)
	ListBySubscription(ctx context.Context, top *int32) (result keyvault.VaultListResultPage, err error)
	ListBySubscriptionComplete(ctx context.Context, top *int32) (result keyvault.VaultListResultIterator, err error)
	ListDeleted(ctx context.Context) (result keyvault.DeletedVaultListResultPage, err error)
	ListDeletedComplete(ctx context.Context) (result keyvault.DeletedVaultListResultIterator, err error)
	PurgeDeleted(ctx context.Context, vaultName string, location string) (result keyvault.VaultsPurgeDeletedFuture, err error)
	Update(ctx context.Context, resourceGroupName string, vaultName string, parameters keyvault.VaultPatchParameters) (result keyvault.Vault, err error)
	UpdateAccessPolicy(ctx context.Context, resourceGroupName string, vaultName string, operationKind keyvault.AccessPolicyUpdateKind, parameters keyvault.VaultAccessPolicyParameters) (result keyvault.VaultAccessPolicyParameters, err error)
}

VaultsClientAPI contains the set of methods on the VaultsClient type.