README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2023-12-15-preview/partnerconfigurations
Documentation
The partnerconfigurations
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/partnerconfigurations"
Client Initialization
client := partnerconfigurations.NewPartnerConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PartnerConfigurationsClient.AuthorizePartner
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
payload := partnerconfigurations.Partner{
// ...
}
read, err := client.AuthorizePartner(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PartnerConfigurationsClient.CreateOrUpdate
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
payload := partnerconfigurations.PartnerConfiguration{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: PartnerConfigurationsClient.Delete
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: PartnerConfigurationsClient.Get
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
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: PartnerConfigurationsClient.ListByResourceGroup
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: PartnerConfigurationsClient.ListBySubscription
ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// alternatively `client.ListBySubscription(ctx, id, partnerconfigurations.DefaultListBySubscriptionOperationOptions())` can be used to do batched pagination
items, err := client.ListBySubscriptionComplete(ctx, id, partnerconfigurations.DefaultListBySubscriptionOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: PartnerConfigurationsClient.UnauthorizePartner
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
payload := partnerconfigurations.Partner{
// ...
}
read, err := client.UnauthorizePartner(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PartnerConfigurationsClient.Update
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
payload := partnerconfigurations.PartnerConfigurationUpdateParameters{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForPartnerConfigurationProvisioningState() []string
- type AuthorizePartnerOperationResponse
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListByResourceGroupCompleteResult
- type ListByResourceGroupOperationResponse
- type ListBySubscriptionCompleteResult
- type ListBySubscriptionOperationOptions
- type ListBySubscriptionOperationResponse
- type Partner
- type PartnerAuthorization
- type PartnerConfiguration
- type PartnerConfigurationOperationPredicate
- type PartnerConfigurationProperties
- type PartnerConfigurationProvisioningState
- type PartnerConfigurationUpdateParameterProperties
- type PartnerConfigurationUpdateParameters
- type PartnerConfigurationsClient
- func (c PartnerConfigurationsClient) AuthorizePartner(ctx context.Context, id commonids.ResourceGroupId, input Partner) (result AuthorizePartnerOperationResponse, err error)
- func (c PartnerConfigurationsClient) CreateOrUpdate(ctx context.Context, id commonids.ResourceGroupId, input PartnerConfiguration) (result CreateOrUpdateOperationResponse, err error)
- func (c PartnerConfigurationsClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.ResourceGroupId, input PartnerConfiguration) error
- func (c PartnerConfigurationsClient) Delete(ctx context.Context, id commonids.ResourceGroupId) (result DeleteOperationResponse, err error)
- func (c PartnerConfigurationsClient) DeleteThenPoll(ctx context.Context, id commonids.ResourceGroupId) error
- func (c PartnerConfigurationsClient) Get(ctx context.Context, id commonids.ResourceGroupId) (result GetOperationResponse, err error)
- func (c PartnerConfigurationsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
- func (c PartnerConfigurationsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
- func (c PartnerConfigurationsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupCompleteResult, err error)
- func (c PartnerConfigurationsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionOperationResponse, err error)
- func (c PartnerConfigurationsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, ...) (ListBySubscriptionCompleteResult, error)
- func (c PartnerConfigurationsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)
- func (c PartnerConfigurationsClient) UnauthorizePartner(ctx context.Context, id commonids.ResourceGroupId, input Partner) (result UnauthorizePartnerOperationResponse, err error)
- func (c PartnerConfigurationsClient) Update(ctx context.Context, id commonids.ResourceGroupId, ...) (result UpdateOperationResponse, err error)
- func (c PartnerConfigurationsClient) UpdateThenPoll(ctx context.Context, id commonids.ResourceGroupId, ...) error
- type UnauthorizePartnerOperationResponse
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForPartnerConfigurationProvisioningState ¶
func PossibleValuesForPartnerConfigurationProvisioningState() []string
Types ¶
type AuthorizePartnerOperationResponse ¶
type AuthorizePartnerOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PartnerConfiguration }
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PartnerConfiguration }
type ListByResourceGroupCompleteResult ¶
type ListByResourceGroupCompleteResult struct { LatestHttpResponse *http.Response Items []PartnerConfiguration }
type ListByResourceGroupOperationResponse ¶
type ListByResourceGroupOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]PartnerConfiguration }
type ListBySubscriptionCompleteResult ¶
type ListBySubscriptionCompleteResult struct { LatestHttpResponse *http.Response Items []PartnerConfiguration }
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 *[]PartnerConfiguration }
type Partner ¶
type Partner struct { AuthorizationExpirationTimeInUtc *string `json:"authorizationExpirationTimeInUtc,omitempty"` PartnerName *string `json:"partnerName,omitempty"` PartnerRegistrationImmutableId *string `json:"partnerRegistrationImmutableId,omitempty"` }
func (*Partner) GetAuthorizationExpirationTimeInUtcAsTime ¶
func (*Partner) SetAuthorizationExpirationTimeInUtcAsTime ¶
type PartnerAuthorization ¶
type PartnerConfiguration ¶
type PartnerConfiguration struct { Id *string `json:"id,omitempty"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` Properties *PartnerConfigurationProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type PartnerConfigurationOperationPredicate ¶
type PartnerConfigurationOperationPredicate struct { Id *string Location *string Name *string Type *string }
func (PartnerConfigurationOperationPredicate) Matches ¶
func (p PartnerConfigurationOperationPredicate) Matches(input PartnerConfiguration) bool
type PartnerConfigurationProperties ¶
type PartnerConfigurationProperties struct { PartnerAuthorization *PartnerAuthorization `json:"partnerAuthorization,omitempty"` ProvisioningState *PartnerConfigurationProvisioningState `json:"provisioningState,omitempty"` }
type PartnerConfigurationProvisioningState ¶
type PartnerConfigurationProvisioningState string
const ( PartnerConfigurationProvisioningStateCanceled PartnerConfigurationProvisioningState = "Canceled" PartnerConfigurationProvisioningStateCreating PartnerConfigurationProvisioningState = "Creating" PartnerConfigurationProvisioningStateDeleting PartnerConfigurationProvisioningState = "Deleting" PartnerConfigurationProvisioningStateFailed PartnerConfigurationProvisioningState = "Failed" PartnerConfigurationProvisioningStateSucceeded PartnerConfigurationProvisioningState = "Succeeded" PartnerConfigurationProvisioningStateUpdating PartnerConfigurationProvisioningState = "Updating" )
func (*PartnerConfigurationProvisioningState) UnmarshalJSON ¶
func (s *PartnerConfigurationProvisioningState) UnmarshalJSON(bytes []byte) error
type PartnerConfigurationUpdateParameterProperties ¶
type PartnerConfigurationUpdateParameterProperties struct {
DefaultMaximumExpirationTimeInDays *int64 `json:"defaultMaximumExpirationTimeInDays,omitempty"`
}
type PartnerConfigurationUpdateParameters ¶
type PartnerConfigurationUpdateParameters struct { Properties *PartnerConfigurationUpdateParameterProperties `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` }
type PartnerConfigurationsClient ¶
type PartnerConfigurationsClient struct {
Client *resourcemanager.Client
}
func NewPartnerConfigurationsClientWithBaseURI ¶
func NewPartnerConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*PartnerConfigurationsClient, error)
func (PartnerConfigurationsClient) AuthorizePartner ¶
func (c PartnerConfigurationsClient) AuthorizePartner(ctx context.Context, id commonids.ResourceGroupId, input Partner) (result AuthorizePartnerOperationResponse, err error)
AuthorizePartner ...
func (PartnerConfigurationsClient) CreateOrUpdate ¶
func (c PartnerConfigurationsClient) CreateOrUpdate(ctx context.Context, id commonids.ResourceGroupId, input PartnerConfiguration) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (PartnerConfigurationsClient) CreateOrUpdateThenPoll ¶
func (c PartnerConfigurationsClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.ResourceGroupId, input PartnerConfiguration) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (PartnerConfigurationsClient) Delete ¶
func (c PartnerConfigurationsClient) Delete(ctx context.Context, id commonids.ResourceGroupId) (result DeleteOperationResponse, err error)
Delete ...
func (PartnerConfigurationsClient) DeleteThenPoll ¶
func (c PartnerConfigurationsClient) DeleteThenPoll(ctx context.Context, id commonids.ResourceGroupId) error
DeleteThenPoll performs Delete then polls until it's completed
func (PartnerConfigurationsClient) Get ¶
func (c PartnerConfigurationsClient) Get(ctx context.Context, id commonids.ResourceGroupId) (result GetOperationResponse, err error)
Get ...
func (PartnerConfigurationsClient) ListByResourceGroup ¶
func (c PartnerConfigurationsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
ListByResourceGroup ...
func (PartnerConfigurationsClient) ListByResourceGroupComplete ¶
func (c PartnerConfigurationsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
ListByResourceGroupComplete retrieves all the results into a single object
func (PartnerConfigurationsClient) ListByResourceGroupCompleteMatchingPredicate ¶
func (c PartnerConfigurationsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate PartnerConfigurationOperationPredicate) (result ListByResourceGroupCompleteResult, err error)
ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (PartnerConfigurationsClient) ListBySubscription ¶
func (c PartnerConfigurationsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (result ListBySubscriptionOperationResponse, err error)
ListBySubscription ...
func (PartnerConfigurationsClient) ListBySubscriptionComplete ¶
func (c PartnerConfigurationsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (ListBySubscriptionCompleteResult, error)
ListBySubscriptionComplete retrieves all the results into a single object
func (PartnerConfigurationsClient) ListBySubscriptionCompleteMatchingPredicate ¶
func (c PartnerConfigurationsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions, predicate PartnerConfigurationOperationPredicate) (result ListBySubscriptionCompleteResult, err error)
ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (PartnerConfigurationsClient) UnauthorizePartner ¶
func (c PartnerConfigurationsClient) UnauthorizePartner(ctx context.Context, id commonids.ResourceGroupId, input Partner) (result UnauthorizePartnerOperationResponse, err error)
UnauthorizePartner ...
func (PartnerConfigurationsClient) Update ¶
func (c PartnerConfigurationsClient) Update(ctx context.Context, id commonids.ResourceGroupId, input PartnerConfigurationUpdateParameters) (result UpdateOperationResponse, err error)
Update ...
func (PartnerConfigurationsClient) UpdateThenPoll ¶
func (c PartnerConfigurationsClient) UpdateThenPoll(ctx context.Context, id commonids.ResourceGroupId, input PartnerConfigurationUpdateParameters) error
UpdateThenPoll performs Update then polls until it's completed
type UnauthorizePartnerOperationResponse ¶
type UnauthorizePartnerOperationResponse struct {}
type UpdateOperationResponse ¶
Source Files ¶
- client.go
- constants.go
- method_authorizepartner.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_listbyresourcegroup.go
- method_listbysubscription.go
- method_unauthorizepartner.go
- method_update.go
- model_partner.go
- model_partnerauthorization.go
- model_partnerconfiguration.go
- model_partnerconfigurationproperties.go
- model_partnerconfigurationupdateparameterproperties.go
- model_partnerconfigurationupdateparameters.go
- predicates.go
- version.go