README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2022-06-15/partnerregistrations
Documentation
The partnerregistrations
SDK allows for interaction with the Azure Resource Manager Service eventgrid
(API Version 2022-06-15
).
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/2022-06-15/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", "partnerRegistrationValue")
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", "partnerRegistrationValue")
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", "partnerRegistrationValue")
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 := partnerregistrations.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 := partnerregistrations.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", "partnerRegistrationValue")
payload := partnerregistrations.PartnerRegistrationUpdateParameters{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForPartnerRegistrationProvisioningState() []string
- func ValidatePartnerRegistrationID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListByResourceGroupCompleteResult
- type ListByResourceGroupOperationOptions
- type ListByResourceGroupOperationResponse
- type ListBySubscriptionCompleteResult
- type ListBySubscriptionOperationOptions
- type ListBySubscriptionOperationResponse
- type PartnerRegistration
- type PartnerRegistrationId
- type PartnerRegistrationOperationPredicate
- type PartnerRegistrationProperties
- type PartnerRegistrationProvisioningState
- type PartnerRegistrationUpdateParameters
- type PartnerRegistrationsClient
- func (c PartnerRegistrationsClient) CreateOrUpdate(ctx context.Context, id PartnerRegistrationId, input PartnerRegistration) (result CreateOrUpdateOperationResponse, err error)
- func (c PartnerRegistrationsClient) CreateOrUpdateThenPoll(ctx context.Context, id PartnerRegistrationId, input PartnerRegistration) error
- func (c PartnerRegistrationsClient) Delete(ctx context.Context, id PartnerRegistrationId) (result DeleteOperationResponse, err error)
- func (c PartnerRegistrationsClient) DeleteThenPoll(ctx context.Context, id PartnerRegistrationId) error
- func (c PartnerRegistrationsClient) Get(ctx context.Context, id PartnerRegistrationId) (result GetOperationResponse, err error)
- func (c PartnerRegistrationsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupOperationResponse, err error)
- func (c PartnerRegistrationsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, ...) (ListByResourceGroupCompleteResult, error)
- func (c PartnerRegistrationsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupCompleteResult, err error)
- func (c PartnerRegistrationsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionOperationResponse, err error)
- func (c PartnerRegistrationsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, ...) (ListBySubscriptionCompleteResult, error)
- func (c PartnerRegistrationsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)
- func (c PartnerRegistrationsClient) Update(ctx context.Context, id PartnerRegistrationId, ...) (result UpdateOperationResponse, err error)
- func (c PartnerRegistrationsClient) UpdateThenPoll(ctx context.Context, id PartnerRegistrationId, ...) error
- type UpdateOperationResponse
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 DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PartnerRegistration }
type ListByResourceGroupCompleteResult ¶
type ListByResourceGroupCompleteResult struct {
Items []PartnerRegistration
}
type ListByResourceGroupOperationOptions ¶
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 *[]PartnerRegistration }
type ListBySubscriptionCompleteResult ¶
type ListBySubscriptionCompleteResult struct {
Items []PartnerRegistration
}
type ListBySubscriptionOperationOptions ¶
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 *[]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 ¶ added in v0.20231127.1171502
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 ¶
func (p PartnerRegistrationOperationPredicate) Matches(input PartnerRegistration) bool
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 PartnerRegistrationsClient ¶
type PartnerRegistrationsClient struct {
Client *resourcemanager.Client
}
func NewPartnerRegistrationsClientWithBaseURI ¶
func NewPartnerRegistrationsClientWithBaseURI(sdkApi sdkEnv.Api) (*PartnerRegistrationsClient, error)
func (PartnerRegistrationsClient) CreateOrUpdate ¶
func (c PartnerRegistrationsClient) CreateOrUpdate(ctx context.Context, id PartnerRegistrationId, input PartnerRegistration) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (PartnerRegistrationsClient) CreateOrUpdateThenPoll ¶
func (c PartnerRegistrationsClient) CreateOrUpdateThenPoll(ctx context.Context, id PartnerRegistrationId, input PartnerRegistration) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (PartnerRegistrationsClient) Delete ¶
func (c PartnerRegistrationsClient) Delete(ctx context.Context, id PartnerRegistrationId) (result DeleteOperationResponse, err error)
Delete ...
func (PartnerRegistrationsClient) DeleteThenPoll ¶
func (c PartnerRegistrationsClient) DeleteThenPoll(ctx context.Context, id PartnerRegistrationId) error
DeleteThenPoll performs Delete then polls until it's completed
func (PartnerRegistrationsClient) Get ¶
func (c PartnerRegistrationsClient) Get(ctx context.Context, id PartnerRegistrationId) (result GetOperationResponse, err error)
Get ...
func (PartnerRegistrationsClient) ListByResourceGroup ¶
func (c PartnerRegistrationsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (result ListByResourceGroupOperationResponse, err error)
ListByResourceGroup ...
func (PartnerRegistrationsClient) ListByResourceGroupComplete ¶
func (c PartnerRegistrationsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (ListByResourceGroupCompleteResult, error)
ListByResourceGroupComplete retrieves all the results into a single object
func (PartnerRegistrationsClient) ListByResourceGroupCompleteMatchingPredicate ¶
func (c PartnerRegistrationsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions, predicate PartnerRegistrationOperationPredicate) (result ListByResourceGroupCompleteResult, err error)
ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (PartnerRegistrationsClient) ListBySubscription ¶
func (c PartnerRegistrationsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (result ListBySubscriptionOperationResponse, err error)
ListBySubscription ...
func (PartnerRegistrationsClient) ListBySubscriptionComplete ¶
func (c PartnerRegistrationsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (ListBySubscriptionCompleteResult, error)
ListBySubscriptionComplete retrieves all the results into a single object
func (PartnerRegistrationsClient) ListBySubscriptionCompleteMatchingPredicate ¶
func (c PartnerRegistrationsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions, predicate PartnerRegistrationOperationPredicate) (result ListBySubscriptionCompleteResult, err error)
ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (PartnerRegistrationsClient) Update ¶
func (c PartnerRegistrationsClient) Update(ctx context.Context, id PartnerRegistrationId, input PartnerRegistrationUpdateParameters) (result UpdateOperationResponse, err error)
Update ...
func (PartnerRegistrationsClient) UpdateThenPoll ¶
func (c PartnerRegistrationsClient) UpdateThenPoll(ctx context.Context, id PartnerRegistrationId, input PartnerRegistrationUpdateParameters) error
UpdateThenPoll performs Update then polls until it's completed
Source Files ¶
- client.go
- constants.go
- id_partnerregistration.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_listbyresourcegroup.go
- method_listbysubscription.go
- method_update.go
- model_partnerregistration.go
- model_partnerregistrationproperties.go
- model_partnerregistrationupdateparameters.go
- predicates.go
- version.go