authorizationruleseventhubs

package
v0.20240125.1115017 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2021-11-01/authorizationruleseventhubs Documentation

The authorizationruleseventhubs SDK allows for interaction with the Azure Resource Manager Service eventhub (API Version 2021-11-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/2021-11-01/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

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 

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

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"
)

func (*AccessRights) UnmarshalJSON 

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

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 *resourcemanager.Client
}

func NewAuthorizationRulesEventHubsClientWithBaseURI 

func NewAuthorizationRulesEventHubsClientWithBaseURI(sdkApi sdkEnv.Api) (*AuthorizationRulesEventHubsClient, error)

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) (result EventHubsListAuthorizationRulesOperationResponse, err error)

EventHubsListAuthorizationRules ...

func (AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRulesComplete 

func (c AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRulesComplete(ctx context.Context, id EventhubId) (EventHubsListAuthorizationRulesCompleteResult, error)

EventHubsListAuthorizationRulesComplete retrieves all the results into a single object

func (AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRulesCompleteMatchingPredicate 

func (c AuthorizationRulesEventHubsClient) EventHubsListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id EventhubId, predicate AuthorizationRuleOperationPredicate) (result EventHubsListAuthorizationRulesCompleteResult, err error)

EventHubsListAuthorizationRulesCompleteMatchingPredicate retrieves all the results and then applies 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
	OData        *odata.OData
	Model        *AuthorizationRule
}

type EventHubsListAuthorizationRulesCompleteResult 

type EventHubsListAuthorizationRulesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AuthorizationRule
}

type EventHubsListAuthorizationRulesOperationResponse 

type EventHubsListAuthorizationRulesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AuthorizationRule
}

type EventHubsListKeysOperationResponse 

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

type EventHubsRegenerateKeysOperationResponse 

type EventHubsRegenerateKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	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) FromParseResult 

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

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) FromParseResult 

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

func (EventhubId) ID 

func (id EventhubId) ID() string

ID returns the formatted Eventhub ID

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

type KeyType 

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

func (*KeyType) UnmarshalJSON 

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

type RegenerateAccessKeyParameters 

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

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.