partnertopics

package
v0.20240321.1145953 Latest Latest
Warning

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

 Go to latest Published: Mar 21, 2024 License: MPL-2.0 Imports: 16 Imported by: 1

README

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

The partnertopics 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2023-12-15-preview/partnertopics"

Client Initialization

client := partnertopics.NewPartnerTopicsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PartnerTopicsClient.Activate

ctx := context.TODO()
id := partnertopics.NewPartnerTopicID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerTopicValue")

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

Example Usage: PartnerTopicsClient.CreateOrUpdate

ctx := context.TODO()
id := partnertopics.NewPartnerTopicID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerTopicValue")

payload := partnertopics.PartnerTopic{
	// ...
}


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

Example Usage: PartnerTopicsClient.Deactivate

ctx := context.TODO()
id := partnertopics.NewPartnerTopicID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerTopicValue")

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

Example Usage: PartnerTopicsClient.Delete

ctx := context.TODO()
id := partnertopics.NewPartnerTopicID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerTopicValue")

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

Example Usage: PartnerTopicsClient.Get

ctx := context.TODO()
id := partnertopics.NewPartnerTopicID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerTopicValue")

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: PartnerTopicsClient.ListByResourceGroup

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

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

Example Usage: PartnerTopicsClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: PartnerTopicsClient.Update

ctx := context.TODO()
id := partnertopics.NewPartnerTopicID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerTopicValue")

payload := partnertopics.PartnerTopicUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForEventDefinitionKind 

func PossibleValuesForEventDefinitionKind() []string

func PossibleValuesForPartnerTopicActivationState 

func PossibleValuesForPartnerTopicActivationState() []string

func PossibleValuesForPartnerTopicProvisioningState 

func PossibleValuesForPartnerTopicProvisioningState() []string

func ValidatePartnerTopicID 

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

ValidatePartnerTopicID checks that 'input' can be parsed as a Partner Topic ID

Types

type ActivateOperationResponse 

type ActivateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerTopic
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerTopic
}

type DeactivateOperationResponse 

type DeactivateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerTopic
}

type DeleteOperationResponse 

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

type EventDefinitionKind 

type EventDefinitionKind string
const (
	EventDefinitionKindInline EventDefinitionKind = "Inline"
)

func (*EventDefinitionKind) UnmarshalJSON 

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

type EventTypeInfo 

type EventTypeInfo struct {
	InlineEventTypes *map[string]InlineEventProperties `json:"inlineEventTypes,omitempty"`
	Kind             *EventDefinitionKind              `json:"kind,omitempty"`
}

type GetOperationResponse 

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

type InlineEventProperties 

type InlineEventProperties struct {
	DataSchemaUrl    *string `json:"dataSchemaUrl,omitempty"`
	Description      *string `json:"description,omitempty"`
	DisplayName      *string `json:"displayName,omitempty"`
	DocumentationUrl *string `json:"documentationUrl,omitempty"`
}

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PartnerTopic
}

type ListByResourceGroupOperationOptions 

type ListByResourceGroupOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByResourceGroupOperationOptions 

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

func (ListByResourceGroupOperationOptions) ToHeaders 

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

func (ListByResourceGroupOperationOptions) ToOData 

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

func (ListByResourceGroupOperationOptions) ToQuery 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PartnerTopic
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PartnerTopic
}

type ListBySubscriptionOperationOptions 

type ListBySubscriptionOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListBySubscriptionOperationOptions 

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

func (ListBySubscriptionOperationOptions) ToHeaders 

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

func (ListBySubscriptionOperationOptions) ToOData 

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

func (ListBySubscriptionOperationOptions) ToQuery 

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

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PartnerTopic
}

type PartnerTopic 

type PartnerTopic struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *PartnerTopicProperties            `json:"properties,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type PartnerTopicActivationState 

type PartnerTopicActivationState string
const (
	PartnerTopicActivationStateActivated      PartnerTopicActivationState = "Activated"
	PartnerTopicActivationStateDeactivated    PartnerTopicActivationState = "Deactivated"
	PartnerTopicActivationStateNeverActivated PartnerTopicActivationState = "NeverActivated"
)

func (*PartnerTopicActivationState) UnmarshalJSON 

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

type PartnerTopicId 

type PartnerTopicId struct {
	SubscriptionId    string
	ResourceGroupName string
	PartnerTopicName  string
}

PartnerTopicId is a struct representing the Resource ID for a Partner Topic

func NewPartnerTopicID 

func NewPartnerTopicID(subscriptionId string, resourceGroupName string, partnerTopicName string) PartnerTopicId

NewPartnerTopicID returns a new PartnerTopicId struct

func ParsePartnerTopicID 

func ParsePartnerTopicID(input string) (*PartnerTopicId, error)

ParsePartnerTopicID parses 'input' into a PartnerTopicId

func ParsePartnerTopicIDInsensitively 

func ParsePartnerTopicIDInsensitively(input string) (*PartnerTopicId, error)

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

func (*PartnerTopicId) FromParseResult 

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

func (PartnerTopicId) ID 

func (id PartnerTopicId) ID() string

ID returns the formatted Partner Topic ID

func (PartnerTopicId) Segments 

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

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

func (PartnerTopicId) String 

func (id PartnerTopicId) String() string

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

type PartnerTopicOperationPredicate 

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

func (PartnerTopicOperationPredicate) Matches 

func (p PartnerTopicOperationPredicate) Matches(input PartnerTopic) bool

type PartnerTopicProperties 

type PartnerTopicProperties struct {
	ActivationState                 *PartnerTopicActivationState   `json:"activationState,omitempty"`
	EventTypeInfo                   *EventTypeInfo                 `json:"eventTypeInfo,omitempty"`
	ExpirationTimeIfNotActivatedUtc *string                        `json:"expirationTimeIfNotActivatedUtc,omitempty"`
	MessageForActivation            *string                        `json:"messageForActivation,omitempty"`
	PartnerRegistrationImmutableId  *string                        `json:"partnerRegistrationImmutableId,omitempty"`
	PartnerTopicFriendlyDescription *string                        `json:"partnerTopicFriendlyDescription,omitempty"`
	ProvisioningState               *PartnerTopicProvisioningState `json:"provisioningState,omitempty"`
	Source                          *string                        `json:"source,omitempty"`
}

func (*PartnerTopicProperties) GetExpirationTimeIfNotActivatedUtcAsTime 

func (o *PartnerTopicProperties) GetExpirationTimeIfNotActivatedUtcAsTime() (*time.Time, error)

func (*PartnerTopicProperties) SetExpirationTimeIfNotActivatedUtcAsTime 

func (o *PartnerTopicProperties) SetExpirationTimeIfNotActivatedUtcAsTime(input time.Time)

type PartnerTopicProvisioningState 

type PartnerTopicProvisioningState string
const (
	PartnerTopicProvisioningStateCanceled                                 PartnerTopicProvisioningState = "Canceled"
	PartnerTopicProvisioningStateCreating                                 PartnerTopicProvisioningState = "Creating"
	PartnerTopicProvisioningStateDeleting                                 PartnerTopicProvisioningState = "Deleting"
	PartnerTopicProvisioningStateFailed                                   PartnerTopicProvisioningState = "Failed"
	PartnerTopicProvisioningStateIdleDueToMirroredChannelResourceDeletion PartnerTopicProvisioningState = "IdleDueToMirroredChannelResourceDeletion"
	PartnerTopicProvisioningStateSucceeded                                PartnerTopicProvisioningState = "Succeeded"
	PartnerTopicProvisioningStateUpdating                                 PartnerTopicProvisioningState = "Updating"
)

func (*PartnerTopicProvisioningState) UnmarshalJSON 

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

type PartnerTopicUpdateParameters 

type PartnerTopicUpdateParameters struct {
	Identity *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Tags     *map[string]string                 `json:"tags,omitempty"`
}

type PartnerTopicsClient 

type PartnerTopicsClient struct {
	Client *resourcemanager.Client
}

func NewPartnerTopicsClientWithBaseURI 

func NewPartnerTopicsClientWithBaseURI(sdkApi sdkEnv.Api) (*PartnerTopicsClient, error)

func (PartnerTopicsClient) Activate 

func (c PartnerTopicsClient) Activate(ctx context.Context, id PartnerTopicId) (result ActivateOperationResponse, err error)

Activate ...

func (PartnerTopicsClient) CreateOrUpdate 

func (c PartnerTopicsClient) CreateOrUpdate(ctx context.Context, id PartnerTopicId, input PartnerTopic) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PartnerTopicsClient) Deactivate 

func (c PartnerTopicsClient) Deactivate(ctx context.Context, id PartnerTopicId) (result DeactivateOperationResponse, err error)

Deactivate ...

func (PartnerTopicsClient) Delete 

func (c PartnerTopicsClient) Delete(ctx context.Context, id PartnerTopicId) (result DeleteOperationResponse, err error)

Delete ...

func (PartnerTopicsClient) DeleteThenPoll 

func (c PartnerTopicsClient) DeleteThenPoll(ctx context.Context, id PartnerTopicId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PartnerTopicsClient) Get 

func (c PartnerTopicsClient) Get(ctx context.Context, id PartnerTopicId) (result GetOperationResponse, err error)

Get ...

func (PartnerTopicsClient) ListByResourceGroup 

func (c PartnerTopicsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (PartnerTopicsClient) ListByResourceGroupComplete 

func (c PartnerTopicsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (PartnerTopicsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c PartnerTopicsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions, predicate PartnerTopicOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PartnerTopicsClient) ListBySubscription 

func (c PartnerTopicsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (PartnerTopicsClient) ListBySubscriptionComplete 

func (c PartnerTopicsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (PartnerTopicsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c PartnerTopicsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions, predicate PartnerTopicOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PartnerTopicsClient) Update 

func (c PartnerTopicsClient) Update(ctx context.Context, id PartnerTopicId, input PartnerTopicUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerTopic
}

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.