sharedgalleries

package
v0.20240118.1101651 Latest Latest
Warning

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

Go to latest
Published: Jan 18, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2022-03-03/sharedgalleries Documentation

The sharedgalleries SDK allows for interaction with the Azure Resource Manager Service compute (API Version 2022-03-03).

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/compute/2022-03-03/sharedgalleries"

Client Initialization

client := sharedgalleries.NewSharedGalleriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SharedGalleriesClient.Get

ctx := context.TODO()
id := sharedgalleries.NewSharedGalleryID("12345678-1234-9876-4563-123456789012", "locationValue", "sharedGalleryValue")

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: SharedGalleriesClient.List

ctx := context.TODO()
id := sharedgalleries.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

// alternatively `client.List(ctx, id, sharedgalleries.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, sharedgalleries.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForSharedToValues

func PossibleValuesForSharedToValues() []string

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

func ValidateSharedGalleryID

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

ValidateSharedGalleryID checks that 'input' can be parsed as a Shared Gallery ID

Types

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PirSharedGalleryResource
}

type ListOperationOptions

type ListOperationOptions struct {
	SharedTo *SharedToValues
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230808.1103829

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData added in v0.20230808.1103829

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery added in v0.20230808.1103829

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PirSharedGalleryResource
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

ParseLocationIDInsensitively parses 'input' case-insensitively into a LocationId note: this method should only be used for API response data and not user input

func (*LocationId) FromParseResult added in v0.20231127.1171502

func (id *LocationId) FromParseResult(input resourceids.ParseResult) error

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type PirSharedGalleryResource

type PirSharedGalleryResource struct {
	Identifier *SharedGalleryIdentifier `json:"identifier,omitempty"`
	Location   *string                  `json:"location,omitempty"`
	Name       *string                  `json:"name,omitempty"`
}

type PirSharedGalleryResourceOperationPredicate

type PirSharedGalleryResourceOperationPredicate struct {
	Location *string
	Name     *string
}

func (PirSharedGalleryResourceOperationPredicate) Matches

type SharedGalleriesClient

type SharedGalleriesClient struct {
	Client *resourcemanager.Client
}

func NewSharedGalleriesClientWithBaseURI

func NewSharedGalleriesClientWithBaseURI(sdkApi sdkEnv.Api) (*SharedGalleriesClient, error)

func (SharedGalleriesClient) Get

Get ...

func (SharedGalleriesClient) List

List ...

func (SharedGalleriesClient) ListComplete

ListComplete retrieves all the results into a single object

func (SharedGalleriesClient) ListCompleteMatchingPredicate

func (c SharedGalleriesClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, options ListOperationOptions, predicate PirSharedGalleryResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SharedGalleryId

type SharedGalleryId struct {
	SubscriptionId    string
	LocationName      string
	SharedGalleryName string
}

SharedGalleryId is a struct representing the Resource ID for a Shared Gallery

func NewSharedGalleryID

func NewSharedGalleryID(subscriptionId string, locationName string, sharedGalleryName string) SharedGalleryId

NewSharedGalleryID returns a new SharedGalleryId struct

func ParseSharedGalleryID

func ParseSharedGalleryID(input string) (*SharedGalleryId, error)

ParseSharedGalleryID parses 'input' into a SharedGalleryId

func ParseSharedGalleryIDInsensitively

func ParseSharedGalleryIDInsensitively(input string) (*SharedGalleryId, error)

ParseSharedGalleryIDInsensitively parses 'input' case-insensitively into a SharedGalleryId note: this method should only be used for API response data and not user input

func (*SharedGalleryId) FromParseResult added in v0.20231127.1171502

func (id *SharedGalleryId) FromParseResult(input resourceids.ParseResult) error

func (SharedGalleryId) ID

func (id SharedGalleryId) ID() string

ID returns the formatted Shared Gallery ID

func (SharedGalleryId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Shared Gallery ID

func (SharedGalleryId) String

func (id SharedGalleryId) String() string

String returns a human-readable description of this Shared Gallery ID

type SharedGalleryIdentifier

type SharedGalleryIdentifier struct {
	UniqueId *string `json:"uniqueId,omitempty"`
}

type SharedToValues

type SharedToValues string
const (
	SharedToValuesTenant SharedToValues = "tenant"
)

func (*SharedToValues) UnmarshalJSON added in v0.20230808.1103829

func (s *SharedToValues) UnmarshalJSON(bytes []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL