publishers

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.PublishersGet

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

read, err := client.PublishersGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PublishersClient.PublishersListByCluster

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

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

Documentation

Index

• func ValidateClusterID(input interface{}, key string) (warnings []string, errors []error)
• func ValidatePublisherID(input interface{}, key string) (warnings []string, errors []error)
• type ClusterId
  • func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId
  • func ParseClusterID(input string) (*ClusterId, error)
  • func ParseClusterIDInsensitively(input string) (*ClusterId, error)
  • func (id ClusterId) ID() string
  • func (id ClusterId) Segments() []resourceids.Segment
  • func (id ClusterId) String() string
• type Publisher
• type PublisherId
  • func NewPublisherID(subscriptionId string, resourceGroupName string, clusterName string, ...) PublisherId
  • func ParsePublisherID(input string) (*PublisherId, error)
  • func ParsePublisherIDInsensitively(input string) (*PublisherId, error)
  • func (id PublisherId) ID() string
  • func (id PublisherId) Segments() []resourceids.Segment
  • func (id PublisherId) String() string
• type PublisherOperationPredicate
  • func (p PublisherOperationPredicate) Matches(input Publisher) bool
• type PublisherProperties
• type PublishersClient
  • func NewPublishersClientWithBaseURI(sdkApi sdkEnv.Api) (*PublishersClient, error)
  • func (c PublishersClient) PublishersGet(ctx context.Context, id PublisherId) (result PublishersGetOperationResponse, err error)
  • func (c PublishersClient) PublishersListByCluster(ctx context.Context, id ClusterId) (result PublishersListByClusterOperationResponse, err error)
  • func (c PublishersClient) PublishersListByClusterComplete(ctx context.Context, id ClusterId) (PublishersListByClusterCompleteResult, error)
  • func (c PublishersClient) PublishersListByClusterCompleteMatchingPredicate(ctx context.Context, id ClusterId, predicate PublisherOperationPredicate) (result PublishersListByClusterCompleteResult, err error)
• type PublishersGetOperationResponse
• type PublishersListByClusterCompleteResult
• type PublishersListByClusterOperationResponse

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) 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 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) 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) PublishersGet

func (c PublishersClient) PublishersGet(ctx context.Context, id PublisherId) (result PublishersGetOperationResponse, err error)

PublishersGet ...

func (PublishersClient) PublishersListByCluster

func (c PublishersClient) PublishersListByCluster(ctx context.Context, id ClusterId) (result PublishersListByClusterOperationResponse, err error)

PublishersListByCluster ...

func (PublishersClient) PublishersListByClusterComplete

func (c PublishersClient) PublishersListByClusterComplete(ctx context.Context, id ClusterId) (PublishersListByClusterCompleteResult, error)

PublishersListByClusterComplete retrieves all the results into a single object

func (PublishersClient) PublishersListByClusterCompleteMatchingPredicate

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

PublishersListByClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PublishersGetOperationResponse

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

type PublishersListByClusterCompleteResult

type PublishersListByClusterCompleteResult struct {
	Items []Publisher
}

type PublishersListByClusterOperationResponse

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