clients

package
v0.20241023.1122425 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := clients.NewClientsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ClientsClient.CreateOrUpdate

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

payload := clients.Client{
	// ...
}


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

Example Usage: ClientsClient.Delete

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

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

Example Usage: ClientsClient.Get

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

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

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

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

func PossibleValuesForClientCertificateValidationScheme() []string

func PossibleValuesForClientProvisioningState 

func PossibleValuesForClientProvisioningState() []string

func PossibleValuesForClientState 

func PossibleValuesForClientState() []string

func ValidateClientID 

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

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

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

type ClientCertificateAuthentication 

type ClientCertificateAuthentication struct {
	AllowedThumbprints *[]string                          `json:"allowedThumbprints,omitempty"`
	ValidationScheme   *ClientCertificateValidationScheme `json:"validationScheme,omitempty"`
}

type ClientCertificateValidationScheme 

type ClientCertificateValidationScheme string
const (
	ClientCertificateValidationSchemeDnsMatchesAuthenticationName     ClientCertificateValidationScheme = "DnsMatchesAuthenticationName"
	ClientCertificateValidationSchemeEmailMatchesAuthenticationName   ClientCertificateValidationScheme = "EmailMatchesAuthenticationName"
	ClientCertificateValidationSchemeIPMatchesAuthenticationName      ClientCertificateValidationScheme = "IpMatchesAuthenticationName"
	ClientCertificateValidationSchemeSubjectMatchesAuthenticationName ClientCertificateValidationScheme = "SubjectMatchesAuthenticationName"
	ClientCertificateValidationSchemeThumbprintMatch                  ClientCertificateValidationScheme = "ThumbprintMatch"
	ClientCertificateValidationSchemeUriMatchesAuthenticationName     ClientCertificateValidationScheme = "UriMatchesAuthenticationName"
)

func (*ClientCertificateValidationScheme) UnmarshalJSON 

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

type ClientId 

type ClientId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
	ClientName        string
}

ClientId is a struct representing the Resource ID for a Client

func NewClientID 

func NewClientID(subscriptionId string, resourceGroupName string, namespaceName string, clientName string) ClientId

NewClientID returns a new ClientId struct

func ParseClientID 

func ParseClientID(input string) (*ClientId, error)

ParseClientID parses 'input' into a ClientId

func ParseClientIDInsensitively 

func ParseClientIDInsensitively(input string) (*ClientId, error)

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

func (*ClientId) FromParseResult 

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

func (ClientId) ID 

func (id ClientId) ID() string

ID returns the formatted Client ID

func (ClientId) Segments 

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

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

func (ClientId) String 

func (id ClientId) String() string

String returns a human-readable description of this Client ID

type ClientOperationPredicate 

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

func (ClientOperationPredicate) Matches 

func (p ClientOperationPredicate) Matches(input Client) bool

type ClientProperties 

type ClientProperties struct {
	Attributes                      *map[string]interface{}          `json:"attributes,omitempty"`
	AuthenticationName              *string                          `json:"authenticationName,omitempty"`
	ClientCertificateAuthentication *ClientCertificateAuthentication `json:"clientCertificateAuthentication,omitempty"`
	Description                     *string                          `json:"description,omitempty"`
	ProvisioningState               *ClientProvisioningState         `json:"provisioningState,omitempty"`
	State                           *ClientState                     `json:"state,omitempty"`
}

type ClientProvisioningState 

type ClientProvisioningState string
const (
	ClientProvisioningStateCanceled  ClientProvisioningState = "Canceled"
	ClientProvisioningStateCreating  ClientProvisioningState = "Creating"
	ClientProvisioningStateDeleted   ClientProvisioningState = "Deleted"
	ClientProvisioningStateDeleting  ClientProvisioningState = "Deleting"
	ClientProvisioningStateFailed    ClientProvisioningState = "Failed"
	ClientProvisioningStateSucceeded ClientProvisioningState = "Succeeded"
	ClientProvisioningStateUpdating  ClientProvisioningState = "Updating"
)

func (*ClientProvisioningState) UnmarshalJSON 

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

type ClientState 

type ClientState string
const (
	ClientStateDisabled ClientState = "Disabled"
	ClientStateEnabled  ClientState = "Enabled"
)

func (*ClientState) UnmarshalJSON 

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

type ClientsClient 

type ClientsClient struct {
	Client *resourcemanager.Client
}

func NewClientsClientWithBaseURI 

func NewClientsClientWithBaseURI(sdkApi sdkEnv.Api) (*ClientsClient, error)

func (ClientsClient) CreateOrUpdate 

func (c ClientsClient) CreateOrUpdate(ctx context.Context, id ClientId, input Client) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ClientsClient) CreateOrUpdateThenPoll 

func (c ClientsClient) CreateOrUpdateThenPoll(ctx context.Context, id ClientId, input Client) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ClientsClient) Delete 

func (c ClientsClient) Delete(ctx context.Context, id ClientId) (result DeleteOperationResponse, err error)

Delete ...

func (ClientsClient) DeleteThenPoll 

func (c ClientsClient) DeleteThenPoll(ctx context.Context, id ClientId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ClientsClient) Get 

func (c ClientsClient) Get(ctx context.Context, id ClientId) (result GetOperationResponse, err error)

Get ...

func (ClientsClient) ListByNamespace 

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

ListByNamespace ...

func (ClientsClient) ListByNamespaceComplete 

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

ListByNamespaceComplete retrieves all the results into a single object

func (ClientsClient) ListByNamespaceCompleteMatchingPredicate 

func (c ClientsClient) ListByNamespaceCompleteMatchingPredicate(ctx context.Context, id NamespaceId, options ListByNamespaceOperationOptions, predicate ClientOperationPredicate) (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        *Client
}

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

type ListByNamespaceCompleteResult 

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

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

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.