communitygalleries

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2023-07-03/communitygalleries Documentation

The communitygalleries SDK allows for interaction with the Azure Resource Manager Service compute (API Version 2023-07-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/2023-07-03/communitygalleries"

Client Initialization

client := communitygalleries.NewCommunityGalleriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CommunityGalleriesClient.Get

ctx := context.TODO()
id := communitygalleries.NewCommunityGalleryID("12345678-1234-9876-4563-123456789012", "locationValue", "communityGalleryValue")

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
}

Documentation

Index

• func ValidateCommunityGalleryID(input interface{}, key string) (warnings []string, errors []error)
• type CommunityGalleriesClient
  • func NewCommunityGalleriesClientWithBaseURI(sdkApi sdkEnv.Api) (*CommunityGalleriesClient, error)
  • func (c CommunityGalleriesClient) Get(ctx context.Context, id CommunityGalleryId) (result GetOperationResponse, err error)
• type CommunityGallery
• type CommunityGalleryDisclaimer
• type CommunityGalleryId
  • func NewCommunityGalleryID(subscriptionId string, locationName string, communityGalleryName string) CommunityGalleryId
  • func ParseCommunityGalleryID(input string) (*CommunityGalleryId, error)
  • func ParseCommunityGalleryIDInsensitively(input string) (*CommunityGalleryId, error)
  • func (id *CommunityGalleryId) FromParseResult(input resourceids.ParseResult) error
  • func (id CommunityGalleryId) ID() string
  • func (id CommunityGalleryId) Segments() []resourceids.Segment
  • func (id CommunityGalleryId) String() string
• type CommunityGalleryIdentifier
• type CommunityGalleryMetadata
• type CommunityGalleryProperties
• type GetOperationResponse

Functions

func ValidateCommunityGalleryID

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

ValidateCommunityGalleryID checks that 'input' can be parsed as a Community Gallery ID

Types

type CommunityGalleriesClient

type CommunityGalleriesClient struct {
	Client *resourcemanager.Client
}

func NewCommunityGalleriesClientWithBaseURI

func NewCommunityGalleriesClientWithBaseURI(sdkApi sdkEnv.Api) (*CommunityGalleriesClient, error)

func (CommunityGalleriesClient) Get

func (c CommunityGalleriesClient) Get(ctx context.Context, id CommunityGalleryId) (result GetOperationResponse, err error)

Get ...

type CommunityGallery

type CommunityGallery struct {
	Identifier *CommunityGalleryIdentifier `json:"identifier,omitempty"`
	Location   *string                     `json:"location,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *CommunityGalleryProperties `json:"properties,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type CommunityGalleryDisclaimer

type CommunityGalleryDisclaimer struct {
	Disclaimer *string `json:"disclaimer,omitempty"`
}

type CommunityGalleryId

type CommunityGalleryId struct {
	SubscriptionId       string
	LocationName         string
	CommunityGalleryName string
}

CommunityGalleryId is a struct representing the Resource ID for a Community Gallery

func NewCommunityGalleryID

func NewCommunityGalleryID(subscriptionId string, locationName string, communityGalleryName string) CommunityGalleryId

NewCommunityGalleryID returns a new CommunityGalleryId struct

func ParseCommunityGalleryID

func ParseCommunityGalleryID(input string) (*CommunityGalleryId, error)

ParseCommunityGalleryID parses 'input' into a CommunityGalleryId

func ParseCommunityGalleryIDInsensitively

func ParseCommunityGalleryIDInsensitively(input string) (*CommunityGalleryId, error)

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

func (*CommunityGalleryId) FromParseResult

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

func (CommunityGalleryId) ID

func (id CommunityGalleryId) ID() string

ID returns the formatted Community Gallery ID

func (CommunityGalleryId) Segments

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

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

func (CommunityGalleryId) String

func (id CommunityGalleryId) String() string

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

type CommunityGalleryIdentifier

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

type CommunityGalleryMetadata

type CommunityGalleryMetadata struct {
	Eula                *string  `json:"eula,omitempty"`
	PrivacyStatementUri *string  `json:"privacyStatementUri,omitempty"`
	PublicNames         []string `json:"publicNames"`
	PublisherContact    string   `json:"publisherContact"`
	PublisherUri        *string  `json:"publisherUri,omitempty"`
}

type CommunityGalleryProperties

type CommunityGalleryProperties struct {
	ArtifactTags      *map[string]string          `json:"artifactTags,omitempty"`
	CommunityMetadata *CommunityGalleryMetadata   `json:"communityMetadata,omitempty"`
	Disclaimer        *CommunityGalleryDisclaimer `json:"disclaimer,omitempty"`
}

type GetOperationResponse

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