applicationgroup

package
v0.20240119.1094410 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2024-01-01/applicationgroup Documentation

The applicationgroup SDK allows for interaction with the Azure Resource Manager Service eventhub (API Version 2024-01-01).

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/eventhub/2024-01-01/applicationgroup"

Client Initialization

client := applicationgroup.NewApplicationGroupClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApplicationGroupClient.CreateOrUpdateApplicationGroup

ctx := context.TODO()
id := applicationgroup.NewApplicationGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "applicationGroupValue")

payload := applicationgroup.ApplicationGroup{
	// ...
}


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

Example Usage: ApplicationGroupClient.Delete

ctx := context.TODO()
id := applicationgroup.NewApplicationGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "applicationGroupValue")

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: ApplicationGroupClient.Get

ctx := context.TODO()
id := applicationgroup.NewApplicationGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "applicationGroupValue")

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: ApplicationGroupClient.ListByNamespace

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

// alternatively `client.ListByNamespace(ctx, id)` can be used to do batched pagination
items, err := client.ListByNamespaceComplete(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 PossibleValuesForApplicationGroupPolicyType 

func PossibleValuesForApplicationGroupPolicyType() []string

func PossibleValuesForMetricId 

func PossibleValuesForMetricId() []string

func ValidateApplicationGroupID 

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

ValidateApplicationGroupID checks that 'input' can be parsed as a Application Group ID

func ValidateNamespaceID 

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

Types

type ApplicationGroup 

type ApplicationGroup struct {
	Id         *string                     `json:"id,omitempty"`
	Location   *string                     `json:"location,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *ApplicationGroupProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type ApplicationGroupClient 

type ApplicationGroupClient struct {
	Client *resourcemanager.Client
}

func NewApplicationGroupClientWithBaseURI 

func NewApplicationGroupClientWithBaseURI(sdkApi sdkEnv.Api) (*ApplicationGroupClient, error)

func (ApplicationGroupClient) CreateOrUpdateApplicationGroup 

func (c ApplicationGroupClient) CreateOrUpdateApplicationGroup(ctx context.Context, id ApplicationGroupId, input ApplicationGroup) (result CreateOrUpdateApplicationGroupOperationResponse, err error)

CreateOrUpdateApplicationGroup ...

func (ApplicationGroupClient) Delete 

func (c ApplicationGroupClient) Delete(ctx context.Context, id ApplicationGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (ApplicationGroupClient) Get 

func (c ApplicationGroupClient) Get(ctx context.Context, id ApplicationGroupId) (result GetOperationResponse, err error)

Get ...

func (ApplicationGroupClient) ListByNamespace 

func (c ApplicationGroupClient) ListByNamespace(ctx context.Context, id NamespaceId) (result ListByNamespaceOperationResponse, err error)

ListByNamespace ...

func (ApplicationGroupClient) ListByNamespaceComplete 

func (c ApplicationGroupClient) ListByNamespaceComplete(ctx context.Context, id NamespaceId) (ListByNamespaceCompleteResult, error)

ListByNamespaceComplete retrieves all the results into a single object

func (ApplicationGroupClient) ListByNamespaceCompleteMatchingPredicate 

func (c ApplicationGroupClient) ListByNamespaceCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate ApplicationGroupOperationPredicate) (result ListByNamespaceCompleteResult, err error)

ListByNamespaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ApplicationGroupId 

type ApplicationGroupId struct {
	SubscriptionId       string
	ResourceGroupName    string
	NamespaceName        string
	ApplicationGroupName string
}

ApplicationGroupId is a struct representing the Resource ID for a Application Group

func NewApplicationGroupID 

func NewApplicationGroupID(subscriptionId string, resourceGroupName string, namespaceName string, applicationGroupName string) ApplicationGroupId

NewApplicationGroupID returns a new ApplicationGroupId struct

func ParseApplicationGroupID 

func ParseApplicationGroupID(input string) (*ApplicationGroupId, error)

ParseApplicationGroupID parses 'input' into a ApplicationGroupId

func ParseApplicationGroupIDInsensitively 

func ParseApplicationGroupIDInsensitively(input string) (*ApplicationGroupId, error)

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

func (*ApplicationGroupId) FromParseResult added in v0.20231127.1171502 

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

func (ApplicationGroupId) ID 

func (id ApplicationGroupId) ID() string

ID returns the formatted Application Group ID

func (ApplicationGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Application Group ID

func (ApplicationGroupId) String 

func (id ApplicationGroupId) String() string

String returns a human-readable description of this Application Group ID

type ApplicationGroupOperationPredicate 

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

func (ApplicationGroupOperationPredicate) Matches 

func (p ApplicationGroupOperationPredicate) Matches(input ApplicationGroup) bool

type ApplicationGroupPolicy 

type ApplicationGroupPolicy interface {
}

type ApplicationGroupPolicyType 

type ApplicationGroupPolicyType string
const (
	ApplicationGroupPolicyTypeThrottlingPolicy ApplicationGroupPolicyType = "ThrottlingPolicy"
)

func (*ApplicationGroupPolicyType) UnmarshalJSON 

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

type ApplicationGroupProperties 

type ApplicationGroupProperties struct {
	ClientAppGroupIdentifier string                    `json:"clientAppGroupIdentifier"`
	IsEnabled                *bool                     `json:"isEnabled,omitempty"`
	Policies                 *[]ApplicationGroupPolicy `json:"policies,omitempty"`
}

func (*ApplicationGroupProperties) UnmarshalJSON 

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

type CreateOrUpdateApplicationGroupOperationResponse 

type CreateOrUpdateApplicationGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationGroup
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByNamespaceCompleteResult 

type ListByNamespaceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApplicationGroup
}

type ListByNamespaceOperationResponse 

type ListByNamespaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApplicationGroup
}

type MetricId 

type MetricId string
const (
	MetricIdIncomingBytes    MetricId = "IncomingBytes"
	MetricIdIncomingMessages MetricId = "IncomingMessages"
	MetricIdOutgoingBytes    MetricId = "OutgoingBytes"
	MetricIdOutgoingMessages MetricId = "OutgoingMessages"
)

func (*MetricId) UnmarshalJSON 

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

type NamespaceId 

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID 

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID 

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively 

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (*NamespaceId) FromParseResult added in v0.20231127.1171502 

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

func (NamespaceId) ID 

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments 

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

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

func (NamespaceId) String 

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type RawApplicationGroupPolicyImpl 

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

RawApplicationGroupPolicyImpl 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 ThrottlingPolicy 

type ThrottlingPolicy struct {
	MetricId           MetricId `json:"metricId"`
	RateLimitThreshold int64    `json:"rateLimitThreshold"`

	// Fields inherited from ApplicationGroupPolicy
	Name string `json:"name"`
}

func (ThrottlingPolicy) MarshalJSON 

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

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.