partnerdestinations

package
v0.20240617.1095803 Latest Latest
Warning

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

 Go to latest Published: Jun 17, 2024 License: MPL-2.0 Imports: 16 Imported by: 1

README

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

The partnerdestinations 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2023-12-15-preview/partnerdestinations"

Client Initialization

client := partnerdestinations.NewPartnerDestinationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PartnerDestinationsClient.Activate

ctx := context.TODO()
id := partnerdestinations.NewPartnerDestinationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerDestinationValue")

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

Example Usage: PartnerDestinationsClient.CreateOrUpdate

ctx := context.TODO()
id := partnerdestinations.NewPartnerDestinationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerDestinationValue")

payload := partnerdestinations.PartnerDestination{
	// ...
}


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

Example Usage: PartnerDestinationsClient.Delete

ctx := context.TODO()
id := partnerdestinations.NewPartnerDestinationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerDestinationValue")

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

Example Usage: PartnerDestinationsClient.Get

ctx := context.TODO()
id := partnerdestinations.NewPartnerDestinationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerDestinationValue")

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: PartnerDestinationsClient.ListByResourceGroup

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

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

Example Usage: PartnerDestinationsClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: PartnerDestinationsClient.Update

ctx := context.TODO()
id := partnerdestinations.NewPartnerDestinationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "partnerDestinationValue")

payload := partnerdestinations.PartnerDestinationUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForPartnerDestinationActivationState 

func PossibleValuesForPartnerDestinationActivationState() []string

func PossibleValuesForPartnerDestinationProvisioningState 

func PossibleValuesForPartnerDestinationProvisioningState() []string

func ValidatePartnerDestinationID 

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

ValidatePartnerDestinationID checks that 'input' can be parsed as a Partner Destination ID

Types

type ActivateOperationResponse 

type ActivateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerDestination
}

type CreateOrUpdateOperationResponse 

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

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PartnerDestination
}

type ListByResourceGroupOperationOptions 

type ListByResourceGroupOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByResourceGroupOperationOptions 

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

func (ListByResourceGroupOperationOptions) ToHeaders 

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

func (ListByResourceGroupOperationOptions) ToOData 

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

func (ListByResourceGroupOperationOptions) ToQuery 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PartnerDestination
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PartnerDestination
}

type ListBySubscriptionOperationOptions 

type ListBySubscriptionOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListBySubscriptionOperationOptions 

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

func (ListBySubscriptionOperationOptions) ToHeaders 

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

func (ListBySubscriptionOperationOptions) ToOData 

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

func (ListBySubscriptionOperationOptions) ToQuery 

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

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PartnerDestination
}

type PartnerDestination 

type PartnerDestination struct {
	Id         *string                       `json:"id,omitempty"`
	Location   string                        `json:"location"`
	Name       *string                       `json:"name,omitempty"`
	Properties *PartnerDestinationProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData        `json:"systemData,omitempty"`
	Tags       *map[string]string            `json:"tags,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type PartnerDestinationActivationState 

type PartnerDestinationActivationState string
const (
	PartnerDestinationActivationStateActivated      PartnerDestinationActivationState = "Activated"
	PartnerDestinationActivationStateNeverActivated PartnerDestinationActivationState = "NeverActivated"
)

func (*PartnerDestinationActivationState) UnmarshalJSON 

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

type PartnerDestinationId 

type PartnerDestinationId struct {
	SubscriptionId         string
	ResourceGroupName      string
	PartnerDestinationName string
}

PartnerDestinationId is a struct representing the Resource ID for a Partner Destination

func NewPartnerDestinationID 

func NewPartnerDestinationID(subscriptionId string, resourceGroupName string, partnerDestinationName string) PartnerDestinationId

NewPartnerDestinationID returns a new PartnerDestinationId struct

func ParsePartnerDestinationID 

func ParsePartnerDestinationID(input string) (*PartnerDestinationId, error)

ParsePartnerDestinationID parses 'input' into a PartnerDestinationId

func ParsePartnerDestinationIDInsensitively 

func ParsePartnerDestinationIDInsensitively(input string) (*PartnerDestinationId, error)

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

func (*PartnerDestinationId) FromParseResult 

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

func (PartnerDestinationId) ID 

func (id PartnerDestinationId) ID() string

ID returns the formatted Partner Destination ID

func (PartnerDestinationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Partner Destination ID

func (PartnerDestinationId) String 

func (id PartnerDestinationId) String() string

String returns a human-readable description of this Partner Destination ID

type PartnerDestinationOperationPredicate 

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

func (PartnerDestinationOperationPredicate) Matches 

func (p PartnerDestinationOperationPredicate) Matches(input PartnerDestination) bool

type PartnerDestinationProperties 

type PartnerDestinationProperties struct {
	ActivationState                 *PartnerDestinationActivationState   `json:"activationState,omitempty"`
	EndpointBaseUrl                 *string                              `json:"endpointBaseUrl,omitempty"`
	EndpointServiceContext          *string                              `json:"endpointServiceContext,omitempty"`
	ExpirationTimeIfNotActivatedUtc *string                              `json:"expirationTimeIfNotActivatedUtc,omitempty"`
	MessageForActivation            *string                              `json:"messageForActivation,omitempty"`
	PartnerRegistrationImmutableId  *string                              `json:"partnerRegistrationImmutableId,omitempty"`
	ProvisioningState               *PartnerDestinationProvisioningState `json:"provisioningState,omitempty"`
}

func (*PartnerDestinationProperties) GetExpirationTimeIfNotActivatedUtcAsTime 

func (o *PartnerDestinationProperties) GetExpirationTimeIfNotActivatedUtcAsTime() (*time.Time, error)

func (*PartnerDestinationProperties) SetExpirationTimeIfNotActivatedUtcAsTime 

func (o *PartnerDestinationProperties) SetExpirationTimeIfNotActivatedUtcAsTime(input time.Time)

type PartnerDestinationProvisioningState 

type PartnerDestinationProvisioningState string
const (
	PartnerDestinationProvisioningStateCanceled                                 PartnerDestinationProvisioningState = "Canceled"
	PartnerDestinationProvisioningStateCreating                                 PartnerDestinationProvisioningState = "Creating"
	PartnerDestinationProvisioningStateDeleting                                 PartnerDestinationProvisioningState = "Deleting"
	PartnerDestinationProvisioningStateFailed                                   PartnerDestinationProvisioningState = "Failed"
	PartnerDestinationProvisioningStateIdleDueToMirroredChannelResourceDeletion PartnerDestinationProvisioningState = "IdleDueToMirroredChannelResourceDeletion"
	PartnerDestinationProvisioningStateSucceeded                                PartnerDestinationProvisioningState = "Succeeded"
	PartnerDestinationProvisioningStateUpdating                                 PartnerDestinationProvisioningState = "Updating"
)

func (*PartnerDestinationProvisioningState) UnmarshalJSON 

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

type PartnerDestinationUpdateParameters 

type PartnerDestinationUpdateParameters struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type PartnerDestinationsClient 

type PartnerDestinationsClient struct {
	Client *resourcemanager.Client
}

func NewPartnerDestinationsClientWithBaseURI 

func NewPartnerDestinationsClientWithBaseURI(sdkApi sdkEnv.Api) (*PartnerDestinationsClient, error)

func (PartnerDestinationsClient) Activate 

func (c PartnerDestinationsClient) Activate(ctx context.Context, id PartnerDestinationId) (result ActivateOperationResponse, err error)

Activate ...

func (PartnerDestinationsClient) CreateOrUpdate 

func (c PartnerDestinationsClient) CreateOrUpdate(ctx context.Context, id PartnerDestinationId, input PartnerDestination) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PartnerDestinationsClient) CreateOrUpdateThenPoll 

func (c PartnerDestinationsClient) CreateOrUpdateThenPoll(ctx context.Context, id PartnerDestinationId, input PartnerDestination) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PartnerDestinationsClient) Delete 

func (c PartnerDestinationsClient) Delete(ctx context.Context, id PartnerDestinationId) (result DeleteOperationResponse, err error)

Delete ...

func (PartnerDestinationsClient) DeleteThenPoll 

func (c PartnerDestinationsClient) DeleteThenPoll(ctx context.Context, id PartnerDestinationId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PartnerDestinationsClient) Get 

func (c PartnerDestinationsClient) Get(ctx context.Context, id PartnerDestinationId) (result GetOperationResponse, err error)

Get ...

func (PartnerDestinationsClient) ListByResourceGroup 

func (c PartnerDestinationsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (PartnerDestinationsClient) ListByResourceGroupComplete 

func (c PartnerDestinationsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (PartnerDestinationsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c PartnerDestinationsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions, predicate PartnerDestinationOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PartnerDestinationsClient) ListBySubscription 

func (c PartnerDestinationsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (PartnerDestinationsClient) ListBySubscriptionComplete 

func (c PartnerDestinationsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (PartnerDestinationsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c PartnerDestinationsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions, predicate PartnerDestinationOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PartnerDestinationsClient) Update 

func (c PartnerDestinationsClient) Update(ctx context.Context, id PartnerDestinationId, input PartnerDestinationUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

func (PartnerDestinationsClient) UpdateThenPoll 

func (c PartnerDestinationsClient) UpdateThenPoll(ctx context.Context, id PartnerDestinationId, input PartnerDestinationUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerDestination
}

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.