partnerregistrations

package
v0.20241209.1115630 Latest Latest
Warning

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

Go to latest
Published: Dec 9, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

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

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

Client Initialization

client := partnerregistrations.NewPartnerRegistrationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PartnerRegistrationsClient.CreateOrUpdate

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

payload := partnerregistrations.PartnerRegistration{
	// ...
}


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

Example Usage: PartnerRegistrationsClient.Delete

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

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

Example Usage: PartnerRegistrationsClient.Get

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

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

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

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

Example Usage: PartnerRegistrationsClient.ListBySubscription

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

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

Example Usage: PartnerRegistrationsClient.Update

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

payload := partnerregistrations.PartnerRegistrationUpdateParameters{
	// ...
}


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 PossibleValuesForPartnerRegistrationProvisioningState

func PossibleValuesForPartnerRegistrationProvisioningState() []string

func ValidatePartnerRegistrationID

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

ValidatePartnerRegistrationID checks that 'input' can be parsed as a Partner Registration ID

Types

type CreateOrUpdateOperationResponse

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

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

type ListByResourceGroupCompleteResult

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

type ListByResourceGroupCustomPager added in v0.20240628.1153531

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

type ListByResourceGroupOperationOptions

type ListByResourceGroupOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByResourceGroupOperationOptions

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

func (ListByResourceGroupOperationOptions) ToHeaders

func (ListByResourceGroupOperationOptions) ToOData

func (ListByResourceGroupOperationOptions) ToQuery

type ListByResourceGroupOperationResponse

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

type ListBySubscriptionCompleteResult

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

type ListBySubscriptionCustomPager added in v0.20240628.1153531

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

type ListBySubscriptionOperationOptions

type ListBySubscriptionOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListBySubscriptionOperationOptions

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

func (ListBySubscriptionOperationOptions) ToHeaders

func (ListBySubscriptionOperationOptions) ToOData

func (ListBySubscriptionOperationOptions) ToQuery

type ListBySubscriptionOperationResponse

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

type PartnerRegistration

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

type PartnerRegistrationId

type PartnerRegistrationId struct {
	SubscriptionId          string
	ResourceGroupName       string
	PartnerRegistrationName string
}

PartnerRegistrationId is a struct representing the Resource ID for a Partner Registration

func NewPartnerRegistrationID

func NewPartnerRegistrationID(subscriptionId string, resourceGroupName string, partnerRegistrationName string) PartnerRegistrationId

NewPartnerRegistrationID returns a new PartnerRegistrationId struct

func ParsePartnerRegistrationID

func ParsePartnerRegistrationID(input string) (*PartnerRegistrationId, error)

ParsePartnerRegistrationID parses 'input' into a PartnerRegistrationId

func ParsePartnerRegistrationIDInsensitively

func ParsePartnerRegistrationIDInsensitively(input string) (*PartnerRegistrationId, error)

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

func (*PartnerRegistrationId) FromParseResult

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

func (PartnerRegistrationId) ID

func (id PartnerRegistrationId) ID() string

ID returns the formatted Partner Registration ID

func (PartnerRegistrationId) Segments

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

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

func (PartnerRegistrationId) String

func (id PartnerRegistrationId) String() string

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

type PartnerRegistrationOperationPredicate

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

func (PartnerRegistrationOperationPredicate) Matches

type PartnerRegistrationProperties

type PartnerRegistrationProperties struct {
	PartnerRegistrationImmutableId *string                               `json:"partnerRegistrationImmutableId,omitempty"`
	ProvisioningState              *PartnerRegistrationProvisioningState `json:"provisioningState,omitempty"`
}

type PartnerRegistrationProvisioningState

type PartnerRegistrationProvisioningState string
const (
	PartnerRegistrationProvisioningStateCanceled  PartnerRegistrationProvisioningState = "Canceled"
	PartnerRegistrationProvisioningStateCreating  PartnerRegistrationProvisioningState = "Creating"
	PartnerRegistrationProvisioningStateDeleting  PartnerRegistrationProvisioningState = "Deleting"
	PartnerRegistrationProvisioningStateFailed    PartnerRegistrationProvisioningState = "Failed"
	PartnerRegistrationProvisioningStateSucceeded PartnerRegistrationProvisioningState = "Succeeded"
	PartnerRegistrationProvisioningStateUpdating  PartnerRegistrationProvisioningState = "Updating"
)

func (*PartnerRegistrationProvisioningState) UnmarshalJSON

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

type PartnerRegistrationUpdateParameters

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

type PartnerRegistrationsClient

type PartnerRegistrationsClient struct {
	Client *resourcemanager.Client
}

func NewPartnerRegistrationsClientWithBaseURI

func NewPartnerRegistrationsClientWithBaseURI(sdkApi sdkEnv.Api) (*PartnerRegistrationsClient, error)

func (PartnerRegistrationsClient) CreateOrUpdate

CreateOrUpdate ...

func (PartnerRegistrationsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PartnerRegistrationsClient) Delete

Delete ...

func (PartnerRegistrationsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (PartnerRegistrationsClient) Get

Get ...

func (PartnerRegistrationsClient) ListByResourceGroup

ListByResourceGroup ...

func (PartnerRegistrationsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (PartnerRegistrationsClient) ListByResourceGroupCompleteMatchingPredicate

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PartnerRegistrationsClient) ListBySubscription

ListBySubscription ...

func (PartnerRegistrationsClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (PartnerRegistrationsClient) ListBySubscriptionCompleteMatchingPredicate

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PartnerRegistrationsClient) Update

Update ...

func (PartnerRegistrationsClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

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