permissionbindings

package
v0.20240612.1122027 Latest Latest
Warning

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

 Go to latest Published: Jun 12, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2023-12-15-preview/permissionbindings Documentation

The permissionbindings SDK allows for interaction with the Azure Resource Manager Service eventgrid (API Version 2023-12-15-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/eventgrid/2023-12-15-preview/permissionbindings"

Client Initialization

client := permissionbindings.NewPermissionBindingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PermissionBindingsClient.CreateOrUpdate

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

payload := permissionbindings.PermissionBinding{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: PermissionBindingsClient.Delete

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

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PermissionBindingsClient.Get

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

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

Example Usage: PermissionBindingsClient.ListByNamespace

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForPermissionBindingProvisioningState 

func PossibleValuesForPermissionBindingProvisioningState() []string

func PossibleValuesForPermissionType 

func PossibleValuesForPermissionType() []string

func ValidateNamespaceID 

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

func ValidatePermissionBindingID 

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

ValidatePermissionBindingID checks that 'input' can be parsed as a Permission Binding ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PermissionBinding
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PermissionBinding
}

type ListByNamespaceCompleteResult 

type ListByNamespaceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PermissionBinding
}

type ListByNamespaceOperationOptions 

type ListByNamespaceOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByNamespaceOperationOptions 

func DefaultListByNamespaceOperationOptions() ListByNamespaceOperationOptions

func (ListByNamespaceOperationOptions) ToHeaders 

func (o ListByNamespaceOperationOptions) ToHeaders() *client.Headers

func (ListByNamespaceOperationOptions) ToOData 

func (o ListByNamespaceOperationOptions) ToOData() *odata.Query

func (ListByNamespaceOperationOptions) ToQuery 

func (o ListByNamespaceOperationOptions) ToQuery() *client.QueryParams

type ListByNamespaceOperationResponse 

type ListByNamespaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PermissionBinding
}

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

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

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 PermissionBinding 

type PermissionBinding struct {
	Id         *string                      `json:"id,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *PermissionBindingProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData       `json:"systemData,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type PermissionBindingId 

type PermissionBindingId struct {
	SubscriptionId        string
	ResourceGroupName     string
	NamespaceName         string
	PermissionBindingName string
}

PermissionBindingId is a struct representing the Resource ID for a Permission Binding

func NewPermissionBindingID 

func NewPermissionBindingID(subscriptionId string, resourceGroupName string, namespaceName string, permissionBindingName string) PermissionBindingId

NewPermissionBindingID returns a new PermissionBindingId struct

func ParsePermissionBindingID 

func ParsePermissionBindingID(input string) (*PermissionBindingId, error)

ParsePermissionBindingID parses 'input' into a PermissionBindingId

func ParsePermissionBindingIDInsensitively 

func ParsePermissionBindingIDInsensitively(input string) (*PermissionBindingId, error)

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

func (*PermissionBindingId) FromParseResult 

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

func (PermissionBindingId) ID 

func (id PermissionBindingId) ID() string

ID returns the formatted Permission Binding ID

func (PermissionBindingId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Permission Binding ID

func (PermissionBindingId) String 

func (id PermissionBindingId) String() string

String returns a human-readable description of this Permission Binding ID

type PermissionBindingOperationPredicate 

type PermissionBindingOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (PermissionBindingOperationPredicate) Matches 

func (p PermissionBindingOperationPredicate) Matches(input PermissionBinding) bool

type PermissionBindingProperties 

type PermissionBindingProperties struct {
	ClientGroupName   *string                             `json:"clientGroupName,omitempty"`
	Description       *string                             `json:"description,omitempty"`
	Permission        *PermissionType                     `json:"permission,omitempty"`
	ProvisioningState *PermissionBindingProvisioningState `json:"provisioningState,omitempty"`
	TopicSpaceName    *string                             `json:"topicSpaceName,omitempty"`
}

type PermissionBindingProvisioningState 

type PermissionBindingProvisioningState string
const (
	PermissionBindingProvisioningStateCanceled  PermissionBindingProvisioningState = "Canceled"
	PermissionBindingProvisioningStateCreating  PermissionBindingProvisioningState = "Creating"
	PermissionBindingProvisioningStateDeleted   PermissionBindingProvisioningState = "Deleted"
	PermissionBindingProvisioningStateDeleting  PermissionBindingProvisioningState = "Deleting"
	PermissionBindingProvisioningStateFailed    PermissionBindingProvisioningState = "Failed"
	PermissionBindingProvisioningStateSucceeded PermissionBindingProvisioningState = "Succeeded"
	PermissionBindingProvisioningStateUpdating  PermissionBindingProvisioningState = "Updating"
)

func (*PermissionBindingProvisioningState) UnmarshalJSON 

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

type PermissionBindingsClient 

type PermissionBindingsClient struct {
	Client *resourcemanager.Client
}

func NewPermissionBindingsClientWithBaseURI 

func NewPermissionBindingsClientWithBaseURI(sdkApi sdkEnv.Api) (*PermissionBindingsClient, error)

func (PermissionBindingsClient) CreateOrUpdate 

func (c PermissionBindingsClient) CreateOrUpdate(ctx context.Context, id PermissionBindingId, input PermissionBinding) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PermissionBindingsClient) CreateOrUpdateThenPoll 

func (c PermissionBindingsClient) CreateOrUpdateThenPoll(ctx context.Context, id PermissionBindingId, input PermissionBinding) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PermissionBindingsClient) Delete 

func (c PermissionBindingsClient) Delete(ctx context.Context, id PermissionBindingId) (result DeleteOperationResponse, err error)

Delete ...

func (PermissionBindingsClient) DeleteThenPoll 

func (c PermissionBindingsClient) DeleteThenPoll(ctx context.Context, id PermissionBindingId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PermissionBindingsClient) Get 

func (c PermissionBindingsClient) Get(ctx context.Context, id PermissionBindingId) (result GetOperationResponse, err error)

Get ...

func (PermissionBindingsClient) ListByNamespace 

func (c PermissionBindingsClient) ListByNamespace(ctx context.Context, id NamespaceId, options ListByNamespaceOperationOptions) (result ListByNamespaceOperationResponse, err error)

ListByNamespace ...

func (PermissionBindingsClient) ListByNamespaceComplete 

func (c PermissionBindingsClient) ListByNamespaceComplete(ctx context.Context, id NamespaceId, options ListByNamespaceOperationOptions) (ListByNamespaceCompleteResult, error)

ListByNamespaceComplete retrieves all the results into a single object

func (PermissionBindingsClient) ListByNamespaceCompleteMatchingPredicate 

func (c PermissionBindingsClient) ListByNamespaceCompleteMatchingPredicate(ctx context.Context, id NamespaceId, options ListByNamespaceOperationOptions, predicate PermissionBindingOperationPredicate) (result ListByNamespaceCompleteResult, err error)

ListByNamespaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PermissionType 

type PermissionType string
const (
	PermissionTypePublisher  PermissionType = "Publisher"
	PermissionTypeSubscriber PermissionType = "Subscriber"
)

func (*PermissionType) UnmarshalJSON 

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

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.