queuesauthorizationrule

package
v0.20240625.1123713 Latest Latest
Warning

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

Go to latest
Published: Jun 25, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicebus/2022-01-01-preview/queuesauthorizationrule Documentation

The queuesauthorizationrule SDK allows for interaction with the Azure Resource Manager Service servicebus (API Version 2022-01-01-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/servicebus/2022-01-01-preview/queuesauthorizationrule"

Client Initialization

client := queuesauthorizationrule.NewQueuesAuthorizationRuleClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: QueuesAuthorizationRuleClient.QueuesCreateOrUpdateAuthorizationRule

ctx := context.TODO()
id := queuesauthorizationrule.NewQueueAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "queueValue", "authorizationRuleValue")

payload := queuesauthorizationrule.SBAuthorizationRule{
	// ...
}


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

Example Usage: QueuesAuthorizationRuleClient.QueuesDeleteAuthorizationRule

ctx := context.TODO()
id := queuesauthorizationrule.NewQueueAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "queueValue", "authorizationRuleValue")

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

Example Usage: QueuesAuthorizationRuleClient.QueuesGetAuthorizationRule

ctx := context.TODO()
id := queuesauthorizationrule.NewQueueAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "queueValue", "authorizationRuleValue")

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

Example Usage: QueuesAuthorizationRuleClient.QueuesListAuthorizationRules

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

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

Example Usage: QueuesAuthorizationRuleClient.QueuesListKeys

ctx := context.TODO()
id := queuesauthorizationrule.NewQueueAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "queueValue", "authorizationRuleValue")

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

Example Usage: QueuesAuthorizationRuleClient.QueuesRegenerateKeys

ctx := context.TODO()
id := queuesauthorizationrule.NewQueueAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "queueValue", "authorizationRuleValue")

payload := queuesauthorizationrule.RegenerateAccessKeyParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccessRights

func PossibleValuesForAccessRights() []string

func PossibleValuesForKeyType

func PossibleValuesForKeyType() []string

func ValidateQueueAuthorizationRuleID

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

ValidateQueueAuthorizationRuleID checks that 'input' can be parsed as a Queue Authorization Rule ID

func ValidateQueueID

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

ValidateQueueID checks that 'input' can be parsed as a Queue ID

Types

type AccessKeys

type AccessKeys struct {
	AliasPrimaryConnectionString   *string `json:"aliasPrimaryConnectionString,omitempty"`
	AliasSecondaryConnectionString *string `json:"aliasSecondaryConnectionString,omitempty"`
	KeyName                        *string `json:"keyName,omitempty"`
	PrimaryConnectionString        *string `json:"primaryConnectionString,omitempty"`
	PrimaryKey                     *string `json:"primaryKey,omitempty"`
	SecondaryConnectionString      *string `json:"secondaryConnectionString,omitempty"`
	SecondaryKey                   *string `json:"secondaryKey,omitempty"`
}

type AccessRights

type AccessRights string
const (
	AccessRightsListen AccessRights = "Listen"
	AccessRightsManage AccessRights = "Manage"
	AccessRightsSend   AccessRights = "Send"
)

func (*AccessRights) UnmarshalJSON

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

type KeyType

type KeyType string
const (
	KeyTypePrimaryKey   KeyType = "PrimaryKey"
	KeyTypeSecondaryKey KeyType = "SecondaryKey"
)

func (*KeyType) UnmarshalJSON

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

type QueueAuthorizationRuleId

type QueueAuthorizationRuleId struct {
	SubscriptionId        string
	ResourceGroupName     string
	NamespaceName         string
	QueueName             string
	AuthorizationRuleName string
}

QueueAuthorizationRuleId is a struct representing the Resource ID for a Queue Authorization Rule

func NewQueueAuthorizationRuleID

func NewQueueAuthorizationRuleID(subscriptionId string, resourceGroupName string, namespaceName string, queueName string, authorizationRuleName string) QueueAuthorizationRuleId

NewQueueAuthorizationRuleID returns a new QueueAuthorizationRuleId struct

func ParseQueueAuthorizationRuleID

func ParseQueueAuthorizationRuleID(input string) (*QueueAuthorizationRuleId, error)

ParseQueueAuthorizationRuleID parses 'input' into a QueueAuthorizationRuleId

func ParseQueueAuthorizationRuleIDInsensitively

func ParseQueueAuthorizationRuleIDInsensitively(input string) (*QueueAuthorizationRuleId, error)

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

func (*QueueAuthorizationRuleId) FromParseResult

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

func (QueueAuthorizationRuleId) ID

ID returns the formatted Queue Authorization Rule ID

func (QueueAuthorizationRuleId) Segments

Segments returns a slice of Resource ID Segments which comprise this Queue Authorization Rule ID

func (QueueAuthorizationRuleId) String

func (id QueueAuthorizationRuleId) String() string

String returns a human-readable description of this Queue Authorization Rule ID

type QueueId

type QueueId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
	QueueName         string
}

QueueId is a struct representing the Resource ID for a Queue

func NewQueueID

func NewQueueID(subscriptionId string, resourceGroupName string, namespaceName string, queueName string) QueueId

NewQueueID returns a new QueueId struct

func ParseQueueID

func ParseQueueID(input string) (*QueueId, error)

ParseQueueID parses 'input' into a QueueId

func ParseQueueIDInsensitively

func ParseQueueIDInsensitively(input string) (*QueueId, error)

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

func (*QueueId) FromParseResult

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

func (QueueId) ID

func (id QueueId) ID() string

ID returns the formatted Queue ID

func (QueueId) Segments

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

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

func (QueueId) String

func (id QueueId) String() string

String returns a human-readable description of this Queue ID

type QueuesAuthorizationRuleClient

type QueuesAuthorizationRuleClient struct {
	Client *resourcemanager.Client
}

func NewQueuesAuthorizationRuleClientWithBaseURI

func NewQueuesAuthorizationRuleClientWithBaseURI(sdkApi sdkEnv.Api) (*QueuesAuthorizationRuleClient, error)

func (QueuesAuthorizationRuleClient) QueuesCreateOrUpdateAuthorizationRule

QueuesCreateOrUpdateAuthorizationRule ...

func (QueuesAuthorizationRuleClient) QueuesDeleteAuthorizationRule

QueuesDeleteAuthorizationRule ...

func (QueuesAuthorizationRuleClient) QueuesGetAuthorizationRule

QueuesGetAuthorizationRule ...

func (QueuesAuthorizationRuleClient) QueuesListAuthorizationRules

func (c QueuesAuthorizationRuleClient) QueuesListAuthorizationRules(ctx context.Context, id QueueId) (result QueuesListAuthorizationRulesOperationResponse, err error)

QueuesListAuthorizationRules ...

func (QueuesAuthorizationRuleClient) QueuesListAuthorizationRulesComplete

func (c QueuesAuthorizationRuleClient) QueuesListAuthorizationRulesComplete(ctx context.Context, id QueueId) (QueuesListAuthorizationRulesCompleteResult, error)

QueuesListAuthorizationRulesComplete retrieves all the results into a single object

func (QueuesAuthorizationRuleClient) QueuesListAuthorizationRulesCompleteMatchingPredicate

func (c QueuesAuthorizationRuleClient) QueuesListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id QueueId, predicate SBAuthorizationRuleOperationPredicate) (result QueuesListAuthorizationRulesCompleteResult, err error)

QueuesListAuthorizationRulesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (QueuesAuthorizationRuleClient) QueuesListKeys

QueuesListKeys ...

func (QueuesAuthorizationRuleClient) QueuesRegenerateKeys

QueuesRegenerateKeys ...

type QueuesCreateOrUpdateAuthorizationRuleOperationResponse

type QueuesCreateOrUpdateAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SBAuthorizationRule
}

type QueuesDeleteAuthorizationRuleOperationResponse

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

type QueuesGetAuthorizationRuleOperationResponse

type QueuesGetAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SBAuthorizationRule
}

type QueuesListAuthorizationRulesCompleteResult

type QueuesListAuthorizationRulesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SBAuthorizationRule
}

type QueuesListAuthorizationRulesOperationResponse

type QueuesListAuthorizationRulesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SBAuthorizationRule
}

type QueuesListKeysOperationResponse

type QueuesListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccessKeys
}

type QueuesRegenerateKeysOperationResponse

type QueuesRegenerateKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccessKeys
}

type RegenerateAccessKeyParameters

type RegenerateAccessKeyParameters struct {
	Key     *string `json:"key,omitempty"`
	KeyType KeyType `json:"keyType"`
}

type SBAuthorizationRule

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

type SBAuthorizationRuleOperationPredicate

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

func (SBAuthorizationRuleOperationPredicate) Matches

type SBAuthorizationRuleProperties

type SBAuthorizationRuleProperties struct {
	Rights []AccessRights `json:"rights"`
}

Jump to

Keyboard shortcuts

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