topictypes

README

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

The topictypes SDK allows for interaction with Azure Resource Manager 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/topictypes"

Client Initialization

client := topictypes.NewTopicTypesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TopicTypesClient.Get

ctx := context.TODO()
id := topictypes.NewTopicTypeID("topicTypeName")

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

ctx := context.TODO()


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

Example Usage: TopicTypesClient.ListEventTypes

ctx := context.TODO()
id := topictypes.NewTopicTypeID("topicTypeName")

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
}

Documentation

Index

• func PossibleValuesForResourceRegionType() []string
• func PossibleValuesForTopicTypeProvisioningState() []string
• func PossibleValuesForTopicTypeSourceScope() []string
• func ValidateTopicTypeID(input interface{}, key string) (warnings []string, errors []error)
• type EventType
• type EventTypeProperties
• type EventTypesListResult
• type GetOperationResponse
• type ListEventTypesOperationResponse
• type ListOperationResponse
• type ResourceRegionType
  • func (s *ResourceRegionType) UnmarshalJSON(bytes []byte) error
• type TopicTypeAdditionalEnforcedPermission
• type TopicTypeId
  • func NewTopicTypeID(topicTypeName string) TopicTypeId
  • func ParseTopicTypeID(input string) (*TopicTypeId, error)
  • func ParseTopicTypeIDInsensitively(input string) (*TopicTypeId, error)
  • func (id *TopicTypeId) FromParseResult(input resourceids.ParseResult) error
  • func (id TopicTypeId) ID() string
  • func (id TopicTypeId) Segments() []resourceids.Segment
  • func (id TopicTypeId) String() string
• type TopicTypeInfo
• type TopicTypeProperties
• type TopicTypeProvisioningState
  • func (s *TopicTypeProvisioningState) UnmarshalJSON(bytes []byte) error
• type TopicTypeSourceScope
  • func (s *TopicTypeSourceScope) UnmarshalJSON(bytes []byte) error
• type TopicTypesClient
  • func NewTopicTypesClientWithBaseURI(sdkApi sdkEnv.Api) (*TopicTypesClient, error)
  • func (c TopicTypesClient) Get(ctx context.Context, id TopicTypeId) (result GetOperationResponse, err error)
  • func (c TopicTypesClient) List(ctx context.Context) (result ListOperationResponse, err error)
  • func (c TopicTypesClient) ListEventTypes(ctx context.Context, id TopicTypeId) (result ListEventTypesOperationResponse, err error)
• type TopicTypesListResult

Functions

func PossibleValuesForResourceRegionType

func PossibleValuesForResourceRegionType() []string

func PossibleValuesForTopicTypeProvisioningState

func PossibleValuesForTopicTypeProvisioningState() []string

func PossibleValuesForTopicTypeSourceScope

func PossibleValuesForTopicTypeSourceScope() []string

func ValidateTopicTypeID

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

ValidateTopicTypeID checks that 'input' can be parsed as a Topic Type ID

Types

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 GetOperationResponse

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

type ListEventTypesOperationResponse

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

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TopicTypesListResult
}

type ResourceRegionType

type ResourceRegionType string

const (
	ResourceRegionTypeGlobalResource   ResourceRegionType = "GlobalResource"
	ResourceRegionTypeRegionalResource ResourceRegionType = "RegionalResource"
)

func (*ResourceRegionType) UnmarshalJSON

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

type TopicTypeAdditionalEnforcedPermission

type TopicTypeAdditionalEnforcedPermission struct {
	IsDataAction   *bool   `json:"isDataAction,omitempty"`
	PermissionName *string `json:"permissionName,omitempty"`
}

type TopicTypeId

type TopicTypeId struct {
	TopicTypeName string
}

TopicTypeId is a struct representing the Resource ID for a Topic Type

func NewTopicTypeID

func NewTopicTypeID(topicTypeName string) TopicTypeId

NewTopicTypeID returns a new TopicTypeId struct

func ParseTopicTypeID

func ParseTopicTypeID(input string) (*TopicTypeId, error)

ParseTopicTypeID parses 'input' into a TopicTypeId

func ParseTopicTypeIDInsensitively

func ParseTopicTypeIDInsensitively(input string) (*TopicTypeId, error)

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

func (*TopicTypeId) FromParseResult

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

func (TopicTypeId) ID

func (id TopicTypeId) ID() string

ID returns the formatted Topic Type ID

func (TopicTypeId) Segments

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

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

func (TopicTypeId) String

func (id TopicTypeId) String() string

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

type TopicTypeInfo

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

type TopicTypeProperties

type TopicTypeProperties struct {
	AdditionalEnforcedPermissions        *[]TopicTypeAdditionalEnforcedPermission `json:"additionalEnforcedPermissions,omitempty"`
	AreRegionalAndGlobalSourcesSupported *bool                                    `json:"areRegionalAndGlobalSourcesSupported,omitempty"`
	Description                          *string                                  `json:"description,omitempty"`
	DisplayName                          *string                                  `json:"displayName,omitempty"`
	Provider                             *string                                  `json:"provider,omitempty"`
	ProvisioningState                    *TopicTypeProvisioningState              `json:"provisioningState,omitempty"`
	ResourceRegionType                   *ResourceRegionType                      `json:"resourceRegionType,omitempty"`
	SourceResourceFormat                 *string                                  `json:"sourceResourceFormat,omitempty"`
	SupportedLocations                   *[]string                                `json:"supportedLocations,omitempty"`
	SupportedScopesForSource             *[]TopicTypeSourceScope                  `json:"supportedScopesForSource,omitempty"`
}

type TopicTypeProvisioningState

type TopicTypeProvisioningState string

const (
	TopicTypeProvisioningStateCanceled  TopicTypeProvisioningState = "Canceled"
	TopicTypeProvisioningStateCreating  TopicTypeProvisioningState = "Creating"
	TopicTypeProvisioningStateDeleting  TopicTypeProvisioningState = "Deleting"
	TopicTypeProvisioningStateFailed    TopicTypeProvisioningState = "Failed"
	TopicTypeProvisioningStateSucceeded TopicTypeProvisioningState = "Succeeded"
	TopicTypeProvisioningStateUpdating  TopicTypeProvisioningState = "Updating"
)

func (*TopicTypeProvisioningState) UnmarshalJSON

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

type TopicTypeSourceScope

type TopicTypeSourceScope string

const (
	TopicTypeSourceScopeAzureSubscription TopicTypeSourceScope = "AzureSubscription"
	TopicTypeSourceScopeManagementGroup   TopicTypeSourceScope = "ManagementGroup"
	TopicTypeSourceScopeResource          TopicTypeSourceScope = "Resource"
	TopicTypeSourceScopeResourceGroup     TopicTypeSourceScope = "ResourceGroup"
)

func (*TopicTypeSourceScope) UnmarshalJSON

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

type TopicTypesClient

type TopicTypesClient struct {
	Client *resourcemanager.Client
}

func NewTopicTypesClientWithBaseURI

func NewTopicTypesClientWithBaseURI(sdkApi sdkEnv.Api) (*TopicTypesClient, error)

func (TopicTypesClient) Get

func (c TopicTypesClient) Get(ctx context.Context, id TopicTypeId) (result GetOperationResponse, err error)

Get ...

func (TopicTypesClient) List

func (c TopicTypesClient) List(ctx context.Context) (result ListOperationResponse, err error)

List ...

func (TopicTypesClient) ListEventTypes

func (c TopicTypesClient) ListEventTypes(ctx context.Context, id TopicTypeId) (result ListEventTypesOperationResponse, err error)

ListEventTypes ...

type TopicTypesListResult

type TopicTypesListResult struct {
	Value *[]TopicTypeInfo `json:"value,omitempty"`
}