README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/keyvault/2023-02-01/secrets
Documentation
The secrets
SDK allows for interaction with the Azure Resource Manager Service keyvault
(API Version 2023-02-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-02-01/secrets"
Client Initialization
client := secrets.NewSecretsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SecretsClient.CreateOrUpdate
ctx := context.TODO()
id := secrets.NewSecretID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "secretValue")
payload := secrets.SecretCreateOrUpdateParameters{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: SecretsClient.Get
ctx := context.TODO()
id := secrets.NewSecretID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "secretValue")
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: SecretsClient.List
ctx := context.TODO()
id := commonids.NewKeyVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")
// alternatively `client.List(ctx, id, secrets.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, secrets.DefaultListOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: SecretsClient.Update
ctx := context.TODO()
id := secrets.NewSecretID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "secretValue")
payload := secrets.SecretPatchParameters{
// ...
}
read, err := client.Update(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func ValidateSecretID(input interface{}, key string) (warnings []string, errors []error)
- type Attributes
- type CreateOrUpdateOperationResponse
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationOptions
- type ListOperationResponse
- type Secret
- type SecretCreateOrUpdateParameters
- type SecretId
- type SecretOperationPredicate
- type SecretPatchParameters
- type SecretPatchProperties
- type SecretProperties
- type SecretsClient
- func (c SecretsClient) CreateOrUpdate(ctx context.Context, id SecretId, input SecretCreateOrUpdateParameters) (result CreateOrUpdateOperationResponse, err error)
- func (c SecretsClient) Get(ctx context.Context, id SecretId) (result GetOperationResponse, err error)
- func (c SecretsClient) List(ctx context.Context, id commonids.KeyVaultId, options ListOperationOptions) (resp ListOperationResponse, err error)
- func (c SecretsClient) ListComplete(ctx context.Context, id commonids.KeyVaultId, options ListOperationOptions) (ListCompleteResult, error)
- func (c SecretsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.KeyVaultId, options ListOperationOptions, ...) (resp ListCompleteResult, err error)
- func (c SecretsClient) Update(ctx context.Context, id SecretId, input SecretPatchParameters) (result UpdateOperationResponse, err error)
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateSecretID ¶
ValidateSecretID checks that 'input' can be parsed as a Secret ID
Types ¶
type Attributes ¶
type GetOperationResponse ¶
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []Secret
}
type ListOperationOptions ¶
type ListOperationOptions struct {
Top *int64
}
func DefaultListOperationOptions ¶
func DefaultListOperationOptions() ListOperationOptions
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response Model *[]Secret // contains filtered or unexported fields }
func (ListOperationResponse) HasMore ¶
func (r ListOperationResponse) HasMore() bool
func (ListOperationResponse) LoadMore ¶
func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)
type SecretCreateOrUpdateParameters ¶
type SecretCreateOrUpdateParameters struct { Properties SecretProperties `json:"properties"` Tags *map[string]string `json:"tags,omitempty"` }
type SecretId ¶
type SecretId struct { SubscriptionId string ResourceGroupName string VaultName string SecretName string }
SecretId is a struct representing the Resource ID for a Secret
func NewSecretID ¶
func NewSecretID(subscriptionId string, resourceGroupName string, vaultName string, secretName string) SecretId
NewSecretID returns a new SecretId struct
func ParseSecretID ¶
ParseSecretID parses 'input' into a SecretId
func ParseSecretIDInsensitively ¶
ParseSecretIDInsensitively parses 'input' case-insensitively into a SecretId note: this method should only be used for API response data and not user input
func (*SecretId) FromParseResult ¶
func (id *SecretId) FromParseResult(input resourceids.ParseResult) error
func (SecretId) Segments ¶
func (id SecretId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Secret ID
type SecretOperationPredicate ¶
func (SecretOperationPredicate) Matches ¶
func (p SecretOperationPredicate) Matches(input Secret) bool
type SecretPatchParameters ¶
type SecretPatchParameters struct { Properties *SecretPatchProperties `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` }
type SecretPatchProperties ¶
type SecretPatchProperties struct { Attributes *Attributes `json:"attributes,omitempty"` ContentType *string `json:"contentType,omitempty"` Value *string `json:"value,omitempty"` }
type SecretProperties ¶
type SecretProperties struct { Attributes *Attributes `json:"attributes,omitempty"` ContentType *string `json:"contentType,omitempty"` SecretUri *string `json:"secretUri,omitempty"` SecretUriWithVersion *string `json:"secretUriWithVersion,omitempty"` Value *string `json:"value,omitempty"` }
type SecretsClient ¶
func NewSecretsClientWithBaseURI ¶
func NewSecretsClientWithBaseURI(endpoint string) SecretsClient
func (SecretsClient) CreateOrUpdate ¶
func (c SecretsClient) CreateOrUpdate(ctx context.Context, id SecretId, input SecretCreateOrUpdateParameters) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (SecretsClient) Get ¶
func (c SecretsClient) Get(ctx context.Context, id SecretId) (result GetOperationResponse, err error)
Get ...
func (SecretsClient) List ¶
func (c SecretsClient) List(ctx context.Context, id commonids.KeyVaultId, options ListOperationOptions) (resp ListOperationResponse, err error)
List ...
func (SecretsClient) ListComplete ¶
func (c SecretsClient) ListComplete(ctx context.Context, id commonids.KeyVaultId, options ListOperationOptions) (ListCompleteResult, error)
ListComplete retrieves all of the results into a single object
func (SecretsClient) ListCompleteMatchingPredicate ¶
func (c SecretsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.KeyVaultId, options ListOperationOptions, predicate SecretOperationPredicate) (resp ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (SecretsClient) Update ¶
func (c SecretsClient) Update(ctx context.Context, id SecretId, input SecretPatchParameters) (result UpdateOperationResponse, err error)
Update ...
type UpdateOperationResponse ¶
Source Files ¶
- client.go
- id_secret.go
- method_createorupdate_autorest.go
- method_get_autorest.go
- method_list_autorest.go
- method_update_autorest.go
- model_attributes.go
- model_secret.go
- model_secretcreateorupdateparameters.go
- model_secretpatchparameters.go
- model_secretpatchproperties.go
- model_secretproperties.go
- predicates.go
- version.go