creators

package
v0.20230425.1021638 Latest Latest
Warning

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

 Go to latest Published: Apr 25, 2023 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/maps/2021-02-01/creators Documentation

The creators SDK allows for interaction with the Azure Resource Manager Service maps (API Version 2021-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-sdk/resource-manager/maps/2021-02-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

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateAccountID 

func ValidateAccountID(input interface{}, key string) (warnings []string, errors []error)

ValidateAccountID checks that 'input' can be parsed as a Account ID

func ValidateCreatorID 

func ValidateCreatorID(input interface{}, key string) (warnings []string, errors []error)

ValidateCreatorID checks that 'input' can be parsed as a Creator ID

Types

type AccountId 

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID 

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID 

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively 

func ParseAccountIDInsensitively(input string) (*AccountId, error)

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) ID 

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments 

func (id AccountId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Account ID

func (AccountId) String 

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Creator
}

type Creator 

type Creator struct {
	Id         *string            `json:"id,omitempty"`
	Location   string             `json:"location"`
	Name       *string            `json:"name,omitempty"`
	Properties CreatorProperties  `json:"properties"`
	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 

func ParseCreatorID(input string) (*CreatorId, error)

ParseCreatorID parses 'input' into a CreatorId

func ParseCreatorIDInsensitively 

func ParseCreatorIDInsensitively(input string) (*CreatorId, error)

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) ID 

func (id CreatorId) ID() string

ID returns the formatted Creator ID

func (CreatorId) Segments 

func (id CreatorId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Creator ID

func (CreatorId) String 

func (id CreatorId) String() string

String returns a human-readable description of this Creator ID

type CreatorOperationPredicate 

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

func (CreatorOperationPredicate) Matches 

func (p CreatorOperationPredicate) Matches(input Creator) bool

type CreatorProperties 

type CreatorProperties struct {
	ProvisioningState *string `json:"provisioningState,omitempty"`
	StorageUnits      int64   `json:"storageUnits"`
}

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(api environments.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 DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

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

type ListByAccountCompleteResult 

type ListByAccountCompleteResult struct {
	Items []Creator
}

type ListByAccountOperationResponse 

type ListByAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Creator
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Creator
}

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.