README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/devtestlab/2018-09-15/secrets
Documentation
The secrets
SDK allows for interaction with the Azure Resource Manager Service devtestlab
(API Version 2018-09-15
).
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-sdk/resource-manager/devtestlab/2018-09-15/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", "labValue", "userValue", "secretValue")
payload := secrets.Secret{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: SecretsClient.Delete
ctx := context.TODO()
id := secrets.NewSecretID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "secretValue")
read, err := client.Delete(ctx, id)
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", "labValue", "userValue", "secretValue")
read, err := client.Get(ctx, id, secrets.DefaultGetOperationOptions())
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 := secrets.NewUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue")
// 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", "labValue", "userValue", "secretValue")
payload := secrets.UpdateResource{
// ...
}
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)
- func ValidateUserID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationOptions
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationOptions
- type ListOperationResponse
- type Secret
- type SecretId
- type SecretOperationPredicate
- type SecretProperties
- type SecretsClient
- func (c SecretsClient) CreateOrUpdate(ctx context.Context, id SecretId, input Secret) (result CreateOrUpdateOperationResponse, err error)
- func (c SecretsClient) CreateOrUpdateThenPoll(ctx context.Context, id SecretId, input Secret) error
- func (c SecretsClient) Delete(ctx context.Context, id SecretId) (result DeleteOperationResponse, err error)
- func (c SecretsClient) Get(ctx context.Context, id SecretId, options GetOperationOptions) (result GetOperationResponse, err error)
- func (c SecretsClient) List(ctx context.Context, id UserId, options ListOperationOptions) (result ListOperationResponse, err error)
- func (c SecretsClient) ListComplete(ctx context.Context, id UserId, options ListOperationOptions) (ListCompleteResult, error)
- func (c SecretsClient) ListCompleteMatchingPredicate(ctx context.Context, id UserId, options ListOperationOptions, ...) (result ListCompleteResult, err error)
- func (c SecretsClient) Update(ctx context.Context, id SecretId, input UpdateResource) (result UpdateOperationResponse, err error)
- type UpdateOperationResponse
- type UpdateResource
- type UserId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateSecretID ¶
ValidateSecretID checks that 'input' can be parsed as a Secret ID
func ValidateUserID ¶
ValidateUserID checks that 'input' can be parsed as a User ID
Types ¶
type DeleteOperationResponse ¶
type GetOperationOptions ¶
type GetOperationOptions struct {
Expand *string
}
func DefaultGetOperationOptions ¶
func DefaultGetOperationOptions() GetOperationOptions
func (GetOperationOptions) ToHeaders ¶ added in v0.20230815.1165905
func (o GetOperationOptions) ToHeaders() *client.Headers
func (GetOperationOptions) ToOData ¶ added in v0.20230815.1165905
func (o GetOperationOptions) ToOData() *odata.Query
func (GetOperationOptions) ToQuery ¶ added in v0.20230815.1165905
func (o GetOperationOptions) ToQuery() *client.QueryParams
type GetOperationResponse ¶
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []Secret
}
type ListOperationOptions ¶
func DefaultListOperationOptions ¶
func DefaultListOperationOptions() ListOperationOptions
func (ListOperationOptions) ToHeaders ¶ added in v0.20230815.1165905
func (o ListOperationOptions) ToHeaders() *client.Headers
func (ListOperationOptions) ToOData ¶ added in v0.20230815.1165905
func (o ListOperationOptions) ToOData() *odata.Query
func (ListOperationOptions) ToQuery ¶ added in v0.20230815.1165905
func (o ListOperationOptions) ToQuery() *client.QueryParams
type ListOperationResponse ¶
type SecretId ¶
type SecretId struct { SubscriptionId string ResourceGroupName string LabName string UserName string SecretName string }
SecretId is a struct representing the Resource ID for a Secret
func NewSecretID ¶
func NewSecretID(subscriptionId string, resourceGroupName string, labName string, userName 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) 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 SecretProperties ¶
type SecretsClient ¶
type SecretsClient struct {
Client *resourcemanager.Client
}
func NewSecretsClientWithBaseURI ¶
func NewSecretsClientWithBaseURI(sdkApi sdkEnv.Api) (*SecretsClient, error)
func (SecretsClient) CreateOrUpdate ¶
func (c SecretsClient) CreateOrUpdate(ctx context.Context, id SecretId, input Secret) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (SecretsClient) CreateOrUpdateThenPoll ¶
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (SecretsClient) Delete ¶
func (c SecretsClient) Delete(ctx context.Context, id SecretId) (result DeleteOperationResponse, err error)
Delete ...
func (SecretsClient) Get ¶
func (c SecretsClient) Get(ctx context.Context, id SecretId, options GetOperationOptions) (result GetOperationResponse, err error)
Get ...
func (SecretsClient) List ¶
func (c SecretsClient) List(ctx context.Context, id UserId, options ListOperationOptions) (result ListOperationResponse, err error)
List ...
func (SecretsClient) ListComplete ¶
func (c SecretsClient) ListComplete(ctx context.Context, id UserId, options ListOperationOptions) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (SecretsClient) ListCompleteMatchingPredicate ¶
func (c SecretsClient) ListCompleteMatchingPredicate(ctx context.Context, id UserId, options ListOperationOptions, predicate SecretOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (SecretsClient) Update ¶
func (c SecretsClient) Update(ctx context.Context, id SecretId, input UpdateResource) (result UpdateOperationResponse, err error)
Update ...
type UpdateOperationResponse ¶
type UpdateResource ¶
type UserId ¶
type UserId struct { SubscriptionId string ResourceGroupName string LabName string UserName string }
UserId is a struct representing the Resource ID for a User
func NewUserID ¶
func NewUserID(subscriptionId string, resourceGroupName string, labName string, userName string) UserId
NewUserID returns a new UserId struct
func ParseUserID ¶
ParseUserID parses 'input' into a UserId
func ParseUserIDInsensitively ¶
ParseUserIDInsensitively parses 'input' case-insensitively into a UserId note: this method should only be used for API response data and not user input
func (UserId) Segments ¶
func (id UserId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this User ID