daprsubscriptions

package
v0.20241206.1180327 Latest Latest
Warning

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

 Go to latest Published: Dec 6, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2024-02-02-preview/daprsubscriptions Documentation

The daprsubscriptions SDK allows for interaction with Azure Resource Manager containerapps (API Version 2024-02-02-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/containerapps/2024-02-02-preview/daprsubscriptions"

Client Initialization

client := daprsubscriptions.NewDaprSubscriptionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DaprSubscriptionsClient.CreateOrUpdate

ctx := context.TODO()
id := daprsubscriptions.NewDaprSubscriptionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentName", "daprSubscriptionName")

payload := daprsubscriptions.DaprSubscription{
	// ...
}


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: DaprSubscriptionsClient.Delete

ctx := context.TODO()
id := daprsubscriptions.NewDaprSubscriptionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentName", "daprSubscriptionName")

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

Example Usage: DaprSubscriptionsClient.Get

ctx := context.TODO()
id := daprsubscriptions.NewDaprSubscriptionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentName", "daprSubscriptionName")

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateDaprSubscriptionID 

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

ValidateDaprSubscriptionID checks that 'input' can be parsed as a Dapr Subscription ID

func ValidateManagedEnvironmentID 

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

ValidateManagedEnvironmentID checks that 'input' can be parsed as a Managed Environment ID

Types

type CreateOrUpdateOperationResponse 

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

type DaprSubscription 

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

type DaprSubscriptionBulkSubscribeOptions 

type DaprSubscriptionBulkSubscribeOptions struct {
	Enabled            *bool  `json:"enabled,omitempty"`
	MaxAwaitDurationMs *int64 `json:"maxAwaitDurationMs,omitempty"`
	MaxMessagesCount   *int64 `json:"maxMessagesCount,omitempty"`
}

type DaprSubscriptionId 

type DaprSubscriptionId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ManagedEnvironmentName string
	DaprSubscriptionName   string
}

DaprSubscriptionId is a struct representing the Resource ID for a Dapr Subscription

func NewDaprSubscriptionID 

func NewDaprSubscriptionID(subscriptionId string, resourceGroupName string, managedEnvironmentName string, daprSubscriptionName string) DaprSubscriptionId

NewDaprSubscriptionID returns a new DaprSubscriptionId struct

func ParseDaprSubscriptionID 

func ParseDaprSubscriptionID(input string) (*DaprSubscriptionId, error)

ParseDaprSubscriptionID parses 'input' into a DaprSubscriptionId

func ParseDaprSubscriptionIDInsensitively 

func ParseDaprSubscriptionIDInsensitively(input string) (*DaprSubscriptionId, error)

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

func (*DaprSubscriptionId) FromParseResult 

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

func (DaprSubscriptionId) ID 

func (id DaprSubscriptionId) ID() string

ID returns the formatted Dapr Subscription ID

func (DaprSubscriptionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Dapr Subscription ID

func (DaprSubscriptionId) String 

func (id DaprSubscriptionId) String() string

String returns a human-readable description of this Dapr Subscription ID

type DaprSubscriptionOperationPredicate 

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

func (DaprSubscriptionOperationPredicate) Matches 

func (p DaprSubscriptionOperationPredicate) Matches(input DaprSubscription) bool

type DaprSubscriptionProperties 

type DaprSubscriptionProperties struct {
	BulkSubscribe   *DaprSubscriptionBulkSubscribeOptions `json:"bulkSubscribe,omitempty"`
	DeadLetterTopic *string                               `json:"deadLetterTopic,omitempty"`
	Metadata        *map[string]string                    `json:"metadata,omitempty"`
	PubsubName      *string                               `json:"pubsubName,omitempty"`
	Routes          *DaprSubscriptionRoutes               `json:"routes,omitempty"`
	Scopes          *[]string                             `json:"scopes,omitempty"`
	Topic           *string                               `json:"topic,omitempty"`
}

type DaprSubscriptionRouteRule 

type DaprSubscriptionRouteRule struct {
	Match *string `json:"match,omitempty"`
	Path  *string `json:"path,omitempty"`
}

type DaprSubscriptionRoutes 

type DaprSubscriptionRoutes struct {
	Default *string                      `json:"default,omitempty"`
	Rules   *[]DaprSubscriptionRouteRule `json:"rules,omitempty"`
}

type DaprSubscriptionsClient 

type DaprSubscriptionsClient struct {
	Client *resourcemanager.Client
}

func NewDaprSubscriptionsClientWithBaseURI 

func NewDaprSubscriptionsClientWithBaseURI(sdkApi sdkEnv.Api) (*DaprSubscriptionsClient, error)

func (DaprSubscriptionsClient) CreateOrUpdate 

func (c DaprSubscriptionsClient) CreateOrUpdate(ctx context.Context, id DaprSubscriptionId, input DaprSubscription) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DaprSubscriptionsClient) Delete 

func (c DaprSubscriptionsClient) Delete(ctx context.Context, id DaprSubscriptionId) (result DeleteOperationResponse, err error)

Delete ...

func (DaprSubscriptionsClient) Get 

func (c DaprSubscriptionsClient) Get(ctx context.Context, id DaprSubscriptionId) (result GetOperationResponse, err error)

Get ...

func (DaprSubscriptionsClient) List 

func (c DaprSubscriptionsClient) List(ctx context.Context, id ManagedEnvironmentId) (result ListOperationResponse, err error)

List ...

func (DaprSubscriptionsClient) ListComplete 

func (c DaprSubscriptionsClient) ListComplete(ctx context.Context, id ManagedEnvironmentId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DaprSubscriptionsClient) ListCompleteMatchingPredicate 

func (c DaprSubscriptionsClient) ListCompleteMatchingPredicate(ctx context.Context, id ManagedEnvironmentId, predicate DaprSubscriptionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DaprSubscription
}

type ManagedEnvironmentId 

type ManagedEnvironmentId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ManagedEnvironmentName string
}

ManagedEnvironmentId is a struct representing the Resource ID for a Managed Environment

func NewManagedEnvironmentID 

func NewManagedEnvironmentID(subscriptionId string, resourceGroupName string, managedEnvironmentName string) ManagedEnvironmentId

NewManagedEnvironmentID returns a new ManagedEnvironmentId struct

func ParseManagedEnvironmentID 

func ParseManagedEnvironmentID(input string) (*ManagedEnvironmentId, error)

ParseManagedEnvironmentID parses 'input' into a ManagedEnvironmentId

func ParseManagedEnvironmentIDInsensitively 

func ParseManagedEnvironmentIDInsensitively(input string) (*ManagedEnvironmentId, error)

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

func (*ManagedEnvironmentId) FromParseResult 

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

func (ManagedEnvironmentId) ID 

func (id ManagedEnvironmentId) ID() string

ID returns the formatted Managed Environment ID

func (ManagedEnvironmentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Managed Environment ID

func (ManagedEnvironmentId) String 

func (id ManagedEnvironmentId) String() string

String returns a human-readable description of this Managed Environment ID

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.