verifiedpartners

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2023-12-15-preview/verifiedpartners Documentation

The verifiedpartners SDK allows for interaction with the Azure Resource Manager Service eventgrid (API Version 2023-12-15-preview).

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/eventgrid/2023-12-15-preview/verifiedpartners"

Client Initialization

client := verifiedpartners.NewVerifiedPartnersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VerifiedPartnersClient.Get

ctx := context.TODO()
id := verifiedpartners.NewVerifiedPartnerID("verifiedPartnerValue")

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

ctx := context.TODO()


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

Documentation

Index

• func PossibleValuesForVerifiedPartnerProvisioningState() []string
• func ValidateVerifiedPartnerID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
  • func (o ListOperationOptions) ToHeaders() *client.Headers
  • func (o ListOperationOptions) ToOData() *odata.Query
  • func (o ListOperationOptions) ToQuery() *client.QueryParams
• type ListOperationResponse
• type PartnerDetails
• type VerifiedPartner
• type VerifiedPartnerId
  • func NewVerifiedPartnerID(verifiedPartnerName string) VerifiedPartnerId
  • func ParseVerifiedPartnerID(input string) (*VerifiedPartnerId, error)
  • func ParseVerifiedPartnerIDInsensitively(input string) (*VerifiedPartnerId, error)
  • func (id *VerifiedPartnerId) FromParseResult(input resourceids.ParseResult) error
  • func (id VerifiedPartnerId) ID() string
  • func (id VerifiedPartnerId) Segments() []resourceids.Segment
  • func (id VerifiedPartnerId) String() string
• type VerifiedPartnerOperationPredicate
  • func (p VerifiedPartnerOperationPredicate) Matches(input VerifiedPartner) bool
• type VerifiedPartnerProperties
• type VerifiedPartnerProvisioningState
  • func (s *VerifiedPartnerProvisioningState) UnmarshalJSON(bytes []byte) error
• type VerifiedPartnersClient
  • func NewVerifiedPartnersClientWithBaseURI(sdkApi sdkEnv.Api) (*VerifiedPartnersClient, error)
  • func (c VerifiedPartnersClient) Get(ctx context.Context, id VerifiedPartnerId) (result GetOperationResponse, err error)
  • func (c VerifiedPartnersClient) List(ctx context.Context, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c VerifiedPartnersClient) ListComplete(ctx context.Context, options ListOperationOptions) (ListCompleteResult, error)
  • func (c VerifiedPartnersClient) ListCompleteMatchingPredicate(ctx context.Context, options ListOperationOptions, ...) (result ListCompleteResult, err error)

Functions

func PossibleValuesForVerifiedPartnerProvisioningState

func PossibleValuesForVerifiedPartnerProvisioningState() []string

func ValidateVerifiedPartnerID

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

ValidateVerifiedPartnerID checks that 'input' can be parsed as a Verified Partner ID

Types

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
	Top    *int64
}

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        *[]VerifiedPartner
}

type PartnerDetails

type PartnerDetails struct {
	Description     *string `json:"description,omitempty"`
	LongDescription *string `json:"longDescription,omitempty"`
	SetupUri        *string `json:"setupUri,omitempty"`
}

type VerifiedPartner

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

type VerifiedPartnerId

type VerifiedPartnerId struct {
	VerifiedPartnerName string
}

VerifiedPartnerId is a struct representing the Resource ID for a Verified Partner

func NewVerifiedPartnerID

func NewVerifiedPartnerID(verifiedPartnerName string) VerifiedPartnerId

NewVerifiedPartnerID returns a new VerifiedPartnerId struct

func ParseVerifiedPartnerID

func ParseVerifiedPartnerID(input string) (*VerifiedPartnerId, error)

ParseVerifiedPartnerID parses 'input' into a VerifiedPartnerId

func ParseVerifiedPartnerIDInsensitively

func ParseVerifiedPartnerIDInsensitively(input string) (*VerifiedPartnerId, error)

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

func (*VerifiedPartnerId) FromParseResult

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

func (VerifiedPartnerId) ID

func (id VerifiedPartnerId) ID() string

ID returns the formatted Verified Partner ID

func (VerifiedPartnerId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Verified Partner ID

func (VerifiedPartnerId) String

func (id VerifiedPartnerId) String() string

String returns a human-readable description of this Verified Partner ID

type VerifiedPartnerOperationPredicate

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

func (VerifiedPartnerOperationPredicate) Matches

func (p VerifiedPartnerOperationPredicate) Matches(input VerifiedPartner) bool

type VerifiedPartnerProperties

type VerifiedPartnerProperties struct {
	OrganizationName               *string                           `json:"organizationName,omitempty"`
	PartnerDestinationDetails      *PartnerDetails                   `json:"partnerDestinationDetails,omitempty"`
	PartnerDisplayName             *string                           `json:"partnerDisplayName,omitempty"`
	PartnerRegistrationImmutableId *string                           `json:"partnerRegistrationImmutableId,omitempty"`
	PartnerTopicDetails            *PartnerDetails                   `json:"partnerTopicDetails,omitempty"`
	ProvisioningState              *VerifiedPartnerProvisioningState `json:"provisioningState,omitempty"`
}

type VerifiedPartnerProvisioningState

type VerifiedPartnerProvisioningState string

const (
	VerifiedPartnerProvisioningStateCanceled  VerifiedPartnerProvisioningState = "Canceled"
	VerifiedPartnerProvisioningStateCreating  VerifiedPartnerProvisioningState = "Creating"
	VerifiedPartnerProvisioningStateDeleting  VerifiedPartnerProvisioningState = "Deleting"
	VerifiedPartnerProvisioningStateFailed    VerifiedPartnerProvisioningState = "Failed"
	VerifiedPartnerProvisioningStateSucceeded VerifiedPartnerProvisioningState = "Succeeded"
	VerifiedPartnerProvisioningStateUpdating  VerifiedPartnerProvisioningState = "Updating"
)

func (*VerifiedPartnerProvisioningState) UnmarshalJSON

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

type VerifiedPartnersClient

type VerifiedPartnersClient struct {
	Client *resourcemanager.Client
}

func NewVerifiedPartnersClientWithBaseURI

func NewVerifiedPartnersClientWithBaseURI(sdkApi sdkEnv.Api) (*VerifiedPartnersClient, error)

func (VerifiedPartnersClient) Get

func (c VerifiedPartnersClient) Get(ctx context.Context, id VerifiedPartnerId) (result GetOperationResponse, err error)

Get ...

func (VerifiedPartnersClient) List

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

List ...

func (VerifiedPartnersClient) ListComplete

func (c VerifiedPartnersClient) ListComplete(ctx context.Context, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (VerifiedPartnersClient) ListCompleteMatchingPredicate

func (c VerifiedPartnersClient) ListCompleteMatchingPredicate(ctx context.Context, options ListOperationOptions, predicate VerifiedPartnerOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate