marketplacesubscription

package
v0.20240923.1142107 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2024-04-01/marketplacesubscription Documentation

The marketplacesubscription SDK allows for interaction with Azure Resource Manager machinelearningservices (API Version 2024-04-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/machinelearningservices/2024-04-01/marketplacesubscription"

Client Initialization

client := marketplacesubscription.NewMarketplaceSubscriptionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MarketplaceSubscriptionClient.CreateOrUpdate

ctx := context.TODO()
id := marketplacesubscription.NewMarketplaceSubscriptionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "name")

payload := marketplacesubscription.MarketplaceSubscriptionResource{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: MarketplaceSubscriptionClient.Delete

ctx := context.TODO()
id := marketplacesubscription.NewMarketplaceSubscriptionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "name")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: MarketplaceSubscriptionClient.Get

ctx := context.TODO()
id := marketplacesubscription.NewMarketplaceSubscriptionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "name")

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

ctx := context.TODO()
id := marketplacesubscription.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName")

// alternatively `client.List(ctx, id, marketplacesubscription.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, marketplacesubscription.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 PossibleValuesForMarketplaceSubscriptionProvisioningState 

func PossibleValuesForMarketplaceSubscriptionProvisioningState() []string

func PossibleValuesForMarketplaceSubscriptionStatus 

func PossibleValuesForMarketplaceSubscriptionStatus() []string

func ValidateMarketplaceSubscriptionID 

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

ValidateMarketplaceSubscriptionID checks that 'input' can be parsed as a Marketplace Subscription ID

func ValidateWorkspaceID 

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MarketplaceSubscriptionResource
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationOptions 

type ListOperationOptions struct {
	Skip *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

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

type MarketplacePlan 

type MarketplacePlan struct {
	OfferId     *string `json:"offerId,omitempty"`
	PlanId      *string `json:"planId,omitempty"`
	PublisherId *string `json:"publisherId,omitempty"`
}

type MarketplaceSubscription 

type MarketplaceSubscription struct {
	MarketplacePlan               *MarketplacePlan                          `json:"marketplacePlan,omitempty"`
	MarketplaceSubscriptionStatus *MarketplaceSubscriptionStatus            `json:"marketplaceSubscriptionStatus,omitempty"`
	ModelId                       string                                    `json:"modelId"`
	ProvisioningState             *MarketplaceSubscriptionProvisioningState `json:"provisioningState,omitempty"`
}

type MarketplaceSubscriptionClient 

type MarketplaceSubscriptionClient struct {
	Client *resourcemanager.Client
}

func NewMarketplaceSubscriptionClientWithBaseURI 

func NewMarketplaceSubscriptionClientWithBaseURI(sdkApi sdkEnv.Api) (*MarketplaceSubscriptionClient, error)

func (MarketplaceSubscriptionClient) CreateOrUpdate 

func (c MarketplaceSubscriptionClient) CreateOrUpdate(ctx context.Context, id MarketplaceSubscriptionId, input MarketplaceSubscriptionResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (MarketplaceSubscriptionClient) CreateOrUpdateThenPoll 

func (c MarketplaceSubscriptionClient) CreateOrUpdateThenPoll(ctx context.Context, id MarketplaceSubscriptionId, input MarketplaceSubscriptionResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (MarketplaceSubscriptionClient) Delete 

func (c MarketplaceSubscriptionClient) Delete(ctx context.Context, id MarketplaceSubscriptionId) (result DeleteOperationResponse, err error)

Delete ...

func (MarketplaceSubscriptionClient) DeleteThenPoll 

func (c MarketplaceSubscriptionClient) DeleteThenPoll(ctx context.Context, id MarketplaceSubscriptionId) error

DeleteThenPoll performs Delete then polls until it's completed

func (MarketplaceSubscriptionClient) Get 

func (c MarketplaceSubscriptionClient) Get(ctx context.Context, id MarketplaceSubscriptionId) (result GetOperationResponse, err error)

Get ...

func (MarketplaceSubscriptionClient) List 

func (c MarketplaceSubscriptionClient) List(ctx context.Context, id WorkspaceId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (MarketplaceSubscriptionClient) ListComplete 

func (c MarketplaceSubscriptionClient) ListComplete(ctx context.Context, id WorkspaceId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (MarketplaceSubscriptionClient) ListCompleteMatchingPredicate 

func (c MarketplaceSubscriptionClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options ListOperationOptions, predicate MarketplaceSubscriptionResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type MarketplaceSubscriptionId 

type MarketplaceSubscriptionId struct {
	SubscriptionId              string
	ResourceGroupName           string
	WorkspaceName               string
	MarketplaceSubscriptionName string
}

MarketplaceSubscriptionId is a struct representing the Resource ID for a Marketplace Subscription

func NewMarketplaceSubscriptionID 

func NewMarketplaceSubscriptionID(subscriptionId string, resourceGroupName string, workspaceName string, marketplaceSubscriptionName string) MarketplaceSubscriptionId

NewMarketplaceSubscriptionID returns a new MarketplaceSubscriptionId struct

func ParseMarketplaceSubscriptionID 

func ParseMarketplaceSubscriptionID(input string) (*MarketplaceSubscriptionId, error)

ParseMarketplaceSubscriptionID parses 'input' into a MarketplaceSubscriptionId

func ParseMarketplaceSubscriptionIDInsensitively 

func ParseMarketplaceSubscriptionIDInsensitively(input string) (*MarketplaceSubscriptionId, error)

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

func (*MarketplaceSubscriptionId) FromParseResult 

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

func (MarketplaceSubscriptionId) ID 

func (id MarketplaceSubscriptionId) ID() string

ID returns the formatted Marketplace Subscription ID

func (MarketplaceSubscriptionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Marketplace Subscription ID

func (MarketplaceSubscriptionId) String 

func (id MarketplaceSubscriptionId) String() string

String returns a human-readable description of this Marketplace Subscription ID

type MarketplaceSubscriptionProvisioningState 

type MarketplaceSubscriptionProvisioningState string
const (
	MarketplaceSubscriptionProvisioningStateCanceled  MarketplaceSubscriptionProvisioningState = "Canceled"
	MarketplaceSubscriptionProvisioningStateCreating  MarketplaceSubscriptionProvisioningState = "Creating"
	MarketplaceSubscriptionProvisioningStateDeleting  MarketplaceSubscriptionProvisioningState = "Deleting"
	MarketplaceSubscriptionProvisioningStateFailed    MarketplaceSubscriptionProvisioningState = "Failed"
	MarketplaceSubscriptionProvisioningStateSucceeded MarketplaceSubscriptionProvisioningState = "Succeeded"
	MarketplaceSubscriptionProvisioningStateUpdating  MarketplaceSubscriptionProvisioningState = "Updating"
)

func (*MarketplaceSubscriptionProvisioningState) UnmarshalJSON 

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

type MarketplaceSubscriptionResource 

type MarketplaceSubscriptionResource struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties MarketplaceSubscription `json:"properties"`
	SystemData *systemdata.SystemData  `json:"systemData,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type MarketplaceSubscriptionResourceOperationPredicate 

type MarketplaceSubscriptionResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (MarketplaceSubscriptionResourceOperationPredicate) Matches 

func (p MarketplaceSubscriptionResourceOperationPredicate) Matches(input MarketplaceSubscriptionResource) bool

type MarketplaceSubscriptionStatus 

type MarketplaceSubscriptionStatus string
const (
	MarketplaceSubscriptionStatusSubscribed   MarketplaceSubscriptionStatus = "Subscribed"
	MarketplaceSubscriptionStatusSuspended    MarketplaceSubscriptionStatus = "Suspended"
	MarketplaceSubscriptionStatusUnsubscribed MarketplaceSubscriptionStatus = "Unsubscribed"
)

func (*MarketplaceSubscriptionStatus) UnmarshalJSON 

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

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult 

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

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

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

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

func (WorkspaceId) String 

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

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.