authorizationrulesnamespaces

package
v0.20230503.1130337 Latest Latest
Warning

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

Go to latest
Published: May 3, 2023 License: MPL-2.0 Imports: 9 Imported by: 1

README

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

The authorizationrulesnamespaces 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/authorizationrulesnamespaces"

Client Initialization

client := authorizationrulesnamespaces.NewAuthorizationRulesNamespacesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AuthorizationRulesNamespacesClient.NamespacesCreateOrUpdateAuthorizationRule

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

payload := authorizationrulesnamespaces.AuthorizationRule{
	// ...
}


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

Example Usage: AuthorizationRulesNamespacesClient.NamespacesDeleteAuthorizationRule

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

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

Example Usage: AuthorizationRulesNamespacesClient.NamespacesGetAuthorizationRule

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

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

Example Usage: AuthorizationRulesNamespacesClient.NamespacesListAuthorizationRules

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

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

Example Usage: AuthorizationRulesNamespacesClient.NamespacesListKeys

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

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

Example Usage: AuthorizationRulesNamespacesClient.NamespacesRegenerateKeys

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

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


read, err := client.NamespacesRegenerateKeys(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 ValidateAuthorizationRuleID

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

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

func ValidateNamespaceID

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace 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 AuthorizationRuleId

type AuthorizationRuleId struct {
	SubscriptionId        string
	ResourceGroupName     string
	NamespaceName         string
	AuthorizationRuleName string
}

AuthorizationRuleId is a struct representing the Resource ID for a Authorization Rule

func NewAuthorizationRuleID

func NewAuthorizationRuleID(subscriptionId string, resourceGroupName string, namespaceName string, authorizationRuleName string) AuthorizationRuleId

NewAuthorizationRuleID returns a new AuthorizationRuleId struct

func ParseAuthorizationRuleID

func ParseAuthorizationRuleID(input string) (*AuthorizationRuleId, error)

ParseAuthorizationRuleID parses 'input' into a AuthorizationRuleId

func ParseAuthorizationRuleIDInsensitively

func ParseAuthorizationRuleIDInsensitively(input string) (*AuthorizationRuleId, error)

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

func (AuthorizationRuleId) ID

func (id AuthorizationRuleId) ID() string

ID returns the formatted Authorization Rule ID

func (AuthorizationRuleId) Segments

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

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

func (AuthorizationRuleId) String

func (id AuthorizationRuleId) String() string

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

type AuthorizationRuleOperationPredicate

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

func (AuthorizationRuleOperationPredicate) Matches

type AuthorizationRuleProperties

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

type AuthorizationRulesNamespacesClient

type AuthorizationRulesNamespacesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewAuthorizationRulesNamespacesClientWithBaseURI

func NewAuthorizationRulesNamespacesClientWithBaseURI(endpoint string) AuthorizationRulesNamespacesClient

func (AuthorizationRulesNamespacesClient) NamespacesCreateOrUpdateAuthorizationRule

NamespacesCreateOrUpdateAuthorizationRule ...

func (AuthorizationRulesNamespacesClient) NamespacesDeleteAuthorizationRule

NamespacesDeleteAuthorizationRule ...

func (AuthorizationRulesNamespacesClient) NamespacesGetAuthorizationRule

NamespacesGetAuthorizationRule ...

func (AuthorizationRulesNamespacesClient) NamespacesListAuthorizationRules

NamespacesListAuthorizationRules ...

func (AuthorizationRulesNamespacesClient) NamespacesListAuthorizationRulesComplete

NamespacesListAuthorizationRulesComplete retrieves all of the results into a single object

func (AuthorizationRulesNamespacesClient) NamespacesListAuthorizationRulesCompleteMatchingPredicate

func (c AuthorizationRulesNamespacesClient) NamespacesListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate AuthorizationRuleOperationPredicate) (resp NamespacesListAuthorizationRulesCompleteResult, err error)

NamespacesListAuthorizationRulesCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (AuthorizationRulesNamespacesClient) NamespacesListKeys

NamespacesListKeys ...

func (AuthorizationRulesNamespacesClient) NamespacesRegenerateKeys

NamespacesRegenerateKeys ...

type KeyType

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

type NamespaceId

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (NamespaceId) ID

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments

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

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

func (NamespaceId) String

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type NamespacesCreateOrUpdateAuthorizationRuleOperationResponse

type NamespacesCreateOrUpdateAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	Model        *AuthorizationRule
}

type NamespacesDeleteAuthorizationRuleOperationResponse

type NamespacesDeleteAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
}

type NamespacesGetAuthorizationRuleOperationResponse

type NamespacesGetAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	Model        *AuthorizationRule
}

type NamespacesListAuthorizationRulesCompleteResult

type NamespacesListAuthorizationRulesCompleteResult struct {
	Items []AuthorizationRule
}

type NamespacesListAuthorizationRulesOperationResponse

type NamespacesListAuthorizationRulesOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]AuthorizationRule
	// contains filtered or unexported fields
}

func (NamespacesListAuthorizationRulesOperationResponse) HasMore

func (NamespacesListAuthorizationRulesOperationResponse) LoadMore

type NamespacesListKeysOperationResponse

type NamespacesListKeysOperationResponse struct {
	HttpResponse *http.Response
	Model        *AccessKeys
}

type NamespacesRegenerateKeysOperationResponse

type NamespacesRegenerateKeysOperationResponse struct {
	HttpResponse *http.Response
	Model        *AccessKeys
}

type RegenerateAccessKeyParameters

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

Jump to

Keyboard shortcuts

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