regions

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2017-04-01/regions Documentation

The regions SDK allows for interaction with the Azure Resource Manager Service eventhub (API Version 2017-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/eventhub/2017-04-01/regions"

Client Initialization

client := regions.NewRegionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RegionsClient.ListBySku

ctx := context.TODO()
id := regions.NewSkuID("12345678-1234-9876-4563-123456789012", "skuValue")

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

Documentation

Index

• func ValidateSkuID(input interface{}, key string) (warnings []string, errors []error)
• type ListBySkuCompleteResult
• type ListBySkuOperationResponse
  • func (r ListBySkuOperationResponse) HasMore() bool
  • func (r ListBySkuOperationResponse) LoadMore(ctx context.Context) (resp ListBySkuOperationResponse, err error)
• type MessagingRegions
• type MessagingRegionsOperationPredicate
  • func (p MessagingRegionsOperationPredicate) Matches(input MessagingRegions) bool
• type MessagingRegionsProperties
• type RegionsClient
  • func NewRegionsClientWithBaseURI(endpoint string) RegionsClient
  • func (c RegionsClient) ListBySku(ctx context.Context, id SkuId) (resp ListBySkuOperationResponse, err error)
  • func (c RegionsClient) ListBySkuComplete(ctx context.Context, id SkuId) (ListBySkuCompleteResult, error)
  • func (c RegionsClient) ListBySkuCompleteMatchingPredicate(ctx context.Context, id SkuId, predicate MessagingRegionsOperationPredicate) (resp ListBySkuCompleteResult, err error)
• type SkuId
  • func NewSkuID(subscriptionId string, sku string) SkuId
  • func ParseSkuID(input string) (*SkuId, error)
  • func ParseSkuIDInsensitively(input string) (*SkuId, error)
  • func (id SkuId) ID() string
  • func (id SkuId) Segments() []resourceids.Segment
  • func (id SkuId) String() string

Functions

func ValidateSkuID

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

ValidateSkuID checks that 'input' can be parsed as a Sku ID

Types

type ListBySkuCompleteResult

type ListBySkuCompleteResult struct {
	Items []MessagingRegions
}

type ListBySkuOperationResponse

type ListBySkuOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]MessagingRegions
	// contains filtered or unexported fields
}

func (ListBySkuOperationResponse) HasMore

func (r ListBySkuOperationResponse) HasMore() bool

func (ListBySkuOperationResponse) LoadMore

func (r ListBySkuOperationResponse) LoadMore(ctx context.Context) (resp ListBySkuOperationResponse, err error)

type MessagingRegions

type MessagingRegions struct {
	Id         *string                     `json:"id,omitempty"`
	Location   *string                     `json:"location,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *MessagingRegionsProperties `json:"properties,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type MessagingRegionsOperationPredicate

type MessagingRegionsOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (MessagingRegionsOperationPredicate) Matches

func (p MessagingRegionsOperationPredicate) Matches(input MessagingRegions) bool

type MessagingRegionsProperties

type MessagingRegionsProperties struct {
	Code     *string `json:"code,omitempty"`
	FullName *string `json:"fullName,omitempty"`
}

type RegionsClient

type RegionsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewRegionsClientWithBaseURI

func NewRegionsClientWithBaseURI(endpoint string) RegionsClient

func (RegionsClient) ListBySku

func (c RegionsClient) ListBySku(ctx context.Context, id SkuId) (resp ListBySkuOperationResponse, err error)

ListBySku ...

func (RegionsClient) ListBySkuComplete

func (c RegionsClient) ListBySkuComplete(ctx context.Context, id SkuId) (ListBySkuCompleteResult, error)

ListBySkuComplete retrieves all of the results into a single object

func (RegionsClient) ListBySkuCompleteMatchingPredicate

func (c RegionsClient) ListBySkuCompleteMatchingPredicate(ctx context.Context, id SkuId, predicate MessagingRegionsOperationPredicate) (resp ListBySkuCompleteResult, err error)

ListBySkuCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type SkuId

type SkuId struct {
	SubscriptionId string
	Sku            string
}

SkuId is a struct representing the Resource ID for a Sku

func NewSkuID

func NewSkuID(subscriptionId string, sku string) SkuId

NewSkuID returns a new SkuId struct

func ParseSkuID

func ParseSkuID(input string) (*SkuId, error)

ParseSkuID parses 'input' into a SkuId

func ParseSkuIDInsensitively

func ParseSkuIDInsensitively(input string) (*SkuId, error)

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

func (SkuId) ID

func (id SkuId) ID() string

ID returns the formatted Sku ID

func (SkuId) Segments

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

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

func (SkuId) String

func (id SkuId) String() string

String returns a human-readable description of this Sku ID