publishers

package
v0.20240110.1133510 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2023-03-01/publishers Documentation

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

Client Initialization

client := publishers.NewPublishersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PublishersClient.Get

ctx := context.TODO()
id := publishers.NewPublisherID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "publisherValue")

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: PublishersClient.ListByCluster

ctx := context.TODO()
id := publishers.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

// alternatively `client.ListByCluster(ctx, id)` can be used to do batched pagination
items, err := client.ListByClusterComplete(ctx, id)
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 ValidateClusterID 

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

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

func ValidatePublisherID 

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

ValidatePublisherID checks that 'input' can be parsed as a Publisher ID

Types

type ClusterId 

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID 

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID 

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively 

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

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

func (*ClusterId) FromParseResult added in v0.20231127.1171502 

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

func (ClusterId) ID 

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments 

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

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

func (ClusterId) String 

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

type GetOperationResponse added in v0.20230906.1160501 

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

type ListByClusterCompleteResult added in v0.20230906.1160501 

type ListByClusterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Publisher
}

type ListByClusterOperationResponse added in v0.20230906.1160501 

type ListByClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Publisher
}

type Publisher 

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

type PublisherId 

type PublisherId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
	PublisherName     string
}

PublisherId is a struct representing the Resource ID for a Publisher

func NewPublisherID 

func NewPublisherID(subscriptionId string, resourceGroupName string, clusterName string, publisherName string) PublisherId

NewPublisherID returns a new PublisherId struct

func ParsePublisherID 

func ParsePublisherID(input string) (*PublisherId, error)

ParsePublisherID parses 'input' into a PublisherId

func ParsePublisherIDInsensitively 

func ParsePublisherIDInsensitively(input string) (*PublisherId, error)

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

func (*PublisherId) FromParseResult added in v0.20231127.1171502 

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

func (PublisherId) ID 

func (id PublisherId) ID() string

ID returns the formatted Publisher ID

func (PublisherId) Segments 

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

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

func (PublisherId) String 

func (id PublisherId) String() string

String returns a human-readable description of this Publisher ID

type PublisherOperationPredicate 

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

func (PublisherOperationPredicate) Matches 

func (p PublisherOperationPredicate) Matches(input Publisher) bool

type PublisherProperties 

type PublisherProperties struct {
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

type PublishersClient 

type PublishersClient struct {
	Client *resourcemanager.Client
}

func NewPublishersClientWithBaseURI 

func NewPublishersClientWithBaseURI(sdkApi sdkEnv.Api) (*PublishersClient, error)

func (PublishersClient) Get added in v0.20230906.1160501 

func (c PublishersClient) Get(ctx context.Context, id PublisherId) (result GetOperationResponse, err error)

Get ...

func (PublishersClient) ListByCluster added in v0.20230906.1160501 

func (c PublishersClient) ListByCluster(ctx context.Context, id ClusterId) (result ListByClusterOperationResponse, err error)

ListByCluster ...

func (PublishersClient) ListByClusterComplete added in v0.20230906.1160501 

func (c PublishersClient) ListByClusterComplete(ctx context.Context, id ClusterId) (ListByClusterCompleteResult, error)

ListByClusterComplete retrieves all the results into a single object

func (PublishersClient) ListByClusterCompleteMatchingPredicate added in v0.20230906.1160501 

func (c PublishersClient) ListByClusterCompleteMatchingPredicate(ctx context.Context, id ClusterId, predicate PublisherOperationPredicate) (result ListByClusterCompleteResult, err error)

ListByClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.