README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/servicebus/2021-06-01-preview/queuesauthorizationrule
Documentation
The queuesauthorizationrule
SDK allows for interaction with the Azure Resource Manager Service servicebus
(API Version 2021-06-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/2021-06-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 ¶
- func PossibleValuesForAccessRights() []string
- func PossibleValuesForKeyType() []string
- func ValidateQueueAuthorizationRuleID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateQueueID(input interface{}, key string) (warnings []string, errors []error)
- type AccessKeys
- type AccessRights
- type KeyType
- type QueueAuthorizationRuleId
- func NewQueueAuthorizationRuleID(subscriptionId string, resourceGroupName string, namespaceName string, ...) QueueAuthorizationRuleId
- func ParseQueueAuthorizationRuleID(input string) (*QueueAuthorizationRuleId, error)
- func ParseQueueAuthorizationRuleIDInsensitively(input string) (*QueueAuthorizationRuleId, error)
- type QueueId
- type QueuesAuthorizationRuleClient
- func (c QueuesAuthorizationRuleClient) QueuesCreateOrUpdateAuthorizationRule(ctx context.Context, id QueueAuthorizationRuleId, input SBAuthorizationRule) (result QueuesCreateOrUpdateAuthorizationRuleOperationResponse, err error)
- func (c QueuesAuthorizationRuleClient) QueuesDeleteAuthorizationRule(ctx context.Context, id QueueAuthorizationRuleId) (result QueuesDeleteAuthorizationRuleOperationResponse, err error)
- func (c QueuesAuthorizationRuleClient) QueuesGetAuthorizationRule(ctx context.Context, id QueueAuthorizationRuleId) (result QueuesGetAuthorizationRuleOperationResponse, err error)
- func (c QueuesAuthorizationRuleClient) QueuesListAuthorizationRules(ctx context.Context, id QueueId) (resp QueuesListAuthorizationRulesOperationResponse, err error)
- func (c QueuesAuthorizationRuleClient) QueuesListAuthorizationRulesComplete(ctx context.Context, id QueueId) (QueuesListAuthorizationRulesCompleteResult, error)
- func (c QueuesAuthorizationRuleClient) QueuesListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id QueueId, ...) (resp QueuesListAuthorizationRulesCompleteResult, err error)
- func (c QueuesAuthorizationRuleClient) QueuesListKeys(ctx context.Context, id QueueAuthorizationRuleId) (result QueuesListKeysOperationResponse, err error)
- func (c QueuesAuthorizationRuleClient) QueuesRegenerateKeys(ctx context.Context, id QueueAuthorizationRuleId, ...) (result QueuesRegenerateKeysOperationResponse, err error)
- type QueuesCreateOrUpdateAuthorizationRuleOperationResponse
- type QueuesDeleteAuthorizationRuleOperationResponse
- type QueuesGetAuthorizationRuleOperationResponse
- type QueuesListAuthorizationRulesCompleteResult
- type QueuesListAuthorizationRulesOperationResponse
- type QueuesListKeysOperationResponse
- type QueuesRegenerateKeysOperationResponse
- type RegenerateAccessKeyParameters
- type SBAuthorizationRule
- type SBAuthorizationRuleOperationPredicate
- type SBAuthorizationRuleProperties
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 ¶
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" )
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) ID ¶
func (id QueueAuthorizationRuleId) ID() string
ID returns the formatted Queue Authorization Rule ID
func (QueueAuthorizationRuleId) Segments ¶
func (id QueueAuthorizationRuleId) Segments() []resourceids.Segment
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 ¶
ParseQueueID parses 'input' into a QueueId
func ParseQueueIDInsensitively ¶
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) Segments ¶
func (id QueueId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Queue ID
type QueuesAuthorizationRuleClient ¶
type QueuesAuthorizationRuleClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewQueuesAuthorizationRuleClientWithBaseURI ¶
func NewQueuesAuthorizationRuleClientWithBaseURI(endpoint string) QueuesAuthorizationRuleClient
func (QueuesAuthorizationRuleClient) QueuesCreateOrUpdateAuthorizationRule ¶
func (c QueuesAuthorizationRuleClient) QueuesCreateOrUpdateAuthorizationRule(ctx context.Context, id QueueAuthorizationRuleId, input SBAuthorizationRule) (result QueuesCreateOrUpdateAuthorizationRuleOperationResponse, err error)
QueuesCreateOrUpdateAuthorizationRule ...
func (QueuesAuthorizationRuleClient) QueuesDeleteAuthorizationRule ¶
func (c QueuesAuthorizationRuleClient) QueuesDeleteAuthorizationRule(ctx context.Context, id QueueAuthorizationRuleId) (result QueuesDeleteAuthorizationRuleOperationResponse, err error)
QueuesDeleteAuthorizationRule ...
func (QueuesAuthorizationRuleClient) QueuesGetAuthorizationRule ¶
func (c QueuesAuthorizationRuleClient) QueuesGetAuthorizationRule(ctx context.Context, id QueueAuthorizationRuleId) (result QueuesGetAuthorizationRuleOperationResponse, err error)
QueuesGetAuthorizationRule ...
func (QueuesAuthorizationRuleClient) QueuesListAuthorizationRules ¶
func (c QueuesAuthorizationRuleClient) QueuesListAuthorizationRules(ctx context.Context, id QueueId) (resp QueuesListAuthorizationRulesOperationResponse, err error)
QueuesListAuthorizationRules ...
func (QueuesAuthorizationRuleClient) QueuesListAuthorizationRulesComplete ¶
func (c QueuesAuthorizationRuleClient) QueuesListAuthorizationRulesComplete(ctx context.Context, id QueueId) (QueuesListAuthorizationRulesCompleteResult, error)
QueuesListAuthorizationRulesComplete retrieves all of the results into a single object
func (QueuesAuthorizationRuleClient) QueuesListAuthorizationRulesCompleteMatchingPredicate ¶
func (c QueuesAuthorizationRuleClient) QueuesListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id QueueId, predicate SBAuthorizationRuleOperationPredicate) (resp QueuesListAuthorizationRulesCompleteResult, err error)
QueuesListAuthorizationRulesCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (QueuesAuthorizationRuleClient) QueuesListKeys ¶
func (c QueuesAuthorizationRuleClient) QueuesListKeys(ctx context.Context, id QueueAuthorizationRuleId) (result QueuesListKeysOperationResponse, err error)
QueuesListKeys ...
func (QueuesAuthorizationRuleClient) QueuesRegenerateKeys ¶
func (c QueuesAuthorizationRuleClient) QueuesRegenerateKeys(ctx context.Context, id QueueAuthorizationRuleId, input RegenerateAccessKeyParameters) (result QueuesRegenerateKeysOperationResponse, err error)
QueuesRegenerateKeys ...
type QueuesCreateOrUpdateAuthorizationRuleOperationResponse ¶
type QueuesCreateOrUpdateAuthorizationRuleOperationResponse struct { HttpResponse *http.Response Model *SBAuthorizationRule }
type QueuesGetAuthorizationRuleOperationResponse ¶
type QueuesGetAuthorizationRuleOperationResponse struct { HttpResponse *http.Response Model *SBAuthorizationRule }
type QueuesListAuthorizationRulesCompleteResult ¶
type QueuesListAuthorizationRulesCompleteResult struct {
Items []SBAuthorizationRule
}
type QueuesListAuthorizationRulesOperationResponse ¶
type QueuesListAuthorizationRulesOperationResponse struct { HttpResponse *http.Response Model *[]SBAuthorizationRule // contains filtered or unexported fields }
func (QueuesListAuthorizationRulesOperationResponse) HasMore ¶
func (r QueuesListAuthorizationRulesOperationResponse) HasMore() bool
func (QueuesListAuthorizationRulesOperationResponse) LoadMore ¶
func (r QueuesListAuthorizationRulesOperationResponse) LoadMore(ctx context.Context) (resp QueuesListAuthorizationRulesOperationResponse, err error)
type QueuesListKeysOperationResponse ¶
type QueuesListKeysOperationResponse struct { HttpResponse *http.Response Model *AccessKeys }
type QueuesRegenerateKeysOperationResponse ¶
type QueuesRegenerateKeysOperationResponse struct { HttpResponse *http.Response Model *AccessKeys }
type SBAuthorizationRule ¶
type SBAuthorizationRule struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *SBAuthorizationRuleProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type SBAuthorizationRuleOperationPredicate ¶
func (SBAuthorizationRuleOperationPredicate) Matches ¶
func (p SBAuthorizationRuleOperationPredicate) Matches(input SBAuthorizationRule) bool
type SBAuthorizationRuleProperties ¶
type SBAuthorizationRuleProperties struct {
Rights []AccessRights `json:"rights"`
}
Source Files ¶
- client.go
- constants.go
- id_queue.go
- id_queueauthorizationrule.go
- method_queuescreateorupdateauthorizationrule_autorest.go
- method_queuesdeleteauthorizationrule_autorest.go
- method_queuesgetauthorizationrule_autorest.go
- method_queueslistauthorizationrules_autorest.go
- method_queueslistkeys_autorest.go
- method_queuesregeneratekeys_autorest.go
- model_accesskeys.go
- model_regenerateaccesskeyparameters.go
- model_sbauthorizationrule.go
- model_sbauthorizationruleproperties.go
- predicates.go
- version.go