README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/servicebus/2021-06-01-preview/topicsauthorizationrule
Documentation
The topicsauthorizationrule
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/topicsauthorizationrule"
Client Initialization
client := topicsauthorizationrule.NewTopicsAuthorizationRuleClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: TopicsAuthorizationRuleClient.TopicsCreateOrUpdateAuthorizationRule
ctx := context.TODO()
id := topicsauthorizationrule.NewTopicAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "topicValue", "authorizationRuleValue")
payload := topicsauthorizationrule.SBAuthorizationRule{
// ...
}
read, err := client.TopicsCreateOrUpdateAuthorizationRule(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TopicsAuthorizationRuleClient.TopicsDeleteAuthorizationRule
ctx := context.TODO()
id := topicsauthorizationrule.NewTopicAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "topicValue", "authorizationRuleValue")
read, err := client.TopicsDeleteAuthorizationRule(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TopicsAuthorizationRuleClient.TopicsGetAuthorizationRule
ctx := context.TODO()
id := topicsauthorizationrule.NewTopicAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "topicValue", "authorizationRuleValue")
read, err := client.TopicsGetAuthorizationRule(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TopicsAuthorizationRuleClient.TopicsListAuthorizationRules
ctx := context.TODO()
id := topicsauthorizationrule.NewTopicID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "topicValue")
// alternatively `client.TopicsListAuthorizationRules(ctx, id)` can be used to do batched pagination
items, err := client.TopicsListAuthorizationRulesComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: TopicsAuthorizationRuleClient.TopicsListKeys
ctx := context.TODO()
id := topicsauthorizationrule.NewTopicAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "topicValue", "authorizationRuleValue")
read, err := client.TopicsListKeys(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: TopicsAuthorizationRuleClient.TopicsRegenerateKeys
ctx := context.TODO()
id := topicsauthorizationrule.NewTopicAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "topicValue", "authorizationRuleValue")
payload := topicsauthorizationrule.RegenerateAccessKeyParameters{
// ...
}
read, err := client.TopicsRegenerateKeys(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 ValidateTopicAuthorizationRuleID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateTopicID(input interface{}, key string) (warnings []string, errors []error)
- type AccessKeys
- type AccessRights
- type KeyType
- type RegenerateAccessKeyParameters
- type SBAuthorizationRule
- type SBAuthorizationRuleOperationPredicate
- type SBAuthorizationRuleProperties
- type TopicAuthorizationRuleId
- func NewTopicAuthorizationRuleID(subscriptionId string, resourceGroupName string, namespaceName string, ...) TopicAuthorizationRuleId
- func ParseTopicAuthorizationRuleID(input string) (*TopicAuthorizationRuleId, error)
- func ParseTopicAuthorizationRuleIDInsensitively(input string) (*TopicAuthorizationRuleId, error)
- type TopicId
- type TopicsAuthorizationRuleClient
- func (c TopicsAuthorizationRuleClient) TopicsCreateOrUpdateAuthorizationRule(ctx context.Context, id TopicAuthorizationRuleId, input SBAuthorizationRule) (result TopicsCreateOrUpdateAuthorizationRuleOperationResponse, err error)
- func (c TopicsAuthorizationRuleClient) TopicsDeleteAuthorizationRule(ctx context.Context, id TopicAuthorizationRuleId) (result TopicsDeleteAuthorizationRuleOperationResponse, err error)
- func (c TopicsAuthorizationRuleClient) TopicsGetAuthorizationRule(ctx context.Context, id TopicAuthorizationRuleId) (result TopicsGetAuthorizationRuleOperationResponse, err error)
- func (c TopicsAuthorizationRuleClient) TopicsListAuthorizationRules(ctx context.Context, id TopicId) (result TopicsListAuthorizationRulesOperationResponse, err error)
- func (c TopicsAuthorizationRuleClient) TopicsListAuthorizationRulesComplete(ctx context.Context, id TopicId) (TopicsListAuthorizationRulesCompleteResult, error)
- func (c TopicsAuthorizationRuleClient) TopicsListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id TopicId, ...) (result TopicsListAuthorizationRulesCompleteResult, err error)
- func (c TopicsAuthorizationRuleClient) TopicsListKeys(ctx context.Context, id TopicAuthorizationRuleId) (result TopicsListKeysOperationResponse, err error)
- func (c TopicsAuthorizationRuleClient) TopicsRegenerateKeys(ctx context.Context, id TopicAuthorizationRuleId, ...) (result TopicsRegenerateKeysOperationResponse, err error)
- type TopicsCreateOrUpdateAuthorizationRuleOperationResponse
- type TopicsDeleteAuthorizationRuleOperationResponse
- type TopicsGetAuthorizationRuleOperationResponse
- type TopicsListAuthorizationRulesCompleteResult
- type TopicsListAuthorizationRulesOperationResponse
- type TopicsListKeysOperationResponse
- type TopicsRegenerateKeysOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForAccessRights ¶
func PossibleValuesForAccessRights() []string
func PossibleValuesForKeyType ¶
func PossibleValuesForKeyType() []string
func ValidateTopicAuthorizationRuleID ¶
func ValidateTopicAuthorizationRuleID(input interface{}, key string) (warnings []string, errors []error)
ValidateTopicAuthorizationRuleID checks that 'input' can be parsed as a Topic Authorization Rule ID
func ValidateTopicID ¶
ValidateTopicID checks that 'input' can be parsed as a Topic 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 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"`
}
type TopicAuthorizationRuleId ¶
type TopicAuthorizationRuleId struct { SubscriptionId string ResourceGroupName string NamespaceName string TopicName string AuthorizationRuleName string }
TopicAuthorizationRuleId is a struct representing the Resource ID for a Topic Authorization Rule
func NewTopicAuthorizationRuleID ¶
func NewTopicAuthorizationRuleID(subscriptionId string, resourceGroupName string, namespaceName string, topicName string, authorizationRuleName string) TopicAuthorizationRuleId
NewTopicAuthorizationRuleID returns a new TopicAuthorizationRuleId struct
func ParseTopicAuthorizationRuleID ¶
func ParseTopicAuthorizationRuleID(input string) (*TopicAuthorizationRuleId, error)
ParseTopicAuthorizationRuleID parses 'input' into a TopicAuthorizationRuleId
func ParseTopicAuthorizationRuleIDInsensitively ¶
func ParseTopicAuthorizationRuleIDInsensitively(input string) (*TopicAuthorizationRuleId, error)
ParseTopicAuthorizationRuleIDInsensitively parses 'input' case-insensitively into a TopicAuthorizationRuleId note: this method should only be used for API response data and not user input
func (*TopicAuthorizationRuleId) FromParseResult ¶
func (id *TopicAuthorizationRuleId) FromParseResult(input resourceids.ParseResult) error
func (TopicAuthorizationRuleId) ID ¶
func (id TopicAuthorizationRuleId) ID() string
ID returns the formatted Topic Authorization Rule ID
func (TopicAuthorizationRuleId) Segments ¶
func (id TopicAuthorizationRuleId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Topic Authorization Rule ID
func (TopicAuthorizationRuleId) String ¶
func (id TopicAuthorizationRuleId) String() string
String returns a human-readable description of this Topic Authorization Rule ID
type TopicId ¶
type TopicId struct { SubscriptionId string ResourceGroupName string NamespaceName string TopicName string }
TopicId is a struct representing the Resource ID for a Topic
func NewTopicID ¶
func NewTopicID(subscriptionId string, resourceGroupName string, namespaceName string, topicName string) TopicId
NewTopicID returns a new TopicId struct
func ParseTopicID ¶
ParseTopicID parses 'input' into a TopicId
func ParseTopicIDInsensitively ¶
ParseTopicIDInsensitively parses 'input' case-insensitively into a TopicId note: this method should only be used for API response data and not user input
func (*TopicId) FromParseResult ¶
func (id *TopicId) FromParseResult(input resourceids.ParseResult) error
func (TopicId) Segments ¶
func (id TopicId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Topic ID
type TopicsAuthorizationRuleClient ¶
type TopicsAuthorizationRuleClient struct {
Client *resourcemanager.Client
}
func NewTopicsAuthorizationRuleClientWithBaseURI ¶
func NewTopicsAuthorizationRuleClientWithBaseURI(sdkApi sdkEnv.Api) (*TopicsAuthorizationRuleClient, error)
func (TopicsAuthorizationRuleClient) TopicsCreateOrUpdateAuthorizationRule ¶
func (c TopicsAuthorizationRuleClient) TopicsCreateOrUpdateAuthorizationRule(ctx context.Context, id TopicAuthorizationRuleId, input SBAuthorizationRule) (result TopicsCreateOrUpdateAuthorizationRuleOperationResponse, err error)
TopicsCreateOrUpdateAuthorizationRule ...
func (TopicsAuthorizationRuleClient) TopicsDeleteAuthorizationRule ¶
func (c TopicsAuthorizationRuleClient) TopicsDeleteAuthorizationRule(ctx context.Context, id TopicAuthorizationRuleId) (result TopicsDeleteAuthorizationRuleOperationResponse, err error)
TopicsDeleteAuthorizationRule ...
func (TopicsAuthorizationRuleClient) TopicsGetAuthorizationRule ¶
func (c TopicsAuthorizationRuleClient) TopicsGetAuthorizationRule(ctx context.Context, id TopicAuthorizationRuleId) (result TopicsGetAuthorizationRuleOperationResponse, err error)
TopicsGetAuthorizationRule ...
func (TopicsAuthorizationRuleClient) TopicsListAuthorizationRules ¶
func (c TopicsAuthorizationRuleClient) TopicsListAuthorizationRules(ctx context.Context, id TopicId) (result TopicsListAuthorizationRulesOperationResponse, err error)
TopicsListAuthorizationRules ...
func (TopicsAuthorizationRuleClient) TopicsListAuthorizationRulesComplete ¶
func (c TopicsAuthorizationRuleClient) TopicsListAuthorizationRulesComplete(ctx context.Context, id TopicId) (TopicsListAuthorizationRulesCompleteResult, error)
TopicsListAuthorizationRulesComplete retrieves all the results into a single object
func (TopicsAuthorizationRuleClient) TopicsListAuthorizationRulesCompleteMatchingPredicate ¶
func (c TopicsAuthorizationRuleClient) TopicsListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id TopicId, predicate SBAuthorizationRuleOperationPredicate) (result TopicsListAuthorizationRulesCompleteResult, err error)
TopicsListAuthorizationRulesCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (TopicsAuthorizationRuleClient) TopicsListKeys ¶
func (c TopicsAuthorizationRuleClient) TopicsListKeys(ctx context.Context, id TopicAuthorizationRuleId) (result TopicsListKeysOperationResponse, err error)
TopicsListKeys ...
func (TopicsAuthorizationRuleClient) TopicsRegenerateKeys ¶
func (c TopicsAuthorizationRuleClient) TopicsRegenerateKeys(ctx context.Context, id TopicAuthorizationRuleId, input RegenerateAccessKeyParameters) (result TopicsRegenerateKeysOperationResponse, err error)
TopicsRegenerateKeys ...
type TopicsCreateOrUpdateAuthorizationRuleOperationResponse ¶
type TopicsCreateOrUpdateAuthorizationRuleOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *SBAuthorizationRule }
type TopicsGetAuthorizationRuleOperationResponse ¶
type TopicsGetAuthorizationRuleOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *SBAuthorizationRule }
type TopicsListAuthorizationRulesCompleteResult ¶
type TopicsListAuthorizationRulesCompleteResult struct { LatestHttpResponse *http.Response Items []SBAuthorizationRule }
type TopicsListAuthorizationRulesOperationResponse ¶
type TopicsListAuthorizationRulesOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]SBAuthorizationRule }
type TopicsListKeysOperationResponse ¶
type TopicsListKeysOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *AccessKeys }
type TopicsRegenerateKeysOperationResponse ¶
type TopicsRegenerateKeysOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *AccessKeys }
Source Files ¶
- client.go
- constants.go
- id_topic.go
- id_topicauthorizationrule.go
- method_topicscreateorupdateauthorizationrule.go
- method_topicsdeleteauthorizationrule.go
- method_topicsgetauthorizationrule.go
- method_topicslistauthorizationrules.go
- method_topicslistkeys.go
- method_topicsregeneratekeys.go
- model_accesskeys.go
- model_regenerateaccesskeyparameters.go
- model_sbauthorizationrule.go
- model_sbauthorizationruleproperties.go
- predicates.go
- version.go