keys

package
v0.20240617.1095803 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 17, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/keyvault/2023-07-01/keys Documentation

The keys SDK allows for interaction with the Azure Resource Manager Service keyvault (API Version 2023-07-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/keyvault/2023-07-01/keys"

Client Initialization

client := keys.NewKeysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: KeysClient.CreateIfNotExist

ctx := context.TODO()
id := commonids.NewKeyVaultKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "keyValue")

payload := keys.KeyCreateParameters{
	// ...
}


read, err := client.CreateIfNotExist(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: KeysClient.Get

ctx := context.TODO()
id := commonids.NewKeyVaultKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "keyValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: KeysClient.GetVersion

ctx := context.TODO()
id := commonids.NewKeyVaultKeyVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "keyValue", "versionValue")

read, err := client.GetVersion(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: KeysClient.List

ctx := context.TODO()
id := commonids.NewKeyVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: KeysClient.ListVersions

ctx := context.TODO()
id := commonids.NewKeyVaultKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "keyValue")

// alternatively `client.ListVersions(ctx, id)` can be used to do batched pagination
items, err := client.ListVersionsComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDeletionRecoveryLevel 

func PossibleValuesForDeletionRecoveryLevel() []string

func PossibleValuesForJsonWebKeyCurveName 

func PossibleValuesForJsonWebKeyCurveName() []string

func PossibleValuesForJsonWebKeyOperation 

func PossibleValuesForJsonWebKeyOperation() []string

func PossibleValuesForJsonWebKeyType 

func PossibleValuesForJsonWebKeyType() []string

func PossibleValuesForKeyRotationPolicyActionType 

func PossibleValuesForKeyRotationPolicyActionType() []string

Types

type Action 

type Action struct {
	Type *KeyRotationPolicyActionType `json:"type,omitempty"`
}

type CreateIfNotExistOperationResponse 

type CreateIfNotExistOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Key
}

type DeletionRecoveryLevel 

type DeletionRecoveryLevel string
const (
	DeletionRecoveryLevelPurgeable                                DeletionRecoveryLevel = "Purgeable"
	DeletionRecoveryLevelRecoverable                              DeletionRecoveryLevel = "Recoverable"
	DeletionRecoveryLevelRecoverablePositiveProtectedSubscription DeletionRecoveryLevel = "Recoverable+ProtectedSubscription"
	DeletionRecoveryLevelRecoverablePositivePurgeable             DeletionRecoveryLevel = "Recoverable+Purgeable"
)

func (*DeletionRecoveryLevel) UnmarshalJSON 

func (s *DeletionRecoveryLevel) UnmarshalJSON(bytes []byte) error

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Key
}

type GetVersionOperationResponse 

type GetVersionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Key
}

type JsonWebKeyCurveName 

type JsonWebKeyCurveName string
const (
	JsonWebKeyCurveNamePNegativeFiveTwoOne     JsonWebKeyCurveName = "P-521"
	JsonWebKeyCurveNamePNegativeThreeEightFour JsonWebKeyCurveName = "P-384"
	JsonWebKeyCurveNamePNegativeTwoFiveSix     JsonWebKeyCurveName = "P-256"
	JsonWebKeyCurveNamePNegativeTwoFiveSixK    JsonWebKeyCurveName = "P-256K"
)

func (*JsonWebKeyCurveName) UnmarshalJSON 

func (s *JsonWebKeyCurveName) UnmarshalJSON(bytes []byte) error

type JsonWebKeyOperation 

type JsonWebKeyOperation string
const (
	JsonWebKeyOperationDecrypt   JsonWebKeyOperation = "decrypt"
	JsonWebKeyOperationEncrypt   JsonWebKeyOperation = "encrypt"
	JsonWebKeyOperationImport    JsonWebKeyOperation = "import"
	JsonWebKeyOperationRelease   JsonWebKeyOperation = "release"
	JsonWebKeyOperationSign      JsonWebKeyOperation = "sign"
	JsonWebKeyOperationUnwrapKey JsonWebKeyOperation = "unwrapKey"
	JsonWebKeyOperationVerify    JsonWebKeyOperation = "verify"
	JsonWebKeyOperationWrapKey   JsonWebKeyOperation = "wrapKey"
)

func (*JsonWebKeyOperation) UnmarshalJSON 

func (s *JsonWebKeyOperation) UnmarshalJSON(bytes []byte) error

type JsonWebKeyType 

type JsonWebKeyType string
const (
	JsonWebKeyTypeEC             JsonWebKeyType = "EC"
	JsonWebKeyTypeECNegativeHSM  JsonWebKeyType = "EC-HSM"
	JsonWebKeyTypeRSA            JsonWebKeyType = "RSA"
	JsonWebKeyTypeRSANegativeHSM JsonWebKeyType = "RSA-HSM"
)

func (*JsonWebKeyType) UnmarshalJSON 

func (s *JsonWebKeyType) UnmarshalJSON(bytes []byte) error

type Key 

type Key struct {
	Id         *string            `json:"id,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties KeyProperties      `json:"properties"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type KeyAttributes 

type KeyAttributes struct {
	Created       *int64                 `json:"created,omitempty"`
	Enabled       *bool                  `json:"enabled,omitempty"`
	Exp           *int64                 `json:"exp,omitempty"`
	Exportable    *bool                  `json:"exportable,omitempty"`
	Nbf           *int64                 `json:"nbf,omitempty"`
	RecoveryLevel *DeletionRecoveryLevel `json:"recoveryLevel,omitempty"`
	Updated       *int64                 `json:"updated,omitempty"`
}

type KeyCreateParameters 

type KeyCreateParameters struct {
	Properties KeyProperties      `json:"properties"`
	Tags       *map[string]string `json:"tags,omitempty"`
}

type KeyOperationPredicate 

type KeyOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (KeyOperationPredicate) Matches 

func (p KeyOperationPredicate) Matches(input Key) bool

type KeyProperties 

type KeyProperties struct {
	Attributes        *KeyAttributes         `json:"attributes,omitempty"`
	CurveName         *JsonWebKeyCurveName   `json:"curveName,omitempty"`
	KeyOps            *[]JsonWebKeyOperation `json:"keyOps,omitempty"`
	KeySize           *int64                 `json:"keySize,omitempty"`
	KeyUri            *string                `json:"keyUri,omitempty"`
	KeyUriWithVersion *string                `json:"keyUriWithVersion,omitempty"`
	Kty               *JsonWebKeyType        `json:"kty,omitempty"`
	ReleasePolicy     *KeyReleasePolicy      `json:"release_policy,omitempty"`
	RotationPolicy    *RotationPolicy        `json:"rotationPolicy,omitempty"`
}

type KeyReleasePolicy 

type KeyReleasePolicy struct {
	ContentType *string `json:"contentType,omitempty"`
	Data        *string `json:"data,omitempty"`
}

type KeyRotationPolicyActionType 

type KeyRotationPolicyActionType string
const (
	KeyRotationPolicyActionTypeNotify KeyRotationPolicyActionType = "notify"
	KeyRotationPolicyActionTypeRotate KeyRotationPolicyActionType = "rotate"
)

func (*KeyRotationPolicyActionType) UnmarshalJSON 

func (s *KeyRotationPolicyActionType) UnmarshalJSON(bytes []byte) error

type KeyRotationPolicyAttributes 

type KeyRotationPolicyAttributes struct {
	Created    *int64  `json:"created,omitempty"`
	ExpiryTime *string `json:"expiryTime,omitempty"`
	Updated    *int64  `json:"updated,omitempty"`
}

type KeysClient 

type KeysClient struct {
	Client *resourcemanager.Client
}

func NewKeysClientWithBaseURI 

func NewKeysClientWithBaseURI(sdkApi sdkEnv.Api) (*KeysClient, error)

func (KeysClient) CreateIfNotExist 

func (c KeysClient) CreateIfNotExist(ctx context.Context, id commonids.KeyVaultKeyId, input KeyCreateParameters) (result CreateIfNotExistOperationResponse, err error)

CreateIfNotExist ...

func (KeysClient) Get 

func (c KeysClient) Get(ctx context.Context, id commonids.KeyVaultKeyId) (result GetOperationResponse, err error)

Get ...

func (KeysClient) GetVersion 

func (c KeysClient) GetVersion(ctx context.Context, id commonids.KeyVaultKeyVersionId) (result GetVersionOperationResponse, err error)

GetVersion ...

func (KeysClient) List 

func (c KeysClient) List(ctx context.Context, id commonids.KeyVaultId) (result ListOperationResponse, err error)

List ...

func (KeysClient) ListComplete 

func (c KeysClient) ListComplete(ctx context.Context, id commonids.KeyVaultId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (KeysClient) ListCompleteMatchingPredicate 

func (c KeysClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.KeyVaultId, predicate KeyOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (KeysClient) ListVersions 

func (c KeysClient) ListVersions(ctx context.Context, id commonids.KeyVaultKeyId) (result ListVersionsOperationResponse, err error)

ListVersions ...

func (KeysClient) ListVersionsComplete 

func (c KeysClient) ListVersionsComplete(ctx context.Context, id commonids.KeyVaultKeyId) (ListVersionsCompleteResult, error)

ListVersionsComplete retrieves all the results into a single object

func (KeysClient) ListVersionsCompleteMatchingPredicate 

func (c KeysClient) ListVersionsCompleteMatchingPredicate(ctx context.Context, id commonids.KeyVaultKeyId, predicate KeyOperationPredicate) (result ListVersionsCompleteResult, err error)

ListVersionsCompleteMatchingPredicate retrieves all the results and then applies the predicate

type LifetimeAction 

type LifetimeAction struct {
	Action  *Action  `json:"action,omitempty"`
	Trigger *Trigger `json:"trigger,omitempty"`
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Key
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Key
}

type ListVersionsCompleteResult 

type ListVersionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Key
}

type ListVersionsOperationResponse 

type ListVersionsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Key
}

type RotationPolicy 

type RotationPolicy struct {
	Attributes      *KeyRotationPolicyAttributes `json:"attributes,omitempty"`
	LifetimeActions *[]LifetimeAction            `json:"lifetimeActions,omitempty"`
}

type Trigger 

type Trigger struct {
	TimeAfterCreate  *string `json:"timeAfterCreate,omitempty"`
	TimeBeforeExpiry *string `json:"timeBeforeExpiry,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.