README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2022-01-01-preview/authorizationruleseventhubs
Documentation
The authorizationruleseventhubs
SDK allows for interaction with the Azure Resource Manager Service eventhub
(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/eventhub/2022-01-01-preview/authorizationruleseventhubs"
Client Initialization
client := authorizationruleseventhubs.NewAuthorizationRulesEventHubsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: AuthorizationRulesEventHubsClient.EventHubsCreateOrUpdateAuthorizationRule
ctx := context.TODO()
id := authorizationruleseventhubs.NewEventhubAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "eventhubValue", "authorizationRuleValue")
payload := authorizationruleseventhubs.AuthorizationRule{
// ...
}
read, err := client.EventHubsCreateOrUpdateAuthorizationRule(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: AuthorizationRulesEventHubsClient.EventHubsListAuthorizationRules
ctx := context.TODO()
id := authorizationruleseventhubs.NewEventhubID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "eventhubValue")
// alternatively `client.EventHubsListAuthorizationRules(ctx, id)` can be used to do batched pagination
items, err := client.EventHubsListAuthorizationRulesComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: AuthorizationRulesEventHubsClient.EventHubsListKeys
ctx := context.TODO()
id := authorizationruleseventhubs.NewEventhubAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "eventhubValue", "authorizationRuleValue")
read, err := client.EventHubsListKeys(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: AuthorizationRulesEventHubsClient.EventHubsRegenerateKeys
ctx := context.TODO()
id := authorizationruleseventhubs.NewEventhubAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "eventhubValue", "authorizationRuleValue")
payload := authorizationruleseventhubs.RegenerateAccessKeyParameters{
// ...
}
read, err := client.EventHubsRegenerateKeys(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 ValidateEventhubAuthorizationRuleID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateEventhubID(input interface{}, key string) (warnings []string, errors []error)
- type AccessKeys
- type AccessRights
- type AuthorizationRule
- type AuthorizationRuleOperationPredicate
- type AuthorizationRuleProperties
- type AuthorizationRulesEventHubsClient
- func (c AuthorizationRulesEventHubsClient) EventHubsCreateOrUpdateAuthorizationRule(ctx context.Context, id EventhubAuthorizationRuleId, input AuthorizationRule) (result EventHubsCreateOrUpdateAuthorizationRuleOperationResponse, err error)
- func (c AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRules(ctx context.Context, id EventhubId) (resp EventHubsListAuthorizationRulesOperationResponse, err error)
- func (c AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRulesComplete(ctx context.Context, id EventhubId) (EventHubsListAuthorizationRulesCompleteResult, error)
- func (c AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id EventhubId, ...) (resp EventHubsListAuthorizationRulesCompleteResult, err error)
- func (c AuthorizationRulesEventHubsClient) EventHubsListKeys(ctx context.Context, id EventhubAuthorizationRuleId) (result EventHubsListKeysOperationResponse, err error)
- func (c AuthorizationRulesEventHubsClient) EventHubsRegenerateKeys(ctx context.Context, id EventhubAuthorizationRuleId, ...) (result EventHubsRegenerateKeysOperationResponse, err error)
- type EventHubsCreateOrUpdateAuthorizationRuleOperationResponse
- type EventHubsListAuthorizationRulesCompleteResult
- type EventHubsListAuthorizationRulesOperationResponse
- type EventHubsListKeysOperationResponse
- type EventHubsRegenerateKeysOperationResponse
- type EventhubAuthorizationRuleId
- func NewEventhubAuthorizationRuleID(subscriptionId string, resourceGroupName string, namespaceName string, ...) EventhubAuthorizationRuleId
- func ParseEventhubAuthorizationRuleID(input string) (*EventhubAuthorizationRuleId, error)
- func ParseEventhubAuthorizationRuleIDInsensitively(input string) (*EventhubAuthorizationRuleId, error)
- type EventhubId
- type KeyType
- type RegenerateAccessKeyParameters
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForAccessRights ¶
func PossibleValuesForAccessRights() []string
func PossibleValuesForKeyType ¶
func PossibleValuesForKeyType() []string
func ValidateEventhubAuthorizationRuleID ¶
func ValidateEventhubAuthorizationRuleID(input interface{}, key string) (warnings []string, errors []error)
ValidateEventhubAuthorizationRuleID checks that 'input' can be parsed as a Eventhub Authorization Rule ID
func ValidateEventhubID ¶
ValidateEventhubID checks that 'input' can be parsed as a Eventhub 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 AuthorizationRule ¶
type AuthorizationRule struct { Id *string `json:"id,omitempty"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` Properties *AuthorizationRuleProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type AuthorizationRuleOperationPredicate ¶
type AuthorizationRuleOperationPredicate struct { Id *string Location *string Name *string Type *string }
func (AuthorizationRuleOperationPredicate) Matches ¶
func (p AuthorizationRuleOperationPredicate) Matches(input AuthorizationRule) bool
type AuthorizationRuleProperties ¶
type AuthorizationRuleProperties struct {
Rights []AccessRights `json:"rights"`
}
type AuthorizationRulesEventHubsClient ¶
type AuthorizationRulesEventHubsClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewAuthorizationRulesEventHubsClientWithBaseURI ¶
func NewAuthorizationRulesEventHubsClientWithBaseURI(endpoint string) AuthorizationRulesEventHubsClient
func (AuthorizationRulesEventHubsClient) EventHubsCreateOrUpdateAuthorizationRule ¶
func (c AuthorizationRulesEventHubsClient) EventHubsCreateOrUpdateAuthorizationRule(ctx context.Context, id EventhubAuthorizationRuleId, input AuthorizationRule) (result EventHubsCreateOrUpdateAuthorizationRuleOperationResponse, err error)
EventHubsCreateOrUpdateAuthorizationRule ...
func (AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRules ¶
func (c AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRules(ctx context.Context, id EventhubId) (resp EventHubsListAuthorizationRulesOperationResponse, err error)
EventHubsListAuthorizationRules ...
func (AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRulesComplete ¶
func (c AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRulesComplete(ctx context.Context, id EventhubId) (EventHubsListAuthorizationRulesCompleteResult, error)
EventHubsListAuthorizationRulesComplete retrieves all of the results into a single object
func (AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRulesCompleteMatchingPredicate ¶
func (c AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id EventhubId, predicate AuthorizationRuleOperationPredicate) (resp EventHubsListAuthorizationRulesCompleteResult, err error)
EventHubsListAuthorizationRulesCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (AuthorizationRulesEventHubsClient) EventHubsListKeys ¶
func (c AuthorizationRulesEventHubsClient) EventHubsListKeys(ctx context.Context, id EventhubAuthorizationRuleId) (result EventHubsListKeysOperationResponse, err error)
EventHubsListKeys ...
func (AuthorizationRulesEventHubsClient) EventHubsRegenerateKeys ¶
func (c AuthorizationRulesEventHubsClient) EventHubsRegenerateKeys(ctx context.Context, id EventhubAuthorizationRuleId, input RegenerateAccessKeyParameters) (result EventHubsRegenerateKeysOperationResponse, err error)
EventHubsRegenerateKeys ...
type EventHubsCreateOrUpdateAuthorizationRuleOperationResponse ¶
type EventHubsCreateOrUpdateAuthorizationRuleOperationResponse struct { HttpResponse *http.Response Model *AuthorizationRule }
type EventHubsListAuthorizationRulesCompleteResult ¶
type EventHubsListAuthorizationRulesCompleteResult struct {
Items []AuthorizationRule
}
type EventHubsListAuthorizationRulesOperationResponse ¶
type EventHubsListAuthorizationRulesOperationResponse struct { HttpResponse *http.Response Model *[]AuthorizationRule // contains filtered or unexported fields }
func (EventHubsListAuthorizationRulesOperationResponse) HasMore ¶
func (r EventHubsListAuthorizationRulesOperationResponse) HasMore() bool
func (EventHubsListAuthorizationRulesOperationResponse) LoadMore ¶
func (r EventHubsListAuthorizationRulesOperationResponse) LoadMore(ctx context.Context) (resp EventHubsListAuthorizationRulesOperationResponse, err error)
type EventHubsListKeysOperationResponse ¶
type EventHubsListKeysOperationResponse struct { HttpResponse *http.Response Model *AccessKeys }
type EventHubsRegenerateKeysOperationResponse ¶
type EventHubsRegenerateKeysOperationResponse struct { HttpResponse *http.Response Model *AccessKeys }
type EventhubAuthorizationRuleId ¶
type EventhubAuthorizationRuleId struct { SubscriptionId string ResourceGroupName string NamespaceName string EventhubName string AuthorizationRuleName string }
EventhubAuthorizationRuleId is a struct representing the Resource ID for a Eventhub Authorization Rule
func NewEventhubAuthorizationRuleID ¶
func NewEventhubAuthorizationRuleID(subscriptionId string, resourceGroupName string, namespaceName string, eventhubName string, authorizationRuleName string) EventhubAuthorizationRuleId
NewEventhubAuthorizationRuleID returns a new EventhubAuthorizationRuleId struct
func ParseEventhubAuthorizationRuleID ¶
func ParseEventhubAuthorizationRuleID(input string) (*EventhubAuthorizationRuleId, error)
ParseEventhubAuthorizationRuleID parses 'input' into a EventhubAuthorizationRuleId
func ParseEventhubAuthorizationRuleIDInsensitively ¶
func ParseEventhubAuthorizationRuleIDInsensitively(input string) (*EventhubAuthorizationRuleId, error)
ParseEventhubAuthorizationRuleIDInsensitively parses 'input' case-insensitively into a EventhubAuthorizationRuleId note: this method should only be used for API response data and not user input
func (EventhubAuthorizationRuleId) ID ¶
func (id EventhubAuthorizationRuleId) ID() string
ID returns the formatted Eventhub Authorization Rule ID
func (EventhubAuthorizationRuleId) Segments ¶
func (id EventhubAuthorizationRuleId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Eventhub Authorization Rule ID
func (EventhubAuthorizationRuleId) String ¶
func (id EventhubAuthorizationRuleId) String() string
String returns a human-readable description of this Eventhub Authorization Rule ID
type EventhubId ¶
type EventhubId struct { SubscriptionId string ResourceGroupName string NamespaceName string EventhubName string }
EventhubId is a struct representing the Resource ID for a Eventhub
func NewEventhubID ¶
func NewEventhubID(subscriptionId string, resourceGroupName string, namespaceName string, eventhubName string) EventhubId
NewEventhubID returns a new EventhubId struct
func ParseEventhubID ¶
func ParseEventhubID(input string) (*EventhubId, error)
ParseEventhubID parses 'input' into a EventhubId
func ParseEventhubIDInsensitively ¶
func ParseEventhubIDInsensitively(input string) (*EventhubId, error)
ParseEventhubIDInsensitively parses 'input' case-insensitively into a EventhubId note: this method should only be used for API response data and not user input
func (EventhubId) Segments ¶
func (id EventhubId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Eventhub ID
func (EventhubId) String ¶
func (id EventhubId) String() string
String returns a human-readable description of this Eventhub ID
Source Files ¶
- client.go
- constants.go
- id_eventhub.go
- id_eventhubauthorizationrule.go
- method_eventhubscreateorupdateauthorizationrule_autorest.go
- method_eventhubslistauthorizationrules_autorest.go
- method_eventhubslistkeys_autorest.go
- method_eventhubsregeneratekeys_autorest.go
- model_accesskeys.go
- model_authorizationrule.go
- model_authorizationruleproperties.go
- model_regenerateaccesskeyparameters.go
- predicates.go
- version.go