partnerconfigurations

package
v0.20230815.1145621 Latest Latest
Warning

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

Go to latest
Published: Aug 15, 2023 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2022-06-15/partnerconfigurations Documentation

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

Client Initialization

client := partnerconfigurations.NewPartnerConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PartnerConfigurationsClient.AuthorizePartner

ctx := context.TODO()
id := partnerconfigurations.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 := partnerconfigurations.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 := partnerconfigurations.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 := partnerconfigurations.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 := partnerconfigurations.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

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

Example Usage: PartnerConfigurationsClient.ListBySubscription

ctx := context.TODO()
id := partnerconfigurations.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 := partnerconfigurations.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 := partnerconfigurations.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

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 CreateOrUpdateOperationResponse

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

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

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerConfigurationsListResult
}

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []PartnerConfiguration
}

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        *[]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 (o *Partner) GetAuthorizationExpirationTimeInUtcAsTime() (*time.Time, error)

func (*Partner) SetAuthorizationExpirationTimeInUtcAsTime

func (o *Partner) SetAuthorizationExpirationTimeInUtcAsTime(input time.Time)

type PartnerAuthorization

type PartnerAuthorization struct {
	AuthorizedPartnersList             *[]Partner `json:"authorizedPartnersList,omitempty"`
	DefaultMaximumExpirationTimeInDays *int64     `json:"defaultMaximumExpirationTimeInDays,omitempty"`
}

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

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

AuthorizePartner ...

func (PartnerConfigurationsClient) CreateOrUpdate

CreateOrUpdate ...

func (PartnerConfigurationsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PartnerConfigurationsClient) Delete

Delete ...

func (PartnerConfigurationsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (PartnerConfigurationsClient) Get

Get ...

func (PartnerConfigurationsClient) ListByResourceGroup

ListByResourceGroup ...

func (PartnerConfigurationsClient) ListBySubscription

ListBySubscription ...

func (PartnerConfigurationsClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (PartnerConfigurationsClient) ListBySubscriptionCompleteMatchingPredicate

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PartnerConfigurationsClient) UnauthorizePartner

UnauthorizePartner ...

func (PartnerConfigurationsClient) Update

Update ...

func (PartnerConfigurationsClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type PartnerConfigurationsListResult

type PartnerConfigurationsListResult struct {
	NextLink *string                 `json:"nextLink,omitempty"`
	Value    *[]PartnerConfiguration `json:"value,omitempty"`
}

type UnauthorizePartnerOperationResponse

type UnauthorizePartnerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerConfiguration
}

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

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