README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/containerregistry/2021-08-01-preview/tokens
Documentation
The tokens
SDK allows for interaction with the Azure Resource Manager Service containerregistry
(API Version 2021-08-01-preview
).
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/containerregistry/2021-08-01-preview/tokens"
Client Initialization
client := tokens.NewTokensClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: TokensClient.Create
ctx := context.TODO()
id := tokens.NewTokenID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "tokenValue")
payload := tokens.Token{
// ...
}
if err := client.CreateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: TokensClient.Delete
ctx := context.TODO()
id := tokens.NewTokenID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "tokenValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: TokensClient.Get
ctx := context.TODO()
id := tokens.NewTokenID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "tokenValue")
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: TokensClient.List
ctx := context.TODO()
id := tokens.NewRegistryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue")
// 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: TokensClient.Update
ctx := context.TODO()
id := tokens.NewTokenID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "tokenValue")
payload := tokens.TokenUpdateParameters{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForProvisioningState() []string
- func PossibleValuesForTokenCertificateName() []string
- func PossibleValuesForTokenPasswordName() []string
- func PossibleValuesForTokenStatus() []string
- func ValidateRegistryID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateTokenID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationResponse
- type ProvisioningState
- type RegistryId
- type Token
- type TokenCertificate
- type TokenCertificateName
- type TokenCredentialsProperties
- type TokenId
- type TokenOperationPredicate
- type TokenPassword
- type TokenPasswordName
- type TokenProperties
- type TokenStatus
- type TokenUpdateParameters
- type TokenUpdateProperties
- type TokensClient
- func (c TokensClient) Create(ctx context.Context, id TokenId, input Token) (result CreateOperationResponse, err error)
- func (c TokensClient) CreateThenPoll(ctx context.Context, id TokenId, input Token) error
- func (c TokensClient) Delete(ctx context.Context, id TokenId) (result DeleteOperationResponse, err error)
- func (c TokensClient) DeleteThenPoll(ctx context.Context, id TokenId) error
- func (c TokensClient) Get(ctx context.Context, id TokenId) (result GetOperationResponse, err error)
- func (c TokensClient) List(ctx context.Context, id RegistryId) (result ListOperationResponse, err error)
- func (c TokensClient) ListComplete(ctx context.Context, id RegistryId) (ListCompleteResult, error)
- func (c TokensClient) ListCompleteMatchingPredicate(ctx context.Context, id RegistryId, predicate TokenOperationPredicate) (result ListCompleteResult, err error)
- func (c TokensClient) Update(ctx context.Context, id TokenId, input TokenUpdateParameters) (result UpdateOperationResponse, err error)
- func (c TokensClient) UpdateThenPoll(ctx context.Context, id TokenId, input TokenUpdateParameters) error
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func PossibleValuesForTokenCertificateName ¶
func PossibleValuesForTokenCertificateName() []string
func PossibleValuesForTokenPasswordName ¶
func PossibleValuesForTokenPasswordName() []string
func PossibleValuesForTokenStatus ¶
func PossibleValuesForTokenStatus() []string
func ValidateRegistryID ¶
ValidateRegistryID checks that 'input' can be parsed as a Registry ID
func ValidateTokenID ¶
ValidateTokenID checks that 'input' can be parsed as a Token ID
Types ¶
type CreateOperationResponse ¶
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []Token
}
type ListOperationResponse ¶
type ProvisioningState ¶
type ProvisioningState string
const ( ProvisioningStateCanceled ProvisioningState = "Canceled" ProvisioningStateCreating ProvisioningState = "Creating" ProvisioningStateDeleting ProvisioningState = "Deleting" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStateSucceeded ProvisioningState = "Succeeded" ProvisioningStateUpdating ProvisioningState = "Updating" )
func (*ProvisioningState) UnmarshalJSON ¶ added in v0.20230406.1124617
func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
type RegistryId ¶
RegistryId is a struct representing the Resource ID for a Registry
func NewRegistryID ¶
func NewRegistryID(subscriptionId string, resourceGroupName string, registryName string) RegistryId
NewRegistryID returns a new RegistryId struct
func ParseRegistryID ¶
func ParseRegistryID(input string) (*RegistryId, error)
ParseRegistryID parses 'input' into a RegistryId
func ParseRegistryIDInsensitively ¶
func ParseRegistryIDInsensitively(input string) (*RegistryId, error)
ParseRegistryIDInsensitively parses 'input' case-insensitively into a RegistryId note: this method should only be used for API response data and not user input
func (RegistryId) Segments ¶
func (id RegistryId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Registry ID
func (RegistryId) String ¶
func (id RegistryId) String() string
String returns a human-readable description of this Registry ID
type Token ¶
type Token struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *TokenProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type TokenCertificate ¶
type TokenCertificate struct { EncodedPemCertificate *string `json:"encodedPemCertificate,omitempty"` Expiry *string `json:"expiry,omitempty"` Name *TokenCertificateName `json:"name,omitempty"` Thumbprint *string `json:"thumbprint,omitempty"` }
func (*TokenCertificate) GetExpiryAsTime ¶
func (o *TokenCertificate) GetExpiryAsTime() (*time.Time, error)
func (*TokenCertificate) SetExpiryAsTime ¶
func (o *TokenCertificate) SetExpiryAsTime(input time.Time)
type TokenCertificateName ¶
type TokenCertificateName string
const ( TokenCertificateNameCertificateOne TokenCertificateName = "certificate1" TokenCertificateNameCertificateTwo TokenCertificateName = "certificate2" )
func (*TokenCertificateName) UnmarshalJSON ¶ added in v0.20230406.1124617
func (s *TokenCertificateName) UnmarshalJSON(bytes []byte) error
type TokenCredentialsProperties ¶
type TokenCredentialsProperties struct { Certificates *[]TokenCertificate `json:"certificates,omitempty"` Passwords *[]TokenPassword `json:"passwords,omitempty"` }
type TokenId ¶
type TokenId struct { SubscriptionId string ResourceGroupName string RegistryName string TokenName string }
TokenId is a struct representing the Resource ID for a Token
func NewTokenID ¶
func NewTokenID(subscriptionId string, resourceGroupName string, registryName string, tokenName string) TokenId
NewTokenID returns a new TokenId struct
func ParseTokenID ¶
ParseTokenID parses 'input' into a TokenId
func ParseTokenIDInsensitively ¶
ParseTokenIDInsensitively parses 'input' case-insensitively into a TokenId note: this method should only be used for API response data and not user input
func (TokenId) Segments ¶
func (id TokenId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Token ID
type TokenOperationPredicate ¶
func (TokenOperationPredicate) Matches ¶
func (p TokenOperationPredicate) Matches(input Token) bool
type TokenPassword ¶
type TokenPassword struct { CreationTime *string `json:"creationTime,omitempty"` Expiry *string `json:"expiry,omitempty"` Name *TokenPasswordName `json:"name,omitempty"` Value *string `json:"value,omitempty"` }
func (*TokenPassword) GetCreationTimeAsTime ¶
func (o *TokenPassword) GetCreationTimeAsTime() (*time.Time, error)
func (*TokenPassword) GetExpiryAsTime ¶
func (o *TokenPassword) GetExpiryAsTime() (*time.Time, error)
func (*TokenPassword) SetCreationTimeAsTime ¶
func (o *TokenPassword) SetCreationTimeAsTime(input time.Time)
func (*TokenPassword) SetExpiryAsTime ¶
func (o *TokenPassword) SetExpiryAsTime(input time.Time)
type TokenPasswordName ¶
type TokenPasswordName string
const ( TokenPasswordNamePasswordOne TokenPasswordName = "password1" TokenPasswordNamePasswordTwo TokenPasswordName = "password2" )
func (*TokenPasswordName) UnmarshalJSON ¶ added in v0.20230406.1124617
func (s *TokenPasswordName) UnmarshalJSON(bytes []byte) error
type TokenProperties ¶
type TokenProperties struct { CreationDate *string `json:"creationDate,omitempty"` Credentials *TokenCredentialsProperties `json:"credentials,omitempty"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` ScopeMapId *string `json:"scopeMapId,omitempty"` Status *TokenStatus `json:"status,omitempty"` }
func (*TokenProperties) GetCreationDateAsTime ¶
func (o *TokenProperties) GetCreationDateAsTime() (*time.Time, error)
func (*TokenProperties) SetCreationDateAsTime ¶
func (o *TokenProperties) SetCreationDateAsTime(input time.Time)
type TokenStatus ¶
type TokenStatus string
const ( TokenStatusDisabled TokenStatus = "disabled" TokenStatusEnabled TokenStatus = "enabled" )
func (*TokenStatus) UnmarshalJSON ¶ added in v0.20230406.1124617
func (s *TokenStatus) UnmarshalJSON(bytes []byte) error
type TokenUpdateParameters ¶
type TokenUpdateParameters struct {
Properties *TokenUpdateProperties `json:"properties,omitempty"`
}
type TokenUpdateProperties ¶
type TokenUpdateProperties struct { Credentials *TokenCredentialsProperties `json:"credentials,omitempty"` ScopeMapId *string `json:"scopeMapId,omitempty"` Status *TokenStatus `json:"status,omitempty"` }
type TokensClient ¶
type TokensClient struct {
Client *resourcemanager.Client
}
func NewTokensClientWithBaseURI ¶
func NewTokensClientWithBaseURI(sdkApi sdkEnv.Api) (*TokensClient, error)
func (TokensClient) Create ¶
func (c TokensClient) Create(ctx context.Context, id TokenId, input Token) (result CreateOperationResponse, err error)
Create ...
func (TokensClient) CreateThenPoll ¶
CreateThenPoll performs Create then polls until it's completed
func (TokensClient) Delete ¶
func (c TokensClient) Delete(ctx context.Context, id TokenId) (result DeleteOperationResponse, err error)
Delete ...
func (TokensClient) DeleteThenPoll ¶
func (c TokensClient) DeleteThenPoll(ctx context.Context, id TokenId) error
DeleteThenPoll performs Delete then polls until it's completed
func (TokensClient) Get ¶
func (c TokensClient) Get(ctx context.Context, id TokenId) (result GetOperationResponse, err error)
Get ...
func (TokensClient) List ¶
func (c TokensClient) List(ctx context.Context, id RegistryId) (result ListOperationResponse, err error)
List ...
func (TokensClient) ListComplete ¶
func (c TokensClient) ListComplete(ctx context.Context, id RegistryId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (TokensClient) ListCompleteMatchingPredicate ¶
func (c TokensClient) ListCompleteMatchingPredicate(ctx context.Context, id RegistryId, predicate TokenOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (TokensClient) Update ¶
func (c TokensClient) Update(ctx context.Context, id TokenId, input TokenUpdateParameters) (result UpdateOperationResponse, err error)
Update ...
func (TokensClient) UpdateThenPoll ¶
func (c TokensClient) UpdateThenPoll(ctx context.Context, id TokenId, input TokenUpdateParameters) error
UpdateThenPoll performs Update then polls until it's completed
Source Files ¶
- client.go
- constants.go
- id_registry.go
- id_token.go
- method_create.go
- method_delete.go
- method_get.go
- method_list.go
- method_update.go
- model_token.go
- model_tokencertificate.go
- model_tokencredentialsproperties.go
- model_tokenpassword.go
- model_tokenproperties.go
- model_tokenupdateparameters.go
- model_tokenupdateproperties.go
- predicates.go
- version.go