topics

package
v0.20231214.1160726 Latest Latest
Warning

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

Go to latest
Published: Dec 14, 2023 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2022-06-15/topics Documentation

The topics SDK allows for interaction with the Azure Resource Manager Service eventgrid (API Version 2022-06-15).

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/2022-06-15/topics"

Client Initialization

client := topics.NewTopicsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TopicsClient.CreateOrUpdate

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

payload := topics.Topic{
	// ...
}


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

Example Usage: TopicsClient.Delete

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

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

Example Usage: TopicsClient.ExtensionTopicsGet

ctx := context.TODO()
id := topics.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: TopicsClient.Get

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

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

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

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

Example Usage: TopicsClient.ListBySubscription

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

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

Example Usage: TopicsClient.ListEventTypes

ctx := context.TODO()
id := topics.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: TopicsClient.ListSharedAccessKeys

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

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

Example Usage: TopicsClient.RegenerateKey

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

payload := topics.TopicRegenerateKeyRequest{
	// ...
}


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

Example Usage: TopicsClient.Update

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

payload := topics.TopicUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDataResidencyBoundary

func PossibleValuesForDataResidencyBoundary() []string

func PossibleValuesForIPActionType

func PossibleValuesForIPActionType() []string

func PossibleValuesForInputSchema

func PossibleValuesForInputSchema() []string

func PossibleValuesForInputSchemaMappingType

func PossibleValuesForInputSchemaMappingType() []string

func PossibleValuesForPersistedConnectionStatus

func PossibleValuesForPersistedConnectionStatus() []string

func PossibleValuesForPublicNetworkAccess

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForResourceProvisioningState

func PossibleValuesForResourceProvisioningState() []string

func PossibleValuesForTopicProvisioningState

func PossibleValuesForTopicProvisioningState() []string

func ValidateTopicID

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

ValidateTopicID checks that 'input' can be parsed as a Topic ID

Types

type ConnectionState

type ConnectionState struct {
	ActionsRequired *string                    `json:"actionsRequired,omitempty"`
	Description     *string                    `json:"description,omitempty"`
	Status          *PersistedConnectionStatus `json:"status,omitempty"`
}

type CreateOrUpdateOperationResponse

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

type DataResidencyBoundary

type DataResidencyBoundary string
const (
	DataResidencyBoundaryWithinGeopair DataResidencyBoundary = "WithinGeopair"
	DataResidencyBoundaryWithinRegion  DataResidencyBoundary = "WithinRegion"
)

func (*DataResidencyBoundary) UnmarshalJSON

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

type DeleteOperationResponse

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

type EventType

type EventType struct {
	Id         *string              `json:"id,omitempty"`
	Name       *string              `json:"name,omitempty"`
	Properties *EventTypeProperties `json:"properties,omitempty"`
	Type       *string              `json:"type,omitempty"`
}

type EventTypeProperties

type EventTypeProperties struct {
	Description    *string `json:"description,omitempty"`
	DisplayName    *string `json:"displayName,omitempty"`
	IsInDefaultSet *bool   `json:"isInDefaultSet,omitempty"`
	SchemaUrl      *string `json:"schemaUrl,omitempty"`
}

type EventTypesListResult

type EventTypesListResult struct {
	Value *[]EventType `json:"value,omitempty"`
}

type ExtensionTopic

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

type ExtensionTopicProperties

type ExtensionTopicProperties struct {
	Description *string `json:"description,omitempty"`
	SystemTopic *string `json:"systemTopic,omitempty"`
}

type ExtensionTopicsGetOperationResponse

type ExtensionTopicsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExtensionTopic
}

type GetOperationResponse

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

type IPActionType

type IPActionType string
const (
	IPActionTypeAllow IPActionType = "Allow"
)

func (*IPActionType) UnmarshalJSON

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

type InboundIPRule

type InboundIPRule struct {
	Action *IPActionType `json:"action,omitempty"`
	IPMask *string       `json:"ipMask,omitempty"`
}

type InputSchema

type InputSchema string
const (
	InputSchemaCloudEventSchemaVOneZero InputSchema = "CloudEventSchemaV1_0"
	InputSchemaCustomEventSchema        InputSchema = "CustomEventSchema"
	InputSchemaEventGridSchema          InputSchema = "EventGridSchema"
)

func (*InputSchema) UnmarshalJSON

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

type InputSchemaMapping

type InputSchemaMapping interface {
}

type InputSchemaMappingType

type InputSchemaMappingType string
const (
	InputSchemaMappingTypeJson InputSchemaMappingType = "Json"
)

func (*InputSchemaMappingType) UnmarshalJSON

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

type JsonField

type JsonField struct {
	SourceField *string `json:"sourceField,omitempty"`
}

type JsonFieldWithDefault

type JsonFieldWithDefault struct {
	DefaultValue *string `json:"defaultValue,omitempty"`
	SourceField  *string `json:"sourceField,omitempty"`
}

type JsonInputSchemaMapping

type JsonInputSchemaMapping struct {
	Properties *JsonInputSchemaMappingProperties `json:"properties,omitempty"`
}

func (JsonInputSchemaMapping) MarshalJSON

func (s JsonInputSchemaMapping) MarshalJSON() ([]byte, error)

type JsonInputSchemaMappingProperties

type JsonInputSchemaMappingProperties struct {
	DataVersion *JsonFieldWithDefault `json:"dataVersion,omitempty"`
	EventTime   *JsonField            `json:"eventTime,omitempty"`
	EventType   *JsonFieldWithDefault `json:"eventType,omitempty"`
	Id          *JsonField            `json:"id,omitempty"`
	Subject     *JsonFieldWithDefault `json:"subject,omitempty"`
	Topic       *JsonField            `json:"topic,omitempty"`
}

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []Topic
}

type ListByResourceGroupOperationOptions

type ListByResourceGroupOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByResourceGroupOperationOptions

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

func (ListByResourceGroupOperationOptions) ToHeaders

func (ListByResourceGroupOperationOptions) ToOData

func (ListByResourceGroupOperationOptions) ToQuery

type ListByResourceGroupOperationResponse

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

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []Topic
}

type ListBySubscriptionOperationOptions

type ListBySubscriptionOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListBySubscriptionOperationOptions

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

func (ListBySubscriptionOperationOptions) ToHeaders

func (ListBySubscriptionOperationOptions) ToOData

func (ListBySubscriptionOperationOptions) ToQuery

type ListBySubscriptionOperationResponse

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

type ListEventTypesOperationResponse

type ListEventTypesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EventTypesListResult
}

type ListSharedAccessKeysOperationResponse

type ListSharedAccessKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TopicSharedAccessKeys
}

type PersistedConnectionStatus

type PersistedConnectionStatus string
const (
	PersistedConnectionStatusApproved     PersistedConnectionStatus = "Approved"
	PersistedConnectionStatusDisconnected PersistedConnectionStatus = "Disconnected"
	PersistedConnectionStatusPending      PersistedConnectionStatus = "Pending"
	PersistedConnectionStatusRejected     PersistedConnectionStatus = "Rejected"
)

func (*PersistedConnectionStatus) UnmarshalJSON

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

type PrivateEndpoint

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                  `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint           `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *ConnectionState           `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *ResourceProvisioningState `json:"provisioningState,omitempty"`
}

type PublicNetworkAccess

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON

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

type RawInputSchemaMappingImpl added in v0.20230807.1063129

type RawInputSchemaMappingImpl struct {
	Type   string
	Values map[string]interface{}
}

RawInputSchemaMappingImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RegenerateKeyOperationResponse

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

type ResourceProvisioningState

type ResourceProvisioningState string
const (
	ResourceProvisioningStateCanceled  ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateCreating  ResourceProvisioningState = "Creating"
	ResourceProvisioningStateDeleting  ResourceProvisioningState = "Deleting"
	ResourceProvisioningStateFailed    ResourceProvisioningState = "Failed"
	ResourceProvisioningStateSucceeded ResourceProvisioningState = "Succeeded"
	ResourceProvisioningStateUpdating  ResourceProvisioningState = "Updating"
)

func (*ResourceProvisioningState) UnmarshalJSON

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

type Topic

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

type TopicId

type TopicId struct {
	SubscriptionId    string
	ResourceGroupName string
	TopicName         string
}

TopicId is a struct representing the Resource ID for a Topic

func NewTopicID

func NewTopicID(subscriptionId string, resourceGroupName string, topicName string) TopicId

NewTopicID returns a new TopicId struct

func ParseTopicID

func ParseTopicID(input string) (*TopicId, error)

ParseTopicID parses 'input' into a TopicId

func ParseTopicIDInsensitively

func ParseTopicIDInsensitively(input string) (*TopicId, error)

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

func (*TopicId) FromParseResult added in v0.20231127.1171502

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

func (TopicId) ID

func (id TopicId) ID() string

ID returns the formatted Topic ID

func (TopicId) Segments

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

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

func (TopicId) String

func (id TopicId) String() string

String returns a human-readable description of this Topic ID

type TopicOperationPredicate

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

func (TopicOperationPredicate) Matches

func (p TopicOperationPredicate) Matches(input Topic) bool

type TopicProperties

type TopicProperties struct {
	DataResidencyBoundary      *DataResidencyBoundary       `json:"dataResidencyBoundary,omitempty"`
	DisableLocalAuth           *bool                        `json:"disableLocalAuth,omitempty"`
	Endpoint                   *string                      `json:"endpoint,omitempty"`
	InboundIPRules             *[]InboundIPRule             `json:"inboundIpRules,omitempty"`
	InputSchema                *InputSchema                 `json:"inputSchema,omitempty"`
	InputSchemaMapping         InputSchemaMapping           `json:"inputSchemaMapping"`
	MetricResourceId           *string                      `json:"metricResourceId,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *TopicProvisioningState      `json:"provisioningState,omitempty"`
	PublicNetworkAccess        *PublicNetworkAccess         `json:"publicNetworkAccess,omitempty"`
}

func (*TopicProperties) UnmarshalJSON

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

type TopicProvisioningState

type TopicProvisioningState string
const (
	TopicProvisioningStateCanceled  TopicProvisioningState = "Canceled"
	TopicProvisioningStateCreating  TopicProvisioningState = "Creating"
	TopicProvisioningStateDeleting  TopicProvisioningState = "Deleting"
	TopicProvisioningStateFailed    TopicProvisioningState = "Failed"
	TopicProvisioningStateSucceeded TopicProvisioningState = "Succeeded"
	TopicProvisioningStateUpdating  TopicProvisioningState = "Updating"
)

func (*TopicProvisioningState) UnmarshalJSON

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

type TopicRegenerateKeyRequest

type TopicRegenerateKeyRequest struct {
	KeyName string `json:"keyName"`
}

type TopicSharedAccessKeys

type TopicSharedAccessKeys struct {
	Key1 *string `json:"key1,omitempty"`
	Key2 *string `json:"key2,omitempty"`
}

type TopicUpdateParameterProperties

type TopicUpdateParameterProperties struct {
	DataResidencyBoundary *DataResidencyBoundary `json:"dataResidencyBoundary,omitempty"`
	DisableLocalAuth      *bool                  `json:"disableLocalAuth,omitempty"`
	InboundIPRules        *[]InboundIPRule       `json:"inboundIpRules,omitempty"`
	PublicNetworkAccess   *PublicNetworkAccess   `json:"publicNetworkAccess,omitempty"`
}

type TopicUpdateParameters

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

type TopicsClient

type TopicsClient struct {
	Client *resourcemanager.Client
}

func NewTopicsClientWithBaseURI

func NewTopicsClientWithBaseURI(sdkApi sdkEnv.Api) (*TopicsClient, error)

func (TopicsClient) CreateOrUpdate

func (c TopicsClient) CreateOrUpdate(ctx context.Context, id TopicId, input Topic) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (TopicsClient) CreateOrUpdateThenPoll

func (c TopicsClient) CreateOrUpdateThenPoll(ctx context.Context, id TopicId, input Topic) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (TopicsClient) Delete

func (c TopicsClient) Delete(ctx context.Context, id TopicId) (result DeleteOperationResponse, err error)

Delete ...

func (TopicsClient) DeleteThenPoll

func (c TopicsClient) DeleteThenPoll(ctx context.Context, id TopicId) error

DeleteThenPoll performs Delete then polls until it's completed

func (TopicsClient) ExtensionTopicsGet

func (c TopicsClient) ExtensionTopicsGet(ctx context.Context, id commonids.ScopeId) (result ExtensionTopicsGetOperationResponse, err error)

ExtensionTopicsGet ...

func (TopicsClient) Get

func (c TopicsClient) Get(ctx context.Context, id TopicId) (result GetOperationResponse, err error)

Get ...

func (TopicsClient) ListByResourceGroup

ListByResourceGroup ...

func (TopicsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (TopicsClient) ListByResourceGroupCompleteMatchingPredicate

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TopicsClient) ListBySubscription

ListBySubscription ...

func (TopicsClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (TopicsClient) ListBySubscriptionCompleteMatchingPredicate

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TopicsClient) ListEventTypes

func (c TopicsClient) ListEventTypes(ctx context.Context, id commonids.ScopeId) (result ListEventTypesOperationResponse, err error)

ListEventTypes ...

func (TopicsClient) ListSharedAccessKeys

func (c TopicsClient) ListSharedAccessKeys(ctx context.Context, id TopicId) (result ListSharedAccessKeysOperationResponse, err error)

ListSharedAccessKeys ...

func (TopicsClient) RegenerateKey

RegenerateKey ...

func (TopicsClient) RegenerateKeyThenPoll

func (c TopicsClient) RegenerateKeyThenPoll(ctx context.Context, id TopicId, input TopicRegenerateKeyRequest) error

RegenerateKeyThenPoll performs RegenerateKey then polls until it's completed

func (TopicsClient) Update

Update ...

func (TopicsClient) UpdateThenPoll

func (c TopicsClient) UpdateThenPoll(ctx context.Context, id TopicId, input TopicUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL