systemtopics

package
v0.20230802.1160114 Latest Latest
Warning

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

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

README

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

The systemtopics 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/systemtopics"

Client Initialization

client := systemtopics.NewSystemTopicsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SystemTopicsClient.CreateOrUpdate

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

payload := systemtopics.SystemTopic{
	// ...
}


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

Example Usage: SystemTopicsClient.Delete

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

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

Example Usage: SystemTopicsClient.Get

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

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

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

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

Example Usage: SystemTopicsClient.ListBySubscription

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

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

Example Usage: SystemTopicsClient.Update

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

payload := systemtopics.SystemTopicUpdateParameters{
	// ...
}


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 PossibleValuesForResourceProvisioningState

func PossibleValuesForResourceProvisioningState() []string

func ValidateSystemTopicID

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

ValidateSystemTopicID checks that 'input' can be parsed as a System Topic ID

Types

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []SystemTopic
}

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

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []SystemTopic
}

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

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 SystemTopic

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

type SystemTopicId

type SystemTopicId struct {
	SubscriptionId    string
	ResourceGroupName string
	SystemTopicName   string
}

SystemTopicId is a struct representing the Resource ID for a System Topic

func NewSystemTopicID

func NewSystemTopicID(subscriptionId string, resourceGroupName string, systemTopicName string) SystemTopicId

NewSystemTopicID returns a new SystemTopicId struct

func ParseSystemTopicID

func ParseSystemTopicID(input string) (*SystemTopicId, error)

ParseSystemTopicID parses 'input' into a SystemTopicId

func ParseSystemTopicIDInsensitively

func ParseSystemTopicIDInsensitively(input string) (*SystemTopicId, error)

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

func (SystemTopicId) ID

func (id SystemTopicId) ID() string

ID returns the formatted System Topic ID

func (SystemTopicId) Segments

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

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

func (SystemTopicId) String

func (id SystemTopicId) String() string

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

type SystemTopicOperationPredicate

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

func (SystemTopicOperationPredicate) Matches

type SystemTopicProperties

type SystemTopicProperties struct {
	MetricResourceId  *string                    `json:"metricResourceId,omitempty"`
	ProvisioningState *ResourceProvisioningState `json:"provisioningState,omitempty"`
	Source            *string                    `json:"source,omitempty"`
	TopicType         *string                    `json:"topicType,omitempty"`
}

type SystemTopicUpdateParameters

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

type SystemTopicsClient

type SystemTopicsClient struct {
	Client *resourcemanager.Client
}

func NewSystemTopicsClientWithBaseURI

func NewSystemTopicsClientWithBaseURI(sdkApi sdkEnv.Api) (*SystemTopicsClient, error)

func (SystemTopicsClient) CreateOrUpdate

func (c SystemTopicsClient) CreateOrUpdate(ctx context.Context, id SystemTopicId, input SystemTopic) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SystemTopicsClient) CreateOrUpdateThenPoll

func (c SystemTopicsClient) CreateOrUpdateThenPoll(ctx context.Context, id SystemTopicId, input SystemTopic) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SystemTopicsClient) Delete

Delete ...

func (SystemTopicsClient) DeleteThenPoll

func (c SystemTopicsClient) DeleteThenPoll(ctx context.Context, id SystemTopicId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SystemTopicsClient) Get

Get ...

func (SystemTopicsClient) ListByResourceGroup

ListByResourceGroup ...

func (SystemTopicsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (SystemTopicsClient) ListByResourceGroupCompleteMatchingPredicate

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SystemTopicsClient) ListBySubscription

ListBySubscription ...

func (SystemTopicsClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (SystemTopicsClient) ListBySubscriptionCompleteMatchingPredicate

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SystemTopicsClient) Update

Update ...

func (SystemTopicsClient) UpdateThenPoll

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