clientgroups

package
v0.20240923.1142107 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

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

The clientgroups SDK allows for interaction with Azure Resource Manager 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/clientgroups"

Client Initialization

client := clientgroups.NewClientGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ClientGroupsClient.CreateOrUpdate

ctx := context.TODO()
id := clientgroups.NewClientGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "clientGroupName")

payload := clientgroups.ClientGroup{
	// ...
}


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

Example Usage: ClientGroupsClient.Delete

ctx := context.TODO()
id := clientgroups.NewClientGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "clientGroupName")

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

Example Usage: ClientGroupsClient.Get

ctx := context.TODO()
id := clientgroups.NewClientGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "clientGroupName")

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: ClientGroupsClient.ListByNamespace

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

// alternatively `client.ListByNamespace(ctx, id, clientgroups.DefaultListByNamespaceOperationOptions())` can be used to do batched pagination
items, err := client.ListByNamespaceComplete(ctx, id, clientgroups.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 PossibleValuesForClientGroupProvisioningState 

func PossibleValuesForClientGroupProvisioningState() []string

func ValidateClientGroupID 

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

ValidateClientGroupID checks that 'input' can be parsed as a Client Group 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 ClientGroup 

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

type ClientGroupId 

type ClientGroupId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
	ClientGroupName   string
}

ClientGroupId is a struct representing the Resource ID for a Client Group

func NewClientGroupID 

func NewClientGroupID(subscriptionId string, resourceGroupName string, namespaceName string, clientGroupName string) ClientGroupId

NewClientGroupID returns a new ClientGroupId struct

func ParseClientGroupID 

func ParseClientGroupID(input string) (*ClientGroupId, error)

ParseClientGroupID parses 'input' into a ClientGroupId

func ParseClientGroupIDInsensitively 

func ParseClientGroupIDInsensitively(input string) (*ClientGroupId, error)

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

func (*ClientGroupId) FromParseResult 

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

func (ClientGroupId) ID 

func (id ClientGroupId) ID() string

ID returns the formatted Client Group ID

func (ClientGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Client Group ID

func (ClientGroupId) String 

func (id ClientGroupId) String() string

String returns a human-readable description of this Client Group ID

type ClientGroupOperationPredicate 

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

func (ClientGroupOperationPredicate) Matches 

func (p ClientGroupOperationPredicate) Matches(input ClientGroup) bool

type ClientGroupProperties 

type ClientGroupProperties struct {
	Description       *string                       `json:"description,omitempty"`
	ProvisioningState *ClientGroupProvisioningState `json:"provisioningState,omitempty"`
	Query             *string                       `json:"query,omitempty"`
}

type ClientGroupProvisioningState 

type ClientGroupProvisioningState string
const (
	ClientGroupProvisioningStateCanceled  ClientGroupProvisioningState = "Canceled"
	ClientGroupProvisioningStateCreating  ClientGroupProvisioningState = "Creating"
	ClientGroupProvisioningStateDeleted   ClientGroupProvisioningState = "Deleted"
	ClientGroupProvisioningStateDeleting  ClientGroupProvisioningState = "Deleting"
	ClientGroupProvisioningStateFailed    ClientGroupProvisioningState = "Failed"
	ClientGroupProvisioningStateSucceeded ClientGroupProvisioningState = "Succeeded"
	ClientGroupProvisioningStateUpdating  ClientGroupProvisioningState = "Updating"
)

func (*ClientGroupProvisioningState) UnmarshalJSON 

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

type ClientGroupsClient 

type ClientGroupsClient struct {
	Client *resourcemanager.Client
}

func NewClientGroupsClientWithBaseURI 

func NewClientGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*ClientGroupsClient, error)

func (ClientGroupsClient) CreateOrUpdate 

func (c ClientGroupsClient) CreateOrUpdate(ctx context.Context, id ClientGroupId, input ClientGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ClientGroupsClient) CreateOrUpdateThenPoll 

func (c ClientGroupsClient) CreateOrUpdateThenPoll(ctx context.Context, id ClientGroupId, input ClientGroup) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ClientGroupsClient) Delete 

func (c ClientGroupsClient) Delete(ctx context.Context, id ClientGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (ClientGroupsClient) DeleteThenPoll 

func (c ClientGroupsClient) DeleteThenPoll(ctx context.Context, id ClientGroupId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ClientGroupsClient) Get 

func (c ClientGroupsClient) Get(ctx context.Context, id ClientGroupId) (result GetOperationResponse, err error)

Get ...

func (ClientGroupsClient) ListByNamespace 

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

ListByNamespace ...

func (ClientGroupsClient) ListByNamespaceComplete 

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

ListByNamespaceComplete retrieves all the results into a single object

func (ClientGroupsClient) ListByNamespaceCompleteMatchingPredicate 

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

ListByNamespaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type CreateOrUpdateOperationResponse 

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

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        *ClientGroup
}

type ListByNamespaceCompleteResult 

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

type ListByNamespaceCustomPager added in v0.20240628.1153531 

type ListByNamespaceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByNamespaceCustomPager) NextPageLink() *odata.Link

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        *[]ClientGroup
}

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

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.