README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/compute/2021-07-01/galleries
Documentation
The galleries
SDK allows for interaction with the Azure Resource Manager Service compute
(API Version 2021-07-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/compute/2021-07-01/galleries"
Client Initialization
client := galleries.NewGalleriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: GalleriesClient.CreateOrUpdate
ctx := context.TODO()
id := galleries.NewGalleryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "galleryValue")
payload := galleries.Gallery{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: GalleriesClient.Delete
ctx := context.TODO()
id := galleries.NewGalleryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "galleryValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: GalleriesClient.Get
ctx := context.TODO()
id := galleries.NewGalleryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "galleryValue")
read, err := client.Get(ctx, id, galleries.DefaultGetOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: GalleriesClient.List
ctx := context.TODO()
id := galleries.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// 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: GalleriesClient.ListByResourceGroup
ctx := context.TODO()
id := galleries.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: GalleriesClient.Update
ctx := context.TODO()
id := galleries.NewGalleryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "galleryValue")
payload := galleries.GalleryUpdate{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForGallerySharingPermissionTypes() []string
- func PossibleValuesForProvisioningState() []string
- func PossibleValuesForSelectPermissions() []string
- func PossibleValuesForSharingProfileGroupTypes() []string
- func ValidateGalleryID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GalleriesClient
- func (c GalleriesClient) CreateOrUpdate(ctx context.Context, id GalleryId, input Gallery) (result CreateOrUpdateOperationResponse, err error)
- func (c GalleriesClient) CreateOrUpdateThenPoll(ctx context.Context, id GalleryId, input Gallery) error
- func (c GalleriesClient) Delete(ctx context.Context, id GalleryId) (result DeleteOperationResponse, err error)
- func (c GalleriesClient) DeleteThenPoll(ctx context.Context, id GalleryId) error
- func (c GalleriesClient) Get(ctx context.Context, id GalleryId, options GetOperationOptions) (result GetOperationResponse, err error)
- func (c GalleriesClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
- func (c GalleriesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
- func (c GalleriesClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
- func (c GalleriesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupCompleteResult, err error)
- func (c GalleriesClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
- func (c GalleriesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)
- func (c GalleriesClient) Update(ctx context.Context, id GalleryId, input GalleryUpdate) (result UpdateOperationResponse, err error)
- func (c GalleriesClient) UpdateThenPoll(ctx context.Context, id GalleryId, input GalleryUpdate) error
- type Gallery
- type GalleryId
- type GalleryIdentifier
- type GalleryOperationPredicate
- type GalleryProperties
- type GallerySharingPermissionTypes
- type GalleryUpdate
- type GetOperationOptions
- type GetOperationResponse
- type ListByResourceGroupCompleteResult
- type ListByResourceGroupOperationResponse
- type ListCompleteResult
- type ListOperationResponse
- type ProvisioningState
- type SelectPermissions
- type SharingProfile
- type SharingProfileGroup
- type SharingProfileGroupTypes
- type SoftDeletePolicy
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForGallerySharingPermissionTypes ¶
func PossibleValuesForGallerySharingPermissionTypes() []string
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func PossibleValuesForSelectPermissions ¶
func PossibleValuesForSelectPermissions() []string
func PossibleValuesForSharingProfileGroupTypes ¶
func PossibleValuesForSharingProfileGroupTypes() []string
func ValidateGalleryID ¶
ValidateGalleryID checks that 'input' can be parsed as a Gallery ID
Types ¶
type DeleteOperationResponse ¶
type GalleriesClient ¶
type GalleriesClient struct {
Client *resourcemanager.Client
}
func NewGalleriesClientWithBaseURI ¶
func NewGalleriesClientWithBaseURI(sdkApi sdkEnv.Api) (*GalleriesClient, error)
func (GalleriesClient) CreateOrUpdate ¶
func (c GalleriesClient) CreateOrUpdate(ctx context.Context, id GalleryId, input Gallery) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (GalleriesClient) CreateOrUpdateThenPoll ¶
func (c GalleriesClient) CreateOrUpdateThenPoll(ctx context.Context, id GalleryId, input Gallery) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (GalleriesClient) Delete ¶
func (c GalleriesClient) Delete(ctx context.Context, id GalleryId) (result DeleteOperationResponse, err error)
Delete ...
func (GalleriesClient) DeleteThenPoll ¶
func (c GalleriesClient) DeleteThenPoll(ctx context.Context, id GalleryId) error
DeleteThenPoll performs Delete then polls until it's completed
func (GalleriesClient) Get ¶
func (c GalleriesClient) Get(ctx context.Context, id GalleryId, options GetOperationOptions) (result GetOperationResponse, err error)
Get ...
func (GalleriesClient) List ¶
func (c GalleriesClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
List ...
func (GalleriesClient) ListByResourceGroup ¶
func (c GalleriesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
ListByResourceGroup ...
func (GalleriesClient) ListByResourceGroupComplete ¶
func (c GalleriesClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
ListByResourceGroupComplete retrieves all the results into a single object
func (GalleriesClient) ListByResourceGroupCompleteMatchingPredicate ¶
func (c GalleriesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate GalleryOperationPredicate) (result ListByResourceGroupCompleteResult, err error)
ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (GalleriesClient) ListComplete ¶
func (c GalleriesClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (GalleriesClient) ListCompleteMatchingPredicate ¶
func (c GalleriesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate GalleryOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (GalleriesClient) Update ¶
func (c GalleriesClient) Update(ctx context.Context, id GalleryId, input GalleryUpdate) (result UpdateOperationResponse, err error)
Update ...
func (GalleriesClient) UpdateThenPoll ¶
func (c GalleriesClient) UpdateThenPoll(ctx context.Context, id GalleryId, input GalleryUpdate) error
UpdateThenPoll performs Update then polls until it's completed
type GalleryId ¶
GalleryId is a struct representing the Resource ID for a Gallery
func NewGalleryID ¶
NewGalleryID returns a new GalleryId struct
func ParseGalleryID ¶
ParseGalleryID parses 'input' into a GalleryId
func ParseGalleryIDInsensitively ¶
ParseGalleryIDInsensitively parses 'input' case-insensitively into a GalleryId note: this method should only be used for API response data and not user input
func (GalleryId) Segments ¶
func (id GalleryId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Gallery ID
type GalleryIdentifier ¶
type GalleryIdentifier struct {
UniqueName *string `json:"uniqueName,omitempty"`
}
type GalleryOperationPredicate ¶
func (GalleryOperationPredicate) Matches ¶
func (p GalleryOperationPredicate) Matches(input Gallery) bool
type GalleryProperties ¶
type GalleryProperties struct { Description *string `json:"description,omitempty"` Identifier *GalleryIdentifier `json:"identifier,omitempty"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` SharingProfile *SharingProfile `json:"sharingProfile,omitempty"` SoftDeletePolicy *SoftDeletePolicy `json:"softDeletePolicy,omitempty"` }
type GallerySharingPermissionTypes ¶
type GallerySharingPermissionTypes string
const ( GallerySharingPermissionTypesGroups GallerySharingPermissionTypes = "Groups" GallerySharingPermissionTypesPrivate GallerySharingPermissionTypes = "Private" )
func (*GallerySharingPermissionTypes) UnmarshalJSON ¶ added in v0.20230808.1103829
func (s *GallerySharingPermissionTypes) UnmarshalJSON(bytes []byte) error
type GalleryUpdate ¶
type GetOperationOptions ¶
type GetOperationOptions struct {
Select *SelectPermissions
}
func DefaultGetOperationOptions ¶
func DefaultGetOperationOptions() GetOperationOptions
func (GetOperationOptions) ToHeaders ¶ added in v0.20230808.1103829
func (o GetOperationOptions) ToHeaders() *client.Headers
func (GetOperationOptions) ToOData ¶ added in v0.20230808.1103829
func (o GetOperationOptions) ToOData() *odata.Query
func (GetOperationOptions) ToQuery ¶ added in v0.20230808.1103829
func (o GetOperationOptions) ToQuery() *client.QueryParams
type GetOperationResponse ¶
type ListByResourceGroupCompleteResult ¶
type ListByResourceGroupCompleteResult struct {
Items []Gallery
}
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []Gallery
}
type ListOperationResponse ¶
type ProvisioningState ¶
type ProvisioningState string
const ( ProvisioningStateCreating ProvisioningState = "Creating" ProvisioningStateDeleting ProvisioningState = "Deleting" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStateMigrating ProvisioningState = "Migrating" ProvisioningStateSucceeded ProvisioningState = "Succeeded" ProvisioningStateUpdating ProvisioningState = "Updating" )
func (*ProvisioningState) UnmarshalJSON ¶ added in v0.20230808.1103829
func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
type SelectPermissions ¶
type SelectPermissions string
const (
SelectPermissionsPermissions SelectPermissions = "Permissions"
)
func (*SelectPermissions) UnmarshalJSON ¶ added in v0.20230808.1103829
func (s *SelectPermissions) UnmarshalJSON(bytes []byte) error
type SharingProfile ¶
type SharingProfile struct { Groups *[]SharingProfileGroup `json:"groups,omitempty"` Permissions *GallerySharingPermissionTypes `json:"permissions,omitempty"` }
type SharingProfileGroup ¶
type SharingProfileGroup struct { Ids *[]string `json:"ids,omitempty"` Type *SharingProfileGroupTypes `json:"type,omitempty"` }
type SharingProfileGroupTypes ¶
type SharingProfileGroupTypes string
const ( SharingProfileGroupTypesAADTenants SharingProfileGroupTypes = "AADTenants" SharingProfileGroupTypesSubscriptions SharingProfileGroupTypes = "Subscriptions" )
func (*SharingProfileGroupTypes) UnmarshalJSON ¶ added in v0.20230808.1103829
func (s *SharingProfileGroupTypes) UnmarshalJSON(bytes []byte) error
type SoftDeletePolicy ¶
type SoftDeletePolicy struct {
IsSoftDeleteEnabled *bool `json:"isSoftDeleteEnabled,omitempty"`
}
Source Files ¶
- client.go
- constants.go
- id_gallery.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_list.go
- method_listbyresourcegroup.go
- method_update.go
- model_gallery.go
- model_galleryidentifier.go
- model_galleryproperties.go
- model_galleryupdate.go
- model_sharingprofile.go
- model_sharingprofilegroup.go
- model_softdeletepolicy.go
- predicates.go
- version.go