README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/maps/2023-06-01/creators
Documentation
The creators
SDK allows for interaction with the Azure Resource Manager Service maps
(API Version 2023-06-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-sdk/resource-manager/maps/2023-06-01/creators"
Client Initialization
client := creators.NewCreatorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: CreatorsClient.CreateOrUpdate
ctx := context.TODO()
id := creators.NewCreatorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "creatorValue")
payload := creators.Creator{
// ...
}
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: CreatorsClient.Delete
ctx := context.TODO()
id := creators.NewCreatorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "creatorValue")
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: CreatorsClient.Get
ctx := context.TODO()
id := creators.NewCreatorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "creatorValue")
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: CreatorsClient.ListByAccount
ctx := context.TODO()
id := creators.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")
// alternatively `client.ListByAccount(ctx, id)` can be used to do batched pagination
items, err := client.ListByAccountComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: CreatorsClient.Update
ctx := context.TODO()
id := creators.NewCreatorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "creatorValue")
payload := creators.CreatorUpdateParameters{
// ...
}
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 ValidateAccountID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateCreatorID(input interface{}, key string) (warnings []string, errors []error)
- type AccountId
- type CreateOrUpdateOperationResponse
- type Creator
- type CreatorId
- type CreatorOperationPredicate
- type CreatorProperties
- type CreatorUpdateParameters
- type CreatorsClient
- func (c CreatorsClient) CreateOrUpdate(ctx context.Context, id CreatorId, input Creator) (result CreateOrUpdateOperationResponse, err error)
- func (c CreatorsClient) Delete(ctx context.Context, id CreatorId) (result DeleteOperationResponse, err error)
- func (c CreatorsClient) Get(ctx context.Context, id CreatorId) (result GetOperationResponse, err error)
- func (c CreatorsClient) ListByAccount(ctx context.Context, id AccountId) (result ListByAccountOperationResponse, err error)
- func (c CreatorsClient) ListByAccountComplete(ctx context.Context, id AccountId) (ListByAccountCompleteResult, error)
- func (c CreatorsClient) ListByAccountCompleteMatchingPredicate(ctx context.Context, id AccountId, predicate CreatorOperationPredicate) (result ListByAccountCompleteResult, err error)
- func (c CreatorsClient) Update(ctx context.Context, id CreatorId, input CreatorUpdateParameters) (result UpdateOperationResponse, err error)
- type DeleteOperationResponse
- type GetOperationResponse
- type ListByAccountCompleteResult
- type ListByAccountOperationResponse
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateAccountID ¶
ValidateAccountID checks that 'input' can be parsed as a Account ID
func ValidateCreatorID ¶
ValidateCreatorID checks that 'input' can be parsed as a Creator ID
Types ¶
type AccountId ¶
AccountId is a struct representing the Resource ID for a Account
func NewAccountID ¶
NewAccountID returns a new AccountId struct
func ParseAccountID ¶
ParseAccountID parses 'input' into a AccountId
func ParseAccountIDInsensitively ¶
ParseAccountIDInsensitively parses 'input' case-insensitively into a AccountId note: this method should only be used for API response data and not user input
func (AccountId) Segments ¶
func (id AccountId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Account ID
type Creator ¶
type Creator struct { Id *string `json:"id,omitempty"` Location string `json:"location"` Name *string `json:"name,omitempty"` Properties CreatorProperties `json:"properties"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type CreatorId ¶
type CreatorId struct { SubscriptionId string ResourceGroupName string AccountName string CreatorName string }
CreatorId is a struct representing the Resource ID for a Creator
func NewCreatorID ¶
func NewCreatorID(subscriptionId string, resourceGroupName string, accountName string, creatorName string) CreatorId
NewCreatorID returns a new CreatorId struct
func ParseCreatorID ¶
ParseCreatorID parses 'input' into a CreatorId
func ParseCreatorIDInsensitively ¶
ParseCreatorIDInsensitively parses 'input' case-insensitively into a CreatorId note: this method should only be used for API response data and not user input
func (CreatorId) Segments ¶
func (id CreatorId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Creator ID
type CreatorOperationPredicate ¶
func (CreatorOperationPredicate) Matches ¶
func (p CreatorOperationPredicate) Matches(input Creator) bool
type CreatorProperties ¶
type CreatorUpdateParameters ¶
type CreatorUpdateParameters struct { Properties *CreatorProperties `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` }
type CreatorsClient ¶
type CreatorsClient struct {
Client *resourcemanager.Client
}
func NewCreatorsClientWithBaseURI ¶
func NewCreatorsClientWithBaseURI(sdkApi sdkEnv.Api) (*CreatorsClient, error)
func (CreatorsClient) CreateOrUpdate ¶
func (c CreatorsClient) CreateOrUpdate(ctx context.Context, id CreatorId, input Creator) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (CreatorsClient) Delete ¶
func (c CreatorsClient) Delete(ctx context.Context, id CreatorId) (result DeleteOperationResponse, err error)
Delete ...
func (CreatorsClient) Get ¶
func (c CreatorsClient) Get(ctx context.Context, id CreatorId) (result GetOperationResponse, err error)
Get ...
func (CreatorsClient) ListByAccount ¶
func (c CreatorsClient) ListByAccount(ctx context.Context, id AccountId) (result ListByAccountOperationResponse, err error)
ListByAccount ...
func (CreatorsClient) ListByAccountComplete ¶
func (c CreatorsClient) ListByAccountComplete(ctx context.Context, id AccountId) (ListByAccountCompleteResult, error)
ListByAccountComplete retrieves all the results into a single object
func (CreatorsClient) ListByAccountCompleteMatchingPredicate ¶
func (c CreatorsClient) ListByAccountCompleteMatchingPredicate(ctx context.Context, id AccountId, predicate CreatorOperationPredicate) (result ListByAccountCompleteResult, err error)
ListByAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (CreatorsClient) Update ¶
func (c CreatorsClient) Update(ctx context.Context, id CreatorId, input CreatorUpdateParameters) (result UpdateOperationResponse, err error)
Update ...
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type ListByAccountCompleteResult ¶
type ListByAccountCompleteResult struct {
Items []Creator
}