armeventgrid

package module
v2.2.0 Latest Latest
Warning

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

 Go to latest Published: Nov 17, 2023 License: MIT Imports: 15 Imported by: 4

README

Azure Event Grid Module for Go

PkgGoDev

The armeventgrid module provides operations for working with Azure Event Grid.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Event Grid module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid/v2

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Event Grid. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Event Grid module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armeventgrid.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armeventgrid.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewPartnerNamespacesClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

More sample code

Major Version Upgrade

Go uses semantic import versioning to ensure a good backward compatibility for modules. For Azure Go management SDK, we usually upgrade module version according to cooresponding service's API version. Regarding it could be a complicated experience for major version upgrade, we will try our best to keep the SDK API stable and release new version in backward compatible way. However, if any unavoidable breaking changes and a new major version releases for SDK modules, you could use these commands under your module folder to upgrade:

go install github.com/icholy/gomajor@latest
gomajor get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute@latest

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Event Grid label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdvancedFilter 

type AdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string
}

AdvancedFilter - This is the base type that represents an advanced filter. To configure an advanced filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsAdvancedFilter, NumberInAdvancedFilter, StringEqualsAdvancedFilter etc. depending on the type of the key based on which you want to filter.

func (*AdvancedFilter) GetAdvancedFilter 

func (a *AdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type AdvancedFilter.

func (AdvancedFilter) MarshalJSON added in v2.1.0 

func (a AdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AdvancedFilter.

func (*AdvancedFilter) UnmarshalJSON added in v2.1.0 

func (a *AdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AdvancedFilter.

type AdvancedFilterClassification 

type AdvancedFilterClassification interface {
	// GetAdvancedFilter returns the AdvancedFilter content of the underlying type.
	GetAdvancedFilter() *AdvancedFilter
}

AdvancedFilterClassification provides polymorphic access to related types. Call the interface's GetAdvancedFilter() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AdvancedFilter, *BoolEqualsAdvancedFilter, *IsNotNullAdvancedFilter, *IsNullOrUndefinedAdvancedFilter, *NumberGreaterThanAdvancedFilter, - *NumberGreaterThanOrEqualsAdvancedFilter, *NumberInAdvancedFilter, *NumberInRangeAdvancedFilter, *NumberLessThanAdvancedFilter, - *NumberLessThanOrEqualsAdvancedFilter, *NumberNotInAdvancedFilter, *NumberNotInRangeAdvancedFilter, *StringBeginsWithAdvancedFilter, - *StringContainsAdvancedFilter, *StringEndsWithAdvancedFilter, *StringInAdvancedFilter, *StringNotBeginsWithAdvancedFilter, - *StringNotContainsAdvancedFilter, *StringNotEndsWithAdvancedFilter, *StringNotInAdvancedFilter

type AdvancedFilterOperatorType 

type AdvancedFilterOperatorType string

AdvancedFilterOperatorType - The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 

const (
	AdvancedFilterOperatorTypeBoolEquals                AdvancedFilterOperatorType = "BoolEquals"
	AdvancedFilterOperatorTypeIsNotNull                 AdvancedFilterOperatorType = "IsNotNull"
	AdvancedFilterOperatorTypeIsNullOrUndefined         AdvancedFilterOperatorType = "IsNullOrUndefined"
	AdvancedFilterOperatorTypeNumberGreaterThan         AdvancedFilterOperatorType = "NumberGreaterThan"
	AdvancedFilterOperatorTypeNumberGreaterThanOrEquals AdvancedFilterOperatorType = "NumberGreaterThanOrEquals"
	AdvancedFilterOperatorTypeNumberIn                  AdvancedFilterOperatorType = "NumberIn"
	AdvancedFilterOperatorTypeNumberInRange             AdvancedFilterOperatorType = "NumberInRange"
	AdvancedFilterOperatorTypeNumberLessThan            AdvancedFilterOperatorType = "NumberLessThan"
	AdvancedFilterOperatorTypeNumberLessThanOrEquals    AdvancedFilterOperatorType = "NumberLessThanOrEquals"
	AdvancedFilterOperatorTypeNumberNotIn               AdvancedFilterOperatorType = "NumberNotIn"
	AdvancedFilterOperatorTypeNumberNotInRange          AdvancedFilterOperatorType = "NumberNotInRange"
	AdvancedFilterOperatorTypeStringBeginsWith          AdvancedFilterOperatorType = "StringBeginsWith"
	AdvancedFilterOperatorTypeStringContains            AdvancedFilterOperatorType = "StringContains"
	AdvancedFilterOperatorTypeStringEndsWith            AdvancedFilterOperatorType = "StringEndsWith"
	AdvancedFilterOperatorTypeStringIn                  AdvancedFilterOperatorType = "StringIn"
	AdvancedFilterOperatorTypeStringNotBeginsWith       AdvancedFilterOperatorType = "StringNotBeginsWith"
	AdvancedFilterOperatorTypeStringNotContains         AdvancedFilterOperatorType = "StringNotContains"
	AdvancedFilterOperatorTypeStringNotEndsWith         AdvancedFilterOperatorType = "StringNotEndsWith"
	AdvancedFilterOperatorTypeStringNotIn               AdvancedFilterOperatorType = "StringNotIn"
)

func PossibleAdvancedFilterOperatorTypeValues 

func PossibleAdvancedFilterOperatorTypeValues() []AdvancedFilterOperatorType

PossibleAdvancedFilterOperatorTypeValues returns the possible values for the AdvancedFilterOperatorType const type.

type AzureFunctionEventSubscriptionDestination 

type AzureFunctionEventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType

	// Azure Function Properties of the event subscription destination.
	Properties *AzureFunctionEventSubscriptionDestinationProperties
}

AzureFunctionEventSubscriptionDestination - Information about the azure function destination for an event subscription.

func (*AzureFunctionEventSubscriptionDestination) GetEventSubscriptionDestination 

func (a *AzureFunctionEventSubscriptionDestination) GetEventSubscriptionDestination() *EventSubscriptionDestination

GetEventSubscriptionDestination implements the EventSubscriptionDestinationClassification interface for type AzureFunctionEventSubscriptionDestination.

func (AzureFunctionEventSubscriptionDestination) MarshalJSON 

func (a AzureFunctionEventSubscriptionDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFunctionEventSubscriptionDestination.

func (*AzureFunctionEventSubscriptionDestination) UnmarshalJSON 

func (a *AzureFunctionEventSubscriptionDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFunctionEventSubscriptionDestination.

type AzureFunctionEventSubscriptionDestinationProperties 

type AzureFunctionEventSubscriptionDestinationProperties struct {
	// Delivery attribute details.
	DeliveryAttributeMappings []DeliveryAttributeMappingClassification

	// Maximum number of events per batch.
	MaxEventsPerBatch *int32

	// Preferred batch size in Kilobytes.
	PreferredBatchSizeInKilobytes *int32

	// The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription.
	ResourceID *string
}

AzureFunctionEventSubscriptionDestinationProperties - The properties that represent the Azure Function destination of an event subscription.

func (AzureFunctionEventSubscriptionDestinationProperties) MarshalJSON 

func (a AzureFunctionEventSubscriptionDestinationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFunctionEventSubscriptionDestinationProperties.

func (*AzureFunctionEventSubscriptionDestinationProperties) UnmarshalJSON 

func (a *AzureFunctionEventSubscriptionDestinationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFunctionEventSubscriptionDestinationProperties.

type BoolEqualsAdvancedFilter 

type BoolEqualsAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The boolean filter value.
	Value *bool
}

BoolEqualsAdvancedFilter - BoolEquals Advanced Filter.

func (*BoolEqualsAdvancedFilter) GetAdvancedFilter 

func (b *BoolEqualsAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type BoolEqualsAdvancedFilter.

func (BoolEqualsAdvancedFilter) MarshalJSON 

func (b BoolEqualsAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BoolEqualsAdvancedFilter.

func (*BoolEqualsAdvancedFilter) UnmarshalJSON 

func (b *BoolEqualsAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BoolEqualsAdvancedFilter.

type Channel 

type Channel struct {
	// Properties of the Channel.
	Properties *ChannelProperties

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to Channel resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

Channel info.

func (Channel) MarshalJSON added in v2.1.0 

func (c Channel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Channel.

func (*Channel) UnmarshalJSON added in v2.1.0 

func (c *Channel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Channel.

type ChannelProperties 

type ChannelProperties struct {
	// The type of the event channel which represents the direction flow of events.
	ChannelType *ChannelType

	// Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel
	// and corresponding partner topic are deleted.
	ExpirationTimeIfNotActivatedUTC *time.Time

	// Context or helpful message that can be used during the approval process by the subscriber.
	MessageForActivation *string

	// This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource
	// corresponding to the channel.
	PartnerTopicInfo *PartnerTopicInfo

	// Provisioning state of the channel.
	ProvisioningState *ChannelProvisioningState

	// The readiness state of the corresponding partner topic.
	ReadinessState *ReadinessState
}

ChannelProperties - Properties of the Channel.

func (ChannelProperties) MarshalJSON 

func (c ChannelProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ChannelProperties.

func (*ChannelProperties) UnmarshalJSON 

func (c *ChannelProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ChannelProperties.

type ChannelProvisioningState 

type ChannelProvisioningState string

ChannelProvisioningState - Provisioning state of the channel. 

const (
	ChannelProvisioningStateCanceled                              ChannelProvisioningState = "Canceled"
	ChannelProvisioningStateCreating                              ChannelProvisioningState = "Creating"
	ChannelProvisioningStateDeleting                              ChannelProvisioningState = "Deleting"
	ChannelProvisioningStateFailed                                ChannelProvisioningState = "Failed"
	ChannelProvisioningStateIdleDueToMirroredPartnerTopicDeletion ChannelProvisioningState = "IdleDueToMirroredPartnerTopicDeletion"
	ChannelProvisioningStateSucceeded                             ChannelProvisioningState = "Succeeded"
	ChannelProvisioningStateUpdating                              ChannelProvisioningState = "Updating"
)

func PossibleChannelProvisioningStateValues 

func PossibleChannelProvisioningStateValues() []ChannelProvisioningState

PossibleChannelProvisioningStateValues returns the possible values for the ChannelProvisioningState const type.

type ChannelType 

type ChannelType string

ChannelType - The type of the event channel which represents the direction flow of events. 

const (
	ChannelTypePartnerTopic ChannelType = "PartnerTopic"
)

func PossibleChannelTypeValues 

func PossibleChannelTypeValues() []ChannelType

PossibleChannelTypeValues returns the possible values for the ChannelType const type.

type ChannelUpdateParameters 

type ChannelUpdateParameters struct {
	// Properties of the channel update parameters.
	Properties *ChannelUpdateParametersProperties
}

ChannelUpdateParameters - Properties of the Channel update.

func (ChannelUpdateParameters) MarshalJSON 

func (c ChannelUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ChannelUpdateParameters.

func (*ChannelUpdateParameters) UnmarshalJSON added in v2.1.0 

func (c *ChannelUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ChannelUpdateParameters.

type ChannelUpdateParametersProperties 

type ChannelUpdateParametersProperties struct {
	// Expiration time of the channel. If this timer expires while the corresponding partner topic or partner destination is never
	// activated, the channel and corresponding partner topic or partner
	// destination are deleted.
	ExpirationTimeIfNotActivatedUTC *time.Time

	// Partner topic properties which can be updated if the channel is of type PartnerTopic.
	PartnerTopicInfo *PartnerUpdateTopicInfo
}

ChannelUpdateParametersProperties - Properties of the channel update parameters.

func (ChannelUpdateParametersProperties) MarshalJSON 

func (c ChannelUpdateParametersProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ChannelUpdateParametersProperties.

func (*ChannelUpdateParametersProperties) UnmarshalJSON 

func (c *ChannelUpdateParametersProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ChannelUpdateParametersProperties.

type ChannelsClient 

type ChannelsClient struct {
	// contains filtered or unexported fields
}

ChannelsClient contains the methods for the Channels group. Don't use this type directly, use NewChannelsClient() instead.

func NewChannelsClient 

func NewChannelsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ChannelsClient, error)

NewChannelsClient creates a new instance of ChannelsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ChannelsClient) BeginDelete 

func (client *ChannelsClient) BeginDelete(ctx context.Context, resourceGroupName string, partnerNamespaceName string, channelName string, options *ChannelsClientBeginDeleteOptions) (*runtime.Poller[ChannelsClientDeleteResponse], error)

BeginDelete - Delete an existing channel. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the partners subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • channelName - Name of the channel.
  • options - ChannelsClientBeginDeleteOptions contains the optional parameters for the ChannelsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Channels_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewChannelsClient().BeginDelete(ctx, "examplerg", "examplePartnerNamespaceName1", "exampleEventChannelName1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*ChannelsClient) CreateOrUpdate 

func (client *ChannelsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, partnerNamespaceName string, channelName string, channelInfo Channel, options *ChannelsClientCreateOrUpdateOptions) (ChannelsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Synchronously creates or updates a new channel with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the partners subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • channelName - Name of the channel.
  • channelInfo - Channel information.
  • options - ChannelsClientCreateOrUpdateOptions contains the optional parameters for the ChannelsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Channels_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewChannelsClient().CreateOrUpdate(ctx, "examplerg", "examplePartnerNamespaceName1", "exampleChannelName1", armeventgrid.Channel{
	Properties: &armeventgrid.ChannelProperties{
		ChannelType:                     to.Ptr(armeventgrid.ChannelTypePartnerTopic),
		ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-21T22:50:25.410Z"); return t }()),
		MessageForActivation:            to.Ptr("Example message to approver"),
		PartnerTopicInfo: &armeventgrid.PartnerTopicInfo{
			Name:                to.Ptr("examplePartnerTopic1"),
			AzureSubscriptionID: to.Ptr("5b4b650e-28b9-4790-b3ab-ddbd88d727c4"),
			ResourceGroupName:   to.Ptr("examplerg2"),
			Source:              to.Ptr("ContosoCorp.Accounts.User1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Channel = armeventgrid.Channel{
// 	Name: to.Ptr("exampleChannelName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerNamespaces/channels"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1/changes/exampleChannelName1"),
// 	Properties: &armeventgrid.ChannelProperties{
// 		ChannelType: to.Ptr(armeventgrid.ChannelTypePartnerTopic),
// 		ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-21T22:50:25.410Z"); return t}()),
// 		MessageForActivation: to.Ptr("Example message to approver"),
// 		PartnerTopicInfo: &armeventgrid.PartnerTopicInfo{
// 			Name: to.Ptr("examplePartnerTopic1"),
// 			AzureSubscriptionID: to.Ptr("5b4b650e-28b9-4790-b3ab-ddbd88d727c4"),
// 			ResourceGroupName: to.Ptr("examplerg2"),
// 			Source: to.Ptr("ContosoCorp.Accounts.User1"),
// 		},
// 	},
// }

Output:

func (*ChannelsClient) Get 

func (client *ChannelsClient) Get(ctx context.Context, resourceGroupName string, partnerNamespaceName string, channelName string, options *ChannelsClientGetOptions) (ChannelsClientGetResponse, error)

Get - Get properties of a channel. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the partners subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • channelName - Name of the channel.
  • options - ChannelsClientGetOptions contains the optional parameters for the ChannelsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Channels_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewChannelsClient().Get(ctx, "examplerg", "examplePartnerNamespaceName1", "exampleChannelName1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Channel = armeventgrid.Channel{
// 	Name: to.Ptr("exampleChannelName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerNamespaces/channels"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1/changes/exampleChannelName1"),
// 	Properties: &armeventgrid.ChannelProperties{
// 		ChannelType: to.Ptr(armeventgrid.ChannelTypePartnerTopic),
// 		ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-21T22:50:25.410Z"); return t}()),
// 		MessageForActivation: to.Ptr("Example message to approver"),
// 		PartnerTopicInfo: &armeventgrid.PartnerTopicInfo{
// 			Name: to.Ptr("examplePartnerTopic1"),
// 			AzureSubscriptionID: to.Ptr("5b4b650e-28b9-4790-b3ab-ddbd88d727c4"),
// 			ResourceGroupName: to.Ptr("examplerg2"),
// 			Source: to.Ptr("ContosoCorp.Accounts.User1"),
// 		},
// 		ProvisioningState: to.Ptr(armeventgrid.ChannelProvisioningStateSucceeded),
// 		ReadinessState: to.Ptr(armeventgrid.ReadinessStateNeverActivated),
// 	},
// }

Output:

func (*ChannelsClient) GetFullURL 

func (client *ChannelsClient) GetFullURL(ctx context.Context, resourceGroupName string, partnerNamespaceName string, channelName string, options *ChannelsClientGetFullURLOptions) (ChannelsClientGetFullURLResponse, error)

GetFullURL - Get the full endpoint URL of a partner destination channel. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the partners subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • channelName - Name of the Channel.
  • options - ChannelsClientGetFullURLOptions contains the optional parameters for the ChannelsClient.GetFullURL method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Channels_GetFullUrl.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewChannelsClient().GetFullURL(ctx, "examplerg", "examplenamespace", "examplechannel", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscriptionFullURL = armeventgrid.EventSubscriptionFullURL{
// 	EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
// }

Output:

func (*ChannelsClient) NewListByPartnerNamespacePager 

func (client *ChannelsClient) NewListByPartnerNamespacePager(resourceGroupName string, partnerNamespaceName string, options *ChannelsClientListByPartnerNamespaceOptions) *runtime.Pager[ChannelsClientListByPartnerNamespaceResponse]

NewListByPartnerNamespacePager - List all the channels in a partner namespace.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the partners subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • options - ChannelsClientListByPartnerNamespaceOptions contains the optional parameters for the ChannelsClient.NewListByPartnerNamespacePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Channels_ListByPartnerNamespace.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewChannelsClient().NewListByPartnerNamespacePager("examplerg", "examplePartnerNamespaceName1", &armeventgrid.ChannelsClientListByPartnerNamespaceOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ChannelsListResult = armeventgrid.ChannelsListResult{
	// 	Value: []*armeventgrid.Channel{
	// 		{
	// 			Name: to.Ptr("exampleChannelName1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerNamespaces/channels"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1/changes/exampleChannelName1"),
	// 			Properties: &armeventgrid.ChannelProperties{
	// 				ChannelType: to.Ptr(armeventgrid.ChannelTypePartnerTopic),
	// 				ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-21T22:50:25.410Z"); return t}()),
	// 				MessageForActivation: to.Ptr("Example message to approver"),
	// 				PartnerTopicInfo: &armeventgrid.PartnerTopicInfo{
	// 					Name: to.Ptr("examplePartnerTopic1"),
	// 					AzureSubscriptionID: to.Ptr("5b4b650e-28b9-4790-b3ab-ddbd88d727c4"),
	// 					ResourceGroupName: to.Ptr("examplerg2"),
	// 					Source: to.Ptr("ContosoCorp.Accounts.User1"),
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.ChannelProvisioningStateSucceeded),
	// 				ReadinessState: to.Ptr(armeventgrid.ReadinessStateNeverActivated),
	// 			},
	// 	}},
	// }
}

Output:

func (*ChannelsClient) Update 

func (client *ChannelsClient) Update(ctx context.Context, resourceGroupName string, partnerNamespaceName string, channelName string, channelUpdateParameters ChannelUpdateParameters, options *ChannelsClientUpdateOptions) (ChannelsClientUpdateResponse, error)

Update - Synchronously updates a channel with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the partners subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • channelName - Name of the channel.
  • channelUpdateParameters - Channel update information.
  • options - ChannelsClientUpdateOptions contains the optional parameters for the ChannelsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Channels_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewChannelsClient().Update(ctx, "examplerg", "examplePartnerNamespaceName1", "exampleChannelName1", armeventgrid.ChannelUpdateParameters{
	Properties: &armeventgrid.ChannelUpdateParametersProperties{
		ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-23T23:06:11.785Z"); return t }()),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

type ChannelsClientBeginDeleteOptions 

type ChannelsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ChannelsClientBeginDeleteOptions contains the optional parameters for the ChannelsClient.BeginDelete method.

type ChannelsClientCreateOrUpdateOptions 

type ChannelsClientCreateOrUpdateOptions struct {
}

ChannelsClientCreateOrUpdateOptions contains the optional parameters for the ChannelsClient.CreateOrUpdate method.

type ChannelsClientCreateOrUpdateResponse 

type ChannelsClientCreateOrUpdateResponse struct {
	// Channel info.
	Channel
}

ChannelsClientCreateOrUpdateResponse contains the response from method ChannelsClient.CreateOrUpdate.

type ChannelsClientDeleteResponse 

type ChannelsClientDeleteResponse struct {
}

ChannelsClientDeleteResponse contains the response from method ChannelsClient.BeginDelete.

type ChannelsClientGetFullURLOptions 

type ChannelsClientGetFullURLOptions struct {
}

ChannelsClientGetFullURLOptions contains the optional parameters for the ChannelsClient.GetFullURL method.

type ChannelsClientGetFullURLResponse 

type ChannelsClientGetFullURLResponse struct {
	// Full endpoint url of an event subscription
	EventSubscriptionFullURL
}

ChannelsClientGetFullURLResponse contains the response from method ChannelsClient.GetFullURL.

type ChannelsClientGetOptions 

type ChannelsClientGetOptions struct {
}

ChannelsClientGetOptions contains the optional parameters for the ChannelsClient.Get method.

type ChannelsClientGetResponse 

type ChannelsClientGetResponse struct {
	// Channel info.
	Channel
}

ChannelsClientGetResponse contains the response from method ChannelsClient.Get.

type ChannelsClientListByPartnerNamespaceOptions 

type ChannelsClientListByPartnerNamespaceOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

ChannelsClientListByPartnerNamespaceOptions contains the optional parameters for the ChannelsClient.NewListByPartnerNamespacePager method.

type ChannelsClientListByPartnerNamespaceResponse 

type ChannelsClientListByPartnerNamespaceResponse struct {
	// Result of the List Channels operation
	ChannelsListResult
}

ChannelsClientListByPartnerNamespaceResponse contains the response from method ChannelsClient.NewListByPartnerNamespacePager.

type ChannelsClientUpdateOptions 

type ChannelsClientUpdateOptions struct {
}

ChannelsClientUpdateOptions contains the optional parameters for the ChannelsClient.Update method.

type ChannelsClientUpdateResponse 

type ChannelsClientUpdateResponse struct {
}

ChannelsClientUpdateResponse contains the response from method ChannelsClient.Update.

type ChannelsListResult 

type ChannelsListResult struct {
	// A link for the next page of channels.
	NextLink *string

	// A collection of Channels.
	Value []*Channel
}

ChannelsListResult - Result of the List Channels operation

func (ChannelsListResult) MarshalJSON added in v2.1.0 

func (c ChannelsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ChannelsListResult.

func (*ChannelsListResult) UnmarshalJSON added in v2.1.0 

func (c *ChannelsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ChannelsListResult.

type ClientFactory added in v2.1.0 

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory added in v2.1.0 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewChannelsClient added in v2.1.0 

func (c *ClientFactory) NewChannelsClient() *ChannelsClient

NewChannelsClient creates a new instance of ChannelsClient.

func (*ClientFactory) NewDomainEventSubscriptionsClient added in v2.1.0 

func (c *ClientFactory) NewDomainEventSubscriptionsClient() *DomainEventSubscriptionsClient

NewDomainEventSubscriptionsClient creates a new instance of DomainEventSubscriptionsClient.

func (*ClientFactory) NewDomainTopicEventSubscriptionsClient added in v2.1.0 

func (c *ClientFactory) NewDomainTopicEventSubscriptionsClient() *DomainTopicEventSubscriptionsClient

NewDomainTopicEventSubscriptionsClient creates a new instance of DomainTopicEventSubscriptionsClient.

func (*ClientFactory) NewDomainTopicsClient added in v2.1.0 

func (c *ClientFactory) NewDomainTopicsClient() *DomainTopicsClient

NewDomainTopicsClient creates a new instance of DomainTopicsClient.

func (*ClientFactory) NewDomainsClient added in v2.1.0 

func (c *ClientFactory) NewDomainsClient() *DomainsClient

NewDomainsClient creates a new instance of DomainsClient.

func (*ClientFactory) NewEventSubscriptionsClient added in v2.1.0 

func (c *ClientFactory) NewEventSubscriptionsClient() *EventSubscriptionsClient

NewEventSubscriptionsClient creates a new instance of EventSubscriptionsClient.

func (*ClientFactory) NewExtensionTopicsClient added in v2.1.0 

func (c *ClientFactory) NewExtensionTopicsClient() *ExtensionTopicsClient

NewExtensionTopicsClient creates a new instance of ExtensionTopicsClient.

func (*ClientFactory) NewOperationsClient added in v2.1.0 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewPartnerConfigurationsClient added in v2.1.0 

func (c *ClientFactory) NewPartnerConfigurationsClient() *PartnerConfigurationsClient

NewPartnerConfigurationsClient creates a new instance of PartnerConfigurationsClient.

func (*ClientFactory) NewPartnerNamespacesClient added in v2.1.0 

func (c *ClientFactory) NewPartnerNamespacesClient() *PartnerNamespacesClient

NewPartnerNamespacesClient creates a new instance of PartnerNamespacesClient.

func (*ClientFactory) NewPartnerRegistrationsClient added in v2.1.0 

func (c *ClientFactory) NewPartnerRegistrationsClient() *PartnerRegistrationsClient

NewPartnerRegistrationsClient creates a new instance of PartnerRegistrationsClient.

func (*ClientFactory) NewPartnerTopicEventSubscriptionsClient added in v2.1.0 

func (c *ClientFactory) NewPartnerTopicEventSubscriptionsClient() *PartnerTopicEventSubscriptionsClient

NewPartnerTopicEventSubscriptionsClient creates a new instance of PartnerTopicEventSubscriptionsClient.

func (*ClientFactory) NewPartnerTopicsClient added in v2.1.0 

func (c *ClientFactory) NewPartnerTopicsClient() *PartnerTopicsClient

NewPartnerTopicsClient creates a new instance of PartnerTopicsClient.

func (*ClientFactory) NewPrivateEndpointConnectionsClient added in v2.1.0 

func (c *ClientFactory) NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient.

func (*ClientFactory) NewPrivateLinkResourcesClient added in v2.1.0 

func (c *ClientFactory) NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient.

func (*ClientFactory) NewSystemTopicEventSubscriptionsClient added in v2.1.0 

func (c *ClientFactory) NewSystemTopicEventSubscriptionsClient() *SystemTopicEventSubscriptionsClient

NewSystemTopicEventSubscriptionsClient creates a new instance of SystemTopicEventSubscriptionsClient.

func (*ClientFactory) NewSystemTopicsClient added in v2.1.0 

func (c *ClientFactory) NewSystemTopicsClient() *SystemTopicsClient

NewSystemTopicsClient creates a new instance of SystemTopicsClient.

func (*ClientFactory) NewTopicEventSubscriptionsClient added in v2.1.0 

func (c *ClientFactory) NewTopicEventSubscriptionsClient() *TopicEventSubscriptionsClient

NewTopicEventSubscriptionsClient creates a new instance of TopicEventSubscriptionsClient.

func (*ClientFactory) NewTopicTypesClient added in v2.1.0 

func (c *ClientFactory) NewTopicTypesClient() *TopicTypesClient

NewTopicTypesClient creates a new instance of TopicTypesClient.

func (*ClientFactory) NewTopicsClient added in v2.1.0 

func (c *ClientFactory) NewTopicsClient() *TopicsClient

NewTopicsClient creates a new instance of TopicsClient.

func (*ClientFactory) NewVerifiedPartnersClient added in v2.1.0 

func (c *ClientFactory) NewVerifiedPartnersClient() *VerifiedPartnersClient

NewVerifiedPartnersClient creates a new instance of VerifiedPartnersClient.

type ConnectionState 

type ConnectionState struct {
	// Actions required (if any).
	ActionsRequired *string

	// Description of the connection state.
	Description *string

	// Status of the connection.
	Status *PersistedConnectionStatus
}

ConnectionState information.

func (ConnectionState) MarshalJSON added in v2.1.0 

func (c ConnectionState) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionState.

func (*ConnectionState) UnmarshalJSON added in v2.1.0 

func (c *ConnectionState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionState.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type DataResidencyBoundary 

type DataResidencyBoundary string

DataResidencyBoundary - Data Residency Boundary of the resource. 

const (
	DataResidencyBoundaryWithinGeopair DataResidencyBoundary = "WithinGeopair"
	DataResidencyBoundaryWithinRegion  DataResidencyBoundary = "WithinRegion"
)

func PossibleDataResidencyBoundaryValues 

func PossibleDataResidencyBoundaryValues() []DataResidencyBoundary

PossibleDataResidencyBoundaryValues returns the possible values for the DataResidencyBoundary const type.

type DeadLetterDestination 

type DeadLetterDestination struct {
	// REQUIRED; Type of the endpoint for the dead letter destination
	EndpointType *DeadLetterEndPointType
}

DeadLetterDestination - Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.

func (*DeadLetterDestination) GetDeadLetterDestination 

func (d *DeadLetterDestination) GetDeadLetterDestination() *DeadLetterDestination

GetDeadLetterDestination implements the DeadLetterDestinationClassification interface for type DeadLetterDestination.

func (DeadLetterDestination) MarshalJSON added in v2.1.0 

func (d DeadLetterDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeadLetterDestination.

func (*DeadLetterDestination) UnmarshalJSON added in v2.1.0 

func (d *DeadLetterDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeadLetterDestination.

type DeadLetterDestinationClassification 

type DeadLetterDestinationClassification interface {
	// GetDeadLetterDestination returns the DeadLetterDestination content of the underlying type.
	GetDeadLetterDestination() *DeadLetterDestination
}

DeadLetterDestinationClassification provides polymorphic access to related types. Call the interface's GetDeadLetterDestination() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DeadLetterDestination, *StorageBlobDeadLetterDestination

type DeadLetterEndPointType 

type DeadLetterEndPointType string

DeadLetterEndPointType - Type of the endpoint for the dead letter destination 

const (
	DeadLetterEndPointTypeStorageBlob DeadLetterEndPointType = "StorageBlob"
)

func PossibleDeadLetterEndPointTypeValues 

func PossibleDeadLetterEndPointTypeValues() []DeadLetterEndPointType

PossibleDeadLetterEndPointTypeValues returns the possible values for the DeadLetterEndPointType const type.

type DeadLetterWithResourceIdentity 

type DeadLetterWithResourceIdentity struct {
	// Information about the destination where events have to be delivered for the event subscription. Uses the managed identity
	// setup on the parent resource (namely, topic or domain) to acquire the
	// authentication tokens being used during delivery / dead-lettering.
	DeadLetterDestination DeadLetterDestinationClassification

	// The identity to use when dead-lettering events.
	Identity *EventSubscriptionIdentity
}

DeadLetterWithResourceIdentity - Information about the deadletter destination with resource identity.

func (DeadLetterWithResourceIdentity) MarshalJSON 

func (d DeadLetterWithResourceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeadLetterWithResourceIdentity.

func (*DeadLetterWithResourceIdentity) UnmarshalJSON 

func (d *DeadLetterWithResourceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeadLetterWithResourceIdentity.

type DeliveryAttributeListResult 

type DeliveryAttributeListResult struct {
	// A collection of DeliveryAttributeMapping
	Value []DeliveryAttributeMappingClassification
}

DeliveryAttributeListResult - Result of the Get delivery attributes operation.

func (DeliveryAttributeListResult) MarshalJSON added in v2.1.0 

func (d DeliveryAttributeListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeliveryAttributeListResult.

func (*DeliveryAttributeListResult) UnmarshalJSON 

func (d *DeliveryAttributeListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeliveryAttributeListResult.

type DeliveryAttributeMapping 

type DeliveryAttributeMapping struct {
	// REQUIRED; Type of the delivery attribute or header name.
	Type *DeliveryAttributeMappingType

	// Name of the delivery attribute or header.
	Name *string
}

DeliveryAttributeMapping - Delivery attribute mapping details.

func (*DeliveryAttributeMapping) GetDeliveryAttributeMapping 

func (d *DeliveryAttributeMapping) GetDeliveryAttributeMapping() *DeliveryAttributeMapping

GetDeliveryAttributeMapping implements the DeliveryAttributeMappingClassification interface for type DeliveryAttributeMapping.

func (DeliveryAttributeMapping) MarshalJSON added in v2.1.0 

func (d DeliveryAttributeMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeliveryAttributeMapping.

func (*DeliveryAttributeMapping) UnmarshalJSON added in v2.1.0 

func (d *DeliveryAttributeMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeliveryAttributeMapping.

type DeliveryAttributeMappingClassification 

type DeliveryAttributeMappingClassification interface {
	// GetDeliveryAttributeMapping returns the DeliveryAttributeMapping content of the underlying type.
	GetDeliveryAttributeMapping() *DeliveryAttributeMapping
}

DeliveryAttributeMappingClassification provides polymorphic access to related types. Call the interface's GetDeliveryAttributeMapping() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DeliveryAttributeMapping, *DynamicDeliveryAttributeMapping, *StaticDeliveryAttributeMapping

type DeliveryAttributeMappingType 

type DeliveryAttributeMappingType string

DeliveryAttributeMappingType - Type of the delivery attribute or header name. 

const (
	DeliveryAttributeMappingTypeDynamic DeliveryAttributeMappingType = "Dynamic"
	DeliveryAttributeMappingTypeStatic  DeliveryAttributeMappingType = "Static"
)

func PossibleDeliveryAttributeMappingTypeValues 

func PossibleDeliveryAttributeMappingTypeValues() []DeliveryAttributeMappingType

PossibleDeliveryAttributeMappingTypeValues returns the possible values for the DeliveryAttributeMappingType const type.

type DeliveryWithResourceIdentity 

type DeliveryWithResourceIdentity struct {
	// Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's
	// identity to acquire the authentication tokens being used during delivery /
	// dead-lettering.
	Destination EventSubscriptionDestinationClassification

	// The identity to use when delivering events.
	Identity *EventSubscriptionIdentity
}

DeliveryWithResourceIdentity - Information about the delivery for an event subscription with resource identity.

func (DeliveryWithResourceIdentity) MarshalJSON 

func (d DeliveryWithResourceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeliveryWithResourceIdentity.

func (*DeliveryWithResourceIdentity) UnmarshalJSON 

func (d *DeliveryWithResourceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeliveryWithResourceIdentity.

type Domain 

type Domain struct {
	// REQUIRED; Location of the resource.
	Location *string

	// Identity information for the Event Grid Domain resource.
	Identity *IdentityInfo

	// Properties of the Event Grid Domain resource.
	Properties *DomainProperties

	// Tags of the resource.
	Tags map[string]*string

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to the Event Grid Domain resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

Domain - EventGrid Domain.

func (Domain) MarshalJSON 

func (d Domain) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Domain.

func (*Domain) UnmarshalJSON added in v2.1.0 

func (d *Domain) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Domain.

type DomainEventSubscriptionsClient 

type DomainEventSubscriptionsClient struct {
	// contains filtered or unexported fields
}

DomainEventSubscriptionsClient contains the methods for the DomainEventSubscriptions group. Don't use this type directly, use NewDomainEventSubscriptionsClient() instead.

func NewDomainEventSubscriptionsClient 

func NewDomainEventSubscriptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DomainEventSubscriptionsClient, error)

NewDomainEventSubscriptionsClient creates a new instance of DomainEventSubscriptionsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DomainEventSubscriptionsClient) BeginCreateOrUpdate 

func (client *DomainEventSubscriptionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, domainName string, eventSubscriptionName string, eventSubscriptionInfo EventSubscription, options *DomainEventSubscriptionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DomainEventSubscriptionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates a new event subscription or updates an existing event subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • eventSubscriptionInfo - Event subscription properties containing the destination and filter information.
  • options - DomainEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the DomainEventSubscriptionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainEventSubscriptions_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleDomain1", "exampleEventSubscriptionName1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
				EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("exampleEventSubscriptionName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/domains/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/eventSubscriptions/exampleEventSubscriptionName1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
// 			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
// 				EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
// 			},
// 		},
// 		EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 		RetryPolicy: &armeventgrid.RetryPolicy{
// 			EventTimeToLiveInMinutes: to.Ptr[int32](1440),
// 			MaxDeliveryAttempts: to.Ptr[int32](30),
// 		},
// 		Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1"),
// 	},
// }

Output:

func (*DomainEventSubscriptionsClient) BeginDelete 

func (client *DomainEventSubscriptionsClient) BeginDelete(ctx context.Context, resourceGroupName string, domainName string, eventSubscriptionName string, options *DomainEventSubscriptionsClientBeginDeleteOptions) (*runtime.Poller[DomainEventSubscriptionsClientDeleteResponse], error)

BeginDelete - Delete an existing event subscription for a domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • eventSubscriptionName - Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - DomainEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the DomainEventSubscriptionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainEventSubscriptions_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainEventSubscriptionsClient().BeginDelete(ctx, "examplerg", "exampleDomain1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DomainEventSubscriptionsClient) BeginUpdate 

func (client *DomainEventSubscriptionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, domainName string, eventSubscriptionName string, eventSubscriptionUpdateParameters EventSubscriptionUpdateParameters, options *DomainEventSubscriptionsClientBeginUpdateOptions) (*runtime.Poller[DomainEventSubscriptionsClientUpdateResponse], error)

BeginUpdate - Update an existing event subscription for a topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • eventSubscriptionName - Name of the event subscription to be updated.
  • eventSubscriptionUpdateParameters - Updated event subscription information.
  • options - DomainEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the DomainEventSubscriptionsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainEventSubscriptions_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainEventSubscriptionsClient().BeginUpdate(ctx, "examplerg", "exampleDomain1", "exampleEventSubscriptionName1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.WebHookEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
		Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
			EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DomainEventSubscriptionsClient) Get 

func (client *DomainEventSubscriptionsClient) Get(ctx context.Context, resourceGroupName string, domainName string, eventSubscriptionName string, options *DomainEventSubscriptionsClientGetOptions) (DomainEventSubscriptionsClientGetResponse, error)

Get - Get properties of an event subscription of a domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the partner topic.
  • eventSubscriptionName - Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - DomainEventSubscriptionsClientGetOptions contains the optional parameters for the DomainEventSubscriptionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainEventSubscriptions_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainEventSubscriptionsClient().Get(ctx, "examplerg", "exampleDomain1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/domains/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
// 			Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
// 				QueueName: to.Ptr("que"),
// 				ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
// 			},
// 		},
// 		EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IncludedEventTypes: []*string{
// 				to.Ptr("Microsoft.Storage.BlobCreated"),
// 				to.Ptr("Microsoft.Storage.BlobDeleted")},
// 				IsSubjectCaseSensitive: to.Ptr(false),
// 				SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 				SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 			},
// 			Labels: []*string{
// 				to.Ptr("label1"),
// 				to.Ptr("label2")},
// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 				RetryPolicy: &armeventgrid.RetryPolicy{
// 					EventTimeToLiveInMinutes: to.Ptr[int32](1440),
// 					MaxDeliveryAttempts: to.Ptr[int32](30),
// 				},
// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1"),
// 			},
// 		}

Output:

func (*DomainEventSubscriptionsClient) GetDeliveryAttributes 

func (client *DomainEventSubscriptionsClient) GetDeliveryAttributes(ctx context.Context, resourceGroupName string, domainName string, eventSubscriptionName string, options *DomainEventSubscriptionsClientGetDeliveryAttributesOptions) (DomainEventSubscriptionsClientGetDeliveryAttributesResponse, error)

GetDeliveryAttributes - Get all delivery attributes for an event subscription for domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - DomainEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the DomainEventSubscriptionsClient.GetDeliveryAttributes method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainEventSubscriptions_GetDeliveryAttributes.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainEventSubscriptionsClient().GetDeliveryAttributes(ctx, "examplerg", "exampleDomain1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeliveryAttributeListResult = armeventgrid.DeliveryAttributeListResult{
// 	Value: []armeventgrid.DeliveryAttributeMappingClassification{
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header1"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 			Properties: &armeventgrid.StaticDeliveryAttributeMappingProperties{
// 				IsSecret: to.Ptr(false),
// 				Value: to.Ptr("NormalValue"),
// 			},
// 		},
// 		&armeventgrid.DynamicDeliveryAttributeMapping{
// 			Name: to.Ptr("header2"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeDynamic),
// 			Properties: &armeventgrid.DynamicDeliveryAttributeMappingProperties{
// 				SourceField: to.Ptr("data.foo"),
// 			},
// 		},
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header3"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 			Properties: &armeventgrid.StaticDeliveryAttributeMappingProperties{
// 				IsSecret: to.Ptr(true),
// 				Value: to.Ptr("mySecretValue"),
// 			},
// 	}},
// }

Output:

func (*DomainEventSubscriptionsClient) GetFullURL 

func (client *DomainEventSubscriptionsClient) GetFullURL(ctx context.Context, resourceGroupName string, domainName string, eventSubscriptionName string, options *DomainEventSubscriptionsClientGetFullURLOptions) (DomainEventSubscriptionsClientGetFullURLResponse, error)

GetFullURL - Get the full endpoint URL for an event subscription for domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - DomainEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the DomainEventSubscriptionsClient.GetFullURL method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainEventSubscriptions_GetFullUrl.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainEventSubscriptionsClient().GetFullURL(ctx, "examplerg", "exampleDomain1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscriptionFullURL = armeventgrid.EventSubscriptionFullURL{
// 	EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
// }

Output:

func (*DomainEventSubscriptionsClient) NewListPager 

func (client *DomainEventSubscriptionsClient) NewListPager(resourceGroupName string, domainName string, options *DomainEventSubscriptionsClientListOptions) *runtime.Pager[DomainEventSubscriptionsClientListResponse]

NewListPager - List all event subscriptions that have been created for a specific topic.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • options - DomainEventSubscriptionsClientListOptions contains the optional parameters for the DomainEventSubscriptionsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainEventSubscriptions_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDomainEventSubscriptionsClient().NewListPager("examplerg", "exampleDomain1", &armeventgrid.DomainEventSubscriptionsClientListOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/domains/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/eventSubscriptions/examplesubscription1"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
	// 					Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
	// 						QueueName: to.Ptr("que"),
	// 						ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
	// 					},
	// 				},
	// 				EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IncludedEventTypes: []*string{
	// 						to.Ptr("Microsoft.Storage.BlobCreated"),
	// 						to.Ptr("Microsoft.Storage.BlobDeleted")},
	// 						IsSubjectCaseSensitive: to.Ptr(false),
	// 						SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 						SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 					},
	// 					Labels: []*string{
	// 						to.Ptr("label1"),
	// 						to.Ptr("label2")},
	// 						ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 						RetryPolicy: &armeventgrid.RetryPolicy{
	// 							EventTimeToLiveInMinutes: to.Ptr[int32](1440),
	// 							MaxDeliveryAttempts: to.Ptr[int32](30),
	// 						},
	// 						Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1"),
	// 					},
	// 			}},
	// 		}
}

Output:

type DomainEventSubscriptionsClientBeginCreateOrUpdateOptions 

type DomainEventSubscriptionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the DomainEventSubscriptionsClient.BeginCreateOrUpdate method.

type DomainEventSubscriptionsClientBeginDeleteOptions 

type DomainEventSubscriptionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the DomainEventSubscriptionsClient.BeginDelete method.

type DomainEventSubscriptionsClientBeginUpdateOptions 

type DomainEventSubscriptionsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the DomainEventSubscriptionsClient.BeginUpdate method.

type DomainEventSubscriptionsClientCreateOrUpdateResponse 

type DomainEventSubscriptionsClientCreateOrUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

DomainEventSubscriptionsClientCreateOrUpdateResponse contains the response from method DomainEventSubscriptionsClient.BeginCreateOrUpdate.

type DomainEventSubscriptionsClientDeleteResponse 

type DomainEventSubscriptionsClientDeleteResponse struct {
}

DomainEventSubscriptionsClientDeleteResponse contains the response from method DomainEventSubscriptionsClient.BeginDelete.

type DomainEventSubscriptionsClientGetDeliveryAttributesOptions 

type DomainEventSubscriptionsClientGetDeliveryAttributesOptions struct {
}

DomainEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the DomainEventSubscriptionsClient.GetDeliveryAttributes method.

type DomainEventSubscriptionsClientGetDeliveryAttributesResponse 

type DomainEventSubscriptionsClientGetDeliveryAttributesResponse struct {
	// Result of the Get delivery attributes operation.
	DeliveryAttributeListResult
}

DomainEventSubscriptionsClientGetDeliveryAttributesResponse contains the response from method DomainEventSubscriptionsClient.GetDeliveryAttributes.

type DomainEventSubscriptionsClientGetFullURLOptions 

type DomainEventSubscriptionsClientGetFullURLOptions struct {
}

DomainEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the DomainEventSubscriptionsClient.GetFullURL method.

type DomainEventSubscriptionsClientGetFullURLResponse 

type DomainEventSubscriptionsClientGetFullURLResponse struct {
	// Full endpoint url of an event subscription
	EventSubscriptionFullURL
}

DomainEventSubscriptionsClientGetFullURLResponse contains the response from method DomainEventSubscriptionsClient.GetFullURL.

type DomainEventSubscriptionsClientGetOptions 

type DomainEventSubscriptionsClientGetOptions struct {
}

DomainEventSubscriptionsClientGetOptions contains the optional parameters for the DomainEventSubscriptionsClient.Get method.

type DomainEventSubscriptionsClientGetResponse 

type DomainEventSubscriptionsClientGetResponse struct {
	// Event Subscription
	EventSubscription
}

DomainEventSubscriptionsClientGetResponse contains the response from method DomainEventSubscriptionsClient.Get.

type DomainEventSubscriptionsClientListOptions 

type DomainEventSubscriptionsClientListOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

DomainEventSubscriptionsClientListOptions contains the optional parameters for the DomainEventSubscriptionsClient.NewListPager method.

type DomainEventSubscriptionsClientListResponse 

type DomainEventSubscriptionsClientListResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

DomainEventSubscriptionsClientListResponse contains the response from method DomainEventSubscriptionsClient.NewListPager.

type DomainEventSubscriptionsClientUpdateResponse 

type DomainEventSubscriptionsClientUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

DomainEventSubscriptionsClientUpdateResponse contains the response from method DomainEventSubscriptionsClient.BeginUpdate.

type DomainProperties 

type DomainProperties struct {
	// This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event
	// Grid Domain resource. In this context, creation of domain topic can be
	// auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property
	// is null or set to true, Event Grid is responsible of automatically creating the
	// domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to
	// false, then creating the first event subscription will require creating a domain
	// topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created,
	// while auto-managed mode provides the flexibility to perform less operations
	// and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain
	// topic on demand if needed.
	AutoCreateTopicWithFirstSubscription *bool

	// This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event
	// Grid Domain resource. In this context, deletion of domain topic can be
	// auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property
	// is set to true, Event Grid is responsible of automatically deleting the domain
	// topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then
	// the user needs to manually delete the domain topic when it is no longer
	// needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode
	// can be used if the user wants full control of when the domain topic needs to be
	// deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the
	// user.
	AutoDeleteTopicWithLastSubscription *bool

	// Data Residency Boundary of the resource.
	DataResidencyBoundary *DataResidencyBoundary

	// This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD
	// token will be used to authenticate if user is allowed to publish to the domain.
	DisableLocalAuth *bool

	// This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess
	// is enabled.
	InboundIPRules []*InboundIPRule

	// This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
	InputSchema *InputSchema

	// Information about the InputSchemaMapping which specified the info about mapping event payload.
	InputSchemaMapping InputSchemaMappingClassification

	// This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific
	// IPs by configuring
	PublicNetworkAccess *PublicNetworkAccess

	// READ-ONLY; Endpoint for the Event Grid Domain Resource which is used for publishing the events.
	Endpoint *string

	// READ-ONLY; Metric resource id for the Event Grid Domain Resource.
	MetricResourceID *string

	// READ-ONLY; List of private endpoint connections.
	PrivateEndpointConnections []*PrivateEndpointConnection

	// READ-ONLY; Provisioning state of the Event Grid Domain Resource.
	ProvisioningState *DomainProvisioningState
}

DomainProperties - Properties of the Event Grid Domain Resource.

func (DomainProperties) MarshalJSON 

func (d DomainProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DomainProperties.

func (*DomainProperties) UnmarshalJSON 

func (d *DomainProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DomainProperties.

type DomainProvisioningState 

type DomainProvisioningState string

DomainProvisioningState - Provisioning state of the Event Grid Domain Resource. 

const (
	DomainProvisioningStateCanceled  DomainProvisioningState = "Canceled"
	DomainProvisioningStateCreating  DomainProvisioningState = "Creating"
	DomainProvisioningStateDeleting  DomainProvisioningState = "Deleting"
	DomainProvisioningStateFailed    DomainProvisioningState = "Failed"
	DomainProvisioningStateSucceeded DomainProvisioningState = "Succeeded"
	DomainProvisioningStateUpdating  DomainProvisioningState = "Updating"
)

func PossibleDomainProvisioningStateValues 

func PossibleDomainProvisioningStateValues() []DomainProvisioningState

PossibleDomainProvisioningStateValues returns the possible values for the DomainProvisioningState const type.

type DomainRegenerateKeyRequest 

type DomainRegenerateKeyRequest struct {
	// REQUIRED; Key name to regenerate key1 or key2.
	KeyName *string
}

DomainRegenerateKeyRequest - Domain regenerate share access key request.

func (DomainRegenerateKeyRequest) MarshalJSON added in v2.1.0 

func (d DomainRegenerateKeyRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DomainRegenerateKeyRequest.

func (*DomainRegenerateKeyRequest) UnmarshalJSON added in v2.1.0 

func (d *DomainRegenerateKeyRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DomainRegenerateKeyRequest.

type DomainSharedAccessKeys 

type DomainSharedAccessKeys struct {
	// Shared access key1 for the domain.
	Key1 *string

	// Shared access key2 for the domain.
	Key2 *string
}

DomainSharedAccessKeys - Shared access keys of the Domain.

func (DomainSharedAccessKeys) MarshalJSON added in v2.1.0 

func (d DomainSharedAccessKeys) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DomainSharedAccessKeys.

func (*DomainSharedAccessKeys) UnmarshalJSON added in v2.1.0 

func (d *DomainSharedAccessKeys) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DomainSharedAccessKeys.

type DomainTopic 

type DomainTopic struct {
	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; Properties of the Domain Topic.
	Properties *DomainTopicProperties

	// READ-ONLY; The system metadata relating to Domain Topic resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

DomainTopic - Domain Topic.

func (DomainTopic) MarshalJSON added in v2.1.0 

func (d DomainTopic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DomainTopic.

func (*DomainTopic) UnmarshalJSON added in v2.1.0 

func (d *DomainTopic) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DomainTopic.

type DomainTopicEventSubscriptionsClient 

type DomainTopicEventSubscriptionsClient struct {
	// contains filtered or unexported fields
}

DomainTopicEventSubscriptionsClient contains the methods for the DomainTopicEventSubscriptions group. Don't use this type directly, use NewDomainTopicEventSubscriptionsClient() instead.

func NewDomainTopicEventSubscriptionsClient 

func NewDomainTopicEventSubscriptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DomainTopicEventSubscriptionsClient, error)

NewDomainTopicEventSubscriptionsClient creates a new instance of DomainTopicEventSubscriptionsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DomainTopicEventSubscriptionsClient) BeginCreateOrUpdate 

func (client *DomainTopicEventSubscriptionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, domainName string, topicName string, eventSubscriptionName string, eventSubscriptionInfo EventSubscription, options *DomainTopicEventSubscriptionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DomainTopicEventSubscriptionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates a new event subscription or updates an existing event subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the top level domain.
  • topicName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • eventSubscriptionInfo - Event subscription properties containing the destination and filter information.
  • options - DomainTopicEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopicEventSubscriptions_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainTopicEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleDomain1", "exampleDomainTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
				EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("exampleEventSubscriptionName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/domains/domainTopics/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/domainTopics/exampleDomainTopic1/eventSubscriptions/exampleEventSubscriptionName1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
// 			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
// 				EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
// 			},
// 		},
// 		EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 		RetryPolicy: &armeventgrid.RetryPolicy{
// 			EventTimeToLiveInMinutes: to.Ptr[int32](1440),
// 			MaxDeliveryAttempts: to.Ptr[int32](30),
// 		},
// 		Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/domainTopics/exampleDomainTopic1"),
// 	},
// }

Output:

func (*DomainTopicEventSubscriptionsClient) BeginDelete 

func (client *DomainTopicEventSubscriptionsClient) BeginDelete(ctx context.Context, resourceGroupName string, domainName string, topicName string, eventSubscriptionName string, options *DomainTopicEventSubscriptionsClientBeginDeleteOptions) (*runtime.Poller[DomainTopicEventSubscriptionsClientDeleteResponse], error)

BeginDelete - Delete a nested existing event subscription for a domain topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the top level domain.
  • topicName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - DomainTopicEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopicEventSubscriptions_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainTopicEventSubscriptionsClient().BeginDelete(ctx, "examplerg", "exampleDomain1", "exampleDomainTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DomainTopicEventSubscriptionsClient) BeginUpdate 

func (client *DomainTopicEventSubscriptionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, domainName string, topicName string, eventSubscriptionName string, eventSubscriptionUpdateParameters EventSubscriptionUpdateParameters, options *DomainTopicEventSubscriptionsClientBeginUpdateOptions) (*runtime.Poller[DomainTopicEventSubscriptionsClientUpdateResponse], error)

BeginUpdate - Update an existing event subscription for a domain topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • topicName - Name of the topic.
  • eventSubscriptionName - Name of the event subscription to be updated.
  • eventSubscriptionUpdateParameters - Updated event subscription information.
  • options - DomainTopicEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopicEventSubscriptions_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainTopicEventSubscriptionsClient().BeginUpdate(ctx, "examplerg", "exampleDomain1", "exampleDomainTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.WebHookEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
		Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
			EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DomainTopicEventSubscriptionsClient) Get 

func (client *DomainTopicEventSubscriptionsClient) Get(ctx context.Context, resourceGroupName string, domainName string, topicName string, eventSubscriptionName string, options *DomainTopicEventSubscriptionsClientGetOptions) (DomainTopicEventSubscriptionsClientGetResponse, error)

Get - Get properties of a nested event subscription for a domain topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the top level domain.
  • topicName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - DomainTopicEventSubscriptionsClientGetOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopicEventSubscriptions_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainTopicEventSubscriptionsClient().Get(ctx, "examplerg", "exampleDomain1", "exampleDomainTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/domains/domainTopics/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/domainTopics/exampleDomainTopic1/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
// 			Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
// 				QueueName: to.Ptr("que"),
// 				ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
// 			},
// 		},
// 		EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IncludedEventTypes: []*string{
// 				to.Ptr("Microsoft.Storage.BlobCreated"),
// 				to.Ptr("Microsoft.Storage.BlobDeleted")},
// 				IsSubjectCaseSensitive: to.Ptr(false),
// 				SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 				SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 			},
// 			Labels: []*string{
// 				to.Ptr("label1"),
// 				to.Ptr("label2")},
// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 				RetryPolicy: &armeventgrid.RetryPolicy{
// 					EventTimeToLiveInMinutes: to.Ptr[int32](1440),
// 					MaxDeliveryAttempts: to.Ptr[int32](30),
// 				},
// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/domainTopics/exampleDomainTopic1"),
// 			},
// 		}

Output:

func (*DomainTopicEventSubscriptionsClient) GetDeliveryAttributes 

func (client *DomainTopicEventSubscriptionsClient) GetDeliveryAttributes(ctx context.Context, resourceGroupName string, domainName string, topicName string, eventSubscriptionName string, options *DomainTopicEventSubscriptionsClientGetDeliveryAttributesOptions) (DomainTopicEventSubscriptionsClientGetDeliveryAttributesResponse, error)

GetDeliveryAttributes - Get all delivery attributes for an event subscription for domain topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the top level domain.
  • topicName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - DomainTopicEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.GetDeliveryAttributes method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopicEventSubscriptions_GetDeliveryAttributes.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainTopicEventSubscriptionsClient().GetDeliveryAttributes(ctx, "examplerg", "exampleDomain1", "exampleDomainTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeliveryAttributeListResult = armeventgrid.DeliveryAttributeListResult{
// 	Value: []armeventgrid.DeliveryAttributeMappingClassification{
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header1"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 			Properties: &armeventgrid.StaticDeliveryAttributeMappingProperties{
// 				IsSecret: to.Ptr(false),
// 				Value: to.Ptr("NormalValue"),
// 			},
// 		},
// 		&armeventgrid.DynamicDeliveryAttributeMapping{
// 			Name: to.Ptr("header2"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeDynamic),
// 			Properties: &armeventgrid.DynamicDeliveryAttributeMappingProperties{
// 				SourceField: to.Ptr("data.foo"),
// 			},
// 		},
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header3"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 			Properties: &armeventgrid.StaticDeliveryAttributeMappingProperties{
// 				IsSecret: to.Ptr(true),
// 				Value: to.Ptr("mySecretValue"),
// 			},
// 	}},
// }

Output:

func (*DomainTopicEventSubscriptionsClient) GetFullURL 

func (client *DomainTopicEventSubscriptionsClient) GetFullURL(ctx context.Context, resourceGroupName string, domainName string, topicName string, eventSubscriptionName string, options *DomainTopicEventSubscriptionsClientGetFullURLOptions) (DomainTopicEventSubscriptionsClientGetFullURLResponse, error)

GetFullURL - Get the full endpoint URL for a nested event subscription for domain topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the top level domain.
  • topicName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - DomainTopicEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.GetFullURL method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopicEventSubscriptions_GetFullUrl.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainTopicEventSubscriptionsClient().GetFullURL(ctx, "examplerg", "exampleDomain1", "exampleDomainTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscriptionFullURL = armeventgrid.EventSubscriptionFullURL{
// 	EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
// }

Output:

func (*DomainTopicEventSubscriptionsClient) NewListPager 

func (client *DomainTopicEventSubscriptionsClient) NewListPager(resourceGroupName string, domainName string, topicName string, options *DomainTopicEventSubscriptionsClientListOptions) *runtime.Pager[DomainTopicEventSubscriptionsClientListResponse]

NewListPager - List all event subscriptions that have been created for a specific domain topic.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the top level domain.
  • topicName - Name of the domain topic.
  • options - DomainTopicEventSubscriptionsClientListOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopicEventSubscriptions_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDomainTopicEventSubscriptionsClient().NewListPager("examplerg", "exampleDomain1", "exampleDomainTopic1", &armeventgrid.DomainTopicEventSubscriptionsClientListOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/domains/domainTopics/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/domainTopics/exampleDomainTopic1/eventSubscriptions/examplesubscription1"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
	// 					Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
	// 						QueueName: to.Ptr("que"),
	// 						ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
	// 					},
	// 				},
	// 				EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IncludedEventTypes: []*string{
	// 						to.Ptr("Microsoft.Storage.BlobCreated"),
	// 						to.Ptr("Microsoft.Storage.BlobDeleted")},
	// 						IsSubjectCaseSensitive: to.Ptr(false),
	// 						SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 						SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 					},
	// 					Labels: []*string{
	// 						to.Ptr("label1"),
	// 						to.Ptr("label2")},
	// 						ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 						RetryPolicy: &armeventgrid.RetryPolicy{
	// 							EventTimeToLiveInMinutes: to.Ptr[int32](1440),
	// 							MaxDeliveryAttempts: to.Ptr[int32](30),
	// 						},
	// 						Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/domainTopics/exampleDomainTopic1"),
	// 					},
	// 			}},
	// 		}
}

Output:

type DomainTopicEventSubscriptionsClientBeginCreateOrUpdateOptions 

type DomainTopicEventSubscriptionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainTopicEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.BeginCreateOrUpdate method.

type DomainTopicEventSubscriptionsClientBeginDeleteOptions 

type DomainTopicEventSubscriptionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainTopicEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.BeginDelete method.

type DomainTopicEventSubscriptionsClientBeginUpdateOptions 

type DomainTopicEventSubscriptionsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainTopicEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.BeginUpdate method.

type DomainTopicEventSubscriptionsClientCreateOrUpdateResponse 

type DomainTopicEventSubscriptionsClientCreateOrUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

DomainTopicEventSubscriptionsClientCreateOrUpdateResponse contains the response from method DomainTopicEventSubscriptionsClient.BeginCreateOrUpdate.

type DomainTopicEventSubscriptionsClientDeleteResponse 

type DomainTopicEventSubscriptionsClientDeleteResponse struct {
}

DomainTopicEventSubscriptionsClientDeleteResponse contains the response from method DomainTopicEventSubscriptionsClient.BeginDelete.

type DomainTopicEventSubscriptionsClientGetDeliveryAttributesOptions 

type DomainTopicEventSubscriptionsClientGetDeliveryAttributesOptions struct {
}

DomainTopicEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.GetDeliveryAttributes method.

type DomainTopicEventSubscriptionsClientGetDeliveryAttributesResponse 

type DomainTopicEventSubscriptionsClientGetDeliveryAttributesResponse struct {
	// Result of the Get delivery attributes operation.
	DeliveryAttributeListResult
}

DomainTopicEventSubscriptionsClientGetDeliveryAttributesResponse contains the response from method DomainTopicEventSubscriptionsClient.GetDeliveryAttributes.

type DomainTopicEventSubscriptionsClientGetFullURLOptions 

type DomainTopicEventSubscriptionsClientGetFullURLOptions struct {
}

DomainTopicEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.GetFullURL method.

type DomainTopicEventSubscriptionsClientGetFullURLResponse 

type DomainTopicEventSubscriptionsClientGetFullURLResponse struct {
	// Full endpoint url of an event subscription
	EventSubscriptionFullURL
}

DomainTopicEventSubscriptionsClientGetFullURLResponse contains the response from method DomainTopicEventSubscriptionsClient.GetFullURL.

type DomainTopicEventSubscriptionsClientGetOptions 

type DomainTopicEventSubscriptionsClientGetOptions struct {
}

DomainTopicEventSubscriptionsClientGetOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.Get method.

type DomainTopicEventSubscriptionsClientGetResponse 

type DomainTopicEventSubscriptionsClientGetResponse struct {
	// Event Subscription
	EventSubscription
}

DomainTopicEventSubscriptionsClientGetResponse contains the response from method DomainTopicEventSubscriptionsClient.Get.

type DomainTopicEventSubscriptionsClientListOptions 

type DomainTopicEventSubscriptionsClientListOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

DomainTopicEventSubscriptionsClientListOptions contains the optional parameters for the DomainTopicEventSubscriptionsClient.NewListPager method.

type DomainTopicEventSubscriptionsClientListResponse 

type DomainTopicEventSubscriptionsClientListResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

DomainTopicEventSubscriptionsClientListResponse contains the response from method DomainTopicEventSubscriptionsClient.NewListPager.

type DomainTopicEventSubscriptionsClientUpdateResponse 

type DomainTopicEventSubscriptionsClientUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

DomainTopicEventSubscriptionsClientUpdateResponse contains the response from method DomainTopicEventSubscriptionsClient.BeginUpdate.

type DomainTopicProperties 

type DomainTopicProperties struct {
	// READ-ONLY; Provisioning state of the domain topic.
	ProvisioningState *DomainTopicProvisioningState
}

DomainTopicProperties - Properties of the Domain Topic.

func (DomainTopicProperties) MarshalJSON added in v2.1.0 

func (d DomainTopicProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DomainTopicProperties.

func (*DomainTopicProperties) UnmarshalJSON added in v2.1.0 

func (d *DomainTopicProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DomainTopicProperties.

type DomainTopicProvisioningState 

type DomainTopicProvisioningState string

DomainTopicProvisioningState - Provisioning state of the domain topic. 

const (
	DomainTopicProvisioningStateCanceled  DomainTopicProvisioningState = "Canceled"
	DomainTopicProvisioningStateCreating  DomainTopicProvisioningState = "Creating"
	DomainTopicProvisioningStateDeleting  DomainTopicProvisioningState = "Deleting"
	DomainTopicProvisioningStateFailed    DomainTopicProvisioningState = "Failed"
	DomainTopicProvisioningStateSucceeded DomainTopicProvisioningState = "Succeeded"
	DomainTopicProvisioningStateUpdating  DomainTopicProvisioningState = "Updating"
)

func PossibleDomainTopicProvisioningStateValues 

func PossibleDomainTopicProvisioningStateValues() []DomainTopicProvisioningState

PossibleDomainTopicProvisioningStateValues returns the possible values for the DomainTopicProvisioningState const type.

type DomainTopicsClient 

type DomainTopicsClient struct {
	// contains filtered or unexported fields
}

DomainTopicsClient contains the methods for the DomainTopics group. Don't use this type directly, use NewDomainTopicsClient() instead.

func NewDomainTopicsClient 

func NewDomainTopicsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DomainTopicsClient, error)

NewDomainTopicsClient creates a new instance of DomainTopicsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DomainTopicsClient) BeginCreateOrUpdate 

func (client *DomainTopicsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, domainName string, domainTopicName string, options *DomainTopicsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DomainTopicsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates or updates a new domain topic with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • domainTopicName - Name of the domain topic.
  • options - DomainTopicsClientBeginCreateOrUpdateOptions contains the optional parameters for the DomainTopicsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopics_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainTopicsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampledomain1", "exampledomaintopic1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DomainTopicsClient) BeginDelete 

func (client *DomainTopicsClient) BeginDelete(ctx context.Context, resourceGroupName string, domainName string, domainTopicName string, options *DomainTopicsClientBeginDeleteOptions) (*runtime.Poller[DomainTopicsClientDeleteResponse], error)

BeginDelete - Delete existing domain topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • domainTopicName - Name of the domain topic.
  • options - DomainTopicsClientBeginDeleteOptions contains the optional parameters for the DomainTopicsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopics_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainTopicsClient().BeginDelete(ctx, "examplerg", "exampledomain1", "exampledomaintopic1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DomainTopicsClient) Get 

func (client *DomainTopicsClient) Get(ctx context.Context, resourceGroupName string, domainName string, domainTopicName string, options *DomainTopicsClientGetOptions) (DomainTopicsClientGetResponse, error)

Get - Get properties of a domain topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • domainTopicName - Name of the topic.
  • options - DomainTopicsClientGetOptions contains the optional parameters for the DomainTopicsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopics_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainTopicsClient().Get(ctx, "examplerg", "exampledomain2", "topic1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DomainTopic = armeventgrid.DomainTopic{
// 	Name: to.Ptr("topic1"),
// 	Type: to.Ptr("Microsoft.EventGrid/domains/topics"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2/topics/topic1"),
// 	Properties: &armeventgrid.DomainTopicProperties{
// 		ProvisioningState: to.Ptr(armeventgrid.DomainTopicProvisioningStateSucceeded),
// 	},
// }

Output:

func (*DomainTopicsClient) NewListByDomainPager 

func (client *DomainTopicsClient) NewListByDomainPager(resourceGroupName string, domainName string, options *DomainTopicsClientListByDomainOptions) *runtime.Pager[DomainTopicsClientListByDomainResponse]

NewListByDomainPager - List all the topics in a domain.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Domain name.
  • options - DomainTopicsClientListByDomainOptions contains the optional parameters for the DomainTopicsClient.NewListByDomainPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/DomainTopics_ListByDomain.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDomainTopicsClient().NewListByDomainPager("examplerg", "exampledomain2", &armeventgrid.DomainTopicsClientListByDomainOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DomainTopicsListResult = armeventgrid.DomainTopicsListResult{
	// 	Value: []*armeventgrid.DomainTopic{
	// 		{
	// 			Name: to.Ptr("domainCli100topic1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/domains/topics"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/devexprg/providers/Microsoft.EventGrid/domains/domainCli100/topics/domainCli100topic1"),
	// 			Properties: &armeventgrid.DomainTopicProperties{
	// 				ProvisioningState: to.Ptr(armeventgrid.DomainTopicProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("domainCli100topic2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/domains/topics"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/devexprg/providers/Microsoft.EventGrid/domains/domainCli100/topics/domainCli100topic2"),
	// 			Properties: &armeventgrid.DomainTopicProperties{
	// 				ProvisioningState: to.Ptr(armeventgrid.DomainTopicProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

type DomainTopicsClientBeginCreateOrUpdateOptions 

type DomainTopicsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainTopicsClientBeginCreateOrUpdateOptions contains the optional parameters for the DomainTopicsClient.BeginCreateOrUpdate method.

type DomainTopicsClientBeginDeleteOptions 

type DomainTopicsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainTopicsClientBeginDeleteOptions contains the optional parameters for the DomainTopicsClient.BeginDelete method.

type DomainTopicsClientCreateOrUpdateResponse 

type DomainTopicsClientCreateOrUpdateResponse struct {
	// Domain Topic.
	DomainTopic
}

DomainTopicsClientCreateOrUpdateResponse contains the response from method DomainTopicsClient.BeginCreateOrUpdate.

type DomainTopicsClientDeleteResponse 

type DomainTopicsClientDeleteResponse struct {
}

DomainTopicsClientDeleteResponse contains the response from method DomainTopicsClient.BeginDelete.

type DomainTopicsClientGetOptions 

type DomainTopicsClientGetOptions struct {
}

DomainTopicsClientGetOptions contains the optional parameters for the DomainTopicsClient.Get method.

type DomainTopicsClientGetResponse 

type DomainTopicsClientGetResponse struct {
	// Domain Topic.
	DomainTopic
}

DomainTopicsClientGetResponse contains the response from method DomainTopicsClient.Get.

type DomainTopicsClientListByDomainOptions 

type DomainTopicsClientListByDomainOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

DomainTopicsClientListByDomainOptions contains the optional parameters for the DomainTopicsClient.NewListByDomainPager method.

type DomainTopicsClientListByDomainResponse 

type DomainTopicsClientListByDomainResponse struct {
	// Result of the List Domain Topics operation.
	DomainTopicsListResult
}

DomainTopicsClientListByDomainResponse contains the response from method DomainTopicsClient.NewListByDomainPager.

type DomainTopicsListResult 

type DomainTopicsListResult struct {
	// A link for the next page of domain topics.
	NextLink *string

	// A collection of Domain Topics.
	Value []*DomainTopic
}

DomainTopicsListResult - Result of the List Domain Topics operation.

func (DomainTopicsListResult) MarshalJSON added in v2.1.0 

func (d DomainTopicsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DomainTopicsListResult.

func (*DomainTopicsListResult) UnmarshalJSON added in v2.1.0 

func (d *DomainTopicsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DomainTopicsListResult.

type DomainUpdateParameterProperties 

type DomainUpdateParameterProperties struct {
	// This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event
	// Grid Domain resource. In this context, creation of domain topic can be
	// auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property
	// is null or set to true, Event Grid is responsible of automatically creating the
	// domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to
	// false, then creating the first event subscription will require creating a domain
	// topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created,
	// while auto-managed mode provides the flexibility to perform less operations
	// and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain
	// topic on demand if needed.
	AutoCreateTopicWithFirstSubscription *bool

	// This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event
	// Grid Domain resource. In this context, deletion of domain topic can be
	// auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property
	// is set to true, Event Grid is responsible of automatically deleting the domain
	// topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then
	// the user needs to manually delete the domain topic when it is no longer
	// needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode
	// can be used if the user wants full control of when the domain topic needs to be
	// deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the
	// user.
	AutoDeleteTopicWithLastSubscription *bool

	// The data residency boundary for the domain.
	DataResidencyBoundary *DataResidencyBoundary

	// This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD
	// token will be used to authenticate if user is allowed to publish to the domain.
	DisableLocalAuth *bool

	// This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess
	// is enabled.
	InboundIPRules []*InboundIPRule

	// This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific
	// IPs by configuring
	PublicNetworkAccess *PublicNetworkAccess
}

DomainUpdateParameterProperties - Information of domain update parameter properties.

func (DomainUpdateParameterProperties) MarshalJSON 

func (d DomainUpdateParameterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DomainUpdateParameterProperties.

func (*DomainUpdateParameterProperties) UnmarshalJSON added in v2.1.0 

func (d *DomainUpdateParameterProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DomainUpdateParameterProperties.

type DomainUpdateParameters 

type DomainUpdateParameters struct {
	// Identity information for the resource.
	Identity *IdentityInfo

	// Properties of the resource.
	Properties *DomainUpdateParameterProperties

	// Tags of the domains resource.
	Tags map[string]*string
}

DomainUpdateParameters - Properties of the Domain update.

func (DomainUpdateParameters) MarshalJSON 

func (d DomainUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DomainUpdateParameters.

func (*DomainUpdateParameters) UnmarshalJSON added in v2.1.0 

func (d *DomainUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DomainUpdateParameters.

type DomainsClient 

type DomainsClient struct {
	// contains filtered or unexported fields
}

DomainsClient contains the methods for the Domains group. Don't use this type directly, use NewDomainsClient() instead.

func NewDomainsClient 

func NewDomainsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DomainsClient, error)

NewDomainsClient creates a new instance of DomainsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DomainsClient) BeginCreateOrUpdate 

func (client *DomainsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, domainName string, domainInfo Domain, options *DomainsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DomainsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates or updates a new domain with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • domainInfo - Domain information.
  • options - DomainsClientBeginCreateOrUpdateOptions contains the optional parameters for the DomainsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampledomain1", armeventgrid.Domain{
	Location: to.Ptr("westus2"),
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
	Properties: &armeventgrid.DomainProperties{
		InboundIPRules: []*armeventgrid.InboundIPRule{
			{
				Action: to.Ptr(armeventgrid.IPActionTypeAllow),
				IPMask: to.Ptr("12.18.30.15"),
			},
			{
				Action: to.Ptr(armeventgrid.IPActionTypeAllow),
				IPMask: to.Ptr("12.18.176.1"),
			}},
		PublicNetworkAccess: to.Ptr(armeventgrid.PublicNetworkAccessEnabled),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DomainsClient) BeginDelete 

func (client *DomainsClient) BeginDelete(ctx context.Context, resourceGroupName string, domainName string, options *DomainsClientBeginDeleteOptions) (*runtime.Poller[DomainsClientDeleteResponse], error)

BeginDelete - Delete existing domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • options - DomainsClientBeginDeleteOptions contains the optional parameters for the DomainsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainsClient().BeginDelete(ctx, "examplerg", "exampledomain1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DomainsClient) BeginUpdate 

func (client *DomainsClient) BeginUpdate(ctx context.Context, resourceGroupName string, domainName string, domainUpdateParameters DomainUpdateParameters, options *DomainsClientBeginUpdateOptions) (*runtime.Poller[DomainsClientUpdateResponse], error)

BeginUpdate - Asynchronously updates a domain with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • domainUpdateParameters - Domain update information.
  • options - DomainsClientBeginUpdateOptions contains the optional parameters for the DomainsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDomainsClient().BeginUpdate(ctx, "examplerg", "exampledomain1", armeventgrid.DomainUpdateParameters{
	Properties: &armeventgrid.DomainUpdateParameterProperties{
		InboundIPRules: []*armeventgrid.InboundIPRule{
			{
				Action: to.Ptr(armeventgrid.IPActionTypeAllow),
				IPMask: to.Ptr("12.18.30.15"),
			},
			{
				Action: to.Ptr(armeventgrid.IPActionTypeAllow),
				IPMask: to.Ptr("12.18.176.1"),
			}},
		PublicNetworkAccess: to.Ptr(armeventgrid.PublicNetworkAccessEnabled),
	},
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DomainsClient) Get 

func (client *DomainsClient) Get(ctx context.Context, resourceGroupName string, domainName string, options *DomainsClientGetOptions) (DomainsClientGetResponse, error)

Get - Get properties of a domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • options - DomainsClientGetOptions contains the optional parameters for the DomainsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainsClient().Get(ctx, "examplerg", "exampledomain2", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Domain = armeventgrid.Domain{
// 	Name: to.Ptr("exampledomain2"),
// 	Type: to.Ptr("Microsoft.EventGrid/domains"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2"),
// 	Location: to.Ptr("westcentralus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armeventgrid.DomainProperties{
// 		Endpoint: to.Ptr("https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events"),
// 		ProvisioningState: to.Ptr(armeventgrid.DomainProvisioningStateSucceeded),
// 	},
// }

Output:

func (*DomainsClient) ListSharedAccessKeys 

func (client *DomainsClient) ListSharedAccessKeys(ctx context.Context, resourceGroupName string, domainName string, options *DomainsClientListSharedAccessKeysOptions) (DomainsClientListSharedAccessKeysResponse, error)

ListSharedAccessKeys - List the two keys used to publish to a domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • options - DomainsClientListSharedAccessKeysOptions contains the optional parameters for the DomainsClient.ListSharedAccessKeys method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_ListSharedAccessKeys.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainsClient().ListSharedAccessKeys(ctx, "examplerg", "exampledomain2", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DomainSharedAccessKeys = armeventgrid.DomainSharedAccessKeys{
// 	Key1: to.Ptr("<key1>"),
// 	Key2: to.Ptr("<key2>"),
// }

Output:

func (*DomainsClient) NewListByResourceGroupPager 

func (client *DomainsClient) NewListByResourceGroupPager(resourceGroupName string, options *DomainsClientListByResourceGroupOptions) *runtime.Pager[DomainsClientListByResourceGroupResponse]

NewListByResourceGroupPager - List all the domains under a resource group.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • options - DomainsClientListByResourceGroupOptions contains the optional parameters for the DomainsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_ListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDomainsClient().NewListByResourceGroupPager("examplerg", &armeventgrid.DomainsClientListByResourceGroupOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DomainsListResult = armeventgrid.DomainsListResult{
	// 	Value: []*armeventgrid.Domain{
	// 		{
	// 			Name: to.Ptr("exampledomain1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/domains"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1"),
	// 			Location: to.Ptr("westus2"),
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 			Properties: &armeventgrid.DomainProperties{
	// 				Endpoint: to.Ptr("https://exampledomain1.westus2-1.eventgrid.azure.net/api/events"),
	// 				ProvisioningState: to.Ptr(armeventgrid.DomainProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("exampledomain2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/domains"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2"),
	// 			Location: to.Ptr("westcentralus"),
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 			Properties: &armeventgrid.DomainProperties{
	// 				Endpoint: to.Ptr("https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events"),
	// 				ProvisioningState: to.Ptr(armeventgrid.DomainProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*DomainsClient) NewListBySubscriptionPager 

func (client *DomainsClient) NewListBySubscriptionPager(options *DomainsClientListBySubscriptionOptions) *runtime.Pager[DomainsClientListBySubscriptionResponse]

NewListBySubscriptionPager - List all the domains under an Azure subscription.

Generated from API version 2022-06-15

  • options - DomainsClientListBySubscriptionOptions contains the optional parameters for the DomainsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_ListBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDomainsClient().NewListBySubscriptionPager(&armeventgrid.DomainsClientListBySubscriptionOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DomainsListResult = armeventgrid.DomainsListResult{
	// 	Value: []*armeventgrid.Domain{
	// 		{
	// 			Name: to.Ptr("exampledomain1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/domains"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1"),
	// 			Location: to.Ptr("westus2"),
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 			Properties: &armeventgrid.DomainProperties{
	// 				Endpoint: to.Ptr("https://exampledomain1.westus2-1.eventgrid.azure.net/api/events"),
	// 				ProvisioningState: to.Ptr(armeventgrid.DomainProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("exampledomain2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/domains"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2"),
	// 			Location: to.Ptr("westcentralus"),
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 			Properties: &armeventgrid.DomainProperties{
	// 				Endpoint: to.Ptr("https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events"),
	// 				ProvisioningState: to.Ptr(armeventgrid.DomainProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*DomainsClient) RegenerateKey 

func (client *DomainsClient) RegenerateKey(ctx context.Context, resourceGroupName string, domainName string, regenerateKeyRequest DomainRegenerateKeyRequest, options *DomainsClientRegenerateKeyOptions) (DomainsClientRegenerateKeyResponse, error)

RegenerateKey - Regenerate a shared access key for a domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the domain.
  • regenerateKeyRequest - Request body to regenerate key.
  • options - DomainsClientRegenerateKeyOptions contains the optional parameters for the DomainsClient.RegenerateKey method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_RegenerateKey.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainsClient().RegenerateKey(ctx, "examplerg", "exampledomain2", armeventgrid.DomainRegenerateKeyRequest{
	KeyName: to.Ptr("key1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DomainSharedAccessKeys = armeventgrid.DomainSharedAccessKeys{
// 	Key1: to.Ptr("<key1>"),
// 	Key2: to.Ptr("<key2>"),
// }

Output:

type DomainsClientBeginCreateOrUpdateOptions 

type DomainsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainsClientBeginCreateOrUpdateOptions contains the optional parameters for the DomainsClient.BeginCreateOrUpdate method.

type DomainsClientBeginDeleteOptions 

type DomainsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainsClientBeginDeleteOptions contains the optional parameters for the DomainsClient.BeginDelete method.

type DomainsClientBeginUpdateOptions 

type DomainsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DomainsClientBeginUpdateOptions contains the optional parameters for the DomainsClient.BeginUpdate method.

type DomainsClientCreateOrUpdateResponse 

type DomainsClientCreateOrUpdateResponse struct {
	// EventGrid Domain.
	Domain
}

DomainsClientCreateOrUpdateResponse contains the response from method DomainsClient.BeginCreateOrUpdate.

type DomainsClientDeleteResponse 

type DomainsClientDeleteResponse struct {
}

DomainsClientDeleteResponse contains the response from method DomainsClient.BeginDelete.

type DomainsClientGetOptions 

type DomainsClientGetOptions struct {
}

DomainsClientGetOptions contains the optional parameters for the DomainsClient.Get method.

type DomainsClientGetResponse 

type DomainsClientGetResponse struct {
	// EventGrid Domain.
	Domain
}

DomainsClientGetResponse contains the response from method DomainsClient.Get.

type DomainsClientListByResourceGroupOptions 

type DomainsClientListByResourceGroupOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

DomainsClientListByResourceGroupOptions contains the optional parameters for the DomainsClient.NewListByResourceGroupPager method.

type DomainsClientListByResourceGroupResponse 

type DomainsClientListByResourceGroupResponse struct {
	// Result of the List Domains operation.
	DomainsListResult
}

DomainsClientListByResourceGroupResponse contains the response from method DomainsClient.NewListByResourceGroupPager.

type DomainsClientListBySubscriptionOptions 

type DomainsClientListBySubscriptionOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

DomainsClientListBySubscriptionOptions contains the optional parameters for the DomainsClient.NewListBySubscriptionPager method.

type DomainsClientListBySubscriptionResponse 

type DomainsClientListBySubscriptionResponse struct {
	// Result of the List Domains operation.
	DomainsListResult
}

DomainsClientListBySubscriptionResponse contains the response from method DomainsClient.NewListBySubscriptionPager.

type DomainsClientListSharedAccessKeysOptions 

type DomainsClientListSharedAccessKeysOptions struct {
}

DomainsClientListSharedAccessKeysOptions contains the optional parameters for the DomainsClient.ListSharedAccessKeys method.

type DomainsClientListSharedAccessKeysResponse 

type DomainsClientListSharedAccessKeysResponse struct {
	// Shared access keys of the Domain.
	DomainSharedAccessKeys
}

DomainsClientListSharedAccessKeysResponse contains the response from method DomainsClient.ListSharedAccessKeys.

type DomainsClientRegenerateKeyOptions 

type DomainsClientRegenerateKeyOptions struct {
}

DomainsClientRegenerateKeyOptions contains the optional parameters for the DomainsClient.RegenerateKey method.

type DomainsClientRegenerateKeyResponse 

type DomainsClientRegenerateKeyResponse struct {
	// Shared access keys of the Domain.
	DomainSharedAccessKeys
}

DomainsClientRegenerateKeyResponse contains the response from method DomainsClient.RegenerateKey.

type DomainsClientUpdateResponse 

type DomainsClientUpdateResponse struct {
	// EventGrid Domain.
	Domain
}

DomainsClientUpdateResponse contains the response from method DomainsClient.BeginUpdate.

type DomainsListResult 

type DomainsListResult struct {
	// A link for the next page of domains.
	NextLink *string

	// A collection of Domains.
	Value []*Domain
}

DomainsListResult - Result of the List Domains operation.

func (DomainsListResult) MarshalJSON added in v2.1.0 

func (d DomainsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DomainsListResult.

func (*DomainsListResult) UnmarshalJSON added in v2.1.0 

func (d *DomainsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DomainsListResult.

type DynamicDeliveryAttributeMapping 

type DynamicDeliveryAttributeMapping struct {
	// REQUIRED; Type of the delivery attribute or header name.
	Type *DeliveryAttributeMappingType

	// Name of the delivery attribute or header.
	Name *string

	// Properties of dynamic delivery attribute mapping.
	Properties *DynamicDeliveryAttributeMappingProperties
}

DynamicDeliveryAttributeMapping - Dynamic delivery attribute mapping details.

func (*DynamicDeliveryAttributeMapping) GetDeliveryAttributeMapping 

func (d *DynamicDeliveryAttributeMapping) GetDeliveryAttributeMapping() *DeliveryAttributeMapping

GetDeliveryAttributeMapping implements the DeliveryAttributeMappingClassification interface for type DynamicDeliveryAttributeMapping.

func (DynamicDeliveryAttributeMapping) MarshalJSON 

func (d DynamicDeliveryAttributeMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DynamicDeliveryAttributeMapping.

func (*DynamicDeliveryAttributeMapping) UnmarshalJSON 

func (d *DynamicDeliveryAttributeMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DynamicDeliveryAttributeMapping.

type DynamicDeliveryAttributeMappingProperties 

type DynamicDeliveryAttributeMappingProperties struct {
	// JSON path in the event which contains attribute value.
	SourceField *string
}

DynamicDeliveryAttributeMappingProperties - Properties of dynamic delivery attribute mapping.

func (DynamicDeliveryAttributeMappingProperties) MarshalJSON added in v2.1.0 

func (d DynamicDeliveryAttributeMappingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DynamicDeliveryAttributeMappingProperties.

func (*DynamicDeliveryAttributeMappingProperties) UnmarshalJSON added in v2.1.0 

func (d *DynamicDeliveryAttributeMappingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DynamicDeliveryAttributeMappingProperties.

type EndpointType 

type EndpointType string

EndpointType - Type of the endpoint for the event subscription destination. 

const (
	EndpointTypeAzureFunction    EndpointType = "AzureFunction"
	EndpointTypeEventHub         EndpointType = "EventHub"
	EndpointTypeHybridConnection EndpointType = "HybridConnection"
	EndpointTypeServiceBusQueue  EndpointType = "ServiceBusQueue"
	EndpointTypeServiceBusTopic  EndpointType = "ServiceBusTopic"
	EndpointTypeStorageQueue     EndpointType = "StorageQueue"
	EndpointTypeWebHook          EndpointType = "WebHook"
)

func PossibleEndpointTypeValues 

func PossibleEndpointTypeValues() []EndpointType

PossibleEndpointTypeValues returns the possible values for the EndpointType const type.

type EventDefinitionKind 

type EventDefinitionKind string

EventDefinitionKind - The kind of event type used. 

const (
	EventDefinitionKindInline EventDefinitionKind = "Inline"
)

func PossibleEventDefinitionKindValues 

func PossibleEventDefinitionKindValues() []EventDefinitionKind

PossibleEventDefinitionKindValues returns the possible values for the EventDefinitionKind const type.

type EventDeliverySchema 

type EventDeliverySchema string

EventDeliverySchema - The event delivery schema for the event subscription. 

const (
	EventDeliverySchemaCloudEventSchemaV10 EventDeliverySchema = "CloudEventSchemaV1_0"
	EventDeliverySchemaCustomInputSchema   EventDeliverySchema = "CustomInputSchema"
	EventDeliverySchemaEventGridSchema     EventDeliverySchema = "EventGridSchema"
)

func PossibleEventDeliverySchemaValues 

func PossibleEventDeliverySchemaValues() []EventDeliverySchema

PossibleEventDeliverySchemaValues returns the possible values for the EventDeliverySchema const type.

type EventHubEventSubscriptionDestination 

type EventHubEventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType

	// Event Hub Properties of the event subscription destination.
	Properties *EventHubEventSubscriptionDestinationProperties
}

EventHubEventSubscriptionDestination - Information about the event hub destination for an event subscription.

func (*EventHubEventSubscriptionDestination) GetEventSubscriptionDestination 

func (e *EventHubEventSubscriptionDestination) GetEventSubscriptionDestination() *EventSubscriptionDestination

GetEventSubscriptionDestination implements the EventSubscriptionDestinationClassification interface for type EventHubEventSubscriptionDestination.

func (EventHubEventSubscriptionDestination) MarshalJSON 

func (e EventHubEventSubscriptionDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventHubEventSubscriptionDestination.

func (*EventHubEventSubscriptionDestination) UnmarshalJSON 

func (e *EventHubEventSubscriptionDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubEventSubscriptionDestination.

type EventHubEventSubscriptionDestinationProperties 

type EventHubEventSubscriptionDestinationProperties struct {
	// Delivery attribute details.
	DeliveryAttributeMappings []DeliveryAttributeMappingClassification

	// The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.
	ResourceID *string
}

EventHubEventSubscriptionDestinationProperties - The properties for a event hub destination.

func (EventHubEventSubscriptionDestinationProperties) MarshalJSON 

func (e EventHubEventSubscriptionDestinationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventHubEventSubscriptionDestinationProperties.

func (*EventHubEventSubscriptionDestinationProperties) UnmarshalJSON 

func (e *EventHubEventSubscriptionDestinationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubEventSubscriptionDestinationProperties.

type EventSubscription 

type EventSubscription struct {
	// Properties of the event subscription.
	Properties *EventSubscriptionProperties

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to Event Subscription resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

EventSubscription - Event Subscription

func (EventSubscription) MarshalJSON added in v2.1.0 

func (e EventSubscription) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSubscription.

func (*EventSubscription) UnmarshalJSON added in v2.1.0 

func (e *EventSubscription) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSubscription.

type EventSubscriptionDestination 

type EventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType
}

EventSubscriptionDestination - Information about the destination for an event subscription.

func (*EventSubscriptionDestination) GetEventSubscriptionDestination 

func (e *EventSubscriptionDestination) GetEventSubscriptionDestination() *EventSubscriptionDestination

GetEventSubscriptionDestination implements the EventSubscriptionDestinationClassification interface for type EventSubscriptionDestination.

func (EventSubscriptionDestination) MarshalJSON added in v2.1.0 

func (e EventSubscriptionDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSubscriptionDestination.

func (*EventSubscriptionDestination) UnmarshalJSON added in v2.1.0 

func (e *EventSubscriptionDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSubscriptionDestination.

type EventSubscriptionDestinationClassification 

type EventSubscriptionDestinationClassification interface {
	// GetEventSubscriptionDestination returns the EventSubscriptionDestination content of the underlying type.
	GetEventSubscriptionDestination() *EventSubscriptionDestination
}

EventSubscriptionDestinationClassification provides polymorphic access to related types. Call the interface's GetEventSubscriptionDestination() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureFunctionEventSubscriptionDestination, *EventHubEventSubscriptionDestination, *EventSubscriptionDestination, *HybridConnectionEventSubscriptionDestination, - *ServiceBusQueueEventSubscriptionDestination, *ServiceBusTopicEventSubscriptionDestination, *StorageQueueEventSubscriptionDestination, - *WebHookEventSubscriptionDestination

type EventSubscriptionFilter 

type EventSubscriptionFilter struct {
	// An array of advanced filters that are used for filtering event subscriptions.
	AdvancedFilters []AdvancedFilterClassification

	// Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.
	EnableAdvancedFilteringOnArrays *bool

	// A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default
	// event types, set the IncludedEventTypes to null.
	IncludedEventTypes []*string

	// Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive
	// manner.
	IsSubjectCaseSensitive *bool

	// An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends
	// on the publisher of the events. Wildcard characters are not supported in this
	// path.
	SubjectBeginsWith *string

	// An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are
	// not supported in this path.
	SubjectEndsWith *string
}

EventSubscriptionFilter - Filter for the Event Subscription.

func (EventSubscriptionFilter) MarshalJSON 

func (e EventSubscriptionFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSubscriptionFilter.

func (*EventSubscriptionFilter) UnmarshalJSON 

func (e *EventSubscriptionFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSubscriptionFilter.

type EventSubscriptionFullURL 

type EventSubscriptionFullURL struct {
	// The URL that represents the endpoint of the destination of an event subscription.
	EndpointURL *string
}

EventSubscriptionFullURL - Full endpoint url of an event subscription

func (EventSubscriptionFullURL) MarshalJSON added in v2.1.0 

func (e EventSubscriptionFullURL) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSubscriptionFullURL.

func (*EventSubscriptionFullURL) UnmarshalJSON added in v2.1.0 

func (e *EventSubscriptionFullURL) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSubscriptionFullURL.

type EventSubscriptionIdentity 

type EventSubscriptionIdentity struct {
	// The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity
	// and a set of user-assigned identities. The type 'None' will remove any identity.
	Type *EventSubscriptionIdentityType

	// The user identity associated with the resource.
	UserAssignedIdentity *string
}

EventSubscriptionIdentity - The identity information with the event subscription.

func (EventSubscriptionIdentity) MarshalJSON added in v2.1.0 

func (e EventSubscriptionIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSubscriptionIdentity.

func (*EventSubscriptionIdentity) UnmarshalJSON added in v2.1.0 

func (e *EventSubscriptionIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSubscriptionIdentity.

type EventSubscriptionIdentityType 

type EventSubscriptionIdentityType string

EventSubscriptionIdentityType - The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. 

const (
	EventSubscriptionIdentityTypeSystemAssigned EventSubscriptionIdentityType = "SystemAssigned"
	EventSubscriptionIdentityTypeUserAssigned   EventSubscriptionIdentityType = "UserAssigned"
)

func PossibleEventSubscriptionIdentityTypeValues 

func PossibleEventSubscriptionIdentityTypeValues() []EventSubscriptionIdentityType

PossibleEventSubscriptionIdentityTypeValues returns the possible values for the EventSubscriptionIdentityType const type.

type EventSubscriptionProperties 

type EventSubscriptionProperties struct {
	// The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to
	// the dead letter destination. Uses Azure Event Grid's identity to acquire the
	// authentication tokens being used during delivery / dead-lettering.
	DeadLetterDestination DeadLetterDestinationClassification

	// The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to
	// the dead letter destination. Uses the managed identity setup on the parent
	// resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.
	DeadLetterWithResourceIdentity *DeadLetterWithResourceIdentity

	// Information about the destination where events have to be delivered for the event subscription. Uses the managed identity
	// setup on the parent resource (namely, topic or domain) to acquire the
	// authentication tokens being used during delivery / dead-lettering.
	DeliveryWithResourceIdentity *DeliveryWithResourceIdentity

	// Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's
	// identity to acquire the authentication tokens being used during delivery /
	// dead-lettering.
	Destination EventSubscriptionDestinationClassification

	// The event delivery schema for the event subscription.
	EventDeliverySchema *EventDeliverySchema

	// Expiration time of the event subscription.
	ExpirationTimeUTC *time.Time

	// Information about the filter for the event subscription.
	Filter *EventSubscriptionFilter

	// List of user defined labels.
	Labels []*string

	// The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
	RetryPolicy *RetryPolicy

	// READ-ONLY; Provisioning state of the event subscription.
	ProvisioningState *EventSubscriptionProvisioningState

	// READ-ONLY; Name of the topic of the event subscription.
	Topic *string
}

EventSubscriptionProperties - Properties of the Event Subscription.

func (EventSubscriptionProperties) MarshalJSON 

func (e EventSubscriptionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSubscriptionProperties.

func (*EventSubscriptionProperties) UnmarshalJSON 

func (e *EventSubscriptionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSubscriptionProperties.

type EventSubscriptionProvisioningState 

type EventSubscriptionProvisioningState string

EventSubscriptionProvisioningState - Provisioning state of the event subscription. 

const (
	EventSubscriptionProvisioningStateAwaitingManualAction EventSubscriptionProvisioningState = "AwaitingManualAction"
	EventSubscriptionProvisioningStateCanceled             EventSubscriptionProvisioningState = "Canceled"
	EventSubscriptionProvisioningStateCreating             EventSubscriptionProvisioningState = "Creating"
	EventSubscriptionProvisioningStateDeleting             EventSubscriptionProvisioningState = "Deleting"
	EventSubscriptionProvisioningStateFailed               EventSubscriptionProvisioningState = "Failed"
	EventSubscriptionProvisioningStateSucceeded            EventSubscriptionProvisioningState = "Succeeded"
	EventSubscriptionProvisioningStateUpdating             EventSubscriptionProvisioningState = "Updating"
)

func PossibleEventSubscriptionProvisioningStateValues 

func PossibleEventSubscriptionProvisioningStateValues() []EventSubscriptionProvisioningState

PossibleEventSubscriptionProvisioningStateValues returns the possible values for the EventSubscriptionProvisioningState const type.

type EventSubscriptionUpdateParameters 

type EventSubscriptionUpdateParameters struct {
	// The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to
	// the dead letter destination. Uses Azure Event Grid's identity to acquire the
	// authentication tokens being used during delivery / dead-lettering.
	DeadLetterDestination DeadLetterDestinationClassification

	// The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to
	// the dead letter destination. Uses the managed identity setup on the parent
	// resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering.
	DeadLetterWithResourceIdentity *DeadLetterWithResourceIdentity

	// Information about the destination where events have to be delivered for the event subscription. Uses the managed identity
	// setup on the parent resource (topic / domain) to acquire the authentication
	// tokens being used during delivery / dead-lettering.
	DeliveryWithResourceIdentity *DeliveryWithResourceIdentity

	// Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's
	// identity to acquire the authentication tokens being used during delivery /
	// dead-lettering.
	Destination EventSubscriptionDestinationClassification

	// The event delivery schema for the event subscription.
	EventDeliverySchema *EventDeliverySchema

	// Information about the expiration time for the event subscription.
	ExpirationTimeUTC *time.Time

	// Information about the filter for the event subscription.
	Filter *EventSubscriptionFilter

	// List of user defined labels.
	Labels []*string

	// The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
	RetryPolicy *RetryPolicy
}

EventSubscriptionUpdateParameters - Properties of the Event Subscription update.

func (EventSubscriptionUpdateParameters) MarshalJSON 

func (e EventSubscriptionUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSubscriptionUpdateParameters.

func (*EventSubscriptionUpdateParameters) UnmarshalJSON 

func (e *EventSubscriptionUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSubscriptionUpdateParameters.

type EventSubscriptionsClient 

type EventSubscriptionsClient struct {
	// contains filtered or unexported fields
}

EventSubscriptionsClient contains the methods for the EventSubscriptions group. Don't use this type directly, use NewEventSubscriptionsClient() instead.

func NewEventSubscriptionsClient 

func NewEventSubscriptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*EventSubscriptionsClient, error)

NewEventSubscriptionsClient creates a new instance of EventSubscriptionsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*EventSubscriptionsClient) BeginCreateOrUpdate 

func (client *EventSubscriptionsClient) BeginCreateOrUpdate(ctx context.Context, scope string, eventSubscriptionName string, eventSubscriptionInfo EventSubscription, options *EventSubscriptionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[EventSubscriptionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • scope - The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
  • eventSubscriptionName - Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.
  • eventSubscriptionInfo - Event subscription properties containing the destination and filter information.
  • options - EventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the EventSubscriptionsClient.BeginCreateOrUpdate method.
Example (EventSubscriptionsCreateOrUpdateForCustomTopic)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForCustomTopic.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		Destination: &armeventgrid.EventHubEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeEventHub),
			Properties: &armeventgrid.EventHubEventSubscriptionDestinationProperties{
				ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsCreateOrUpdateForCustomTopicAzureFunctionDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_AzureFunctionDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		DeadLetterDestination: &armeventgrid.StorageBlobDeadLetterDestination{
			EndpointType: to.Ptr(armeventgrid.DeadLetterEndPointTypeStorageBlob),
			Properties: &armeventgrid.StorageBlobDeadLetterDestinationProperties{
				BlobContainerName: to.Ptr("contosocontainer"),
				ResourceID:        to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
			},
		},
		Destination: &armeventgrid.AzureFunctionEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeAzureFunction),
			Properties: &armeventgrid.AzureFunctionEventSubscriptionDestinationProperties{
				ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsCreateOrUpdateForCustomTopicEventHubDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		DeadLetterDestination: &armeventgrid.StorageBlobDeadLetterDestination{
			EndpointType: to.Ptr(armeventgrid.DeadLetterEndPointTypeStorageBlob),
			Properties: &armeventgrid.StorageBlobDeadLetterDestinationProperties{
				BlobContainerName: to.Ptr("contosocontainer"),
				ResourceID:        to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
			},
		},
		Destination: &armeventgrid.EventHubEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeEventHub),
			Properties: &armeventgrid.EventHubEventSubscriptionDestinationProperties{
				ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsCreateOrUpdateForCustomTopicHybridConnectionDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		DeadLetterDestination: &armeventgrid.StorageBlobDeadLetterDestination{
			EndpointType: to.Ptr(armeventgrid.DeadLetterEndPointTypeStorageBlob),
			Properties: &armeventgrid.StorageBlobDeadLetterDestinationProperties{
				BlobContainerName: to.Ptr("contosocontainer"),
				ResourceID:        to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
			},
		},
		Destination: &armeventgrid.HybridConnectionEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeHybridConnection),
			Properties: &armeventgrid.HybridConnectionEventSubscriptionDestinationProperties{
				ResourceID: to.Ptr("/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsCreateOrUpdateForCustomTopicServiceBusQueueDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusQueueDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		DeadLetterDestination: &armeventgrid.StorageBlobDeadLetterDestination{
			EndpointType: to.Ptr(armeventgrid.DeadLetterEndPointTypeStorageBlob),
			Properties: &armeventgrid.StorageBlobDeadLetterDestinationProperties{
				BlobContainerName: to.Ptr("contosocontainer"),
				ResourceID:        to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
			},
		},
		Destination: &armeventgrid.ServiceBusQueueEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeServiceBusQueue),
			Properties: &armeventgrid.ServiceBusQueueEventSubscriptionDestinationProperties{
				ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsCreateOrUpdateForCustomTopicServiceBusTopicDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusTopicDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		DeadLetterDestination: &armeventgrid.StorageBlobDeadLetterDestination{
			EndpointType: to.Ptr(armeventgrid.DeadLetterEndPointTypeStorageBlob),
			Properties: &armeventgrid.StorageBlobDeadLetterDestinationProperties{
				BlobContainerName: to.Ptr("contosocontainer"),
				ResourceID:        to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
			},
		},
		Destination: &armeventgrid.ServiceBusTopicEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeServiceBusTopic),
			Properties: &armeventgrid.ServiceBusTopicEventSubscriptionDestinationProperties{
				ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsCreateOrUpdateForCustomTopicStorageQueueDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		DeadLetterDestination: &armeventgrid.StorageBlobDeadLetterDestination{
			EndpointType: to.Ptr(armeventgrid.DeadLetterEndPointTypeStorageBlob),
			Properties: &armeventgrid.StorageBlobDeadLetterDestinationProperties{
				BlobContainerName: to.Ptr("contosocontainer"),
				ResourceID:        to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
			},
		},
		Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
			Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
				QueueName:  to.Ptr("queue1"),
				ResourceID: to.Ptr("/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsCreateOrUpdateForCustomTopicWebhookDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
				EndpointURL: to.Ptr("https://azurefunctionexample.azurewebsites.net/runtime/webhooks/EventGrid?functionName=EventGridTrigger1&code=PASSWORDCODE"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsCreateOrUpdateForResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", "examplesubscription10", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
				EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsCreateOrUpdateForResourceGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", "examplesubscription2", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
				EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsCreateOrUpdateForSubscription)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_CreateOrUpdateForSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", "examplesubscription3", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
				EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*EventSubscriptionsClient) BeginDelete 

func (client *EventSubscriptionsClient) BeginDelete(ctx context.Context, scope string, eventSubscriptionName string, options *EventSubscriptionsClientBeginDeleteOptions) (*runtime.Poller[EventSubscriptionsClientDeleteResponse], error)

BeginDelete - Delete an existing event subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - EventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the EventSubscriptionsClient.BeginDelete method.
Example (EventSubscriptionsDeleteForCustomTopic)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_DeleteForCustomTopic.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginDelete(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsDeleteForResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_DeleteForResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginDelete(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", "examplesubscription10", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsDeleteForResourceGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_DeleteForResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginDelete(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", "examplesubscription2", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsDeleteForSubscription)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_DeleteForSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginDelete(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", "examplesubscription3", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*EventSubscriptionsClient) BeginUpdate 

func (client *EventSubscriptionsClient) BeginUpdate(ctx context.Context, scope string, eventSubscriptionName string, eventSubscriptionUpdateParameters EventSubscriptionUpdateParameters, options *EventSubscriptionsClientBeginUpdateOptions) (*runtime.Poller[EventSubscriptionsClientUpdateResponse], error)

BeginUpdate - Asynchronously updates an existing event subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • scope - The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
  • eventSubscriptionName - Name of the event subscription to be updated.
  • eventSubscriptionUpdateParameters - Updated event subscription information.
  • options - EventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the EventSubscriptionsClient.BeginUpdate method.
Example (EventSubscriptionsUpdateForCustomTopic)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForCustomTopic.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.WebHookEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
		Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
			EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsUpdateForCustomTopicAzureFunctionDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForCustomTopic_AzureFunctionDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscriptionUpdateParameters{
	DeadLetterDestination: &armeventgrid.StorageBlobDeadLetterDestination{
		EndpointType: to.Ptr(armeventgrid.DeadLetterEndPointTypeStorageBlob),
		Properties: &armeventgrid.StorageBlobDeadLetterDestinationProperties{
			BlobContainerName: to.Ptr("contosocontainer"),
			ResourceID:        to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
		},
	},
	Destination: &armeventgrid.AzureFunctionEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeAzureFunction),
		Properties: &armeventgrid.AzureFunctionEventSubscriptionDestinationProperties{
			ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(false),
		SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
		SubjectEndsWith:        to.Ptr("ExampleSuffix"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsUpdateForCustomTopicEventHubDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForCustomTopic_EventHubDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.EventHubEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeEventHub),
		Properties: &armeventgrid.EventHubEventSubscriptionDestinationProperties{
			ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsUpdateForCustomTopicHybridConnectionDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForCustomTopic_HybridConnectionDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.HybridConnectionEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeHybridConnection),
		Properties: &armeventgrid.HybridConnectionEventSubscriptionDestinationProperties{
			ResourceID: to.Ptr("/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsUpdateForCustomTopicServiceBusQueueDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForCustomTopic_ServiceBusQueueDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscriptionUpdateParameters{
	DeadLetterDestination: &armeventgrid.StorageBlobDeadLetterDestination{
		EndpointType: to.Ptr(armeventgrid.DeadLetterEndPointTypeStorageBlob),
		Properties: &armeventgrid.StorageBlobDeadLetterDestinationProperties{
			BlobContainerName: to.Ptr("contosocontainer"),
			ResourceID:        to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
		},
	},
	Destination: &armeventgrid.ServiceBusQueueEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeServiceBusQueue),
		Properties: &armeventgrid.ServiceBusQueueEventSubscriptionDestinationProperties{
			ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(false),
		SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
		SubjectEndsWith:        to.Ptr("ExampleSuffix"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsUpdateForCustomTopicServiceBusTopicDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForCustomTopic_ServiceBusTopicDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.ServiceBusTopicEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeServiceBusTopic),
		Properties: &armeventgrid.ServiceBusTopicEventSubscriptionDestinationProperties{
			ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsUpdateForCustomTopicStorageQueueDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForCustomTopic_StorageQueueDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", "examplesubscription1", armeventgrid.EventSubscriptionUpdateParameters{
	DeadLetterDestination: &armeventgrid.StorageBlobDeadLetterDestination{
		EndpointType: to.Ptr(armeventgrid.DeadLetterEndPointTypeStorageBlob),
		Properties: &armeventgrid.StorageBlobDeadLetterDestinationProperties{
			BlobContainerName: to.Ptr("contosocontainer"),
			ResourceID:        to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
		},
	},
	Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
		Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
			QueueMessageTimeToLiveInSeconds: to.Ptr[int64](300),
			QueueName:                       to.Ptr("queue1"),
			ResourceID:                      to.Ptr("/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(false),
		SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
		SubjectEndsWith:        to.Ptr("ExampleSuffix"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsUpdateForCustomTopicWebhookDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForCustomTopic_WebhookDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.WebHookEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
		Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
			EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsUpdateForResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", "examplesubscription1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.WebHookEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
		Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
			EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsUpdateForResourceGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", "examplesubscription2", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.EventHubEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeEventHub),
		Properties: &armeventgrid.EventHubEventSubscriptionDestinationProperties{
			ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:
Example (EventSubscriptionsUpdateForSubscription)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_UpdateForSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEventSubscriptionsClient().BeginUpdate(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", "examplesubscription3", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.WebHookEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
		Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
			EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*EventSubscriptionsClient) Get 

func (client *EventSubscriptionsClient) Get(ctx context.Context, scope string, eventSubscriptionName string, options *EventSubscriptionsClientGetOptions) (EventSubscriptionsClientGetResponse, error)

Get - Get properties of an event subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - EventSubscriptionsClientGetOptions contains the optional parameters for the EventSubscriptionsClient.Get method.
Example (EventSubscriptionsGetForCustomTopic)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForCustomTopic.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
// 			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
// 				EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
// 		},
// 	}

Output:
Example (EventSubscriptionsGetForCustomTopicAzureFunctionDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForCustomTopic_AzureFunctionDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.AzureFunctionEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeAzureFunction),
// 			Properties: &armeventgrid.AzureFunctionEventSubscriptionDestinationProperties{
// 				ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
// 		},
// 	}

Output:
Example (EventSubscriptionsGetForCustomTopicEventHubDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForCustomTopic_EventHubDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.EventHubEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeEventHub),
// 			Properties: &armeventgrid.EventHubEventSubscriptionDestinationProperties{
// 				ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
// 		},
// 	}

Output:
Example (EventSubscriptionsGetForCustomTopicHybridConnectionDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForCustomTopic_HybridConnectionDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.HybridConnectionEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeHybridConnection),
// 			Properties: &armeventgrid.HybridConnectionEventSubscriptionDestinationProperties{
// 				ResourceID: to.Ptr("/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
// 		},
// 	}

Output:
Example (EventSubscriptionsGetForCustomTopicServiceBusQueueDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.ServiceBusQueueEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeServiceBusQueue),
// 			Properties: &armeventgrid.ServiceBusQueueEventSubscriptionDestinationProperties{
// 				ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
// 		},
// 	}

Output:
Example (EventSubscriptionsGetForCustomTopicServiceBusTopicDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.ServiceBusTopicEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeServiceBusTopic),
// 			Properties: &armeventgrid.ServiceBusTopicEventSubscriptionDestinationProperties{
// 				ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
// 		},
// 	}

Output:
Example (EventSubscriptionsGetForCustomTopicStorageQueueDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForCustomTopic_StorageQueueDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
// 			Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
// 				QueueMessageTimeToLiveInSeconds: to.Ptr[int64](300),
// 				QueueName: to.Ptr("queue1"),
// 				ResourceID: to.Ptr("/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
// 		},
// 	}

Output:
Example (EventSubscriptionsGetForCustomTopicWebhookDestination)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForCustomTopic_WebhookDestination.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
// 			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
// 				EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
// 		},
// 	}

Output:
Example (EventSubscriptionsGetForResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.EventHubEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeEventHub),
// 			Properties: &armeventgrid.EventHubEventSubscriptionDestinationProperties{
// 				ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"),
// 		},
// 	}

Output:
Example (EventSubscriptionsGetForResourceGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", "examplesubscription2", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription2"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
// 			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
// 				EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"),
// 		},
// 	}

Output:
Example (EventSubscriptionsGetForSubscription)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetForSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", "examplesubscription3", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription3"),
// 	Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
// 			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
// 				EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
// 			},
// 		},
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		Labels: []*string{
// 			to.Ptr("label1"),
// 			to.Ptr("label2")},
// 			ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 			Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"),
// 		},
// 	}

Output:

func (*EventSubscriptionsClient) GetDeliveryAttributes 

func (client *EventSubscriptionsClient) GetDeliveryAttributes(ctx context.Context, scope string, eventSubscriptionName string, options *EventSubscriptionsClientGetDeliveryAttributesOptions) (EventSubscriptionsClientGetDeliveryAttributesResponse, error)

GetDeliveryAttributes - Get all delivery attributes for an event subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - EventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the EventSubscriptionsClient.GetDeliveryAttributes method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetDeliveryAttributes.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().GetDeliveryAttributes(ctx, "aaaaaaaaaaaaaaaaaaaaaaaaa", "aaaaaaaaaaaaaaaaaa", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeliveryAttributeListResult = armeventgrid.DeliveryAttributeListResult{
// 	Value: []armeventgrid.DeliveryAttributeMappingClassification{
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header1"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 		},
// 		&armeventgrid.DynamicDeliveryAttributeMapping{
// 			Name: to.Ptr("header2"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeDynamic),
// 		},
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header3"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 	}},
// }

Output:

func (*EventSubscriptionsClient) GetFullURL 

func (client *EventSubscriptionsClient) GetFullURL(ctx context.Context, scope string, eventSubscriptionName string, options *EventSubscriptionsClientGetFullURLOptions) (EventSubscriptionsClientGetFullURLResponse, error)

GetFullURL - Get the full endpoint URL for an event subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - EventSubscriptionsClientGetFullURLOptions contains the optional parameters for the EventSubscriptionsClient.GetFullURL method.
Example (EventSubscriptionsGetFullUrlForCustomTopic)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetFullUrlForCustomTopic.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().GetFullURL(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscriptionFullURL = armeventgrid.EventSubscriptionFullURL{
// 	EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
// }

Output:
Example (EventSubscriptionsGetFullUrlForResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetFullUrlForResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().GetFullURL(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscriptionFullURL = armeventgrid.EventSubscriptionFullURL{
// 	EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
// }

Output:
Example (EventSubscriptionsGetFullUrlForResourceGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetFullUrlForResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().GetFullURL(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", "examplesubscription2", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscriptionFullURL = armeventgrid.EventSubscriptionFullURL{
// 	EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
// }

Output:
Example (EventSubscriptionsGetFullUrlForSubscription)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_GetFullUrlForSubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEventSubscriptionsClient().GetFullURL(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", "examplesubscription3", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscriptionFullURL = armeventgrid.EventSubscriptionFullURL{
// 	EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
// }

Output:

func (*EventSubscriptionsClient) NewListByDomainTopicPager 

func (client *EventSubscriptionsClient) NewListByDomainTopicPager(resourceGroupName string, domainName string, topicName string, options *EventSubscriptionsClientListByDomainTopicOptions) *runtime.Pager[EventSubscriptionsClientListByDomainTopicResponse]

NewListByDomainTopicPager - List all event subscriptions that have been created for a specific domain topic.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • domainName - Name of the top level domain.
  • topicName - Name of the domain topic.
  • options - EventSubscriptionsClientListByDomainTopicOptions contains the optional parameters for the EventSubscriptionsClient.NewListByDomainTopicPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_ListByDomainTopic.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEventSubscriptionsClient().NewListByDomainTopicPager("examplerg", "domain1", "topic1", &armeventgrid.EventSubscriptionsClientListByDomainTopicOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("examplesubscription2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("examplesubscription3"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				Labels: []*string{
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1"),
	// 			},
	// 	}},
	// }
}

Output:

func (*EventSubscriptionsClient) NewListByResourcePager 

func (client *EventSubscriptionsClient) NewListByResourcePager(resourceGroupName string, providerNamespace string, resourceTypeName string, resourceName string, options *EventSubscriptionsClientListByResourceOptions) *runtime.Pager[EventSubscriptionsClientListByResourceResponse]

NewListByResourcePager - List all event subscriptions that have been created for a specific resource.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • providerNamespace - Namespace of the provider of the topic.
  • resourceTypeName - Name of the resource type.
  • resourceName - Name of the resource.
  • options - EventSubscriptionsClientListByResourceOptions contains the optional parameters for the EventSubscriptionsClient.NewListByResourcePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_ListByResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEventSubscriptionsClient().NewListByResourcePager("examplerg", "Microsoft.EventGrid", "topics", "exampletopic2", &armeventgrid.EventSubscriptionsClientListByResourceOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("examplesubscription2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("examplesubscription3"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				Labels: []*string{
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"),
	// 			},
	// 	}},
	// }
}

Output:

func (*EventSubscriptionsClient) NewListGlobalByResourceGroupForTopicTypePager 

func (client *EventSubscriptionsClient) NewListGlobalByResourceGroupForTopicTypePager(resourceGroupName string, topicTypeName string, options *EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeOptions) *runtime.Pager[EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeResponse]

NewListGlobalByResourceGroupForTopicTypePager - List all global event subscriptions under a resource group for a specific topic type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicTypeName - Name of the topic type.
  • options - EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeOptions contains the optional parameters for the EventSubscriptionsClient.NewListGlobalByResourceGroupForTopicTypePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEventSubscriptionsClient().NewListGlobalByResourceGroupForTopicTypePager("examplerg", "Microsoft.Resources.ResourceGroups", &armeventgrid.EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription3"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 					SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 				},
	// 				Labels: []*string{
	// 					to.Ptr("Finance"),
	// 					to.Ptr("HR")},
	// 					ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 					Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"),
	// 				},
	// 		}},
	// 	}
}

Output:

func (*EventSubscriptionsClient) NewListGlobalByResourceGroupPager 

func (client *EventSubscriptionsClient) NewListGlobalByResourceGroupPager(resourceGroupName string, options *EventSubscriptionsClientListGlobalByResourceGroupOptions) *runtime.Pager[EventSubscriptionsClientListGlobalByResourceGroupResponse]

NewListGlobalByResourceGroupPager - List all global event subscriptions under a specific Azure subscription and resource group.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • options - EventSubscriptionsClientListGlobalByResourceGroupOptions contains the optional parameters for the EventSubscriptionsClient.NewListGlobalByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_ListGlobalByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEventSubscriptionsClient().NewListGlobalByResourceGroupPager("examplerg", &armeventgrid.EventSubscriptionsClientListGlobalByResourceGroupOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("examplesubscription4"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription4"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"),
	// 			},
	// 	}},
	// }
}

Output:

func (*EventSubscriptionsClient) NewListGlobalBySubscriptionForTopicTypePager 

func (client *EventSubscriptionsClient) NewListGlobalBySubscriptionForTopicTypePager(topicTypeName string, options *EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeOptions) *runtime.Pager[EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeResponse]

NewListGlobalBySubscriptionForTopicTypePager - List all global event subscriptions under an Azure subscription for a topic type.

Generated from API version 2022-06-15

  • topicTypeName - Name of the topic type.
  • options - EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeOptions contains the optional parameters for the EventSubscriptionsClient.NewListGlobalBySubscriptionForTopicTypePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEventSubscriptionsClient().NewListGlobalBySubscriptionForTopicTypePager("Microsoft.Resources.Subscriptions", &armeventgrid.EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription3"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 					SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 				},
	// 				Labels: []*string{
	// 					to.Ptr("Finance"),
	// 					to.Ptr("HR")},
	// 					ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 					Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"),
	// 				},
	// 		}},
	// 	}
}

Output:

func (*EventSubscriptionsClient) NewListGlobalBySubscriptionPager 

func (client *EventSubscriptionsClient) NewListGlobalBySubscriptionPager(options *EventSubscriptionsClientListGlobalBySubscriptionOptions) *runtime.Pager[EventSubscriptionsClientListGlobalBySubscriptionResponse]

NewListGlobalBySubscriptionPager - List all aggregated global event subscriptions under a specific Azure subscription.

Generated from API version 2022-06-15

  • options - EventSubscriptionsClientListGlobalBySubscriptionOptions contains the optional parameters for the EventSubscriptionsClient.NewListGlobalBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_ListGlobalBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEventSubscriptionsClient().NewListGlobalBySubscriptionPager(&armeventgrid.EventSubscriptionsClientListGlobalBySubscriptionOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("examplesubscription4"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription4"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"),
	// 			},
	// 	}},
	// }
}

Output:

func (*EventSubscriptionsClient) NewListRegionalByResourceGroupForTopicTypePager 

func (client *EventSubscriptionsClient) NewListRegionalByResourceGroupForTopicTypePager(resourceGroupName string, location string, topicTypeName string, options *EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeOptions) *runtime.Pager[EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeResponse]

NewListRegionalByResourceGroupForTopicTypePager - List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • location - Name of the location.
  • topicTypeName - Name of the topic type.
  • options - EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeOptions contains the optional parameters for the EventSubscriptionsClient.NewListRegionalByResourceGroupForTopicTypePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEventSubscriptionsClient().NewListRegionalByResourceGroupForTopicTypePager("examplerg", "westus2", "Microsoft.EventHub.namespaces", &armeventgrid.EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription10"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 					SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 				},
	// 				Labels: []*string{
	// 					to.Ptr("Finance"),
	// 					to.Ptr("HR")},
	// 					ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 					Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"),
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("examplesubscription11"),
	// 				Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 				ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11"),
	// 				Properties: &armeventgrid.EventSubscriptionProperties{
	// 					Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 						EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 						Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 							EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 						},
	// 					},
	// 					Filter: &armeventgrid.EventSubscriptionFilter{
	// 						IsSubjectCaseSensitive: to.Ptr(false),
	// 						SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 						SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 					},
	// 					Labels: []*string{
	// 						to.Ptr("Finance"),
	// 						to.Ptr("HR")},
	// 						ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 						Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"),
	// 					},
	// 			}},
	// 		}
}

Output:

func (*EventSubscriptionsClient) NewListRegionalByResourceGroupPager 

func (client *EventSubscriptionsClient) NewListRegionalByResourceGroupPager(resourceGroupName string, location string, options *EventSubscriptionsClientListRegionalByResourceGroupOptions) *runtime.Pager[EventSubscriptionsClientListRegionalByResourceGroupResponse]

NewListRegionalByResourceGroupPager - List all event subscriptions from the given location under a specific Azure subscription and resource group.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • location - Name of the location.
  • options - EventSubscriptionsClientListRegionalByResourceGroupOptions contains the optional parameters for the EventSubscriptionsClient.NewListRegionalByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_ListRegionalByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEventSubscriptionsClient().NewListRegionalByResourceGroupPager("examplerg", "westus2", &armeventgrid.EventSubscriptionsClientListRegionalByResourceGroupOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription10"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 					SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 				},
	// 				Labels: []*string{
	// 					to.Ptr("Finance"),
	// 					to.Ptr("HR")},
	// 					ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 					Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"),
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("examplesubscription11"),
	// 				Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 				ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11"),
	// 				Properties: &armeventgrid.EventSubscriptionProperties{
	// 					Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 						EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 						Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 							EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 						},
	// 					},
	// 					Filter: &armeventgrid.EventSubscriptionFilter{
	// 						IsSubjectCaseSensitive: to.Ptr(false),
	// 						SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 						SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 					},
	// 					Labels: []*string{
	// 						to.Ptr("Finance"),
	// 						to.Ptr("HR")},
	// 						ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 						Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"),
	// 					},
	// 			}},
	// 		}
}

Output:

func (*EventSubscriptionsClient) NewListRegionalBySubscriptionForTopicTypePager 

func (client *EventSubscriptionsClient) NewListRegionalBySubscriptionForTopicTypePager(location string, topicTypeName string, options *EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeOptions) *runtime.Pager[EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeResponse]

NewListRegionalBySubscriptionForTopicTypePager - List all event subscriptions from the given location under a specific Azure subscription and topic type.

Generated from API version 2022-06-15

  • location - Name of the location.
  • topicTypeName - Name of the topic type.
  • options - EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeOptions contains the optional parameters for the EventSubscriptionsClient.NewListRegionalBySubscriptionForTopicTypePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEventSubscriptionsClient().NewListRegionalBySubscriptionForTopicTypePager("westus2", "Microsoft.EventHub.namespaces", &armeventgrid.EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription10"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 					Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 						EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 					SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 				},
	// 				Labels: []*string{
	// 					to.Ptr("Finance"),
	// 					to.Ptr("HR")},
	// 					ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 					Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"),
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("examplesubscription11"),
	// 				Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 				ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11"),
	// 				Properties: &armeventgrid.EventSubscriptionProperties{
	// 					Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 						EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 						Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 							EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 						},
	// 					},
	// 					Filter: &armeventgrid.EventSubscriptionFilter{
	// 						IsSubjectCaseSensitive: to.Ptr(false),
	// 						SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 						SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 					},
	// 					Labels: []*string{
	// 						to.Ptr("Finance"),
	// 						to.Ptr("HR")},
	// 						ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 						Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"),
	// 					},
	// 			}},
	// 		}
}

Output:

func (*EventSubscriptionsClient) NewListRegionalBySubscriptionPager 

func (client *EventSubscriptionsClient) NewListRegionalBySubscriptionPager(location string, options *EventSubscriptionsClientListRegionalBySubscriptionOptions) *runtime.Pager[EventSubscriptionsClientListRegionalBySubscriptionResponse]

NewListRegionalBySubscriptionPager - List all event subscriptions from the given location under a specific Azure subscription.

Generated from API version 2022-06-15

  • location - Name of the location.
  • options - EventSubscriptionsClientListRegionalBySubscriptionOptions contains the optional parameters for the EventSubscriptionsClient.NewListRegionalBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/EventSubscriptions_ListRegionalBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEventSubscriptionsClient().NewListRegionalBySubscriptionPager("westus2", &armeventgrid.EventSubscriptionsClientListRegionalBySubscriptionOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription10"),
	// 			Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.EventHubEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeEventHub),
	// 					Properties: &armeventgrid.EventHubEventSubscriptionDestinationProperties{
	// 						ResourceID: to.Ptr("/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"),
	// 					},
	// 				},
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IsSubjectCaseSensitive: to.Ptr(false),
	// 					SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 					SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 				},
	// 				Labels: []*string{
	// 					to.Ptr("Finance"),
	// 					to.Ptr("HR")},
	// 					ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 					Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"),
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("examplesubscription11"),
	// 				Type: to.Ptr("Microsoft.EventGrid/eventSubscriptions"),
	// 				ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11"),
	// 				Properties: &armeventgrid.EventSubscriptionProperties{
	// 					Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 						EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 						Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 							EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 						},
	// 					},
	// 					Filter: &armeventgrid.EventSubscriptionFilter{
	// 						IsSubjectCaseSensitive: to.Ptr(false),
	// 						SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 						SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 					},
	// 					Labels: []*string{
	// 						to.Ptr("Finance"),
	// 						to.Ptr("HR")},
	// 						ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 						Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"),
	// 					},
	// 			}},
	// 		}
}

Output:

type EventSubscriptionsClientBeginCreateOrUpdateOptions 

type EventSubscriptionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

EventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the EventSubscriptionsClient.BeginCreateOrUpdate method.

type EventSubscriptionsClientBeginDeleteOptions 

type EventSubscriptionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

EventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the EventSubscriptionsClient.BeginDelete method.

type EventSubscriptionsClientBeginUpdateOptions 

type EventSubscriptionsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

EventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the EventSubscriptionsClient.BeginUpdate method.

type EventSubscriptionsClientCreateOrUpdateResponse 

type EventSubscriptionsClientCreateOrUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

EventSubscriptionsClientCreateOrUpdateResponse contains the response from method EventSubscriptionsClient.BeginCreateOrUpdate.

type EventSubscriptionsClientDeleteResponse 

type EventSubscriptionsClientDeleteResponse struct {
}

EventSubscriptionsClientDeleteResponse contains the response from method EventSubscriptionsClient.BeginDelete.

type EventSubscriptionsClientGetDeliveryAttributesOptions 

type EventSubscriptionsClientGetDeliveryAttributesOptions struct {
}

EventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the EventSubscriptionsClient.GetDeliveryAttributes method.

type EventSubscriptionsClientGetDeliveryAttributesResponse 

type EventSubscriptionsClientGetDeliveryAttributesResponse struct {
	// Result of the Get delivery attributes operation.
	DeliveryAttributeListResult
}

EventSubscriptionsClientGetDeliveryAttributesResponse contains the response from method EventSubscriptionsClient.GetDeliveryAttributes.

type EventSubscriptionsClientGetFullURLOptions 

type EventSubscriptionsClientGetFullURLOptions struct {
}

EventSubscriptionsClientGetFullURLOptions contains the optional parameters for the EventSubscriptionsClient.GetFullURL method.

type EventSubscriptionsClientGetFullURLResponse 

type EventSubscriptionsClientGetFullURLResponse struct {
	// Full endpoint url of an event subscription
	EventSubscriptionFullURL
}

EventSubscriptionsClientGetFullURLResponse contains the response from method EventSubscriptionsClient.GetFullURL.

type EventSubscriptionsClientGetOptions 

type EventSubscriptionsClientGetOptions struct {
}

EventSubscriptionsClientGetOptions contains the optional parameters for the EventSubscriptionsClient.Get method.

type EventSubscriptionsClientGetResponse 

type EventSubscriptionsClientGetResponse struct {
	// Event Subscription
	EventSubscription
}

EventSubscriptionsClientGetResponse contains the response from method EventSubscriptionsClient.Get.

type EventSubscriptionsClientListByDomainTopicOptions 

type EventSubscriptionsClientListByDomainTopicOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

EventSubscriptionsClientListByDomainTopicOptions contains the optional parameters for the EventSubscriptionsClient.NewListByDomainTopicPager method.

type EventSubscriptionsClientListByDomainTopicResponse 

type EventSubscriptionsClientListByDomainTopicResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

EventSubscriptionsClientListByDomainTopicResponse contains the response from method EventSubscriptionsClient.NewListByDomainTopicPager.

type EventSubscriptionsClientListByResourceOptions 

type EventSubscriptionsClientListByResourceOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

EventSubscriptionsClientListByResourceOptions contains the optional parameters for the EventSubscriptionsClient.NewListByResourcePager method.

type EventSubscriptionsClientListByResourceResponse 

type EventSubscriptionsClientListByResourceResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

EventSubscriptionsClientListByResourceResponse contains the response from method EventSubscriptionsClient.NewListByResourcePager.

type EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeOptions 

type EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeOptions contains the optional parameters for the EventSubscriptionsClient.NewListGlobalByResourceGroupForTopicTypePager method.

type EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeResponse 

type EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeResponse contains the response from method EventSubscriptionsClient.NewListGlobalByResourceGroupForTopicTypePager.

type EventSubscriptionsClientListGlobalByResourceGroupOptions 

type EventSubscriptionsClientListGlobalByResourceGroupOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

EventSubscriptionsClientListGlobalByResourceGroupOptions contains the optional parameters for the EventSubscriptionsClient.NewListGlobalByResourceGroupPager method.

type EventSubscriptionsClientListGlobalByResourceGroupResponse 

type EventSubscriptionsClientListGlobalByResourceGroupResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

EventSubscriptionsClientListGlobalByResourceGroupResponse contains the response from method EventSubscriptionsClient.NewListGlobalByResourceGroupPager.

type EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeOptions 

type EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeOptions contains the optional parameters for the EventSubscriptionsClient.NewListGlobalBySubscriptionForTopicTypePager method.

type EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeResponse 

type EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeResponse contains the response from method EventSubscriptionsClient.NewListGlobalBySubscriptionForTopicTypePager.

type EventSubscriptionsClientListGlobalBySubscriptionOptions 

type EventSubscriptionsClientListGlobalBySubscriptionOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

EventSubscriptionsClientListGlobalBySubscriptionOptions contains the optional parameters for the EventSubscriptionsClient.NewListGlobalBySubscriptionPager method.

type EventSubscriptionsClientListGlobalBySubscriptionResponse 

type EventSubscriptionsClientListGlobalBySubscriptionResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

EventSubscriptionsClientListGlobalBySubscriptionResponse contains the response from method EventSubscriptionsClient.NewListGlobalBySubscriptionPager.

type EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeOptions 

type EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeOptions contains the optional parameters for the EventSubscriptionsClient.NewListRegionalByResourceGroupForTopicTypePager method.

type EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeResponse 

type EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeResponse contains the response from method EventSubscriptionsClient.NewListRegionalByResourceGroupForTopicTypePager.

type EventSubscriptionsClientListRegionalByResourceGroupOptions 

type EventSubscriptionsClientListRegionalByResourceGroupOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

EventSubscriptionsClientListRegionalByResourceGroupOptions contains the optional parameters for the EventSubscriptionsClient.NewListRegionalByResourceGroupPager method.

type EventSubscriptionsClientListRegionalByResourceGroupResponse 

type EventSubscriptionsClientListRegionalByResourceGroupResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

EventSubscriptionsClientListRegionalByResourceGroupResponse contains the response from method EventSubscriptionsClient.NewListRegionalByResourceGroupPager.

type EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeOptions 

type EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeOptions contains the optional parameters for the EventSubscriptionsClient.NewListRegionalBySubscriptionForTopicTypePager method.

type EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeResponse 

type EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeResponse contains the response from method EventSubscriptionsClient.NewListRegionalBySubscriptionForTopicTypePager.

type EventSubscriptionsClientListRegionalBySubscriptionOptions 

type EventSubscriptionsClientListRegionalBySubscriptionOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

EventSubscriptionsClientListRegionalBySubscriptionOptions contains the optional parameters for the EventSubscriptionsClient.NewListRegionalBySubscriptionPager method.

type EventSubscriptionsClientListRegionalBySubscriptionResponse 

type EventSubscriptionsClientListRegionalBySubscriptionResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

EventSubscriptionsClientListRegionalBySubscriptionResponse contains the response from method EventSubscriptionsClient.NewListRegionalBySubscriptionPager.

type EventSubscriptionsClientUpdateResponse 

type EventSubscriptionsClientUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

EventSubscriptionsClientUpdateResponse contains the response from method EventSubscriptionsClient.BeginUpdate.

type EventSubscriptionsListResult 

type EventSubscriptionsListResult struct {
	// A link for the next page of event subscriptions
	NextLink *string

	// A collection of EventSubscriptions
	Value []*EventSubscription
}

EventSubscriptionsListResult - Result of the List EventSubscriptions operation

func (EventSubscriptionsListResult) MarshalJSON added in v2.1.0 

func (e EventSubscriptionsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSubscriptionsListResult.

func (*EventSubscriptionsListResult) UnmarshalJSON added in v2.1.0 

func (e *EventSubscriptionsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSubscriptionsListResult.

type EventType 

type EventType struct {
	// Properties of the event type.
	Properties *EventTypeProperties

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; Type of the resource.
	Type *string
}

EventType - Event Type for a subject under a topic

func (EventType) MarshalJSON added in v2.1.0 

func (e EventType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventType.

func (*EventType) UnmarshalJSON added in v2.1.0 

func (e *EventType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventType.

type EventTypeInfo 

type EventTypeInfo struct {
	// A collection of inline event types for the resource. The inline event type keys are of type string which represents the
	// name of the event. An example of a valid inline event name is
	// "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information
	// for every inline event type.
	InlineEventTypes map[string]*InlineEventProperties

	// The kind of event type used.
	Kind *EventDefinitionKind
}

EventTypeInfo - The event type information for Channels.

func (EventTypeInfo) MarshalJSON 

func (e EventTypeInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventTypeInfo.

func (*EventTypeInfo) UnmarshalJSON added in v2.1.0 

func (e *EventTypeInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventTypeInfo.

type EventTypeProperties 

type EventTypeProperties struct {
	// Description of the event type.
	Description *string

	// Display name of the event type.
	DisplayName *string

	// IsInDefaultSet flag of the event type.
	IsInDefaultSet *bool

	// Url of the schema for this event type.
	SchemaURL *string
}

EventTypeProperties - Properties of the event type

func (EventTypeProperties) MarshalJSON added in v2.1.0 

func (e EventTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventTypeProperties.

func (*EventTypeProperties) UnmarshalJSON added in v2.1.0 

func (e *EventTypeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventTypeProperties.

type EventTypesListResult 

type EventTypesListResult struct {
	// A collection of event types
	Value []*EventType
}

EventTypesListResult - Result of the List Event Types operation

func (EventTypesListResult) MarshalJSON added in v2.1.0 

func (e EventTypesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventTypesListResult.

func (*EventTypesListResult) UnmarshalJSON added in v2.1.0 

func (e *EventTypesListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventTypesListResult.

type ExtensionTopic 

type ExtensionTopic struct {
	// Properties of the extension topic
	Properties *ExtensionTopicProperties

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to Extension Topic resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

ExtensionTopic - Event grid Extension Topic. This is used for getting Event Grid related metrics for Azure resources.

func (ExtensionTopic) MarshalJSON added in v2.1.0 

func (e ExtensionTopic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtensionTopic.

func (*ExtensionTopic) UnmarshalJSON added in v2.1.0 

func (e *ExtensionTopic) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionTopic.

type ExtensionTopicProperties 

type ExtensionTopicProperties struct {
	// Description of the extension topic.
	Description *string

	// System topic resource id which is mapped to the source.
	SystemTopic *string
}

ExtensionTopicProperties - Properties of the Extension Topic

func (ExtensionTopicProperties) MarshalJSON added in v2.1.0 

func (e ExtensionTopicProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtensionTopicProperties.

func (*ExtensionTopicProperties) UnmarshalJSON added in v2.1.0 

func (e *ExtensionTopicProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionTopicProperties.

type ExtensionTopicsClient 

type ExtensionTopicsClient struct {
	// contains filtered or unexported fields
}

ExtensionTopicsClient contains the methods for the ExtensionTopics group. Don't use this type directly, use NewExtensionTopicsClient() instead.

func NewExtensionTopicsClient 

func NewExtensionTopicsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ExtensionTopicsClient, error)

NewExtensionTopicsClient creates a new instance of ExtensionTopicsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ExtensionTopicsClient) Get 

func (client *ExtensionTopicsClient) Get(ctx context.Context, scope string, options *ExtensionTopicsClientGetOptions) (ExtensionTopicsClientGetResponse, error)

Get - Get the properties of an extension topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • scope - The identifier of the resource to which extension topic is queried. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for Azure resource.
  • options - ExtensionTopicsClientGetOptions contains the optional parameters for the ExtensionTopicsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/ExtensionTopics_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewExtensionTopicsClient().Get(ctx, "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.storage/storageaccounts/exampleResourceName/providers/Microsoft.eventgrid/extensionTopics/default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ExtensionTopic = armeventgrid.ExtensionTopic{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("providers/Microsoft.EventGrid/extensionTopics"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.storage/storageaccounts/exampleResourceName/providers/Microsoft.eventgrid/extensionTopics/default"),
// 	Properties: &armeventgrid.ExtensionTopicProperties{
// 		Description: to.Ptr("Extension topic for /subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.storage/storageaccounts/exampleResourceName/providers/Microsoft.eventgrid/extensionTopics/default that can be used to obtain metrics"),
// 		SystemTopic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleResourceName-2a41650f-00dd-4790-b3ab-dabd12d227cb"),
// 	},
// }

Output:

type ExtensionTopicsClientGetOptions 

type ExtensionTopicsClientGetOptions struct {
}

ExtensionTopicsClientGetOptions contains the optional parameters for the ExtensionTopicsClient.Get method.

type ExtensionTopicsClientGetResponse 

type ExtensionTopicsClientGetResponse struct {
	// Event grid Extension Topic. This is used for getting Event Grid related metrics for Azure resources.
	ExtensionTopic
}

ExtensionTopicsClientGetResponse contains the response from method ExtensionTopicsClient.Get.

type HybridConnectionEventSubscriptionDestination 

type HybridConnectionEventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType

	// Hybrid connection Properties of the event subscription destination.
	Properties *HybridConnectionEventSubscriptionDestinationProperties
}

HybridConnectionEventSubscriptionDestination - Information about the HybridConnection destination for an event subscription.

func (*HybridConnectionEventSubscriptionDestination) GetEventSubscriptionDestination 

func (h *HybridConnectionEventSubscriptionDestination) GetEventSubscriptionDestination() *EventSubscriptionDestination

GetEventSubscriptionDestination implements the EventSubscriptionDestinationClassification interface for type HybridConnectionEventSubscriptionDestination.

func (HybridConnectionEventSubscriptionDestination) MarshalJSON 

func (h HybridConnectionEventSubscriptionDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HybridConnectionEventSubscriptionDestination.

func (*HybridConnectionEventSubscriptionDestination) UnmarshalJSON 

func (h *HybridConnectionEventSubscriptionDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HybridConnectionEventSubscriptionDestination.

type HybridConnectionEventSubscriptionDestinationProperties 

type HybridConnectionEventSubscriptionDestinationProperties struct {
	// Delivery attribute details.
	DeliveryAttributeMappings []DeliveryAttributeMappingClassification

	// The Azure Resource ID of an hybrid connection that is the destination of an event subscription.
	ResourceID *string
}

HybridConnectionEventSubscriptionDestinationProperties - The properties for a hybrid connection destination.

func (HybridConnectionEventSubscriptionDestinationProperties) MarshalJSON 

func (h HybridConnectionEventSubscriptionDestinationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HybridConnectionEventSubscriptionDestinationProperties.

func (*HybridConnectionEventSubscriptionDestinationProperties) UnmarshalJSON 

func (h *HybridConnectionEventSubscriptionDestinationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HybridConnectionEventSubscriptionDestinationProperties.

type IPActionType 

type IPActionType string

IPActionType - Action to perform based on the match or no match of the IpMask. 

const (
	IPActionTypeAllow IPActionType = "Allow"
)

func PossibleIPActionTypeValues 

func PossibleIPActionTypeValues() []IPActionType

PossibleIPActionTypeValues returns the possible values for the IPActionType const type.

type IdentityInfo 

type IdentityInfo struct {
	// The principal ID of resource identity.
	PrincipalID *string

	// The tenant ID of resource.
	TenantID *string

	// The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity
	// and a set of user-assigned identities. The type 'None' will remove any identity.
	Type *IdentityType

	// The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource
	// ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	// This property is currently not used and reserved for
	// future usage.
	UserAssignedIdentities map[string]*UserIdentityProperties
}

IdentityInfo - The identity information for the resource.

func (IdentityInfo) MarshalJSON 

func (i IdentityInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityInfo.

func (*IdentityInfo) UnmarshalJSON added in v2.1.0 

func (i *IdentityInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IdentityInfo.

type IdentityType 

type IdentityType string

IdentityType - The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. 

const (
	IdentityTypeNone                       IdentityType = "None"
	IdentityTypeSystemAssigned             IdentityType = "SystemAssigned"
	IdentityTypeSystemAssignedUserAssigned IdentityType = "SystemAssigned, UserAssigned"
	IdentityTypeUserAssigned               IdentityType = "UserAssigned"
)

func PossibleIdentityTypeValues 

func PossibleIdentityTypeValues() []IdentityType

PossibleIdentityTypeValues returns the possible values for the IdentityType const type.

type InboundIPRule 

type InboundIPRule struct {
	// Action to perform based on the match or no match of the IpMask.
	Action *IPActionType

	// IP Address in CIDR notation e.g., 10.0.0.0/8.
	IPMask *string
}

func (InboundIPRule) MarshalJSON added in v2.1.0 

func (i InboundIPRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundIPRule.

func (*InboundIPRule) UnmarshalJSON added in v2.1.0 

func (i *InboundIPRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InboundIPRule.

type InlineEventProperties 

type InlineEventProperties struct {
	// The dataSchemaUrl for the inline event.
	DataSchemaURL *string

	// The description for the inline event.
	Description *string

	// The displayName for the inline event.
	DisplayName *string

	// The documentationUrl for the inline event.
	DocumentationURL *string
}

InlineEventProperties - Additional information about every inline event.

func (InlineEventProperties) MarshalJSON added in v2.1.0 

func (i InlineEventProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InlineEventProperties.

func (*InlineEventProperties) UnmarshalJSON added in v2.1.0 

func (i *InlineEventProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InlineEventProperties.

type InputSchema 

type InputSchema string

InputSchema - This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. 

const (
	InputSchemaCloudEventSchemaV10 InputSchema = "CloudEventSchemaV1_0"
	InputSchemaCustomEventSchema   InputSchema = "CustomEventSchema"
	InputSchemaEventGridSchema     InputSchema = "EventGridSchema"
)

func PossibleInputSchemaValues 

func PossibleInputSchemaValues() []InputSchema

PossibleInputSchemaValues returns the possible values for the InputSchema const type.

type InputSchemaMapping 

type InputSchemaMapping struct {
	// REQUIRED; Type of the custom mapping
	InputSchemaMappingType *InputSchemaMappingType
}

InputSchemaMapping - By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.

func (*InputSchemaMapping) GetInputSchemaMapping 

func (i *InputSchemaMapping) GetInputSchemaMapping() *InputSchemaMapping

GetInputSchemaMapping implements the InputSchemaMappingClassification interface for type InputSchemaMapping.

func (InputSchemaMapping) MarshalJSON added in v2.1.0 

func (i InputSchemaMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InputSchemaMapping.

func (*InputSchemaMapping) UnmarshalJSON added in v2.1.0 

func (i *InputSchemaMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InputSchemaMapping.

type InputSchemaMappingClassification 

type InputSchemaMappingClassification interface {
	// GetInputSchemaMapping returns the InputSchemaMapping content of the underlying type.
	GetInputSchemaMapping() *InputSchemaMapping
}

InputSchemaMappingClassification provides polymorphic access to related types. Call the interface's GetInputSchemaMapping() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *InputSchemaMapping, *JSONInputSchemaMapping

type InputSchemaMappingType 

type InputSchemaMappingType string

InputSchemaMappingType - Type of the custom mapping 

const (
	InputSchemaMappingTypeJSON InputSchemaMappingType = "Json"
)

func PossibleInputSchemaMappingTypeValues 

func PossibleInputSchemaMappingTypeValues() []InputSchemaMappingType

PossibleInputSchemaMappingTypeValues returns the possible values for the InputSchemaMappingType const type.

type IsNotNullAdvancedFilter 

type IsNotNullAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string
}

IsNotNullAdvancedFilter - IsNotNull Advanced Filter.

func (*IsNotNullAdvancedFilter) GetAdvancedFilter 

func (i *IsNotNullAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type IsNotNullAdvancedFilter.

func (IsNotNullAdvancedFilter) MarshalJSON 

func (i IsNotNullAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IsNotNullAdvancedFilter.

func (*IsNotNullAdvancedFilter) UnmarshalJSON 

func (i *IsNotNullAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IsNotNullAdvancedFilter.

type IsNullOrUndefinedAdvancedFilter 

type IsNullOrUndefinedAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string
}

IsNullOrUndefinedAdvancedFilter - IsNullOrUndefined Advanced Filter.

func (*IsNullOrUndefinedAdvancedFilter) GetAdvancedFilter 

func (i *IsNullOrUndefinedAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type IsNullOrUndefinedAdvancedFilter.

func (IsNullOrUndefinedAdvancedFilter) MarshalJSON 

func (i IsNullOrUndefinedAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IsNullOrUndefinedAdvancedFilter.

func (*IsNullOrUndefinedAdvancedFilter) UnmarshalJSON 

func (i *IsNullOrUndefinedAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IsNullOrUndefinedAdvancedFilter.

type JSONField 

type JSONField struct {
	// Name of a field in the input event schema that's to be used as the source of a mapping.
	SourceField *string
}

JSONField - This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.

func (JSONField) MarshalJSON added in v2.1.0 

func (j JSONField) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JSONField.

func (*JSONField) UnmarshalJSON added in v2.1.0 

func (j *JSONField) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JSONField.

type JSONFieldWithDefault 

type JSONFieldWithDefault struct {
	// The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified
	// name in the published JSON event payload.
	DefaultValue *string

	// Name of a field in the input event schema that's to be used as the source of a mapping.
	SourceField *string
}

JSONFieldWithDefault - This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject', 'eventtype' and 'dataversion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.

func (JSONFieldWithDefault) MarshalJSON added in v2.1.0 

func (j JSONFieldWithDefault) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JSONFieldWithDefault.

func (*JSONFieldWithDefault) UnmarshalJSON added in v2.1.0 

func (j *JSONFieldWithDefault) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JSONFieldWithDefault.

type JSONInputSchemaMapping 

type JSONInputSchemaMapping struct {
	// REQUIRED; Type of the custom mapping
	InputSchemaMappingType *InputSchemaMappingType

	// JSON Properties of the input schema mapping
	Properties *JSONInputSchemaMappingProperties
}

JSONInputSchemaMapping - This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.

func (*JSONInputSchemaMapping) GetInputSchemaMapping 

func (j *JSONInputSchemaMapping) GetInputSchemaMapping() *InputSchemaMapping

GetInputSchemaMapping implements the InputSchemaMappingClassification interface for type JSONInputSchemaMapping.

func (JSONInputSchemaMapping) MarshalJSON 

func (j JSONInputSchemaMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JSONInputSchemaMapping.

func (*JSONInputSchemaMapping) UnmarshalJSON 

func (j *JSONInputSchemaMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JSONInputSchemaMapping.

type JSONInputSchemaMappingProperties 

type JSONInputSchemaMappingProperties struct {
	// The mapping information for the DataVersion property of the Event Grid Event.
	DataVersion *JSONFieldWithDefault

	// The mapping information for the EventTime property of the Event Grid Event.
	EventTime *JSONField

	// The mapping information for the EventType property of the Event Grid Event.
	EventType *JSONFieldWithDefault

	// The mapping information for the Id property of the Event Grid Event.
	ID *JSONField

	// The mapping information for the Subject property of the Event Grid Event.
	Subject *JSONFieldWithDefault

	// The mapping information for the Topic property of the Event Grid Event.
	Topic *JSONField
}

JSONInputSchemaMappingProperties - This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.

func (JSONInputSchemaMappingProperties) MarshalJSON added in v2.1.0 

func (j JSONInputSchemaMappingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JSONInputSchemaMappingProperties.

func (*JSONInputSchemaMappingProperties) UnmarshalJSON added in v2.1.0 

func (j *JSONInputSchemaMappingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JSONInputSchemaMappingProperties.

type NumberGreaterThanAdvancedFilter 

type NumberGreaterThanAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The filter value.
	Value *float64
}

NumberGreaterThanAdvancedFilter - NumberGreaterThan Advanced Filter.

func (*NumberGreaterThanAdvancedFilter) GetAdvancedFilter 

func (n *NumberGreaterThanAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type NumberGreaterThanAdvancedFilter.

func (NumberGreaterThanAdvancedFilter) MarshalJSON 

func (n NumberGreaterThanAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NumberGreaterThanAdvancedFilter.

func (*NumberGreaterThanAdvancedFilter) UnmarshalJSON 

func (n *NumberGreaterThanAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NumberGreaterThanAdvancedFilter.

type NumberGreaterThanOrEqualsAdvancedFilter 

type NumberGreaterThanOrEqualsAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The filter value.
	Value *float64
}

NumberGreaterThanOrEqualsAdvancedFilter - NumberGreaterThanOrEquals Advanced Filter.

func (*NumberGreaterThanOrEqualsAdvancedFilter) GetAdvancedFilter 

func (n *NumberGreaterThanOrEqualsAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type NumberGreaterThanOrEqualsAdvancedFilter.

func (NumberGreaterThanOrEqualsAdvancedFilter) MarshalJSON 

func (n NumberGreaterThanOrEqualsAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NumberGreaterThanOrEqualsAdvancedFilter.

func (*NumberGreaterThanOrEqualsAdvancedFilter) UnmarshalJSON 

func (n *NumberGreaterThanOrEqualsAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NumberGreaterThanOrEqualsAdvancedFilter.

type NumberInAdvancedFilter 

type NumberInAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values []*float64
}

NumberInAdvancedFilter - NumberIn Advanced Filter.

func (*NumberInAdvancedFilter) GetAdvancedFilter 

func (n *NumberInAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type NumberInAdvancedFilter.

func (NumberInAdvancedFilter) MarshalJSON 

func (n NumberInAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NumberInAdvancedFilter.

func (*NumberInAdvancedFilter) UnmarshalJSON 

func (n *NumberInAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NumberInAdvancedFilter.

type NumberInRangeAdvancedFilter 

type NumberInRangeAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values [][]*float64
}

NumberInRangeAdvancedFilter - NumberInRange Advanced Filter.

func (*NumberInRangeAdvancedFilter) GetAdvancedFilter 

func (n *NumberInRangeAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type NumberInRangeAdvancedFilter.

func (NumberInRangeAdvancedFilter) MarshalJSON 

func (n NumberInRangeAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NumberInRangeAdvancedFilter.

func (*NumberInRangeAdvancedFilter) UnmarshalJSON 

func (n *NumberInRangeAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NumberInRangeAdvancedFilter.

type NumberLessThanAdvancedFilter 

type NumberLessThanAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The filter value.
	Value *float64
}

NumberLessThanAdvancedFilter - NumberLessThan Advanced Filter.

func (*NumberLessThanAdvancedFilter) GetAdvancedFilter 

func (n *NumberLessThanAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type NumberLessThanAdvancedFilter.

func (NumberLessThanAdvancedFilter) MarshalJSON 

func (n NumberLessThanAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NumberLessThanAdvancedFilter.

func (*NumberLessThanAdvancedFilter) UnmarshalJSON 

func (n *NumberLessThanAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NumberLessThanAdvancedFilter.

type NumberLessThanOrEqualsAdvancedFilter 

type NumberLessThanOrEqualsAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The filter value.
	Value *float64
}

NumberLessThanOrEqualsAdvancedFilter - NumberLessThanOrEquals Advanced Filter.

func (*NumberLessThanOrEqualsAdvancedFilter) GetAdvancedFilter 

func (n *NumberLessThanOrEqualsAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type NumberLessThanOrEqualsAdvancedFilter.

func (NumberLessThanOrEqualsAdvancedFilter) MarshalJSON 

func (n NumberLessThanOrEqualsAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NumberLessThanOrEqualsAdvancedFilter.

func (*NumberLessThanOrEqualsAdvancedFilter) UnmarshalJSON 

func (n *NumberLessThanOrEqualsAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NumberLessThanOrEqualsAdvancedFilter.

type NumberNotInAdvancedFilter 

type NumberNotInAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values []*float64
}

NumberNotInAdvancedFilter - NumberNotIn Advanced Filter.

func (*NumberNotInAdvancedFilter) GetAdvancedFilter 

func (n *NumberNotInAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type NumberNotInAdvancedFilter.

func (NumberNotInAdvancedFilter) MarshalJSON 

func (n NumberNotInAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NumberNotInAdvancedFilter.

func (*NumberNotInAdvancedFilter) UnmarshalJSON 

func (n *NumberNotInAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NumberNotInAdvancedFilter.

type NumberNotInRangeAdvancedFilter 

type NumberNotInRangeAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values [][]*float64
}

NumberNotInRangeAdvancedFilter - NumberNotInRange Advanced Filter.

func (*NumberNotInRangeAdvancedFilter) GetAdvancedFilter 

func (n *NumberNotInRangeAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type NumberNotInRangeAdvancedFilter.

func (NumberNotInRangeAdvancedFilter) MarshalJSON 

func (n NumberNotInRangeAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NumberNotInRangeAdvancedFilter.

func (*NumberNotInRangeAdvancedFilter) UnmarshalJSON 

func (n *NumberNotInRangeAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NumberNotInRangeAdvancedFilter.

type Operation 

type Operation struct {
	// Display name of the operation.
	Display *OperationInfo

	// This Boolean is used to determine if the operation is a data plane action or not.
	IsDataAction *bool

	// Name of the operation.
	Name *string

	// Origin of the operation.
	Origin *string

	// Properties of the operation.
	Properties any
}

Operation - Represents an operation returned by the GetOperations request.

func (Operation) MarshalJSON added in v2.1.0 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON added in v2.1.0 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationInfo 

type OperationInfo struct {
	// Description of the operation
	Description *string

	// Name of the operation
	Operation *string

	// Name of the provider
	Provider *string

	// Name of the resource type
	Resource *string
}

OperationInfo - Information about an operation

func (OperationInfo) MarshalJSON added in v2.1.0 

func (o OperationInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationInfo.

func (*OperationInfo) UnmarshalJSON added in v2.1.0 

func (o *OperationInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationInfo.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - List the available operations supported by the Microsoft.EventGrid resource provider.

Generated from API version 2022-06-15

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Operations_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOperationsClient().NewListPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.OperationsListResult = armeventgrid.OperationsListResult{
	// 	Value: []*armeventgrid.Operation{
	// 		{
	// 			Name: to.Ptr("Microsoft.EventGrid/register/action"),
	// 			Display: &armeventgrid.OperationInfo{
	// 				Description: to.Ptr("Registers the eventSubscription for the EventGrid resource provider and enables the creation of Event Grid subscriptions."),
	// 				Operation: to.Ptr("Registers the EventGrid Resource Provider"),
	// 				Provider: to.Ptr("Microsoft Event Grid"),
	// 				Resource: to.Ptr("EventGrid Resource Provider"),
	// 			},
	// 			Origin: to.Ptr("UserAndSystem"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.EventGrid/eventSubscriptions/write"),
	// 			Display: &armeventgrid.OperationInfo{
	// 				Description: to.Ptr("Create or update a eventSubscription"),
	// 				Operation: to.Ptr("Write EventSubscription"),
	// 				Provider: to.Ptr("Microsoft Event Grid"),
	// 				Resource: to.Ptr("eventSubscriptions"),
	// 			},
	// 			Origin: to.Ptr("UserAndSystem"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.EventGrid/eventSubscriptions/read"),
	// 			Display: &armeventgrid.OperationInfo{
	// 				Description: to.Ptr("Read a eventSubscription"),
	// 				Operation: to.Ptr("Read EventSubscription"),
	// 				Provider: to.Ptr("Microsoft Event Grid"),
	// 				Resource: to.Ptr("eventSubscriptions"),
	// 			},
	// 			Origin: to.Ptr("UserAndSystem"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.EventGrid/eventSubscriptions/delete"),
	// 			Display: &armeventgrid.OperationInfo{
	// 				Description: to.Ptr("Delete a eventSubscription"),
	// 				Operation: to.Ptr("Delete EventSubscription"),
	// 				Provider: to.Ptr("Microsoft Event Grid"),
	// 				Resource: to.Ptr("eventSubscriptions"),
	// 			},
	// 			Origin: to.Ptr("UserAndSystem"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.EventGrid/topics/write"),
	// 			Display: &armeventgrid.OperationInfo{
	// 				Description: to.Ptr("Create or update a topic"),
	// 				Operation: to.Ptr("Write Topic"),
	// 				Provider: to.Ptr("Microsoft Event Grid"),
	// 				Resource: to.Ptr("topics"),
	// 			},
	// 			Origin: to.Ptr("UserAndSystem"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.EventGrid/topics/read"),
	// 			Display: &armeventgrid.OperationInfo{
	// 				Description: to.Ptr("Read a topic"),
	// 				Operation: to.Ptr("Read Topic"),
	// 				Provider: to.Ptr("Microsoft Event Grid"),
	// 				Resource: to.Ptr("topics"),
	// 			},
	// 			Origin: to.Ptr("UserAndSystem"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.EventGrid/topics/delete"),
	// 			Display: &armeventgrid.OperationInfo{
	// 				Description: to.Ptr("Delete a topic"),
	// 				Operation: to.Ptr("Delete Topic"),
	// 				Provider: to.Ptr("Microsoft Event Grid"),
	// 				Resource: to.Ptr("topics"),
	// 			},
	// 			Origin: to.Ptr("UserAndSystem"),
	// 	}},
	// }
}

Output:

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	// Result of the List Operations operation
	OperationsListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type OperationsListResult 

type OperationsListResult struct {
	// A collection of operations
	Value []*Operation
}

OperationsListResult - Result of the List Operations operation

func (OperationsListResult) MarshalJSON added in v2.1.0 

func (o OperationsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationsListResult.

func (*OperationsListResult) UnmarshalJSON added in v2.1.0 

func (o *OperationsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationsListResult.

type Partner 

type Partner struct {
	// Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or
	// delete resources in subscriber's context will fail. If specified, the allowed
	// values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified,
	// the default value will be the value of defaultMaximumExpirationTimeInDays
	// specified in PartnerConfiguration or 7 if this value is not specified.
	AuthorizationExpirationTimeInUTC *time.Time

	// The partner name.
	PartnerName *string

	// The immutableId of the corresponding partner registration.
	PartnerRegistrationImmutableID *string
}

Partner - Information about the partner.

func (Partner) MarshalJSON 

func (p Partner) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Partner.

func (*Partner) UnmarshalJSON 

func (p *Partner) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Partner.

type PartnerAuthorization 

type PartnerAuthorization struct {
	// The list of authorized partners.
	AuthorizedPartnersList []*Partner

	// Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays
	// is not specified, the default is 7 days. Otherwise, allowed values are
	// between 1 and 365 days.
	DefaultMaximumExpirationTimeInDays *int32
}

PartnerAuthorization - The partner authorization details.

func (PartnerAuthorization) MarshalJSON 

func (p PartnerAuthorization) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerAuthorization.

func (*PartnerAuthorization) UnmarshalJSON added in v2.1.0 

func (p *PartnerAuthorization) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerAuthorization.

type PartnerConfiguration 

type PartnerConfiguration struct {
	// Location of the resource.
	Location *string

	// Properties of the partner configuration.
	Properties *PartnerConfigurationProperties

	// Tags of the resource.
	Tags map[string]*string

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to partner configuration resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

PartnerConfiguration - Partner configuration information

func (PartnerConfiguration) MarshalJSON 

func (p PartnerConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerConfiguration.

func (*PartnerConfiguration) UnmarshalJSON added in v2.1.0 

func (p *PartnerConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerConfiguration.

type PartnerConfigurationProperties 

type PartnerConfigurationProperties struct {
	// The details of authorized partners.
	PartnerAuthorization *PartnerAuthorization

	// Provisioning state of the partner configuration.
	ProvisioningState *PartnerConfigurationProvisioningState
}

PartnerConfigurationProperties - Properties of the partner configuration.

func (PartnerConfigurationProperties) MarshalJSON added in v2.1.0 

func (p PartnerConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerConfigurationProperties.

func (*PartnerConfigurationProperties) UnmarshalJSON added in v2.1.0 

func (p *PartnerConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerConfigurationProperties.

type PartnerConfigurationProvisioningState 

type PartnerConfigurationProvisioningState string

PartnerConfigurationProvisioningState - Provisioning state of the partner configuration. 

const (
	PartnerConfigurationProvisioningStateCanceled  PartnerConfigurationProvisioningState = "Canceled"
	PartnerConfigurationProvisioningStateCreating  PartnerConfigurationProvisioningState = "Creating"
	PartnerConfigurationProvisioningStateDeleting  PartnerConfigurationProvisioningState = "Deleting"
	PartnerConfigurationProvisioningStateFailed    PartnerConfigurationProvisioningState = "Failed"
	PartnerConfigurationProvisioningStateSucceeded PartnerConfigurationProvisioningState = "Succeeded"
	PartnerConfigurationProvisioningStateUpdating  PartnerConfigurationProvisioningState = "Updating"
)

func PossiblePartnerConfigurationProvisioningStateValues 

func PossiblePartnerConfigurationProvisioningStateValues() []PartnerConfigurationProvisioningState

PossiblePartnerConfigurationProvisioningStateValues returns the possible values for the PartnerConfigurationProvisioningState const type.

type PartnerConfigurationUpdateParameterProperties 

type PartnerConfigurationUpdateParameterProperties struct {
	// The default time used to validate the maximum expiration time for each authorized partners in days. Allowed values ar between
	// 1 and 365 days.
	DefaultMaximumExpirationTimeInDays *int32
}

PartnerConfigurationUpdateParameterProperties - Information of partner configuration update parameter properties.

func (PartnerConfigurationUpdateParameterProperties) MarshalJSON added in v2.1.0 

func (p PartnerConfigurationUpdateParameterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerConfigurationUpdateParameterProperties.

func (*PartnerConfigurationUpdateParameterProperties) UnmarshalJSON added in v2.1.0 

func (p *PartnerConfigurationUpdateParameterProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerConfigurationUpdateParameterProperties.

type PartnerConfigurationUpdateParameters 

type PartnerConfigurationUpdateParameters struct {
	// Properties of the Topic resource.
	Properties *PartnerConfigurationUpdateParameterProperties

	// Tags of the partner configuration resource.
	Tags map[string]*string
}

PartnerConfigurationUpdateParameters - Properties of the partner configuration update.

func (PartnerConfigurationUpdateParameters) MarshalJSON 

func (p PartnerConfigurationUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerConfigurationUpdateParameters.

func (*PartnerConfigurationUpdateParameters) UnmarshalJSON added in v2.1.0 

func (p *PartnerConfigurationUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerConfigurationUpdateParameters.

type PartnerConfigurationsClient 

type PartnerConfigurationsClient struct {
	// contains filtered or unexported fields
}

PartnerConfigurationsClient contains the methods for the PartnerConfigurations group. Don't use this type directly, use NewPartnerConfigurationsClient() instead.

func NewPartnerConfigurationsClient 

func NewPartnerConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PartnerConfigurationsClient, error)

NewPartnerConfigurationsClient creates a new instance of PartnerConfigurationsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PartnerConfigurationsClient) AuthorizePartner 

func (client *PartnerConfigurationsClient) AuthorizePartner(ctx context.Context, resourceGroupName string, partnerInfo Partner, options *PartnerConfigurationsClientAuthorizePartnerOptions) (PartnerConfigurationsClientAuthorizePartnerResponse, error)

AuthorizePartner - Authorize a single partner either by partner registration immutable Id or by partner name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerInfo - The information of the partner to be authorized.
  • options - PartnerConfigurationsClientAuthorizePartnerOptions contains the optional parameters for the PartnerConfigurationsClient.AuthorizePartner method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerConfigurations_AuthorizePartner.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerConfigurationsClient().AuthorizePartner(ctx, "examplerg", armeventgrid.Partner{
	AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-28T01:20:55.142Z"); return t }()),
	PartnerName:                      to.Ptr("Contoso.Finance"),
	PartnerRegistrationImmutableID:   to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerConfiguration = armeventgrid.PartnerConfiguration{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerConfigurations"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerConfigurations/default"),
// 	Location: to.Ptr("global"),
// 	Properties: &armeventgrid.PartnerConfigurationProperties{
// 		PartnerAuthorization: &armeventgrid.PartnerAuthorization{
// 			AuthorizedPartnersList: []*armeventgrid.Partner{
// 				{
// 					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-28T01:20:55.142Z"); return t}()),
// 					PartnerName: to.Ptr("Contoso.Finance"),
// 					PartnerRegistrationImmutableID: to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
// 				},
// 				{
// 					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-20T01:00:00.142Z"); return t}()),
// 					PartnerName: to.Ptr("fabrikam.HR"),
// 					PartnerRegistrationImmutableID: to.Ptr("5362bdb6-ce3e-4d0d-9a5b-3eb92c8aab38"),
// 			}},
// 			DefaultMaximumExpirationTimeInDays: to.Ptr[int32](10),
// 		},
// 	},
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// }

Output:

func (*PartnerConfigurationsClient) BeginCreateOrUpdate 

func (client *PartnerConfigurationsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, partnerConfigurationInfo PartnerConfiguration, options *PartnerConfigurationsClientBeginCreateOrUpdateOptions) (*runtime.Poller[PartnerConfigurationsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Synchronously creates or updates a partner configuration with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerConfigurationInfo - Partner configuration information.
  • options - PartnerConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the PartnerConfigurationsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerConfigurations_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerConfigurationsClient().BeginCreateOrUpdate(ctx, "examplerg", armeventgrid.PartnerConfiguration{
	Properties: &armeventgrid.PartnerConfigurationProperties{
		PartnerAuthorization: &armeventgrid.PartnerAuthorization{
			AuthorizedPartnersList: []*armeventgrid.Partner{
				{
					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-28T01:20:55.142Z"); return t }()),
					PartnerName:                      to.Ptr("Contoso.Finance"),
					PartnerRegistrationImmutableID:   to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
				},
				{
					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-20T01:00:00.142Z"); return t }()),
					PartnerName:                      to.Ptr("fabrikam.HR"),
					PartnerRegistrationImmutableID:   to.Ptr("5362bdb6-ce3e-4d0d-9a5b-3eb92c8aab38"),
				}},
			DefaultMaximumExpirationTimeInDays: to.Ptr[int32](10),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerConfiguration = armeventgrid.PartnerConfiguration{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerConfigurations"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerConfigurations/default"),
// 	Location: to.Ptr("global"),
// 	Properties: &armeventgrid.PartnerConfigurationProperties{
// 		PartnerAuthorization: &armeventgrid.PartnerAuthorization{
// 			AuthorizedPartnersList: []*armeventgrid.Partner{
// 				{
// 					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-28T01:20:55.142Z"); return t}()),
// 					PartnerName: to.Ptr("Contoso.Finance"),
// 					PartnerRegistrationImmutableID: to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
// 				},
// 				{
// 					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-20T01:00:00.142Z"); return t}()),
// 					PartnerName: to.Ptr("fabrikam.HR"),
// 					PartnerRegistrationImmutableID: to.Ptr("5362bdb6-ce3e-4d0d-9a5b-3eb92c8aab38"),
// 			}},
// 			DefaultMaximumExpirationTimeInDays: to.Ptr[int32](10),
// 		},
// 	},
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// }

Output:

func (*PartnerConfigurationsClient) BeginDelete 

func (client *PartnerConfigurationsClient) BeginDelete(ctx context.Context, resourceGroupName string, options *PartnerConfigurationsClientBeginDeleteOptions) (*runtime.Poller[PartnerConfigurationsClientDeleteResponse], error)

BeginDelete - Delete existing partner configuration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • options - PartnerConfigurationsClientBeginDeleteOptions contains the optional parameters for the PartnerConfigurationsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerConfigurations_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerConfigurationsClient().BeginDelete(ctx, "examplerg", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PartnerConfigurationsClient) BeginUpdate 

func (client *PartnerConfigurationsClient) BeginUpdate(ctx context.Context, resourceGroupName string, partnerConfigurationUpdateParameters PartnerConfigurationUpdateParameters, options *PartnerConfigurationsClientBeginUpdateOptions) (*runtime.Poller[PartnerConfigurationsClientUpdateResponse], error)

BeginUpdate - Synchronously updates a partner configuration with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerConfigurationUpdateParameters - Partner configuration update information.
  • options - PartnerConfigurationsClientBeginUpdateOptions contains the optional parameters for the PartnerConfigurationsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerConfigurations_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerConfigurationsClient().BeginUpdate(ctx, "examplerg", armeventgrid.PartnerConfigurationUpdateParameters{
	Properties: &armeventgrid.PartnerConfigurationUpdateParameterProperties{
		DefaultMaximumExpirationTimeInDays: to.Ptr[int32](100),
	},
	Tags: map[string]*string{
		"tag1": to.Ptr("value11"),
		"tag2": to.Ptr("value22"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerConfiguration = armeventgrid.PartnerConfiguration{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerConfigurations"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerConfigurations/default"),
// 	Location: to.Ptr("global"),
// 	Properties: &armeventgrid.PartnerConfigurationProperties{
// 		PartnerAuthorization: &armeventgrid.PartnerAuthorization{
// 			AuthorizedPartnersList: []*armeventgrid.Partner{
// 				{
// 					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-28T01:20:55.142Z"); return t}()),
// 					PartnerName: to.Ptr("Contoso.Finance"),
// 					PartnerRegistrationImmutableID: to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
// 				},
// 				{
// 					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-20T01:00:00.142Z"); return t}()),
// 					PartnerName: to.Ptr("fabrikam.HR"),
// 					PartnerRegistrationImmutableID: to.Ptr("5362bdb6-ce3e-4d0d-9a5b-3eb92c8aab38"),
// 			}},
// 			DefaultMaximumExpirationTimeInDays: to.Ptr[int32](100),
// 		},
// 	},
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value11"),
// 		"tag2": to.Ptr("value22"),
// 	},
// }

Output:

func (*PartnerConfigurationsClient) Get 

func (client *PartnerConfigurationsClient) Get(ctx context.Context, resourceGroupName string, options *PartnerConfigurationsClientGetOptions) (PartnerConfigurationsClientGetResponse, error)

Get - Get properties of a partner configuration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • options - PartnerConfigurationsClientGetOptions contains the optional parameters for the PartnerConfigurationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerConfigurations_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerConfigurationsClient().Get(ctx, "examplerg", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerConfiguration = armeventgrid.PartnerConfiguration{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerConfigurations"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerConfigurations/default"),
// 	Location: to.Ptr("global"),
// 	Properties: &armeventgrid.PartnerConfigurationProperties{
// 		PartnerAuthorization: &armeventgrid.PartnerAuthorization{
// 			AuthorizedPartnersList: []*armeventgrid.Partner{
// 				{
// 					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-28T01:20:55.142Z"); return t}()),
// 					PartnerName: to.Ptr("Contoso.Finance"),
// 					PartnerRegistrationImmutableID: to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
// 				},
// 				{
// 					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-20T01:00:00.142Z"); return t}()),
// 					PartnerName: to.Ptr("fabrikam.HR"),
// 					PartnerRegistrationImmutableID: to.Ptr("5362bdb6-ce3e-4d0d-9a5b-3eb92c8aab38"),
// 			}},
// 			DefaultMaximumExpirationTimeInDays: to.Ptr[int32](10),
// 		},
// 	},
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// }

Output:

func (*PartnerConfigurationsClient) NewListByResourceGroupPager 

func (client *PartnerConfigurationsClient) NewListByResourceGroupPager(resourceGroupName string, options *PartnerConfigurationsClientListByResourceGroupOptions) *runtime.Pager[PartnerConfigurationsClientListByResourceGroupResponse]

NewListByResourceGroupPager - List all the partner configurations under a resource group.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • options - PartnerConfigurationsClientListByResourceGroupOptions contains the optional parameters for the PartnerConfigurationsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerConfigurations_ListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPartnerConfigurationsClient().NewListByResourceGroupPager("examplerg", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PartnerConfigurationsListResult = armeventgrid.PartnerConfigurationsListResult{
	// 	Value: []*armeventgrid.PartnerConfiguration{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerConfigurations"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerConfigurations/default"),
	// 			Location: to.Ptr("global"),
	// 			Properties: &armeventgrid.PartnerConfigurationProperties{
	// 				PartnerAuthorization: &armeventgrid.PartnerAuthorization{
	// 					AuthorizedPartnersList: []*armeventgrid.Partner{
	// 						{
	// 							AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-28T01:20:55.142Z"); return t}()),
	// 							PartnerName: to.Ptr("Contoso.Finance"),
	// 							PartnerRegistrationImmutableID: to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
	// 						},
	// 						{
	// 							AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-20T01:00:00.142Z"); return t}()),
	// 							PartnerName: to.Ptr("fabrikam.HR"),
	// 							PartnerRegistrationImmutableID: to.Ptr("5362bdb6-ce3e-4d0d-9a5b-3eb92c8aab38"),
	// 					}},
	// 					DefaultMaximumExpirationTimeInDays: to.Ptr[int32](10),
	// 				},
	// 			},
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 	}},
	// }
}

Output:

func (*PartnerConfigurationsClient) NewListBySubscriptionPager 

func (client *PartnerConfigurationsClient) NewListBySubscriptionPager(options *PartnerConfigurationsClientListBySubscriptionOptions) *runtime.Pager[PartnerConfigurationsClientListBySubscriptionResponse]

NewListBySubscriptionPager - List all the partner configurations under an Azure subscription.

Generated from API version 2022-06-15

  • options - PartnerConfigurationsClientListBySubscriptionOptions contains the optional parameters for the PartnerConfigurationsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerConfigurations_ListBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPartnerConfigurationsClient().NewListBySubscriptionPager(&armeventgrid.PartnerConfigurationsClientListBySubscriptionOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PartnerConfigurationsListResult = armeventgrid.PartnerConfigurationsListResult{
	// 	Value: []*armeventgrid.PartnerConfiguration{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerConfigurations"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerConfigurations/default"),
	// 			Location: to.Ptr("global"),
	// 			Properties: &armeventgrid.PartnerConfigurationProperties{
	// 				PartnerAuthorization: &armeventgrid.PartnerAuthorization{
	// 					AuthorizedPartnersList: []*armeventgrid.Partner{
	// 						{
	// 							AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-28T01:20:55.142Z"); return t}()),
	// 							PartnerName: to.Ptr("Contoso.Finance"),
	// 							PartnerRegistrationImmutableID: to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
	// 						},
	// 						{
	// 							AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-20T01:00:00.142Z"); return t}()),
	// 							PartnerName: to.Ptr("fabrikam.HR"),
	// 							PartnerRegistrationImmutableID: to.Ptr("5362bdb6-ce3e-4d0d-9a5b-3eb92c8aab38"),
	// 					}},
	// 					DefaultMaximumExpirationTimeInDays: to.Ptr[int32](10),
	// 				},
	// 			},
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 	}},
	// }
}

Output:

func (*PartnerConfigurationsClient) UnauthorizePartner 

func (client *PartnerConfigurationsClient) UnauthorizePartner(ctx context.Context, resourceGroupName string, partnerInfo Partner, options *PartnerConfigurationsClientUnauthorizePartnerOptions) (PartnerConfigurationsClientUnauthorizePartnerResponse, error)

UnauthorizePartner - Unauthorize a single partner either by partner registration immutable Id or by partner name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerInfo - The information of the partner to be unauthorized.
  • options - PartnerConfigurationsClientUnauthorizePartnerOptions contains the optional parameters for the PartnerConfigurationsClient.UnauthorizePartner method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerConfigurations_UnauthorizePartner.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerConfigurationsClient().UnauthorizePartner(ctx, "examplerg", armeventgrid.Partner{
	AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-28T01:20:55.142Z"); return t }()),
	PartnerName:                      to.Ptr("Contoso.Finance"),
	PartnerRegistrationImmutableID:   to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerConfiguration = armeventgrid.PartnerConfiguration{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerConfigurations"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerConfigurations/default"),
// 	Location: to.Ptr("global"),
// 	Properties: &armeventgrid.PartnerConfigurationProperties{
// 		PartnerAuthorization: &armeventgrid.PartnerAuthorization{
// 			AuthorizedPartnersList: []*armeventgrid.Partner{
// 				{
// 					AuthorizationExpirationTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-20T01:00:00.142Z"); return t}()),
// 					PartnerName: to.Ptr("fabrikam.HR"),
// 					PartnerRegistrationImmutableID: to.Ptr("5362bdb6-ce3e-4d0d-9a5b-3eb92c8aab38"),
// 			}},
// 			DefaultMaximumExpirationTimeInDays: to.Ptr[int32](10),
// 		},
// 	},
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// }

Output:

type PartnerConfigurationsClientAuthorizePartnerOptions 

type PartnerConfigurationsClientAuthorizePartnerOptions struct {
}

PartnerConfigurationsClientAuthorizePartnerOptions contains the optional parameters for the PartnerConfigurationsClient.AuthorizePartner method.

type PartnerConfigurationsClientAuthorizePartnerResponse 

type PartnerConfigurationsClientAuthorizePartnerResponse struct {
	// Partner configuration information
	PartnerConfiguration
}

PartnerConfigurationsClientAuthorizePartnerResponse contains the response from method PartnerConfigurationsClient.AuthorizePartner.

type PartnerConfigurationsClientBeginCreateOrUpdateOptions 

type PartnerConfigurationsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the PartnerConfigurationsClient.BeginCreateOrUpdate method.

type PartnerConfigurationsClientBeginDeleteOptions 

type PartnerConfigurationsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerConfigurationsClientBeginDeleteOptions contains the optional parameters for the PartnerConfigurationsClient.BeginDelete method.

type PartnerConfigurationsClientBeginUpdateOptions 

type PartnerConfigurationsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerConfigurationsClientBeginUpdateOptions contains the optional parameters for the PartnerConfigurationsClient.BeginUpdate method.

type PartnerConfigurationsClientCreateOrUpdateResponse 

type PartnerConfigurationsClientCreateOrUpdateResponse struct {
	// Partner configuration information
	PartnerConfiguration
}

PartnerConfigurationsClientCreateOrUpdateResponse contains the response from method PartnerConfigurationsClient.BeginCreateOrUpdate.

type PartnerConfigurationsClientDeleteResponse 

type PartnerConfigurationsClientDeleteResponse struct {
}

PartnerConfigurationsClientDeleteResponse contains the response from method PartnerConfigurationsClient.BeginDelete.

type PartnerConfigurationsClientGetOptions 

type PartnerConfigurationsClientGetOptions struct {
}

PartnerConfigurationsClientGetOptions contains the optional parameters for the PartnerConfigurationsClient.Get method.

type PartnerConfigurationsClientGetResponse 

type PartnerConfigurationsClientGetResponse struct {
	// Partner configuration information
	PartnerConfiguration
}

PartnerConfigurationsClientGetResponse contains the response from method PartnerConfigurationsClient.Get.

type PartnerConfigurationsClientListByResourceGroupOptions 

type PartnerConfigurationsClientListByResourceGroupOptions struct {
}

PartnerConfigurationsClientListByResourceGroupOptions contains the optional parameters for the PartnerConfigurationsClient.NewListByResourceGroupPager method.

type PartnerConfigurationsClientListByResourceGroupResponse 

type PartnerConfigurationsClientListByResourceGroupResponse struct {
	// Result of the List partner configurations operation
	PartnerConfigurationsListResult
}

PartnerConfigurationsClientListByResourceGroupResponse contains the response from method PartnerConfigurationsClient.NewListByResourceGroupPager.

type PartnerConfigurationsClientListBySubscriptionOptions 

type PartnerConfigurationsClientListBySubscriptionOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

PartnerConfigurationsClientListBySubscriptionOptions contains the optional parameters for the PartnerConfigurationsClient.NewListBySubscriptionPager method.

type PartnerConfigurationsClientListBySubscriptionResponse 

type PartnerConfigurationsClientListBySubscriptionResponse struct {
	// Result of the List partner configurations operation
	PartnerConfigurationsListResult
}

PartnerConfigurationsClientListBySubscriptionResponse contains the response from method PartnerConfigurationsClient.NewListBySubscriptionPager.

type PartnerConfigurationsClientUnauthorizePartnerOptions 

type PartnerConfigurationsClientUnauthorizePartnerOptions struct {
}

PartnerConfigurationsClientUnauthorizePartnerOptions contains the optional parameters for the PartnerConfigurationsClient.UnauthorizePartner method.

type PartnerConfigurationsClientUnauthorizePartnerResponse 

type PartnerConfigurationsClientUnauthorizePartnerResponse struct {
	// Partner configuration information
	PartnerConfiguration
}

PartnerConfigurationsClientUnauthorizePartnerResponse contains the response from method PartnerConfigurationsClient.UnauthorizePartner.

type PartnerConfigurationsClientUpdateResponse 

type PartnerConfigurationsClientUpdateResponse struct {
	// Partner configuration information
	PartnerConfiguration
}

PartnerConfigurationsClientUpdateResponse contains the response from method PartnerConfigurationsClient.BeginUpdate.

type PartnerConfigurationsListResult 

type PartnerConfigurationsListResult struct {
	// A link for the next page of partner configurations.
	NextLink *string

	// A collection of partner configurations.
	Value []*PartnerConfiguration
}

PartnerConfigurationsListResult - Result of the List partner configurations operation

func (PartnerConfigurationsListResult) MarshalJSON added in v2.1.0 

func (p PartnerConfigurationsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerConfigurationsListResult.

func (*PartnerConfigurationsListResult) UnmarshalJSON added in v2.1.0 

func (p *PartnerConfigurationsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerConfigurationsListResult.

type PartnerDetails 

type PartnerDetails struct {
	// This is short description about the partner. The length of this description should not exceed 256 characters.
	Description *string

	// Long description for the partner's scenarios and integration.Length of this description should not exceed 2048 characters.
	LongDescription *string

	// URI of the partner website that can be used by Azure customers to setup Event Grid integration on an event source.
	SetupURI *string
}

PartnerDetails - Information about the partner.

func (PartnerDetails) MarshalJSON added in v2.1.0 

func (p PartnerDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerDetails.

func (*PartnerDetails) UnmarshalJSON added in v2.1.0 

func (p *PartnerDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerDetails.

type PartnerNamespace 

type PartnerNamespace struct {
	// REQUIRED; Location of the resource.
	Location *string

	// Properties of the Partner Namespace.
	Properties *PartnerNamespaceProperties

	// Tags of the resource.
	Tags map[string]*string

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to Partner Namespace resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

PartnerNamespace - EventGrid Partner Namespace.

func (PartnerNamespace) MarshalJSON 

func (p PartnerNamespace) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerNamespace.

func (*PartnerNamespace) UnmarshalJSON added in v2.1.0 

func (p *PartnerNamespace) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerNamespace.

type PartnerNamespaceProperties 

type PartnerNamespaceProperties struct {
	// This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD
	// token will be used to authenticate if user is allowed to publish to the partner
	// namespace.
	DisableLocalAuth *bool

	// This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess
	// is enabled.
	InboundIPRules []*InboundIPRule

	// The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes
	// the following format:
	// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
	PartnerRegistrationFullyQualifiedID *string

	// This determines if events published to this partner namespace should use the source attribute in the event payload or use
	// the channel name in the header when matching to the partner topic. If none is
	// specified, source attribute routing will be used to match the partner topic.
	PartnerTopicRoutingMode *PartnerTopicRoutingMode

	// This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific
	// IPs by configuring
	PublicNetworkAccess *PublicNetworkAccess

	// READ-ONLY; Endpoint for the partner namespace.
	Endpoint *string

	// READ-ONLY
	PrivateEndpointConnections []*PrivateEndpointConnection

	// READ-ONLY; Provisioning state of the partner namespace.
	ProvisioningState *PartnerNamespaceProvisioningState
}

PartnerNamespaceProperties - Properties of the partner namespace.

func (PartnerNamespaceProperties) MarshalJSON 

func (p PartnerNamespaceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerNamespaceProperties.

func (*PartnerNamespaceProperties) UnmarshalJSON added in v2.1.0 

func (p *PartnerNamespaceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerNamespaceProperties.

type PartnerNamespaceProvisioningState 

type PartnerNamespaceProvisioningState string

PartnerNamespaceProvisioningState - Provisioning state of the partner namespace. 

const (
	PartnerNamespaceProvisioningStateCanceled  PartnerNamespaceProvisioningState = "Canceled"
	PartnerNamespaceProvisioningStateCreating  PartnerNamespaceProvisioningState = "Creating"
	PartnerNamespaceProvisioningStateDeleting  PartnerNamespaceProvisioningState = "Deleting"
	PartnerNamespaceProvisioningStateFailed    PartnerNamespaceProvisioningState = "Failed"
	PartnerNamespaceProvisioningStateSucceeded PartnerNamespaceProvisioningState = "Succeeded"
	PartnerNamespaceProvisioningStateUpdating  PartnerNamespaceProvisioningState = "Updating"
)

func PossiblePartnerNamespaceProvisioningStateValues 

func PossiblePartnerNamespaceProvisioningStateValues() []PartnerNamespaceProvisioningState

PossiblePartnerNamespaceProvisioningStateValues returns the possible values for the PartnerNamespaceProvisioningState const type.

type PartnerNamespaceRegenerateKeyRequest 

type PartnerNamespaceRegenerateKeyRequest struct {
	// REQUIRED; Key name to regenerate (key1 or key2).
	KeyName *string
}

PartnerNamespaceRegenerateKeyRequest - PartnerNamespace regenerate shared access key request.

func (PartnerNamespaceRegenerateKeyRequest) MarshalJSON added in v2.1.0 

func (p PartnerNamespaceRegenerateKeyRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerNamespaceRegenerateKeyRequest.

func (*PartnerNamespaceRegenerateKeyRequest) UnmarshalJSON added in v2.1.0 

func (p *PartnerNamespaceRegenerateKeyRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerNamespaceRegenerateKeyRequest.

type PartnerNamespaceSharedAccessKeys 

type PartnerNamespaceSharedAccessKeys struct {
	// Shared access key1 for the partner namespace.
	Key1 *string

	// Shared access key2 for the partner namespace.
	Key2 *string
}

PartnerNamespaceSharedAccessKeys - Shared access keys of the partner namespace.

func (PartnerNamespaceSharedAccessKeys) MarshalJSON added in v2.1.0 

func (p PartnerNamespaceSharedAccessKeys) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerNamespaceSharedAccessKeys.

func (*PartnerNamespaceSharedAccessKeys) UnmarshalJSON added in v2.1.0 

func (p *PartnerNamespaceSharedAccessKeys) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerNamespaceSharedAccessKeys.

type PartnerNamespaceUpdateParameterProperties 

type PartnerNamespaceUpdateParameterProperties struct {
	// This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD
	// token will be used to authenticate if user is allowed to publish to the partner
	// namespace.
	DisableLocalAuth *bool

	// This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess
	// is enabled.
	InboundIPRules []*InboundIPRule

	// This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific
	// IPs by configuring
	PublicNetworkAccess *PublicNetworkAccess
}

PartnerNamespaceUpdateParameterProperties - Information of Partner Namespace update parameter properties.

func (PartnerNamespaceUpdateParameterProperties) MarshalJSON 

func (p PartnerNamespaceUpdateParameterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerNamespaceUpdateParameterProperties.

func (*PartnerNamespaceUpdateParameterProperties) UnmarshalJSON added in v2.1.0 

func (p *PartnerNamespaceUpdateParameterProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerNamespaceUpdateParameterProperties.

type PartnerNamespaceUpdateParameters 

type PartnerNamespaceUpdateParameters struct {
	// Properties of the Partner Namespace.
	Properties *PartnerNamespaceUpdateParameterProperties

	// Tags of the Partner Namespace.
	Tags map[string]*string
}

PartnerNamespaceUpdateParameters - Properties of the Partner Namespace update.

func (PartnerNamespaceUpdateParameters) MarshalJSON 

func (p PartnerNamespaceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerNamespaceUpdateParameters.

func (*PartnerNamespaceUpdateParameters) UnmarshalJSON added in v2.1.0 

func (p *PartnerNamespaceUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerNamespaceUpdateParameters.

type PartnerNamespacesClient 

type PartnerNamespacesClient struct {
	// contains filtered or unexported fields
}

PartnerNamespacesClient contains the methods for the PartnerNamespaces group. Don't use this type directly, use NewPartnerNamespacesClient() instead.

func NewPartnerNamespacesClient 

func NewPartnerNamespacesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PartnerNamespacesClient, error)

NewPartnerNamespacesClient creates a new instance of PartnerNamespacesClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PartnerNamespacesClient) BeginCreateOrUpdate 

func (client *PartnerNamespacesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, partnerNamespaceName string, partnerNamespaceInfo PartnerNamespace, options *PartnerNamespacesClientBeginCreateOrUpdateOptions) (*runtime.Poller[PartnerNamespacesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates a new partner namespace with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • partnerNamespaceInfo - PartnerNamespace information.
  • options - PartnerNamespacesClientBeginCreateOrUpdateOptions contains the optional parameters for the PartnerNamespacesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerNamespacesClient().BeginCreateOrUpdate(ctx, "examplerg", "examplePartnerNamespaceName1", armeventgrid.PartnerNamespace{
	Location: to.Ptr("westus"),
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
	Properties: &armeventgrid.PartnerNamespaceProperties{
		PartnerRegistrationFullyQualifiedID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PartnerNamespacesClient) BeginDelete 

func (client *PartnerNamespacesClient) BeginDelete(ctx context.Context, resourceGroupName string, partnerNamespaceName string, options *PartnerNamespacesClientBeginDeleteOptions) (*runtime.Poller[PartnerNamespacesClientDeleteResponse], error)

BeginDelete - Delete existing partner namespace. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • options - PartnerNamespacesClientBeginDeleteOptions contains the optional parameters for the PartnerNamespacesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerNamespacesClient().BeginDelete(ctx, "examplerg", "examplePartnerNamespaceName1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PartnerNamespacesClient) BeginUpdate 

func (client *PartnerNamespacesClient) BeginUpdate(ctx context.Context, resourceGroupName string, partnerNamespaceName string, partnerNamespaceUpdateParameters PartnerNamespaceUpdateParameters, options *PartnerNamespacesClientBeginUpdateOptions) (*runtime.Poller[PartnerNamespacesClientUpdateResponse], error)

BeginUpdate - Asynchronously updates a partner namespace with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • partnerNamespaceUpdateParameters - Partner namespace update information.
  • options - PartnerNamespacesClientBeginUpdateOptions contains the optional parameters for the PartnerNamespacesClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerNamespacesClient().BeginUpdate(ctx, "examplerg", "examplePartnerNamespaceName1", armeventgrid.PartnerNamespaceUpdateParameters{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PartnerNamespacesClient) Get 

func (client *PartnerNamespacesClient) Get(ctx context.Context, resourceGroupName string, partnerNamespaceName string, options *PartnerNamespacesClientGetOptions) (PartnerNamespacesClientGetResponse, error)

Get - Get properties of a partner namespace. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • options - PartnerNamespacesClientGetOptions contains the optional parameters for the PartnerNamespacesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerNamespacesClient().Get(ctx, "examplerg", "examplePartnerNamespaceName1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerNamespace = armeventgrid.PartnerNamespace{
// 	Name: to.Ptr("examplePartnerNamespaceName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerNamespaces"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1"),
// 	Location: to.Ptr("Central US EUAP"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("value1"),
// 		"key2": to.Ptr("value2"),
// 		"key3": to.Ptr("value3"),
// 	},
// 	Properties: &armeventgrid.PartnerNamespaceProperties{
// 		Endpoint: to.Ptr("https://examplePartnerNamespaceName1.centraluseuap-1.eventgrid.azure.net/api/events"),
// 		PartnerRegistrationFullyQualifiedID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"),
// 		ProvisioningState: to.Ptr(armeventgrid.PartnerNamespaceProvisioningStateSucceeded),
// 	},
// }

Output:

func (*PartnerNamespacesClient) ListSharedAccessKeys 

func (client *PartnerNamespacesClient) ListSharedAccessKeys(ctx context.Context, resourceGroupName string, partnerNamespaceName string, options *PartnerNamespacesClientListSharedAccessKeysOptions) (PartnerNamespacesClientListSharedAccessKeysResponse, error)

ListSharedAccessKeys - List the two keys used to publish to a partner namespace. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • options - PartnerNamespacesClientListSharedAccessKeysOptions contains the optional parameters for the PartnerNamespacesClient.ListSharedAccessKeys method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_ListSharedAccessKeys.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerNamespacesClient().ListSharedAccessKeys(ctx, "examplerg", "examplePartnerNamespaceName1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerNamespaceSharedAccessKeys = armeventgrid.PartnerNamespaceSharedAccessKeys{
// 	Key1: to.Ptr("testKey1Value"),
// 	Key2: to.Ptr("testKey2Value"),
// }

Output:

func (*PartnerNamespacesClient) NewListByResourceGroupPager 

func (client *PartnerNamespacesClient) NewListByResourceGroupPager(resourceGroupName string, options *PartnerNamespacesClientListByResourceGroupOptions) *runtime.Pager[PartnerNamespacesClientListByResourceGroupResponse]

NewListByResourceGroupPager - List all the partner namespaces under a resource group.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • options - PartnerNamespacesClientListByResourceGroupOptions contains the optional parameters for the PartnerNamespacesClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_ListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPartnerNamespacesClient().NewListByResourceGroupPager("examplerg", &armeventgrid.PartnerNamespacesClientListByResourceGroupOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PartnerNamespacesListResult = armeventgrid.PartnerNamespacesListResult{
	// 	Value: []*armeventgrid.PartnerNamespace{
	// 		{
	// 			Name: to.Ptr("partnerNamespace123"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerNamespaces"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123"),
	// 			Location: to.Ptr("Central US EUAP"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("value1"),
	// 				"key2": to.Ptr("value2"),
	// 				"key3": to.Ptr("value3"),
	// 			},
	// 			Properties: &armeventgrid.PartnerNamespaceProperties{
	// 				Endpoint: to.Ptr("https://partnernamespace123.centraluseuap-1.eventgrid.azure.net/api/events"),
	// 				PartnerRegistrationFullyQualifiedID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"),
	// 				ProvisioningState: to.Ptr(armeventgrid.PartnerNamespaceProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*PartnerNamespacesClient) NewListBySubscriptionPager 

func (client *PartnerNamespacesClient) NewListBySubscriptionPager(options *PartnerNamespacesClientListBySubscriptionOptions) *runtime.Pager[PartnerNamespacesClientListBySubscriptionResponse]

NewListBySubscriptionPager - List all the partner namespaces under an Azure subscription.

Generated from API version 2022-06-15

  • options - PartnerNamespacesClientListBySubscriptionOptions contains the optional parameters for the PartnerNamespacesClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_ListBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPartnerNamespacesClient().NewListBySubscriptionPager(&armeventgrid.PartnerNamespacesClientListBySubscriptionOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PartnerNamespacesListResult = armeventgrid.PartnerNamespacesListResult{
	// 	Value: []*armeventgrid.PartnerNamespace{
	// 		{
	// 			Name: to.Ptr("partnerNamespace123"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerNamespaces"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123"),
	// 			Location: to.Ptr("Central US EUAP"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("value1"),
	// 				"key2": to.Ptr("value2"),
	// 				"key3": to.Ptr("value3"),
	// 			},
	// 			Properties: &armeventgrid.PartnerNamespaceProperties{
	// 				Endpoint: to.Ptr("https://partnernamespace123.centraluseuap-1.eventgrid.azure.net/api/events"),
	// 				PartnerRegistrationFullyQualifiedID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"),
	// 				ProvisioningState: to.Ptr(armeventgrid.PartnerNamespaceProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*PartnerNamespacesClient) RegenerateKey 

func (client *PartnerNamespacesClient) RegenerateKey(ctx context.Context, resourceGroupName string, partnerNamespaceName string, regenerateKeyRequest PartnerNamespaceRegenerateKeyRequest, options *PartnerNamespacesClientRegenerateKeyOptions) (PartnerNamespacesClientRegenerateKeyResponse, error)

RegenerateKey - Regenerate a shared access key for a partner namespace. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerNamespaceName - Name of the partner namespace.
  • regenerateKeyRequest - Request body to regenerate key.
  • options - PartnerNamespacesClientRegenerateKeyOptions contains the optional parameters for the PartnerNamespacesClient.RegenerateKey method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_RegenerateKey.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerNamespacesClient().RegenerateKey(ctx, "examplerg", "examplePartnerNamespaceName1", armeventgrid.PartnerNamespaceRegenerateKeyRequest{
	KeyName: to.Ptr("key1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerNamespaceSharedAccessKeys = armeventgrid.PartnerNamespaceSharedAccessKeys{
// 	Key1: to.Ptr("testKey1Value"),
// 	Key2: to.Ptr("testKey2Value"),
// }

Output:

type PartnerNamespacesClientBeginCreateOrUpdateOptions 

type PartnerNamespacesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerNamespacesClientBeginCreateOrUpdateOptions contains the optional parameters for the PartnerNamespacesClient.BeginCreateOrUpdate method.

type PartnerNamespacesClientBeginDeleteOptions 

type PartnerNamespacesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerNamespacesClientBeginDeleteOptions contains the optional parameters for the PartnerNamespacesClient.BeginDelete method.

type PartnerNamespacesClientBeginUpdateOptions 

type PartnerNamespacesClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerNamespacesClientBeginUpdateOptions contains the optional parameters for the PartnerNamespacesClient.BeginUpdate method.

type PartnerNamespacesClientCreateOrUpdateResponse 

type PartnerNamespacesClientCreateOrUpdateResponse struct {
	// EventGrid Partner Namespace.
	PartnerNamespace
}

PartnerNamespacesClientCreateOrUpdateResponse contains the response from method PartnerNamespacesClient.BeginCreateOrUpdate.

type PartnerNamespacesClientDeleteResponse 

type PartnerNamespacesClientDeleteResponse struct {
}

PartnerNamespacesClientDeleteResponse contains the response from method PartnerNamespacesClient.BeginDelete.

type PartnerNamespacesClientGetOptions 

type PartnerNamespacesClientGetOptions struct {
}

PartnerNamespacesClientGetOptions contains the optional parameters for the PartnerNamespacesClient.Get method.

type PartnerNamespacesClientGetResponse 

type PartnerNamespacesClientGetResponse struct {
	// EventGrid Partner Namespace.
	PartnerNamespace
}

PartnerNamespacesClientGetResponse contains the response from method PartnerNamespacesClient.Get.

type PartnerNamespacesClientListByResourceGroupOptions 

type PartnerNamespacesClientListByResourceGroupOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

PartnerNamespacesClientListByResourceGroupOptions contains the optional parameters for the PartnerNamespacesClient.NewListByResourceGroupPager method.

type PartnerNamespacesClientListByResourceGroupResponse 

type PartnerNamespacesClientListByResourceGroupResponse struct {
	// Result of the List Partner Namespaces operation
	PartnerNamespacesListResult
}

PartnerNamespacesClientListByResourceGroupResponse contains the response from method PartnerNamespacesClient.NewListByResourceGroupPager.

type PartnerNamespacesClientListBySubscriptionOptions 

type PartnerNamespacesClientListBySubscriptionOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

PartnerNamespacesClientListBySubscriptionOptions contains the optional parameters for the PartnerNamespacesClient.NewListBySubscriptionPager method.

type PartnerNamespacesClientListBySubscriptionResponse 

type PartnerNamespacesClientListBySubscriptionResponse struct {
	// Result of the List Partner Namespaces operation
	PartnerNamespacesListResult
}

PartnerNamespacesClientListBySubscriptionResponse contains the response from method PartnerNamespacesClient.NewListBySubscriptionPager.

type PartnerNamespacesClientListSharedAccessKeysOptions 

type PartnerNamespacesClientListSharedAccessKeysOptions struct {
}

PartnerNamespacesClientListSharedAccessKeysOptions contains the optional parameters for the PartnerNamespacesClient.ListSharedAccessKeys method.

type PartnerNamespacesClientListSharedAccessKeysResponse 

type PartnerNamespacesClientListSharedAccessKeysResponse struct {
	// Shared access keys of the partner namespace.
	PartnerNamespaceSharedAccessKeys
}

PartnerNamespacesClientListSharedAccessKeysResponse contains the response from method PartnerNamespacesClient.ListSharedAccessKeys.

type PartnerNamespacesClientRegenerateKeyOptions 

type PartnerNamespacesClientRegenerateKeyOptions struct {
}

PartnerNamespacesClientRegenerateKeyOptions contains the optional parameters for the PartnerNamespacesClient.RegenerateKey method.

type PartnerNamespacesClientRegenerateKeyResponse 

type PartnerNamespacesClientRegenerateKeyResponse struct {
	// Shared access keys of the partner namespace.
	PartnerNamespaceSharedAccessKeys
}

PartnerNamespacesClientRegenerateKeyResponse contains the response from method PartnerNamespacesClient.RegenerateKey.

type PartnerNamespacesClientUpdateResponse 

type PartnerNamespacesClientUpdateResponse struct {
	// EventGrid Partner Namespace.
	PartnerNamespace
}

PartnerNamespacesClientUpdateResponse contains the response from method PartnerNamespacesClient.BeginUpdate.

type PartnerNamespacesListResult 

type PartnerNamespacesListResult struct {
	// A link for the next page of partner namespaces.
	NextLink *string

	// A collection of partner namespaces.
	Value []*PartnerNamespace
}

PartnerNamespacesListResult - Result of the List Partner Namespaces operation

func (PartnerNamespacesListResult) MarshalJSON added in v2.1.0 

func (p PartnerNamespacesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerNamespacesListResult.

func (*PartnerNamespacesListResult) UnmarshalJSON added in v2.1.0 

func (p *PartnerNamespacesListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerNamespacesListResult.

type PartnerRegistration 

type PartnerRegistration struct {
	// REQUIRED; Location of the resource.
	Location *string

	// Properties of the partner registration.
	Properties *PartnerRegistrationProperties

	// Tags of the resource.
	Tags map[string]*string

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to Partner Registration resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

PartnerRegistration - Information about a partner registration.

func (PartnerRegistration) MarshalJSON 

func (p PartnerRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerRegistration.

func (*PartnerRegistration) UnmarshalJSON added in v2.1.0 

func (p *PartnerRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerRegistration.

type PartnerRegistrationProperties 

type PartnerRegistrationProperties struct {
	// The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported
	// in any future GA API version
	PartnerRegistrationImmutableID *string

	// READ-ONLY; Provisioning state of the partner registration.
	ProvisioningState *PartnerRegistrationProvisioningState
}

PartnerRegistrationProperties - Properties of the partner registration.

func (PartnerRegistrationProperties) MarshalJSON added in v2.1.0 

func (p PartnerRegistrationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerRegistrationProperties.

func (*PartnerRegistrationProperties) UnmarshalJSON added in v2.1.0 

func (p *PartnerRegistrationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerRegistrationProperties.

type PartnerRegistrationProvisioningState 

type PartnerRegistrationProvisioningState string

PartnerRegistrationProvisioningState - Provisioning state of the partner registration. 

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

func PossiblePartnerRegistrationProvisioningStateValues 

func PossiblePartnerRegistrationProvisioningStateValues() []PartnerRegistrationProvisioningState

PossiblePartnerRegistrationProvisioningStateValues returns the possible values for the PartnerRegistrationProvisioningState const type.

type PartnerRegistrationUpdateParameters 

type PartnerRegistrationUpdateParameters struct {
	// Tags of the partner registration resource.
	Tags map[string]*string
}

PartnerRegistrationUpdateParameters - Properties of the Partner Registration update.

func (PartnerRegistrationUpdateParameters) MarshalJSON 

func (p PartnerRegistrationUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerRegistrationUpdateParameters.

func (*PartnerRegistrationUpdateParameters) UnmarshalJSON added in v2.1.0 

func (p *PartnerRegistrationUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerRegistrationUpdateParameters.

type PartnerRegistrationsClient 

type PartnerRegistrationsClient struct {
	// contains filtered or unexported fields
}

PartnerRegistrationsClient contains the methods for the PartnerRegistrations group. Don't use this type directly, use NewPartnerRegistrationsClient() instead.

func NewPartnerRegistrationsClient 

func NewPartnerRegistrationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PartnerRegistrationsClient, error)

NewPartnerRegistrationsClient creates a new instance of PartnerRegistrationsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PartnerRegistrationsClient) BeginCreateOrUpdate 

func (client *PartnerRegistrationsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, partnerRegistrationName string, partnerRegistrationInfo PartnerRegistration, options *PartnerRegistrationsClientBeginCreateOrUpdateOptions) (*runtime.Poller[PartnerRegistrationsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a new partner registration with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerRegistrationName - Name of the partner registration.
  • partnerRegistrationInfo - PartnerRegistration information.
  • options - PartnerRegistrationsClientBeginCreateOrUpdateOptions contains the optional parameters for the PartnerRegistrationsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerRegistrations_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerRegistrationsClient().BeginCreateOrUpdate(ctx, "examplerg", "examplePartnerRegistrationName1", armeventgrid.PartnerRegistration{
	Location: to.Ptr("global"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
		"key2": to.Ptr("Value2"),
		"key3": to.Ptr("Value3"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerRegistration = armeventgrid.PartnerRegistration{
// 	Name: to.Ptr("examplePartnerRegistrationName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerRegistrations"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/examplePartnerRegistrationName1"),
// 	Location: to.Ptr("global"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("value1"),
// 		"key2": to.Ptr("Value2"),
// 		"key3": to.Ptr("Value3"),
// 	},
// 	Properties: &armeventgrid.PartnerRegistrationProperties{
// 		PartnerRegistrationImmutableID: to.Ptr("6a1e637f-1495-4938-bf46-ff468b9a75d2"),
// 		ProvisioningState: to.Ptr(armeventgrid.PartnerRegistrationProvisioningStateSucceeded),
// 	},
// }

Output:

func (*PartnerRegistrationsClient) BeginDelete 

func (client *PartnerRegistrationsClient) BeginDelete(ctx context.Context, resourceGroupName string, partnerRegistrationName string, options *PartnerRegistrationsClientBeginDeleteOptions) (*runtime.Poller[PartnerRegistrationsClientDeleteResponse], error)

BeginDelete - Deletes a partner registration with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerRegistrationName - Name of the partner registration.
  • options - PartnerRegistrationsClientBeginDeleteOptions contains the optional parameters for the PartnerRegistrationsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerRegistrations_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerRegistrationsClient().BeginDelete(ctx, "examplerg", "examplePartnerRegistrationName1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PartnerRegistrationsClient) BeginUpdate 

func (client *PartnerRegistrationsClient) BeginUpdate(ctx context.Context, resourceGroupName string, partnerRegistrationName string, partnerRegistrationUpdateParameters PartnerRegistrationUpdateParameters, options *PartnerRegistrationsClientBeginUpdateOptions) (*runtime.Poller[PartnerRegistrationsClientUpdateResponse], error)

BeginUpdate - Updates a partner registration with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerRegistrationName - Name of the partner registration.
  • partnerRegistrationUpdateParameters - Partner registration update information.
  • options - PartnerRegistrationsClientBeginUpdateOptions contains the optional parameters for the PartnerRegistrationsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerRegistrations_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerRegistrationsClient().BeginUpdate(ctx, "examplerg", "examplePartnerRegistrationName1", armeventgrid.PartnerRegistrationUpdateParameters{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PartnerRegistrationsClient) Get 

func (client *PartnerRegistrationsClient) Get(ctx context.Context, resourceGroupName string, partnerRegistrationName string, options *PartnerRegistrationsClientGetOptions) (PartnerRegistrationsClientGetResponse, error)

Get - Gets a partner registration with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerRegistrationName - Name of the partner registration.
  • options - PartnerRegistrationsClientGetOptions contains the optional parameters for the PartnerRegistrationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerRegistrations_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerRegistrationsClient().Get(ctx, "examplerg", "examplePartnerRegistrationName1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerRegistration = armeventgrid.PartnerRegistration{
// 	Name: to.Ptr("examplePartnerRegistrationName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerRegistrations"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/examplePartnerRegistrationName1"),
// 	Location: to.Ptr("global"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("value1"),
// 		"key2": to.Ptr("Value2"),
// 		"key3": to.Ptr("Value3"),
// 	},
// 	Properties: &armeventgrid.PartnerRegistrationProperties{
// 		PartnerRegistrationImmutableID: to.Ptr("6a1e637f-1495-4938-bf46-ff468b9a75d2"),
// 		ProvisioningState: to.Ptr(armeventgrid.PartnerRegistrationProvisioningStateSucceeded),
// 	},
// }

Output:

func (*PartnerRegistrationsClient) NewListByResourceGroupPager 

func (client *PartnerRegistrationsClient) NewListByResourceGroupPager(resourceGroupName string, options *PartnerRegistrationsClientListByResourceGroupOptions) *runtime.Pager[PartnerRegistrationsClientListByResourceGroupResponse]

NewListByResourceGroupPager - List all the partner registrations under a resource group.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • options - PartnerRegistrationsClientListByResourceGroupOptions contains the optional parameters for the PartnerRegistrationsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerRegistrations_ListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPartnerRegistrationsClient().NewListByResourceGroupPager("examplerg", &armeventgrid.PartnerRegistrationsClientListByResourceGroupOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PartnerRegistrationsListResult = armeventgrid.PartnerRegistrationsListResult{
	// 	Value: []*armeventgrid.PartnerRegistration{
	// 		{
	// 			Name: to.Ptr("ContosoCorpAccount1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerRegistrations"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"),
	// 			Location: to.Ptr("global"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("value1"),
	// 				"key2": to.Ptr("Value2"),
	// 				"key3": to.Ptr("Value3"),
	// 			},
	// 			Properties: &armeventgrid.PartnerRegistrationProperties{
	// 				PartnerRegistrationImmutableID: to.Ptr("6a1e637f-1495-4938-bf46-ff468b9a75d2"),
	// 				ProvisioningState: to.Ptr(armeventgrid.PartnerRegistrationProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*PartnerRegistrationsClient) NewListBySubscriptionPager 

func (client *PartnerRegistrationsClient) NewListBySubscriptionPager(options *PartnerRegistrationsClientListBySubscriptionOptions) *runtime.Pager[PartnerRegistrationsClientListBySubscriptionResponse]

NewListBySubscriptionPager - List all the partner registrations under an Azure subscription.

Generated from API version 2022-06-15

  • options - PartnerRegistrationsClientListBySubscriptionOptions contains the optional parameters for the PartnerRegistrationsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerRegistrations_ListBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPartnerRegistrationsClient().NewListBySubscriptionPager(&armeventgrid.PartnerRegistrationsClientListBySubscriptionOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PartnerRegistrationsListResult = armeventgrid.PartnerRegistrationsListResult{
	// 	Value: []*armeventgrid.PartnerRegistration{
	// 		{
	// 			Name: to.Ptr("ContosoCorpAccount1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerRegistrations"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"),
	// 			Location: to.Ptr("global"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("value1"),
	// 				"key2": to.Ptr("Value2"),
	// 				"key3": to.Ptr("Value3"),
	// 			},
	// 			Properties: &armeventgrid.PartnerRegistrationProperties{
	// 				PartnerRegistrationImmutableID: to.Ptr("6a1e637f-1495-4938-bf46-ff468b9a75d2"),
	// 				ProvisioningState: to.Ptr(armeventgrid.PartnerRegistrationProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

type PartnerRegistrationsClientBeginCreateOrUpdateOptions 

type PartnerRegistrationsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerRegistrationsClientBeginCreateOrUpdateOptions contains the optional parameters for the PartnerRegistrationsClient.BeginCreateOrUpdate method.

type PartnerRegistrationsClientBeginDeleteOptions 

type PartnerRegistrationsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerRegistrationsClientBeginDeleteOptions contains the optional parameters for the PartnerRegistrationsClient.BeginDelete method.

type PartnerRegistrationsClientBeginUpdateOptions 

type PartnerRegistrationsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerRegistrationsClientBeginUpdateOptions contains the optional parameters for the PartnerRegistrationsClient.BeginUpdate method.

type PartnerRegistrationsClientCreateOrUpdateResponse 

type PartnerRegistrationsClientCreateOrUpdateResponse struct {
	// Information about a partner registration.
	PartnerRegistration
}

PartnerRegistrationsClientCreateOrUpdateResponse contains the response from method PartnerRegistrationsClient.BeginCreateOrUpdate.

type PartnerRegistrationsClientDeleteResponse 

type PartnerRegistrationsClientDeleteResponse struct {
}

PartnerRegistrationsClientDeleteResponse contains the response from method PartnerRegistrationsClient.BeginDelete.

type PartnerRegistrationsClientGetOptions 

type PartnerRegistrationsClientGetOptions struct {
}

PartnerRegistrationsClientGetOptions contains the optional parameters for the PartnerRegistrationsClient.Get method.

type PartnerRegistrationsClientGetResponse 

type PartnerRegistrationsClientGetResponse struct {
	// Information about a partner registration.
	PartnerRegistration
}

PartnerRegistrationsClientGetResponse contains the response from method PartnerRegistrationsClient.Get.

type PartnerRegistrationsClientListByResourceGroupOptions 

type PartnerRegistrationsClientListByResourceGroupOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

PartnerRegistrationsClientListByResourceGroupOptions contains the optional parameters for the PartnerRegistrationsClient.NewListByResourceGroupPager method.

type PartnerRegistrationsClientListByResourceGroupResponse 

type PartnerRegistrationsClientListByResourceGroupResponse struct {
	// Result of the List Partner Registrations operation.
	PartnerRegistrationsListResult
}

PartnerRegistrationsClientListByResourceGroupResponse contains the response from method PartnerRegistrationsClient.NewListByResourceGroupPager.

type PartnerRegistrationsClientListBySubscriptionOptions 

type PartnerRegistrationsClientListBySubscriptionOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

PartnerRegistrationsClientListBySubscriptionOptions contains the optional parameters for the PartnerRegistrationsClient.NewListBySubscriptionPager method.

type PartnerRegistrationsClientListBySubscriptionResponse 

type PartnerRegistrationsClientListBySubscriptionResponse struct {
	// Result of the List Partner Registrations operation.
	PartnerRegistrationsListResult
}

PartnerRegistrationsClientListBySubscriptionResponse contains the response from method PartnerRegistrationsClient.NewListBySubscriptionPager.

type PartnerRegistrationsClientUpdateResponse 

type PartnerRegistrationsClientUpdateResponse struct {
	// Information about a partner registration.
	PartnerRegistration
}

PartnerRegistrationsClientUpdateResponse contains the response from method PartnerRegistrationsClient.BeginUpdate.

type PartnerRegistrationsListResult 

type PartnerRegistrationsListResult struct {
	// A link for the next page of partner registrations.
	NextLink *string

	// A collection of partner registrations.
	Value []*PartnerRegistration
}

PartnerRegistrationsListResult - Result of the List Partner Registrations operation.

func (PartnerRegistrationsListResult) MarshalJSON added in v2.1.0 

func (p PartnerRegistrationsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerRegistrationsListResult.

func (*PartnerRegistrationsListResult) UnmarshalJSON added in v2.1.0 

func (p *PartnerRegistrationsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerRegistrationsListResult.

type PartnerTopic 

type PartnerTopic struct {
	// REQUIRED; Location of the resource.
	Location *string

	// Identity information for the Partner Topic resource.
	Identity *IdentityInfo

	// Properties of the Partner Topic.
	Properties *PartnerTopicProperties

	// Tags of the resource.
	Tags map[string]*string

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to Partner Topic resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

PartnerTopic - Event Grid Partner Topic.

func (PartnerTopic) MarshalJSON 

func (p PartnerTopic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerTopic.

func (*PartnerTopic) UnmarshalJSON added in v2.1.0 

func (p *PartnerTopic) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerTopic.

type PartnerTopicActivationState 

type PartnerTopicActivationState string

PartnerTopicActivationState - Activation state of the partner topic. 

const (
	PartnerTopicActivationStateActivated      PartnerTopicActivationState = "Activated"
	PartnerTopicActivationStateDeactivated    PartnerTopicActivationState = "Deactivated"
	PartnerTopicActivationStateNeverActivated PartnerTopicActivationState = "NeverActivated"
)

func PossiblePartnerTopicActivationStateValues 

func PossiblePartnerTopicActivationStateValues() []PartnerTopicActivationState

PossiblePartnerTopicActivationStateValues returns the possible values for the PartnerTopicActivationState const type.

type PartnerTopicEventSubscriptionsClient 

type PartnerTopicEventSubscriptionsClient struct {
	// contains filtered or unexported fields
}

PartnerTopicEventSubscriptionsClient contains the methods for the PartnerTopicEventSubscriptions group. Don't use this type directly, use NewPartnerTopicEventSubscriptionsClient() instead.

func NewPartnerTopicEventSubscriptionsClient 

func NewPartnerTopicEventSubscriptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PartnerTopicEventSubscriptionsClient, error)

NewPartnerTopicEventSubscriptionsClient creates a new instance of PartnerTopicEventSubscriptionsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PartnerTopicEventSubscriptionsClient) BeginCreateOrUpdate 

func (client *PartnerTopicEventSubscriptionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, partnerTopicName string, eventSubscriptionName string, eventSubscriptionInfo EventSubscription, options *PartnerTopicEventSubscriptionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[PartnerTopicEventSubscriptionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • eventSubscriptionInfo - Event subscription properties containing the destination and filter information.
  • options - PartnerTopicEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopicEventSubscriptions_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerTopicEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "examplerg", "examplePartnerTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
				EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("exampleEventSubscriptionName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerTopics/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/exampleEventSubscriptionName1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
// 			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
// 				EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
// 			},
// 		},
// 		EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 		RetryPolicy: &armeventgrid.RetryPolicy{
// 			EventTimeToLiveInMinutes: to.Ptr[int32](1440),
// 			MaxDeliveryAttempts: to.Ptr[int32](30),
// 		},
// 		Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1"),
// 	},
// }

Output:

func (*PartnerTopicEventSubscriptionsClient) BeginDelete 

func (client *PartnerTopicEventSubscriptionsClient) BeginDelete(ctx context.Context, resourceGroupName string, partnerTopicName string, eventSubscriptionName string, options *PartnerTopicEventSubscriptionsClientBeginDeleteOptions) (*runtime.Poller[PartnerTopicEventSubscriptionsClientDeleteResponse], error)

BeginDelete - Delete an existing event subscription of a partner topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - PartnerTopicEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopicEventSubscriptions_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerTopicEventSubscriptionsClient().BeginDelete(ctx, "examplerg", "examplePartnerTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PartnerTopicEventSubscriptionsClient) BeginUpdate 

func (client *PartnerTopicEventSubscriptionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, partnerTopicName string, eventSubscriptionName string, eventSubscriptionUpdateParameters EventSubscriptionUpdateParameters, options *PartnerTopicEventSubscriptionsClientBeginUpdateOptions) (*runtime.Poller[PartnerTopicEventSubscriptionsClientUpdateResponse], error)

BeginUpdate - Update an existing event subscription of a partner topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • eventSubscriptionUpdateParameters - Updated event subscription information.
  • options - PartnerTopicEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopicEventSubscriptions_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerTopicEventSubscriptionsClient().BeginUpdate(ctx, "examplerg", "examplePartnerTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.WebHookEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
		Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
			EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PartnerTopicEventSubscriptionsClient) Get 

func (client *PartnerTopicEventSubscriptionsClient) Get(ctx context.Context, resourceGroupName string, partnerTopicName string, eventSubscriptionName string, options *PartnerTopicEventSubscriptionsClientGetOptions) (PartnerTopicEventSubscriptionsClientGetResponse, error)

Get - Get properties of an event subscription of a partner topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • eventSubscriptionName - Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - PartnerTopicEventSubscriptionsClientGetOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopicEventSubscriptions_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerTopicEventSubscriptionsClient().Get(ctx, "examplerg", "examplePartnerTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerTopics/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
// 			Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
// 				QueueName: to.Ptr("que"),
// 				ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
// 			},
// 		},
// 		EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IncludedEventTypes: []*string{
// 				to.Ptr("Microsoft.Storage.BlobCreated"),
// 				to.Ptr("Microsoft.Storage.BlobDeleted")},
// 				IsSubjectCaseSensitive: to.Ptr(false),
// 				SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 				SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 			},
// 			Labels: []*string{
// 				to.Ptr("label1"),
// 				to.Ptr("label2")},
// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 				RetryPolicy: &armeventgrid.RetryPolicy{
// 					EventTimeToLiveInMinutes: to.Ptr[int32](1440),
// 					MaxDeliveryAttempts: to.Ptr[int32](30),
// 				},
// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1"),
// 			},
// 		}

Output:

func (*PartnerTopicEventSubscriptionsClient) GetDeliveryAttributes 

func (client *PartnerTopicEventSubscriptionsClient) GetDeliveryAttributes(ctx context.Context, resourceGroupName string, partnerTopicName string, eventSubscriptionName string, options *PartnerTopicEventSubscriptionsClientGetDeliveryAttributesOptions) (PartnerTopicEventSubscriptionsClientGetDeliveryAttributesResponse, error)

GetDeliveryAttributes - Get all delivery attributes for an event subscription of a partner topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - PartnerTopicEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.GetDeliveryAttributes method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopicEventSubscriptions_GetDeliveryAttributes.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerTopicEventSubscriptionsClient().GetDeliveryAttributes(ctx, "examplerg", "examplePartnerTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeliveryAttributeListResult = armeventgrid.DeliveryAttributeListResult{
// 	Value: []armeventgrid.DeliveryAttributeMappingClassification{
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header1"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 			Properties: &armeventgrid.StaticDeliveryAttributeMappingProperties{
// 				IsSecret: to.Ptr(false),
// 				Value: to.Ptr("NormalValue"),
// 			},
// 		},
// 		&armeventgrid.DynamicDeliveryAttributeMapping{
// 			Name: to.Ptr("header2"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeDynamic),
// 			Properties: &armeventgrid.DynamicDeliveryAttributeMappingProperties{
// 				SourceField: to.Ptr("data.foo"),
// 			},
// 		},
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header3"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 			Properties: &armeventgrid.StaticDeliveryAttributeMappingProperties{
// 				IsSecret: to.Ptr(true),
// 				Value: to.Ptr("mySecretValue"),
// 			},
// 	}},
// }

Output:

func (*PartnerTopicEventSubscriptionsClient) GetFullURL 

func (client *PartnerTopicEventSubscriptionsClient) GetFullURL(ctx context.Context, resourceGroupName string, partnerTopicName string, eventSubscriptionName string, options *PartnerTopicEventSubscriptionsClientGetFullURLOptions) (PartnerTopicEventSubscriptionsClientGetFullURLResponse, error)

GetFullURL - Get the full endpoint URL for an event subscription of a partner topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - PartnerTopicEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.GetFullURL method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopicEventSubscriptions_GetFullUrl.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerTopicEventSubscriptionsClient().GetFullURL(ctx, "examplerg", "examplePartnerTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscriptionFullURL = armeventgrid.EventSubscriptionFullURL{
// 	EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
// }

Output:

func (*PartnerTopicEventSubscriptionsClient) NewListByPartnerTopicPager 

func (client *PartnerTopicEventSubscriptionsClient) NewListByPartnerTopicPager(resourceGroupName string, partnerTopicName string, options *PartnerTopicEventSubscriptionsClientListByPartnerTopicOptions) *runtime.Pager[PartnerTopicEventSubscriptionsClientListByPartnerTopicResponse]

NewListByPartnerTopicPager - List event subscriptions that belong to a specific partner topic.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • options - PartnerTopicEventSubscriptionsClientListByPartnerTopicOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.NewListByPartnerTopicPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopicEventSubscriptions_ListByPartnerTopic.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPartnerTopicEventSubscriptionsClient().NewListByPartnerTopicPager("examplerg", "examplePartnerTopic1", &armeventgrid.PartnerTopicEventSubscriptionsClientListByPartnerTopicOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerTopics/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/examplesubscription1"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
	// 					Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
	// 						QueueName: to.Ptr("que"),
	// 						ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
	// 					},
	// 				},
	// 				EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				Labels: []*string{
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				RetryPolicy: &armeventgrid.RetryPolicy{
	// 					EventTimeToLiveInMinutes: to.Ptr[int32](1440),
	// 					MaxDeliveryAttempts: to.Ptr[int32](10),
	// 				},
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("examplesubscription2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerTopics/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/examplesubscription2"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
	// 					Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
	// 						QueueName: to.Ptr("que"),
	// 						ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
	// 					},
	// 				},
	// 				EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IncludedEventTypes: []*string{
	// 						to.Ptr("Microsoft.Storage.BlobCreated"),
	// 						to.Ptr("Microsoft.Storage.BlobDeleted")},
	// 						IsSubjectCaseSensitive: to.Ptr(false),
	// 						SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 						SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 					},
	// 					Labels: []*string{
	// 						to.Ptr("label1"),
	// 						to.Ptr("label2")},
	// 						ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 						RetryPolicy: &armeventgrid.RetryPolicy{
	// 							EventTimeToLiveInMinutes: to.Ptr[int32](1440),
	// 							MaxDeliveryAttempts: to.Ptr[int32](30),
	// 						},
	// 						Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1"),
	// 					},
	// 			}},
	// 		}
}

Output:

type PartnerTopicEventSubscriptionsClientBeginCreateOrUpdateOptions 

type PartnerTopicEventSubscriptionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerTopicEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.BeginCreateOrUpdate method.

type PartnerTopicEventSubscriptionsClientBeginDeleteOptions 

type PartnerTopicEventSubscriptionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerTopicEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.BeginDelete method.

type PartnerTopicEventSubscriptionsClientBeginUpdateOptions 

type PartnerTopicEventSubscriptionsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerTopicEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.BeginUpdate method.

type PartnerTopicEventSubscriptionsClientCreateOrUpdateResponse 

type PartnerTopicEventSubscriptionsClientCreateOrUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

PartnerTopicEventSubscriptionsClientCreateOrUpdateResponse contains the response from method PartnerTopicEventSubscriptionsClient.BeginCreateOrUpdate.

type PartnerTopicEventSubscriptionsClientDeleteResponse 

type PartnerTopicEventSubscriptionsClientDeleteResponse struct {
}

PartnerTopicEventSubscriptionsClientDeleteResponse contains the response from method PartnerTopicEventSubscriptionsClient.BeginDelete.

type PartnerTopicEventSubscriptionsClientGetDeliveryAttributesOptions 

type PartnerTopicEventSubscriptionsClientGetDeliveryAttributesOptions struct {
}

PartnerTopicEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.GetDeliveryAttributes method.

type PartnerTopicEventSubscriptionsClientGetDeliveryAttributesResponse 

type PartnerTopicEventSubscriptionsClientGetDeliveryAttributesResponse struct {
	// Result of the Get delivery attributes operation.
	DeliveryAttributeListResult
}

PartnerTopicEventSubscriptionsClientGetDeliveryAttributesResponse contains the response from method PartnerTopicEventSubscriptionsClient.GetDeliveryAttributes.

type PartnerTopicEventSubscriptionsClientGetFullURLOptions 

type PartnerTopicEventSubscriptionsClientGetFullURLOptions struct {
}

PartnerTopicEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.GetFullURL method.

type PartnerTopicEventSubscriptionsClientGetFullURLResponse 

type PartnerTopicEventSubscriptionsClientGetFullURLResponse struct {
	// Full endpoint url of an event subscription
	EventSubscriptionFullURL
}

PartnerTopicEventSubscriptionsClientGetFullURLResponse contains the response from method PartnerTopicEventSubscriptionsClient.GetFullURL.

type PartnerTopicEventSubscriptionsClientGetOptions 

type PartnerTopicEventSubscriptionsClientGetOptions struct {
}

PartnerTopicEventSubscriptionsClientGetOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.Get method.

type PartnerTopicEventSubscriptionsClientGetResponse 

type PartnerTopicEventSubscriptionsClientGetResponse struct {
	// Event Subscription
	EventSubscription
}

PartnerTopicEventSubscriptionsClientGetResponse contains the response from method PartnerTopicEventSubscriptionsClient.Get.

type PartnerTopicEventSubscriptionsClientListByPartnerTopicOptions 

type PartnerTopicEventSubscriptionsClientListByPartnerTopicOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

PartnerTopicEventSubscriptionsClientListByPartnerTopicOptions contains the optional parameters for the PartnerTopicEventSubscriptionsClient.NewListByPartnerTopicPager method.

type PartnerTopicEventSubscriptionsClientListByPartnerTopicResponse 

type PartnerTopicEventSubscriptionsClientListByPartnerTopicResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

PartnerTopicEventSubscriptionsClientListByPartnerTopicResponse contains the response from method PartnerTopicEventSubscriptionsClient.NewListByPartnerTopicPager.

type PartnerTopicEventSubscriptionsClientUpdateResponse 

type PartnerTopicEventSubscriptionsClientUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

PartnerTopicEventSubscriptionsClientUpdateResponse contains the response from method PartnerTopicEventSubscriptionsClient.BeginUpdate.

type PartnerTopicInfo 

type PartnerTopicInfo struct {
	// Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure
	// subscription.
	AzureSubscriptionID *string

	// Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber
	// to view different types of events that are published.
	EventTypeInfo *EventTypeInfo

	// Name of the partner topic associated with the channel.
	Name *string

	// Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource
	// group.
	ResourceGroupName *string

	// The source information is provided by the publisher to determine the scope or context from which the events are originating.
	// This information can be used by the subscriber during the approval process
	// of the created partner topic.
	Source *string
}

PartnerTopicInfo - Properties of the corresponding partner topic of a Channel.

func (PartnerTopicInfo) MarshalJSON added in v2.1.0 

func (p PartnerTopicInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerTopicInfo.

func (*PartnerTopicInfo) UnmarshalJSON added in v2.1.0 

func (p *PartnerTopicInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerTopicInfo.

type PartnerTopicProperties 

type PartnerTopicProperties struct {
	// Activation state of the partner topic.
	ActivationState *PartnerTopicActivationState

	// Event Type information from the corresponding event channel.
	EventTypeInfo *EventTypeInfo

	// Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner
	// topic and corresponding event channel are deleted.
	ExpirationTimeIfNotActivatedUTC *time.Time

	// Context or helpful message that can be used during the approval process by the subscriber.
	MessageForActivation *string

	// The immutableId of the corresponding partner registration.
	PartnerRegistrationImmutableID *string

	// Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer
	// partner topic. This will be helpful to remove any ambiguity of the origin of
	// creation of the partner topic for the customer.
	PartnerTopicFriendlyDescription *string

	// Source associated with this partner topic. This represents a unique partner resource.
	Source *string

	// READ-ONLY; Provisioning state of the partner topic.
	ProvisioningState *PartnerTopicProvisioningState
}

PartnerTopicProperties - Properties of the Partner Topic.

func (PartnerTopicProperties) MarshalJSON 

func (p PartnerTopicProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerTopicProperties.

func (*PartnerTopicProperties) UnmarshalJSON 

func (p *PartnerTopicProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerTopicProperties.

type PartnerTopicProvisioningState 

type PartnerTopicProvisioningState string

PartnerTopicProvisioningState - Provisioning state of the partner topic. 

const (
	PartnerTopicProvisioningStateCanceled                                 PartnerTopicProvisioningState = "Canceled"
	PartnerTopicProvisioningStateCreating                                 PartnerTopicProvisioningState = "Creating"
	PartnerTopicProvisioningStateDeleting                                 PartnerTopicProvisioningState = "Deleting"
	PartnerTopicProvisioningStateFailed                                   PartnerTopicProvisioningState = "Failed"
	PartnerTopicProvisioningStateIdleDueToMirroredChannelResourceDeletion PartnerTopicProvisioningState = "IdleDueToMirroredChannelResourceDeletion"
	PartnerTopicProvisioningStateSucceeded                                PartnerTopicProvisioningState = "Succeeded"
	PartnerTopicProvisioningStateUpdating                                 PartnerTopicProvisioningState = "Updating"
)

func PossiblePartnerTopicProvisioningStateValues 

func PossiblePartnerTopicProvisioningStateValues() []PartnerTopicProvisioningState

PossiblePartnerTopicProvisioningStateValues returns the possible values for the PartnerTopicProvisioningState const type.

type PartnerTopicRoutingMode 

type PartnerTopicRoutingMode string

PartnerTopicRoutingMode - This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. 

const (
	PartnerTopicRoutingModeChannelNameHeader    PartnerTopicRoutingMode = "ChannelNameHeader"
	PartnerTopicRoutingModeSourceEventAttribute PartnerTopicRoutingMode = "SourceEventAttribute"
)

func PossiblePartnerTopicRoutingModeValues 

func PossiblePartnerTopicRoutingModeValues() []PartnerTopicRoutingMode

PossiblePartnerTopicRoutingModeValues returns the possible values for the PartnerTopicRoutingMode const type.

type PartnerTopicUpdateParameters 

type PartnerTopicUpdateParameters struct {
	// Identity information for the Partner Topic resource.
	Identity *IdentityInfo

	// Tags of the Partner Topic resource.
	Tags map[string]*string
}

PartnerTopicUpdateParameters - Properties of the Partner Topic update.

func (PartnerTopicUpdateParameters) MarshalJSON 

func (p PartnerTopicUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerTopicUpdateParameters.

func (*PartnerTopicUpdateParameters) UnmarshalJSON added in v2.1.0 

func (p *PartnerTopicUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerTopicUpdateParameters.

type PartnerTopicsClient 

type PartnerTopicsClient struct {
	// contains filtered or unexported fields
}

PartnerTopicsClient contains the methods for the PartnerTopics group. Don't use this type directly, use NewPartnerTopicsClient() instead.

func NewPartnerTopicsClient 

func NewPartnerTopicsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PartnerTopicsClient, error)

NewPartnerTopicsClient creates a new instance of PartnerTopicsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PartnerTopicsClient) Activate 

func (client *PartnerTopicsClient) Activate(ctx context.Context, resourceGroupName string, partnerTopicName string, options *PartnerTopicsClientActivateOptions) (PartnerTopicsClientActivateResponse, error)

Activate - Activate a newly created partner topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • options - PartnerTopicsClientActivateOptions contains the optional parameters for the PartnerTopicsClient.Activate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_Activate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerTopicsClient().Activate(ctx, "examplerg", "examplePartnerTopic1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerTopic = armeventgrid.PartnerTopic{
// 	Name: to.Ptr("examplePartnerTopic1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerTopics"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1"),
// 	Location: to.Ptr("centraluseuap"),
// 	Properties: &armeventgrid.PartnerTopicProperties{
// 		ActivationState: to.Ptr(armeventgrid.PartnerTopicActivationStateActivated),
// 		ProvisioningState: to.Ptr(armeventgrid.PartnerTopicProvisioningStateSucceeded),
// 		Source: to.Ptr("ContosoCorp.Accounts.User1"),
// 	},
// }

Output:

func (*PartnerTopicsClient) BeginDelete 

func (client *PartnerTopicsClient) BeginDelete(ctx context.Context, resourceGroupName string, partnerTopicName string, options *PartnerTopicsClientBeginDeleteOptions) (*runtime.Poller[PartnerTopicsClientDeleteResponse], error)

BeginDelete - Delete existing partner topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • options - PartnerTopicsClientBeginDeleteOptions contains the optional parameters for the PartnerTopicsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPartnerTopicsClient().BeginDelete(ctx, "examplerg", "examplePartnerTopicName1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PartnerTopicsClient) CreateOrUpdate 

func (client *PartnerTopicsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, partnerTopicName string, partnerTopicInfo PartnerTopic, options *PartnerTopicsClientCreateOrUpdateOptions) (PartnerTopicsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Asynchronously creates a new partner topic with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • partnerTopicInfo - Partner Topic information.
  • options - PartnerTopicsClientCreateOrUpdateOptions contains the optional parameters for the PartnerTopicsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerTopicsClient().CreateOrUpdate(ctx, "examplerg", "examplePartnerTopicName1", armeventgrid.PartnerTopic{
	Location: to.Ptr("westus2"),
	Properties: &armeventgrid.PartnerTopicProperties{
		ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-23T23:06:13.109Z"); return t }()),
		MessageForActivation:            to.Ptr("Example message for activation"),
		PartnerRegistrationImmutableID:  to.Ptr("6f541064-031d-4cc8-9ec3-a3b4fc0f7185"),
		PartnerTopicFriendlyDescription: to.Ptr("Example description"),
		Source:                          to.Ptr("ContosoCorp.Accounts.User1"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerTopic = armeventgrid.PartnerTopic{
// 	Name: to.Ptr("examplePartnerTopicName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerTopics"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopicName1"),
// 	Location: to.Ptr("centraluseuap"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armeventgrid.PartnerTopicProperties{
// 		ActivationState: to.Ptr(armeventgrid.PartnerTopicActivationStateNeverActivated),
// 		ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-23T23:06:13.109Z"); return t}()),
// 		MessageForActivation: to.Ptr("Example message for activation"),
// 		PartnerRegistrationImmutableID: to.Ptr("6f541064-031d-4cc8-9ec3-a3b4fc0f7185"),
// 		PartnerTopicFriendlyDescription: to.Ptr("Example description"),
// 		ProvisioningState: to.Ptr(armeventgrid.PartnerTopicProvisioningStateSucceeded),
// 		Source: to.Ptr("ContosoCorp.Accounts.User1"),
// 	},
// }

Output:

func (*PartnerTopicsClient) Deactivate 

func (client *PartnerTopicsClient) Deactivate(ctx context.Context, resourceGroupName string, partnerTopicName string, options *PartnerTopicsClientDeactivateOptions) (PartnerTopicsClientDeactivateResponse, error)

Deactivate - Deactivate specific partner topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • options - PartnerTopicsClientDeactivateOptions contains the optional parameters for the PartnerTopicsClient.Deactivate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_Deactivate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerTopicsClient().Deactivate(ctx, "examplerg", "examplePartnerTopic1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerTopic = armeventgrid.PartnerTopic{
// 	Name: to.Ptr("examplePartnerTopic1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerTopics"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1"),
// 	Location: to.Ptr("centraluseuap"),
// 	Properties: &armeventgrid.PartnerTopicProperties{
// 		ActivationState: to.Ptr(armeventgrid.PartnerTopicActivationStateDeactivated),
// 		ProvisioningState: to.Ptr(armeventgrid.PartnerTopicProvisioningStateSucceeded),
// 		Source: to.Ptr("ContosoCorp.Accounts.User1"),
// 	},
// }

Output:

func (*PartnerTopicsClient) Get 

func (client *PartnerTopicsClient) Get(ctx context.Context, resourceGroupName string, partnerTopicName string, options *PartnerTopicsClientGetOptions) (PartnerTopicsClientGetResponse, error)

Get - Get properties of a partner topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • options - PartnerTopicsClientGetOptions contains the optional parameters for the PartnerTopicsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPartnerTopicsClient().Get(ctx, "examplerg", "examplePartnerTopicName1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PartnerTopic = armeventgrid.PartnerTopic{
// 	Name: to.Ptr("examplePartnerTopicName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/partnerTopics"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopicName1"),
// 	Location: to.Ptr("centraluseuap"),
// 	Properties: &armeventgrid.PartnerTopicProperties{
// 		ActivationState: to.Ptr(armeventgrid.PartnerTopicActivationStateNeverActivated),
// 		ProvisioningState: to.Ptr(armeventgrid.PartnerTopicProvisioningStateSucceeded),
// 		Source: to.Ptr("ContosoCorp.Accounts.User1"),
// 	},
// }

Output:

func (*PartnerTopicsClient) NewListByResourceGroupPager 

func (client *PartnerTopicsClient) NewListByResourceGroupPager(resourceGroupName string, options *PartnerTopicsClientListByResourceGroupOptions) *runtime.Pager[PartnerTopicsClientListByResourceGroupResponse]

NewListByResourceGroupPager - List all the partner topics under a resource group.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • options - PartnerTopicsClientListByResourceGroupOptions contains the optional parameters for the PartnerTopicsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_ListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPartnerTopicsClient().NewListByResourceGroupPager("examplerg", &armeventgrid.PartnerTopicsClientListByResourceGroupOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PartnerTopicsListResult = armeventgrid.PartnerTopicsListResult{
	// 	Value: []*armeventgrid.PartnerTopic{
	// 		{
	// 			Name: to.Ptr("examplePartnerTopic1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerTopics"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1"),
	// 			Location: to.Ptr("centraluseuap"),
	// 			Properties: &armeventgrid.PartnerTopicProperties{
	// 				ActivationState: to.Ptr(armeventgrid.PartnerTopicActivationStateNeverActivated),
	// 				ProvisioningState: to.Ptr(armeventgrid.PartnerTopicProvisioningStateSucceeded),
	// 				Source: to.Ptr("ContosoCorp.Accounts.User1"),
	// 			},
	// 	}},
	// }
}

Output:

func (*PartnerTopicsClient) NewListBySubscriptionPager 

func (client *PartnerTopicsClient) NewListBySubscriptionPager(options *PartnerTopicsClientListBySubscriptionOptions) *runtime.Pager[PartnerTopicsClientListBySubscriptionResponse]

NewListBySubscriptionPager - List all the partner topics under an Azure subscription.

Generated from API version 2022-06-15

  • options - PartnerTopicsClientListBySubscriptionOptions contains the optional parameters for the PartnerTopicsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_ListBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPartnerTopicsClient().NewListBySubscriptionPager(&armeventgrid.PartnerTopicsClientListBySubscriptionOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PartnerTopicsListResult = armeventgrid.PartnerTopicsListResult{
	// 	Value: []*armeventgrid.PartnerTopic{
	// 		{
	// 			Name: to.Ptr("examplePartnerTopic1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/partnerTopics"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1"),
	// 			Location: to.Ptr("centraluseuap"),
	// 			Properties: &armeventgrid.PartnerTopicProperties{
	// 				ActivationState: to.Ptr(armeventgrid.PartnerTopicActivationStateNeverActivated),
	// 				ProvisioningState: to.Ptr(armeventgrid.PartnerTopicProvisioningStateSucceeded),
	// 				Source: to.Ptr("ContosoCorp.Accounts.User1"),
	// 			},
	// 	}},
	// }
}

Output:

func (*PartnerTopicsClient) Update 

func (client *PartnerTopicsClient) Update(ctx context.Context, resourceGroupName string, partnerTopicName string, partnerTopicUpdateParameters PartnerTopicUpdateParameters, options *PartnerTopicsClientUpdateOptions) (PartnerTopicsClientUpdateResponse, error)

Update - Asynchronously updates a partner topic with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • partnerTopicName - Name of the partner topic.
  • partnerTopicUpdateParameters - PartnerTopic update information.
  • options - PartnerTopicsClientUpdateOptions contains the optional parameters for the PartnerTopicsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewPartnerTopicsClient().Update(ctx, "examplerg", "examplePartnerTopicName1", armeventgrid.PartnerTopicUpdateParameters{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

type PartnerTopicsClientActivateOptions 

type PartnerTopicsClientActivateOptions struct {
}

PartnerTopicsClientActivateOptions contains the optional parameters for the PartnerTopicsClient.Activate method.

type PartnerTopicsClientActivateResponse 

type PartnerTopicsClientActivateResponse struct {
	// Event Grid Partner Topic.
	PartnerTopic
}

PartnerTopicsClientActivateResponse contains the response from method PartnerTopicsClient.Activate.

type PartnerTopicsClientBeginDeleteOptions 

type PartnerTopicsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PartnerTopicsClientBeginDeleteOptions contains the optional parameters for the PartnerTopicsClient.BeginDelete method.

type PartnerTopicsClientCreateOrUpdateOptions 

type PartnerTopicsClientCreateOrUpdateOptions struct {
}

PartnerTopicsClientCreateOrUpdateOptions contains the optional parameters for the PartnerTopicsClient.CreateOrUpdate method.

type PartnerTopicsClientCreateOrUpdateResponse 

type PartnerTopicsClientCreateOrUpdateResponse struct {
	// Event Grid Partner Topic.
	PartnerTopic
}

PartnerTopicsClientCreateOrUpdateResponse contains the response from method PartnerTopicsClient.CreateOrUpdate.

type PartnerTopicsClientDeactivateOptions 

type PartnerTopicsClientDeactivateOptions struct {
}

PartnerTopicsClientDeactivateOptions contains the optional parameters for the PartnerTopicsClient.Deactivate method.

type PartnerTopicsClientDeactivateResponse 

type PartnerTopicsClientDeactivateResponse struct {
	// Event Grid Partner Topic.
	PartnerTopic
}

PartnerTopicsClientDeactivateResponse contains the response from method PartnerTopicsClient.Deactivate.

type PartnerTopicsClientDeleteResponse 

type PartnerTopicsClientDeleteResponse struct {
}

PartnerTopicsClientDeleteResponse contains the response from method PartnerTopicsClient.BeginDelete.

type PartnerTopicsClientGetOptions 

type PartnerTopicsClientGetOptions struct {
}

PartnerTopicsClientGetOptions contains the optional parameters for the PartnerTopicsClient.Get method.

type PartnerTopicsClientGetResponse 

type PartnerTopicsClientGetResponse struct {
	// Event Grid Partner Topic.
	PartnerTopic
}

PartnerTopicsClientGetResponse contains the response from method PartnerTopicsClient.Get.

type PartnerTopicsClientListByResourceGroupOptions 

type PartnerTopicsClientListByResourceGroupOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

PartnerTopicsClientListByResourceGroupOptions contains the optional parameters for the PartnerTopicsClient.NewListByResourceGroupPager method.

type PartnerTopicsClientListByResourceGroupResponse 

type PartnerTopicsClientListByResourceGroupResponse struct {
	// Result of the List Partner Topics operation.
	PartnerTopicsListResult
}

PartnerTopicsClientListByResourceGroupResponse contains the response from method PartnerTopicsClient.NewListByResourceGroupPager.

type PartnerTopicsClientListBySubscriptionOptions 

type PartnerTopicsClientListBySubscriptionOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

PartnerTopicsClientListBySubscriptionOptions contains the optional parameters for the PartnerTopicsClient.NewListBySubscriptionPager method.

type PartnerTopicsClientListBySubscriptionResponse 

type PartnerTopicsClientListBySubscriptionResponse struct {
	// Result of the List Partner Topics operation.
	PartnerTopicsListResult
}

PartnerTopicsClientListBySubscriptionResponse contains the response from method PartnerTopicsClient.NewListBySubscriptionPager.

type PartnerTopicsClientUpdateOptions 

type PartnerTopicsClientUpdateOptions struct {
}

PartnerTopicsClientUpdateOptions contains the optional parameters for the PartnerTopicsClient.Update method.

type PartnerTopicsClientUpdateResponse 

type PartnerTopicsClientUpdateResponse struct {
	// Event Grid Partner Topic.
	PartnerTopic
}

PartnerTopicsClientUpdateResponse contains the response from method PartnerTopicsClient.Update.

type PartnerTopicsListResult 

type PartnerTopicsListResult struct {
	// A link for the next page of partner topics.
	NextLink *string

	// A collection of partner topics.
	Value []*PartnerTopic
}

PartnerTopicsListResult - Result of the List Partner Topics operation.

func (PartnerTopicsListResult) MarshalJSON added in v2.1.0 

func (p PartnerTopicsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerTopicsListResult.

func (*PartnerTopicsListResult) UnmarshalJSON added in v2.1.0 

func (p *PartnerTopicsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerTopicsListResult.

type PartnerUpdateTopicInfo 

type PartnerUpdateTopicInfo struct {
	// Event type info for the partner topic
	EventTypeInfo *EventTypeInfo
}

PartnerUpdateTopicInfo - Update properties for the corresponding partner topic of a channel.

func (PartnerUpdateTopicInfo) MarshalJSON added in v2.1.0 

func (p PartnerUpdateTopicInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartnerUpdateTopicInfo.

func (*PartnerUpdateTopicInfo) UnmarshalJSON added in v2.1.0 

func (p *PartnerUpdateTopicInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartnerUpdateTopicInfo.

type PersistedConnectionStatus 

type PersistedConnectionStatus string

PersistedConnectionStatus - Status of the connection. 

const (
	PersistedConnectionStatusApproved     PersistedConnectionStatus = "Approved"
	PersistedConnectionStatusDisconnected PersistedConnectionStatus = "Disconnected"
	PersistedConnectionStatusPending      PersistedConnectionStatus = "Pending"
	PersistedConnectionStatusRejected     PersistedConnectionStatus = "Rejected"
)

func PossiblePersistedConnectionStatusValues 

func PossiblePersistedConnectionStatusValues() []PersistedConnectionStatus

PossiblePersistedConnectionStatusValues returns the possible values for the PersistedConnectionStatus const type.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// The ARM identifier for Private Endpoint.
	ID *string
}

PrivateEndpoint information.

func (PrivateEndpoint) MarshalJSON added in v2.1.0 

func (p PrivateEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpoint.

func (*PrivateEndpoint) UnmarshalJSON added in v2.1.0 

func (p *PrivateEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpoint.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Properties of the PrivateEndpointConnection.
	Properties *PrivateEndpointConnectionProperties

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; Type of the resource.
	Type *string
}

func (PrivateEndpointConnection) MarshalJSON added in v2.1.0 

func (p PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON added in v2.1.0 

func (p *PrivateEndpointConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// A link for the next page of private endpoint connection resources.
	NextLink *string

	// A collection of private endpoint connection resources.
	Value []*PrivateEndpointConnection
}

PrivateEndpointConnectionListResult - Result of the list of all private endpoint connections operation.

func (PrivateEndpointConnectionListResult) MarshalJSON added in v2.1.0 

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

func (*PrivateEndpointConnectionListResult) UnmarshalJSON added in v2.1.0 

func (p *PrivateEndpointConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// GroupIds from the private link service resource.
	GroupIDs []*string

	// The Private Endpoint resource for this Connection.
	PrivateEndpoint *PrivateEndpoint

	// Details about the state of the connection.
	PrivateLinkServiceConnectionState *ConnectionState

	// Provisioning state of the Private Endpoint Connection.
	ProvisioningState *ResourceProvisioningState
}

PrivateEndpointConnectionProperties - Properties of the private endpoint connection resource.

func (PrivateEndpointConnectionProperties) MarshalJSON 

func (p PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

func (*PrivateEndpointConnectionProperties) UnmarshalJSON added in v2.1.0 

func (p *PrivateEndpointConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, parentType PrivateEndpointConnectionsParentType, parentName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)

BeginDelete - Delete a specific private endpoint connection under a topic, domain, or partner namespace. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • parentType - The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'.
  • parentName - The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
  • privateEndpointConnectionName - The name of the private endpoint connection connection.
  • options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PrivateEndpointConnections_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginDelete(ctx, "examplerg", armeventgrid.PrivateEndpointConnectionsParentTypeTopics, "exampletopic1", "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PrivateEndpointConnectionsClient) BeginUpdate 

func (client *PrivateEndpointConnectionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, parentType PrivateEndpointConnectionsParentType, parentName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection, options *PrivateEndpointConnectionsClientBeginUpdateOptions) (*runtime.Poller[PrivateEndpointConnectionsClientUpdateResponse], error)

BeginUpdate - Update a specific private endpoint connection under a topic, domain or partner namespace. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • parentType - The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'.
  • parentName - The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
  • privateEndpointConnectionName - The name of the private endpoint connection connection.
  • privateEndpointConnection - The private endpoint connection object to update.
  • options - PrivateEndpointConnectionsClientBeginUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PrivateEndpointConnections_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginUpdate(ctx, "examplerg", armeventgrid.PrivateEndpointConnectionsParentTypeTopics, "exampletopic1", "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", armeventgrid.PrivateEndpointConnection{
	Properties: &armeventgrid.PrivateEndpointConnectionProperties{
		PrivateLinkServiceConnectionState: &armeventgrid.ConnectionState{
			Description:     to.Ptr("approving connection"),
			ActionsRequired: to.Ptr("None"),
			Status:          to.Ptr(armeventgrid.PersistedConnectionStatusApproved),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateEndpointConnection = armeventgrid.PrivateEndpointConnection{
// 	Name: to.Ptr("BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B"),
// 	Type: to.Ptr("Microsoft.EventGrid/topics/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B"),
// 	Properties: &armeventgrid.PrivateEndpointConnectionProperties{
// 		GroupIDs: []*string{
// 			to.Ptr("topic")},
// 			PrivateEndpoint: &armeventgrid.PrivateEndpoint{
// 				ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5"),
// 			},
// 			PrivateLinkServiceConnectionState: &armeventgrid.ConnectionState{
// 				Description: to.Ptr("approving connection"),
// 				ActionsRequired: to.Ptr("None"),
// 				Status: to.Ptr(armeventgrid.PersistedConnectionStatusApproved),
// 			},
// 			ProvisioningState: to.Ptr(armeventgrid.ResourceProvisioningStateSucceeded),
// 		},
// 	}

Output:

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, parentType PrivateEndpointConnectionsParentType, parentName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Get a specific private endpoint connection under a topic, domain, or partner namespace. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • parentType - The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'.
  • parentName - The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
  • privateEndpointConnectionName - The name of the private endpoint connection connection.
  • options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PrivateEndpointConnections_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateEndpointConnectionsClient().Get(ctx, "examplerg", armeventgrid.PrivateEndpointConnectionsParentTypeTopics, "exampletopic1", "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateEndpointConnection = armeventgrid.PrivateEndpointConnection{
// 	Name: to.Ptr("BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B"),
// 	Type: to.Ptr("Microsoft.EventGrid/topics/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B"),
// 	Properties: &armeventgrid.PrivateEndpointConnectionProperties{
// 		GroupIDs: []*string{
// 			to.Ptr("topic")},
// 			PrivateEndpoint: &armeventgrid.PrivateEndpoint{
// 				ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5"),
// 			},
// 			PrivateLinkServiceConnectionState: &armeventgrid.ConnectionState{
// 				Description: to.Ptr("Test"),
// 				ActionsRequired: to.Ptr("None"),
// 				Status: to.Ptr(armeventgrid.PersistedConnectionStatusPending),
// 			},
// 			ProvisioningState: to.Ptr(armeventgrid.ResourceProvisioningStateSucceeded),
// 		},
// 	}

Output:

func (*PrivateEndpointConnectionsClient) NewListByResourcePager 

func (client *PrivateEndpointConnectionsClient) NewListByResourcePager(resourceGroupName string, parentType PrivateEndpointConnectionsParentType, parentName string, options *PrivateEndpointConnectionsClientListByResourceOptions) *runtime.Pager[PrivateEndpointConnectionsClientListByResourceResponse]

NewListByResourcePager - Get all private endpoint connections under a topic, domain, or partner namespace.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • parentType - The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'.
  • parentName - The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
  • options - PrivateEndpointConnectionsClientListByResourceOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListByResourcePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PrivateEndpointConnections_ListByResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListByResourcePager("examplerg", armeventgrid.PrivateEndpointConnectionsParentTypeTopics, "exampletopic1", &armeventgrid.PrivateEndpointConnectionsClientListByResourceOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PrivateEndpointConnectionListResult = armeventgrid.PrivateEndpointConnectionListResult{
	// 	Value: []*armeventgrid.PrivateEndpointConnection{
	// 		{
	// 			Name: to.Ptr("BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topics/privateEndpointConnections"),
	// 			ID: to.Ptr("/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B"),
	// 			Properties: &armeventgrid.PrivateEndpointConnectionProperties{
	// 				GroupIDs: []*string{
	// 					to.Ptr("topic")},
	// 					PrivateEndpoint: &armeventgrid.PrivateEndpoint{
	// 						ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5"),
	// 					},
	// 					PrivateLinkServiceConnectionState: &armeventgrid.ConnectionState{
	// 						Description: to.Ptr("Test"),
	// 						ActionsRequired: to.Ptr("None"),
	// 						Status: to.Ptr(armeventgrid.PersistedConnectionStatusPending),
	// 					},
	// 					ProvisioningState: to.Ptr(armeventgrid.ResourceProvisioningStateSucceeded),
	// 				},
	// 		}},
	// 	}
}

Output:

type PrivateEndpointConnectionsClientBeginDeleteOptions 

type PrivateEndpointConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientBeginUpdateOptions 

type PrivateEndpointConnectionsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointConnectionsClientBeginUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginUpdate method.

type PrivateEndpointConnectionsClientDeleteResponse 

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.BeginDelete.

type PrivateEndpointConnectionsClientGetOptions 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse 

type PrivateEndpointConnectionsClientGetResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListByResourceOptions 

type PrivateEndpointConnectionsClientListByResourceOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

PrivateEndpointConnectionsClientListByResourceOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListByResourcePager method.

type PrivateEndpointConnectionsClientListByResourceResponse 

type PrivateEndpointConnectionsClientListByResourceResponse struct {
	// Result of the list of all private endpoint connections operation.
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListByResourceResponse contains the response from method PrivateEndpointConnectionsClient.NewListByResourcePager.

type PrivateEndpointConnectionsClientUpdateResponse 

type PrivateEndpointConnectionsClientUpdateResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientUpdateResponse contains the response from method PrivateEndpointConnectionsClient.BeginUpdate.

type PrivateEndpointConnectionsParentType 

type PrivateEndpointConnectionsParentType string
const (
	PrivateEndpointConnectionsParentTypeDomains           PrivateEndpointConnectionsParentType = "domains"
	PrivateEndpointConnectionsParentTypePartnerNamespaces PrivateEndpointConnectionsParentType = "partnerNamespaces"
	PrivateEndpointConnectionsParentTypeTopics            PrivateEndpointConnectionsParentType = "topics"
)

func PossiblePrivateEndpointConnectionsParentTypeValues 

func PossiblePrivateEndpointConnectionsParentTypeValues() []PrivateEndpointConnectionsParentType

PossiblePrivateEndpointConnectionsParentTypeValues returns the possible values for the PrivateEndpointConnectionsParentType const type.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// Fully qualified identifier of the resource.
	ID *string

	// Name of the resource.
	Name *string

	// Properties of the private link resource.
	Properties *PrivateLinkResourceProperties

	// Type of the resource.
	Type *string
}

PrivateLinkResource - Information of the private link resource.

func (PrivateLinkResource) MarshalJSON added in v2.1.0 

func (p PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON added in v2.1.0 

func (p *PrivateLinkResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResource.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	DisplayName       *string
	GroupID           *string
	RequiredMembers   []*string
	RequiredZoneNames []*string
}

func (PrivateLinkResourceProperties) MarshalJSON added in v2.1.0 

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

func (*PrivateLinkResourceProperties) UnmarshalJSON added in v2.1.0 

func (p *PrivateLinkResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	// contains filtered or unexported fields
}

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) Get 

func (client *PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, parentType string, parentName string, privateLinkResourceName string, options *PrivateLinkResourcesClientGetOptions) (PrivateLinkResourcesClientGetResponse, error)

Get - Get properties of a private link resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • parentType - The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'.
  • parentName - The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
  • privateLinkResourceName - The name of private link resource.
  • options - PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PrivateLinkResources_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkResourcesClient().Get(ctx, "examplerg", "topics", "exampletopic1", "topic", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateLinkResource = armeventgrid.PrivateLinkResource{
// 	Name: to.Ptr("topic"),
// 	Type: to.Ptr("Microsoft.EventGrid/topics/privateLinkResources"),
// 	ID: to.Ptr("/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/amh/providers/Microsoft.EventGrid/topics/exampletopic1/privateLinkResources/topic"),
// 	Properties: &armeventgrid.PrivateLinkResourceProperties{
// 		DisplayName: to.Ptr("Event Grid topic"),
// 		GroupID: to.Ptr("topic"),
// 		RequiredMembers: []*string{
// 			to.Ptr("topic")},
// 			RequiredZoneNames: []*string{
// 				to.Ptr("privatelink.eventgrid.azure.net")},
// 			},
// 		}

Output:

func (*PrivateLinkResourcesClient) NewListByResourcePager 

func (client *PrivateLinkResourcesClient) NewListByResourcePager(resourceGroupName string, parentType string, parentName string, options *PrivateLinkResourcesClientListByResourceOptions) *runtime.Pager[PrivateLinkResourcesClientListByResourceResponse]

NewListByResourcePager - List all the private link resources under a topic, domain, or partner namespace.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • parentType - The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'.
  • parentName - The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
  • options - PrivateLinkResourcesClientListByResourceOptions contains the optional parameters for the PrivateLinkResourcesClient.NewListByResourcePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PrivateLinkResources_ListByResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateLinkResourcesClient().NewListByResourcePager("examplerg", "topics", "exampletopic1", &armeventgrid.PrivateLinkResourcesClientListByResourceOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PrivateLinkResourcesListResult = armeventgrid.PrivateLinkResourcesListResult{
	// 	Value: []*armeventgrid.PrivateLinkResource{
	// 		{
	// 			Name: to.Ptr("topic"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topics/privateLinkResources"),
	// 			ID: to.Ptr("/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/amh/providers/Microsoft.EventGrid/topics/exampletopic1/privateLinkResources/topic"),
	// 			Properties: &armeventgrid.PrivateLinkResourceProperties{
	// 				DisplayName: to.Ptr("Event Grid topic"),
	// 				GroupID: to.Ptr("topic"),
	// 				RequiredMembers: []*string{
	// 					to.Ptr("topic")},
	// 					RequiredZoneNames: []*string{
	// 						to.Ptr("privatelink.eventgrid.azure.net")},
	// 					},
	// 			}},
	// 		}
}

Output:

type PrivateLinkResourcesClientGetOptions 

type PrivateLinkResourcesClientGetOptions struct {
}

PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

type PrivateLinkResourcesClientGetResponse 

type PrivateLinkResourcesClientGetResponse struct {
	// Information of the private link resource.
	PrivateLinkResource
}

PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientListByResourceOptions 

type PrivateLinkResourcesClientListByResourceOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

PrivateLinkResourcesClientListByResourceOptions contains the optional parameters for the PrivateLinkResourcesClient.NewListByResourcePager method.

type PrivateLinkResourcesClientListByResourceResponse 

type PrivateLinkResourcesClientListByResourceResponse struct {
	// Result of the List private link resources operation.
	PrivateLinkResourcesListResult
}

PrivateLinkResourcesClientListByResourceResponse contains the response from method PrivateLinkResourcesClient.NewListByResourcePager.

type PrivateLinkResourcesListResult 

type PrivateLinkResourcesListResult struct {
	// A link for the next page of private link resources.
	NextLink *string

	// A collection of private link resources
	Value []*PrivateLinkResource
}

PrivateLinkResourcesListResult - Result of the List private link resources operation.

func (PrivateLinkResourcesListResult) MarshalJSON added in v2.1.0 

func (p PrivateLinkResourcesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourcesListResult.

func (*PrivateLinkResourcesListResult) UnmarshalJSON added in v2.1.0 

func (p *PrivateLinkResourcesListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourcesListResult.

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess - This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring 

const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

type ReadinessState 

type ReadinessState string

ReadinessState - The readiness state of the corresponding partner topic. 

const (
	ReadinessStateActivated      ReadinessState = "Activated"
	ReadinessStateNeverActivated ReadinessState = "NeverActivated"
)

func PossibleReadinessStateValues 

func PossibleReadinessStateValues() []ReadinessState

PossibleReadinessStateValues returns the possible values for the ReadinessState const type.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; Type of the resource.
	Type *string
}

Resource - Definition of a Resource.

func (Resource) MarshalJSON added in v2.1.0 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON added in v2.1.0 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceProvisioningState 

type ResourceProvisioningState string

ResourceProvisioningState - Provisioning state of the Private Endpoint Connection. 

const (
	ResourceProvisioningStateCanceled  ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateCreating  ResourceProvisioningState = "Creating"
	ResourceProvisioningStateDeleting  ResourceProvisioningState = "Deleting"
	ResourceProvisioningStateFailed    ResourceProvisioningState = "Failed"
	ResourceProvisioningStateSucceeded ResourceProvisioningState = "Succeeded"
	ResourceProvisioningStateUpdating  ResourceProvisioningState = "Updating"
)

func PossibleResourceProvisioningStateValues 

func PossibleResourceProvisioningStateValues() []ResourceProvisioningState

PossibleResourceProvisioningStateValues returns the possible values for the ResourceProvisioningState const type.

type ResourceRegionType 

type ResourceRegionType string

ResourceRegionType - Region type of the resource. 

const (
	ResourceRegionTypeGlobalResource   ResourceRegionType = "GlobalResource"
	ResourceRegionTypeRegionalResource ResourceRegionType = "RegionalResource"
)

func PossibleResourceRegionTypeValues 

func PossibleResourceRegionTypeValues() []ResourceRegionType

PossibleResourceRegionTypeValues returns the possible values for the ResourceRegionType const type.

type RetryPolicy 

type RetryPolicy struct {
	// Time To Live (in minutes) for events.
	EventTimeToLiveInMinutes *int32

	// Maximum number of delivery retry attempts for events.
	MaxDeliveryAttempts *int32
}

RetryPolicy - Information about the retry policy for an event subscription.

func (RetryPolicy) MarshalJSON added in v2.1.0 

func (r RetryPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RetryPolicy.

func (*RetryPolicy) UnmarshalJSON added in v2.1.0 

func (r *RetryPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RetryPolicy.

type ServiceBusQueueEventSubscriptionDestination 

type ServiceBusQueueEventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType

	// Service Bus Properties of the event subscription destination.
	Properties *ServiceBusQueueEventSubscriptionDestinationProperties
}

ServiceBusQueueEventSubscriptionDestination - Information about the service bus destination for an event subscription.

func (*ServiceBusQueueEventSubscriptionDestination) GetEventSubscriptionDestination 

func (s *ServiceBusQueueEventSubscriptionDestination) GetEventSubscriptionDestination() *EventSubscriptionDestination

GetEventSubscriptionDestination implements the EventSubscriptionDestinationClassification interface for type ServiceBusQueueEventSubscriptionDestination.

func (ServiceBusQueueEventSubscriptionDestination) MarshalJSON 

func (s ServiceBusQueueEventSubscriptionDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceBusQueueEventSubscriptionDestination.

func (*ServiceBusQueueEventSubscriptionDestination) UnmarshalJSON 

func (s *ServiceBusQueueEventSubscriptionDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceBusQueueEventSubscriptionDestination.

type ServiceBusQueueEventSubscriptionDestinationProperties 

type ServiceBusQueueEventSubscriptionDestinationProperties struct {
	// Delivery attribute details.
	DeliveryAttributeMappings []DeliveryAttributeMappingClassification

	// The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.
	ResourceID *string
}

ServiceBusQueueEventSubscriptionDestinationProperties - The properties that represent the Service Bus destination of an event subscription.

func (ServiceBusQueueEventSubscriptionDestinationProperties) MarshalJSON 

func (s ServiceBusQueueEventSubscriptionDestinationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceBusQueueEventSubscriptionDestinationProperties.

func (*ServiceBusQueueEventSubscriptionDestinationProperties) UnmarshalJSON 

func (s *ServiceBusQueueEventSubscriptionDestinationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceBusQueueEventSubscriptionDestinationProperties.

type ServiceBusTopicEventSubscriptionDestination 

type ServiceBusTopicEventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType

	// Service Bus Topic Properties of the event subscription destination.
	Properties *ServiceBusTopicEventSubscriptionDestinationProperties
}

ServiceBusTopicEventSubscriptionDestination - Information about the service bus topic destination for an event subscription.

func (*ServiceBusTopicEventSubscriptionDestination) GetEventSubscriptionDestination 

func (s *ServiceBusTopicEventSubscriptionDestination) GetEventSubscriptionDestination() *EventSubscriptionDestination

GetEventSubscriptionDestination implements the EventSubscriptionDestinationClassification interface for type ServiceBusTopicEventSubscriptionDestination.

func (ServiceBusTopicEventSubscriptionDestination) MarshalJSON 

func (s ServiceBusTopicEventSubscriptionDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceBusTopicEventSubscriptionDestination.

func (*ServiceBusTopicEventSubscriptionDestination) UnmarshalJSON 

func (s *ServiceBusTopicEventSubscriptionDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceBusTopicEventSubscriptionDestination.

type ServiceBusTopicEventSubscriptionDestinationProperties 

type ServiceBusTopicEventSubscriptionDestinationProperties struct {
	// Delivery attribute details.
	DeliveryAttributeMappings []DeliveryAttributeMappingClassification

	// The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription.
	ResourceID *string
}

ServiceBusTopicEventSubscriptionDestinationProperties - The properties that represent the Service Bus Topic destination of an event subscription.

func (ServiceBusTopicEventSubscriptionDestinationProperties) MarshalJSON 

func (s ServiceBusTopicEventSubscriptionDestinationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceBusTopicEventSubscriptionDestinationProperties.

func (*ServiceBusTopicEventSubscriptionDestinationProperties) UnmarshalJSON 

func (s *ServiceBusTopicEventSubscriptionDestinationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceBusTopicEventSubscriptionDestinationProperties.

type StaticDeliveryAttributeMapping 

type StaticDeliveryAttributeMapping struct {
	// REQUIRED; Type of the delivery attribute or header name.
	Type *DeliveryAttributeMappingType

	// Name of the delivery attribute or header.
	Name *string

	// Properties of static delivery attribute mapping.
	Properties *StaticDeliveryAttributeMappingProperties
}

StaticDeliveryAttributeMapping - Static delivery attribute mapping details.

func (*StaticDeliveryAttributeMapping) GetDeliveryAttributeMapping 

func (s *StaticDeliveryAttributeMapping) GetDeliveryAttributeMapping() *DeliveryAttributeMapping

GetDeliveryAttributeMapping implements the DeliveryAttributeMappingClassification interface for type StaticDeliveryAttributeMapping.

func (StaticDeliveryAttributeMapping) MarshalJSON 

func (s StaticDeliveryAttributeMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StaticDeliveryAttributeMapping.

func (*StaticDeliveryAttributeMapping) UnmarshalJSON 

func (s *StaticDeliveryAttributeMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StaticDeliveryAttributeMapping.

type StaticDeliveryAttributeMappingProperties 

type StaticDeliveryAttributeMappingProperties struct {
	// Boolean flag to tell if the attribute contains sensitive information .
	IsSecret *bool

	// Value of the delivery attribute.
	Value *string
}

StaticDeliveryAttributeMappingProperties - Properties of static delivery attribute mapping.

func (StaticDeliveryAttributeMappingProperties) MarshalJSON added in v2.1.0 

func (s StaticDeliveryAttributeMappingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StaticDeliveryAttributeMappingProperties.

func (*StaticDeliveryAttributeMappingProperties) UnmarshalJSON added in v2.1.0 

func (s *StaticDeliveryAttributeMappingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StaticDeliveryAttributeMappingProperties.

type StorageBlobDeadLetterDestination 

type StorageBlobDeadLetterDestination struct {
	// REQUIRED; Type of the endpoint for the dead letter destination
	EndpointType *DeadLetterEndPointType

	// The properties of the Storage Blob based deadletter destination
	Properties *StorageBlobDeadLetterDestinationProperties
}

StorageBlobDeadLetterDestination - Information about the storage blob based dead letter destination.

func (*StorageBlobDeadLetterDestination) GetDeadLetterDestination 

func (s *StorageBlobDeadLetterDestination) GetDeadLetterDestination() *DeadLetterDestination

GetDeadLetterDestination implements the DeadLetterDestinationClassification interface for type StorageBlobDeadLetterDestination.

func (StorageBlobDeadLetterDestination) MarshalJSON 

func (s StorageBlobDeadLetterDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageBlobDeadLetterDestination.

func (*StorageBlobDeadLetterDestination) UnmarshalJSON 

func (s *StorageBlobDeadLetterDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageBlobDeadLetterDestination.

type StorageBlobDeadLetterDestinationProperties 

type StorageBlobDeadLetterDestinationProperties struct {
	// The name of the Storage blob container that is the destination of the deadletter events
	BlobContainerName *string

	// The Azure Resource ID of the storage account that is the destination of the deadletter events
	ResourceID *string
}

StorageBlobDeadLetterDestinationProperties - Properties of the storage blob based dead letter destination.

func (StorageBlobDeadLetterDestinationProperties) MarshalJSON added in v2.1.0 

func (s StorageBlobDeadLetterDestinationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageBlobDeadLetterDestinationProperties.

func (*StorageBlobDeadLetterDestinationProperties) UnmarshalJSON added in v2.1.0 

func (s *StorageBlobDeadLetterDestinationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageBlobDeadLetterDestinationProperties.

type StorageQueueEventSubscriptionDestination 

type StorageQueueEventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType

	// Storage Queue Properties of the event subscription destination.
	Properties *StorageQueueEventSubscriptionDestinationProperties
}

StorageQueueEventSubscriptionDestination - Information about the storage queue destination for an event subscription.

func (*StorageQueueEventSubscriptionDestination) GetEventSubscriptionDestination 

func (s *StorageQueueEventSubscriptionDestination) GetEventSubscriptionDestination() *EventSubscriptionDestination

GetEventSubscriptionDestination implements the EventSubscriptionDestinationClassification interface for type StorageQueueEventSubscriptionDestination.

func (StorageQueueEventSubscriptionDestination) MarshalJSON 

func (s StorageQueueEventSubscriptionDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageQueueEventSubscriptionDestination.

func (*StorageQueueEventSubscriptionDestination) UnmarshalJSON 

func (s *StorageQueueEventSubscriptionDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageQueueEventSubscriptionDestination.

type StorageQueueEventSubscriptionDestinationProperties 

type StorageQueueEventSubscriptionDestinationProperties struct {
	// Storage queue message time to live in seconds.
	QueueMessageTimeToLiveInSeconds *int64

	// The name of the Storage queue under a storage account that is the destination of an event subscription.
	QueueName *string

	// The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.
	ResourceID *string
}

StorageQueueEventSubscriptionDestinationProperties - The properties for a storage queue destination.

func (StorageQueueEventSubscriptionDestinationProperties) MarshalJSON added in v2.1.0 

func (s StorageQueueEventSubscriptionDestinationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageQueueEventSubscriptionDestinationProperties.

func (*StorageQueueEventSubscriptionDestinationProperties) UnmarshalJSON added in v2.1.0 

func (s *StorageQueueEventSubscriptionDestinationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageQueueEventSubscriptionDestinationProperties.

type StringBeginsWithAdvancedFilter 

type StringBeginsWithAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values []*string
}

StringBeginsWithAdvancedFilter - StringBeginsWith Advanced Filter.

func (*StringBeginsWithAdvancedFilter) GetAdvancedFilter 

func (s *StringBeginsWithAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type StringBeginsWithAdvancedFilter.

func (StringBeginsWithAdvancedFilter) MarshalJSON 

func (s StringBeginsWithAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StringBeginsWithAdvancedFilter.

func (*StringBeginsWithAdvancedFilter) UnmarshalJSON 

func (s *StringBeginsWithAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StringBeginsWithAdvancedFilter.

type StringContainsAdvancedFilter 

type StringContainsAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values []*string
}

StringContainsAdvancedFilter - StringContains Advanced Filter.

func (*StringContainsAdvancedFilter) GetAdvancedFilter 

func (s *StringContainsAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type StringContainsAdvancedFilter.

func (StringContainsAdvancedFilter) MarshalJSON 

func (s StringContainsAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StringContainsAdvancedFilter.

func (*StringContainsAdvancedFilter) UnmarshalJSON 

func (s *StringContainsAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StringContainsAdvancedFilter.

type StringEndsWithAdvancedFilter 

type StringEndsWithAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values []*string
}

StringEndsWithAdvancedFilter - StringEndsWith Advanced Filter.

func (*StringEndsWithAdvancedFilter) GetAdvancedFilter 

func (s *StringEndsWithAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type StringEndsWithAdvancedFilter.

func (StringEndsWithAdvancedFilter) MarshalJSON 

func (s StringEndsWithAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StringEndsWithAdvancedFilter.

func (*StringEndsWithAdvancedFilter) UnmarshalJSON 

func (s *StringEndsWithAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StringEndsWithAdvancedFilter.

type StringInAdvancedFilter 

type StringInAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values []*string
}

StringInAdvancedFilter - StringIn Advanced Filter.

func (*StringInAdvancedFilter) GetAdvancedFilter 

func (s *StringInAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type StringInAdvancedFilter.

func (StringInAdvancedFilter) MarshalJSON 

func (s StringInAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StringInAdvancedFilter.

func (*StringInAdvancedFilter) UnmarshalJSON 

func (s *StringInAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StringInAdvancedFilter.

type StringNotBeginsWithAdvancedFilter 

type StringNotBeginsWithAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values []*string
}

StringNotBeginsWithAdvancedFilter - StringNotBeginsWith Advanced Filter.

func (*StringNotBeginsWithAdvancedFilter) GetAdvancedFilter 

func (s *StringNotBeginsWithAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type StringNotBeginsWithAdvancedFilter.

func (StringNotBeginsWithAdvancedFilter) MarshalJSON 

func (s StringNotBeginsWithAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StringNotBeginsWithAdvancedFilter.

func (*StringNotBeginsWithAdvancedFilter) UnmarshalJSON 

func (s *StringNotBeginsWithAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StringNotBeginsWithAdvancedFilter.

type StringNotContainsAdvancedFilter 

type StringNotContainsAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values []*string
}

StringNotContainsAdvancedFilter - StringNotContains Advanced Filter.

func (*StringNotContainsAdvancedFilter) GetAdvancedFilter 

func (s *StringNotContainsAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type StringNotContainsAdvancedFilter.

func (StringNotContainsAdvancedFilter) MarshalJSON 

func (s StringNotContainsAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StringNotContainsAdvancedFilter.

func (*StringNotContainsAdvancedFilter) UnmarshalJSON 

func (s *StringNotContainsAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StringNotContainsAdvancedFilter.

type StringNotEndsWithAdvancedFilter 

type StringNotEndsWithAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values []*string
}

StringNotEndsWithAdvancedFilter - StringNotEndsWith Advanced Filter.

func (*StringNotEndsWithAdvancedFilter) GetAdvancedFilter 

func (s *StringNotEndsWithAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type StringNotEndsWithAdvancedFilter.

func (StringNotEndsWithAdvancedFilter) MarshalJSON 

func (s StringNotEndsWithAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StringNotEndsWithAdvancedFilter.

func (*StringNotEndsWithAdvancedFilter) UnmarshalJSON 

func (s *StringNotEndsWithAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StringNotEndsWithAdvancedFilter.

type StringNotInAdvancedFilter 

type StringNotInAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType

	// The field/property in the event based on which you want to filter.
	Key *string

	// The set of filter values.
	Values []*string
}

StringNotInAdvancedFilter - StringNotIn Advanced Filter.

func (*StringNotInAdvancedFilter) GetAdvancedFilter 

func (s *StringNotInAdvancedFilter) GetAdvancedFilter() *AdvancedFilter

GetAdvancedFilter implements the AdvancedFilterClassification interface for type StringNotInAdvancedFilter.

func (StringNotInAdvancedFilter) MarshalJSON 

func (s StringNotInAdvancedFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StringNotInAdvancedFilter.

func (*StringNotInAdvancedFilter) UnmarshalJSON 

func (s *StringNotInAdvancedFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StringNotInAdvancedFilter.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type SystemTopic 

type SystemTopic struct {
	// REQUIRED; Location of the resource.
	Location *string

	// Identity information for the resource.
	Identity *IdentityInfo

	// Properties of the system topic.
	Properties *SystemTopicProperties

	// Tags of the resource.
	Tags map[string]*string

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to System Topic resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

SystemTopic - EventGrid System Topic.

func (SystemTopic) MarshalJSON 

func (s SystemTopic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemTopic.

func (*SystemTopic) UnmarshalJSON added in v2.1.0 

func (s *SystemTopic) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemTopic.

type SystemTopicEventSubscriptionsClient 

type SystemTopicEventSubscriptionsClient struct {
	// contains filtered or unexported fields
}

SystemTopicEventSubscriptionsClient contains the methods for the SystemTopicEventSubscriptions group. Don't use this type directly, use NewSystemTopicEventSubscriptionsClient() instead.

func NewSystemTopicEventSubscriptionsClient 

func NewSystemTopicEventSubscriptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SystemTopicEventSubscriptionsClient, error)

NewSystemTopicEventSubscriptionsClient creates a new instance of SystemTopicEventSubscriptionsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SystemTopicEventSubscriptionsClient) BeginCreateOrUpdate 

func (client *SystemTopicEventSubscriptionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, systemTopicName string, eventSubscriptionName string, eventSubscriptionInfo EventSubscription, options *SystemTopicEventSubscriptionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[SystemTopicEventSubscriptionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • eventSubscriptionInfo - Event subscription properties containing the destination and filter information.
  • options - SystemTopicEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSystemTopicEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleSystemTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
				EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*SystemTopicEventSubscriptionsClient) BeginDelete 

func (client *SystemTopicEventSubscriptionsClient) BeginDelete(ctx context.Context, resourceGroupName string, systemTopicName string, eventSubscriptionName string, options *SystemTopicEventSubscriptionsClientBeginDeleteOptions) (*runtime.Poller[SystemTopicEventSubscriptionsClientDeleteResponse], error)

BeginDelete - Delete an existing event subscription of a system topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - SystemTopicEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSystemTopicEventSubscriptionsClient().BeginDelete(ctx, "examplerg", "exampleSystemTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*SystemTopicEventSubscriptionsClient) BeginUpdate 

func (client *SystemTopicEventSubscriptionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, systemTopicName string, eventSubscriptionName string, eventSubscriptionUpdateParameters EventSubscriptionUpdateParameters, options *SystemTopicEventSubscriptionsClientBeginUpdateOptions) (*runtime.Poller[SystemTopicEventSubscriptionsClientUpdateResponse], error)

BeginUpdate - Update an existing event subscription of a system topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • eventSubscriptionUpdateParameters - Updated event subscription information.
  • options - SystemTopicEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSystemTopicEventSubscriptionsClient().BeginUpdate(ctx, "examplerg", "exampleSystemTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.WebHookEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
		Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
			EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*SystemTopicEventSubscriptionsClient) Get 

func (client *SystemTopicEventSubscriptionsClient) Get(ctx context.Context, resourceGroupName string, systemTopicName string, eventSubscriptionName string, options *SystemTopicEventSubscriptionsClientGetOptions) (SystemTopicEventSubscriptionsClientGetResponse, error)

Get - Get an event subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - SystemTopicEventSubscriptionsClientGetOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSystemTopicEventSubscriptionsClient().Get(ctx, "examplerg", "exampleSystemTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/systemTopics/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
// 			Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
// 				QueueName: to.Ptr("que"),
// 				ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
// 			},
// 		},
// 		EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IncludedEventTypes: []*string{
// 				to.Ptr("Microsoft.Storage.BlobCreated"),
// 				to.Ptr("Microsoft.Storage.BlobDeleted")},
// 				IsSubjectCaseSensitive: to.Ptr(false),
// 				SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 				SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 			},
// 			Labels: []*string{
// 				to.Ptr("label1"),
// 				to.Ptr("label2")},
// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 				RetryPolicy: &armeventgrid.RetryPolicy{
// 					EventTimeToLiveInMinutes: to.Ptr[int32](1440),
// 					MaxDeliveryAttempts: to.Ptr[int32](30),
// 				},
// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1"),
// 			},
// 		}

Output:

func (*SystemTopicEventSubscriptionsClient) GetDeliveryAttributes 

func (client *SystemTopicEventSubscriptionsClient) GetDeliveryAttributes(ctx context.Context, resourceGroupName string, systemTopicName string, eventSubscriptionName string, options *SystemTopicEventSubscriptionsClientGetDeliveryAttributesOptions) (SystemTopicEventSubscriptionsClientGetDeliveryAttributesResponse, error)

GetDeliveryAttributes - Get all delivery attributes for an event subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - SystemTopicEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.GetDeliveryAttributes method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_GetDeliveryAttributes.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSystemTopicEventSubscriptionsClient().GetDeliveryAttributes(ctx, "examplerg", "exampleSystemTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeliveryAttributeListResult = armeventgrid.DeliveryAttributeListResult{
// 	Value: []armeventgrid.DeliveryAttributeMappingClassification{
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header1"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 			Properties: &armeventgrid.StaticDeliveryAttributeMappingProperties{
// 				IsSecret: to.Ptr(false),
// 				Value: to.Ptr("NormalValue"),
// 			},
// 		},
// 		&armeventgrid.DynamicDeliveryAttributeMapping{
// 			Name: to.Ptr("header2"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeDynamic),
// 			Properties: &armeventgrid.DynamicDeliveryAttributeMappingProperties{
// 				SourceField: to.Ptr("data.foo"),
// 			},
// 		},
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header3"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 			Properties: &armeventgrid.StaticDeliveryAttributeMappingProperties{
// 				IsSecret: to.Ptr(true),
// 				Value: to.Ptr("mySecretValue"),
// 			},
// 	}},
// }

Output:

func (*SystemTopicEventSubscriptionsClient) GetFullURL 

func (client *SystemTopicEventSubscriptionsClient) GetFullURL(ctx context.Context, resourceGroupName string, systemTopicName string, eventSubscriptionName string, options *SystemTopicEventSubscriptionsClientGetFullURLOptions) (SystemTopicEventSubscriptionsClientGetFullURLResponse, error)

GetFullURL - Get the full endpoint URL for an event subscription of a system topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - SystemTopicEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.GetFullURL method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_GetFullUrl.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSystemTopicEventSubscriptionsClient().GetFullURL(ctx, "examplerg", "exampleSystemTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscriptionFullURL = armeventgrid.EventSubscriptionFullURL{
// 	EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
// }

Output:

func (*SystemTopicEventSubscriptionsClient) NewListBySystemTopicPager 

func (client *SystemTopicEventSubscriptionsClient) NewListBySystemTopicPager(resourceGroupName string, systemTopicName string, options *SystemTopicEventSubscriptionsClientListBySystemTopicOptions) *runtime.Pager[SystemTopicEventSubscriptionsClientListBySystemTopicResponse]

NewListBySystemTopicPager - List event subscriptions that belong to a specific system topic.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • options - SystemTopicEventSubscriptionsClientListBySystemTopicOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.NewListBySystemTopicPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_ListBySystemTopic.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSystemTopicEventSubscriptionsClient().NewListBySystemTopicPager("examplerg", "exampleSystemTopic1", &armeventgrid.SystemTopicEventSubscriptionsClientListBySystemTopicOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/systemTopics/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/examplesubscription1"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
	// 					Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
	// 						QueueName: to.Ptr("que"),
	// 						ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
	// 					},
	// 				},
	// 				EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					SubjectBeginsWith: to.Ptr(""),
	// 					SubjectEndsWith: to.Ptr(""),
	// 				},
	// 				Labels: []*string{
	// 				},
	// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 				RetryPolicy: &armeventgrid.RetryPolicy{
	// 					EventTimeToLiveInMinutes: to.Ptr[int32](1440),
	// 					MaxDeliveryAttempts: to.Ptr[int32](10),
	// 				},
	// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("examplesubscription2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/systemTopics/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/examplesubscription2"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
	// 					Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
	// 						QueueName: to.Ptr("que"),
	// 						ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
	// 					},
	// 				},
	// 				EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IncludedEventTypes: []*string{
	// 						to.Ptr("Microsoft.Storage.BlobCreated"),
	// 						to.Ptr("Microsoft.Storage.BlobDeleted")},
	// 						IsSubjectCaseSensitive: to.Ptr(false),
	// 						SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 						SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 					},
	// 					Labels: []*string{
	// 						to.Ptr("label1"),
	// 						to.Ptr("label2")},
	// 						ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 						RetryPolicy: &armeventgrid.RetryPolicy{
	// 							EventTimeToLiveInMinutes: to.Ptr[int32](1440),
	// 							MaxDeliveryAttempts: to.Ptr[int32](30),
	// 						},
	// 						Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1"),
	// 					},
	// 			}},
	// 		}
}

Output:

type SystemTopicEventSubscriptionsClientBeginCreateOrUpdateOptions 

type SystemTopicEventSubscriptionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SystemTopicEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.BeginCreateOrUpdate method.

type SystemTopicEventSubscriptionsClientBeginDeleteOptions 

type SystemTopicEventSubscriptionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SystemTopicEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.BeginDelete method.

type SystemTopicEventSubscriptionsClientBeginUpdateOptions 

type SystemTopicEventSubscriptionsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SystemTopicEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.BeginUpdate method.

type SystemTopicEventSubscriptionsClientCreateOrUpdateResponse 

type SystemTopicEventSubscriptionsClientCreateOrUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

SystemTopicEventSubscriptionsClientCreateOrUpdateResponse contains the response from method SystemTopicEventSubscriptionsClient.BeginCreateOrUpdate.

type SystemTopicEventSubscriptionsClientDeleteResponse 

type SystemTopicEventSubscriptionsClientDeleteResponse struct {
}

SystemTopicEventSubscriptionsClientDeleteResponse contains the response from method SystemTopicEventSubscriptionsClient.BeginDelete.

type SystemTopicEventSubscriptionsClientGetDeliveryAttributesOptions 

type SystemTopicEventSubscriptionsClientGetDeliveryAttributesOptions struct {
}

SystemTopicEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.GetDeliveryAttributes method.

type SystemTopicEventSubscriptionsClientGetDeliveryAttributesResponse 

type SystemTopicEventSubscriptionsClientGetDeliveryAttributesResponse struct {
	// Result of the Get delivery attributes operation.
	DeliveryAttributeListResult
}

SystemTopicEventSubscriptionsClientGetDeliveryAttributesResponse contains the response from method SystemTopicEventSubscriptionsClient.GetDeliveryAttributes.

type SystemTopicEventSubscriptionsClientGetFullURLOptions 

type SystemTopicEventSubscriptionsClientGetFullURLOptions struct {
}

SystemTopicEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.GetFullURL method.

type SystemTopicEventSubscriptionsClientGetFullURLResponse 

type SystemTopicEventSubscriptionsClientGetFullURLResponse struct {
	// Full endpoint url of an event subscription
	EventSubscriptionFullURL
}

SystemTopicEventSubscriptionsClientGetFullURLResponse contains the response from method SystemTopicEventSubscriptionsClient.GetFullURL.

type SystemTopicEventSubscriptionsClientGetOptions 

type SystemTopicEventSubscriptionsClientGetOptions struct {
}

SystemTopicEventSubscriptionsClientGetOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.Get method.

type SystemTopicEventSubscriptionsClientGetResponse 

type SystemTopicEventSubscriptionsClientGetResponse struct {
	// Event Subscription
	EventSubscription
}

SystemTopicEventSubscriptionsClientGetResponse contains the response from method SystemTopicEventSubscriptionsClient.Get.

type SystemTopicEventSubscriptionsClientListBySystemTopicOptions 

type SystemTopicEventSubscriptionsClientListBySystemTopicOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

SystemTopicEventSubscriptionsClientListBySystemTopicOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.NewListBySystemTopicPager method.

type SystemTopicEventSubscriptionsClientListBySystemTopicResponse 

type SystemTopicEventSubscriptionsClientListBySystemTopicResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

SystemTopicEventSubscriptionsClientListBySystemTopicResponse contains the response from method SystemTopicEventSubscriptionsClient.NewListBySystemTopicPager.

type SystemTopicEventSubscriptionsClientUpdateResponse 

type SystemTopicEventSubscriptionsClientUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

SystemTopicEventSubscriptionsClientUpdateResponse contains the response from method SystemTopicEventSubscriptionsClient.BeginUpdate.

type SystemTopicProperties 

type SystemTopicProperties struct {
	// Source for the system topic.
	Source *string

	// TopicType for the system topic.
	TopicType *string

	// READ-ONLY; Metric resource id for the system topic.
	MetricResourceID *string

	// READ-ONLY; Provisioning state of the system topic.
	ProvisioningState *ResourceProvisioningState
}

SystemTopicProperties - Properties of the System Topic.

func (SystemTopicProperties) MarshalJSON added in v2.1.0 

func (s SystemTopicProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemTopicProperties.

func (*SystemTopicProperties) UnmarshalJSON added in v2.1.0 

func (s *SystemTopicProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemTopicProperties.

type SystemTopicUpdateParameters 

type SystemTopicUpdateParameters struct {
	// Resource identity information.
	Identity *IdentityInfo

	// Tags of the system topic.
	Tags map[string]*string
}

SystemTopicUpdateParameters - Properties of the System Topic update.

func (SystemTopicUpdateParameters) MarshalJSON 

func (s SystemTopicUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemTopicUpdateParameters.

func (*SystemTopicUpdateParameters) UnmarshalJSON added in v2.1.0 

func (s *SystemTopicUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemTopicUpdateParameters.

type SystemTopicsClient 

type SystemTopicsClient struct {
	// contains filtered or unexported fields
}

SystemTopicsClient contains the methods for the SystemTopics group. Don't use this type directly, use NewSystemTopicsClient() instead.

func NewSystemTopicsClient 

func NewSystemTopicsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SystemTopicsClient, error)

NewSystemTopicsClient creates a new instance of SystemTopicsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SystemTopicsClient) BeginCreateOrUpdate 

func (client *SystemTopicsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, systemTopicName string, systemTopicInfo SystemTopic, options *SystemTopicsClientBeginCreateOrUpdateOptions) (*runtime.Poller[SystemTopicsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates a new system topic with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • systemTopicInfo - System Topic information.
  • options - SystemTopicsClientBeginCreateOrUpdateOptions contains the optional parameters for the SystemTopicsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopics_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSystemTopicsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleSystemTopic1", armeventgrid.SystemTopic{
	Location: to.Ptr("westus2"),
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
	Properties: &armeventgrid.SystemTopicProperties{
		Source:    to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e"),
		TopicType: to.Ptr("microsoft.storage.storageaccounts"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SystemTopic = armeventgrid.SystemTopic{
// 	Name: to.Ptr("exampleSystemTopic2"),
// 	Type: to.Ptr("Microsoft.EventGrid/systemTopics"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2"),
// 	Location: to.Ptr("centraluseuap"),
// 	Properties: &armeventgrid.SystemTopicProperties{
// 		MetricResourceID: to.Ptr("183c0fb1-17ff-47b6-ac77-5a47420ab01e"),
// 		ProvisioningState: to.Ptr(armeventgrid.ResourceProvisioningStateSucceeded),
// 		Source: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e"),
// 		TopicType: to.Ptr("microsoft.storage.storageaccounts"),
// 	},
// }

Output:

func (*SystemTopicsClient) BeginDelete 

func (client *SystemTopicsClient) BeginDelete(ctx context.Context, resourceGroupName string, systemTopicName string, options *SystemTopicsClientBeginDeleteOptions) (*runtime.Poller[SystemTopicsClientDeleteResponse], error)

BeginDelete - Delete existing system topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • options - SystemTopicsClientBeginDeleteOptions contains the optional parameters for the SystemTopicsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopics_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSystemTopicsClient().BeginDelete(ctx, "examplerg", "exampleSystemTopic1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*SystemTopicsClient) BeginUpdate 

func (client *SystemTopicsClient) BeginUpdate(ctx context.Context, resourceGroupName string, systemTopicName string, systemTopicUpdateParameters SystemTopicUpdateParameters, options *SystemTopicsClientBeginUpdateOptions) (*runtime.Poller[SystemTopicsClientUpdateResponse], error)

BeginUpdate - Asynchronously updates a system topic with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • systemTopicUpdateParameters - SystemTopic update information.
  • options - SystemTopicsClientBeginUpdateOptions contains the optional parameters for the SystemTopicsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopics_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSystemTopicsClient().BeginUpdate(ctx, "examplerg", "exampleSystemTopic1", armeventgrid.SystemTopicUpdateParameters{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SystemTopic = armeventgrid.SystemTopic{
// 	Name: to.Ptr("exampleSystemTopic2"),
// 	Type: to.Ptr("Microsoft.EventGrid/systemTopics"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2"),
// 	Location: to.Ptr("centraluseuap"),
// 	Properties: &armeventgrid.SystemTopicProperties{
// 		MetricResourceID: to.Ptr("183c0fb1-17ff-47b6-ac77-5a47420ab01e"),
// 		ProvisioningState: to.Ptr(armeventgrid.ResourceProvisioningStateSucceeded),
// 		Source: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e"),
// 		TopicType: to.Ptr("microsoft.storage.storageaccounts"),
// 	},
// }

Output:

func (*SystemTopicsClient) Get 

func (client *SystemTopicsClient) Get(ctx context.Context, resourceGroupName string, systemTopicName string, options *SystemTopicsClientGetOptions) (SystemTopicsClientGetResponse, error)

Get - Get properties of a system topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • systemTopicName - Name of the system topic.
  • options - SystemTopicsClientGetOptions contains the optional parameters for the SystemTopicsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopics_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSystemTopicsClient().Get(ctx, "examplerg", "exampleSystemTopic2", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SystemTopic = armeventgrid.SystemTopic{
// 	Name: to.Ptr("exampleSystemTopic2"),
// 	Type: to.Ptr("Microsoft.EventGrid/systemTopics"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2"),
// 	Location: to.Ptr("centraluseuap"),
// 	Properties: &armeventgrid.SystemTopicProperties{
// 		MetricResourceID: to.Ptr("183c0fb1-17ff-47b6-ac77-5a47420ab01e"),
// 		ProvisioningState: to.Ptr(armeventgrid.ResourceProvisioningStateSucceeded),
// 		Source: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e"),
// 		TopicType: to.Ptr("microsoft.storage.storageaccounts"),
// 	},
// }

Output:

func (*SystemTopicsClient) NewListByResourceGroupPager 

func (client *SystemTopicsClient) NewListByResourceGroupPager(resourceGroupName string, options *SystemTopicsClientListByResourceGroupOptions) *runtime.Pager[SystemTopicsClientListByResourceGroupResponse]

NewListByResourceGroupPager - List all the system topics under a resource group.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • options - SystemTopicsClientListByResourceGroupOptions contains the optional parameters for the SystemTopicsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopics_ListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSystemTopicsClient().NewListByResourceGroupPager("examplerg", &armeventgrid.SystemTopicsClientListByResourceGroupOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SystemTopicsListResult = armeventgrid.SystemTopicsListResult{
	// 	Value: []*armeventgrid.SystemTopic{
	// 		{
	// 			Name: to.Ptr("pubstgrunnerb71cd29e-86fad330-7bac-4238-8cab-9e46b75165aa"),
	// 			Type: to.Ptr("Microsoft.EventGrid/systemTopics"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/pubstgrunnerb71cd29e-86fad330-7bac-4238-8cab-9e46b75165aa"),
	// 			Location: to.Ptr("centraluseuap"),
	// 			Properties: &armeventgrid.SystemTopicProperties{
	// 				MetricResourceID: to.Ptr("183c0fb1-17ff-47b6-ac77-5a47420ab01e"),
	// 				ProvisioningState: to.Ptr(armeventgrid.ResourceProvisioningStateSucceeded),
	// 				Source: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e"),
	// 				TopicType: to.Ptr("microsoft.storage.storageaccounts"),
	// 			},
	// 	}},
	// }
}

Output:

func (*SystemTopicsClient) NewListBySubscriptionPager 

func (client *SystemTopicsClient) NewListBySubscriptionPager(options *SystemTopicsClientListBySubscriptionOptions) *runtime.Pager[SystemTopicsClientListBySubscriptionResponse]

NewListBySubscriptionPager - List all the system topics under an Azure subscription.

Generated from API version 2022-06-15

  • options - SystemTopicsClientListBySubscriptionOptions contains the optional parameters for the SystemTopicsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopics_ListBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSystemTopicsClient().NewListBySubscriptionPager(&armeventgrid.SystemTopicsClientListBySubscriptionOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SystemTopicsListResult = armeventgrid.SystemTopicsListResult{
	// 	Value: []*armeventgrid.SystemTopic{
	// 		{
	// 			Name: to.Ptr("exampleSystemTopic2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/systemTopics"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2"),
	// 			Location: to.Ptr("centraluseuap"),
	// 			Properties: &armeventgrid.SystemTopicProperties{
	// 				MetricResourceID: to.Ptr("183c0fb1-17ff-47b6-ac77-5a47420ab01e"),
	// 				ProvisioningState: to.Ptr(armeventgrid.ResourceProvisioningStateSucceeded),
	// 				Source: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e"),
	// 				TopicType: to.Ptr("microsoft.storage.storageaccounts"),
	// 			},
	// 	}},
	// }
}

Output:

type SystemTopicsClientBeginCreateOrUpdateOptions 

type SystemTopicsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SystemTopicsClientBeginCreateOrUpdateOptions contains the optional parameters for the SystemTopicsClient.BeginCreateOrUpdate method.

type SystemTopicsClientBeginDeleteOptions 

type SystemTopicsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SystemTopicsClientBeginDeleteOptions contains the optional parameters for the SystemTopicsClient.BeginDelete method.

type SystemTopicsClientBeginUpdateOptions 

type SystemTopicsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SystemTopicsClientBeginUpdateOptions contains the optional parameters for the SystemTopicsClient.BeginUpdate method.

type SystemTopicsClientCreateOrUpdateResponse 

type SystemTopicsClientCreateOrUpdateResponse struct {
	// EventGrid System Topic.
	SystemTopic
}

SystemTopicsClientCreateOrUpdateResponse contains the response from method SystemTopicsClient.BeginCreateOrUpdate.

type SystemTopicsClientDeleteResponse 

type SystemTopicsClientDeleteResponse struct {
}

SystemTopicsClientDeleteResponse contains the response from method SystemTopicsClient.BeginDelete.

type SystemTopicsClientGetOptions 

type SystemTopicsClientGetOptions struct {
}

SystemTopicsClientGetOptions contains the optional parameters for the SystemTopicsClient.Get method.

type SystemTopicsClientGetResponse 

type SystemTopicsClientGetResponse struct {
	// EventGrid System Topic.
	SystemTopic
}

SystemTopicsClientGetResponse contains the response from method SystemTopicsClient.Get.

type SystemTopicsClientListByResourceGroupOptions 

type SystemTopicsClientListByResourceGroupOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

SystemTopicsClientListByResourceGroupOptions contains the optional parameters for the SystemTopicsClient.NewListByResourceGroupPager method.

type SystemTopicsClientListByResourceGroupResponse 

type SystemTopicsClientListByResourceGroupResponse struct {
	// Result of the List System topics operation.
	SystemTopicsListResult
}

SystemTopicsClientListByResourceGroupResponse contains the response from method SystemTopicsClient.NewListByResourceGroupPager.

type SystemTopicsClientListBySubscriptionOptions 

type SystemTopicsClientListBySubscriptionOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

SystemTopicsClientListBySubscriptionOptions contains the optional parameters for the SystemTopicsClient.NewListBySubscriptionPager method.

type SystemTopicsClientListBySubscriptionResponse 

type SystemTopicsClientListBySubscriptionResponse struct {
	// Result of the List System topics operation.
	SystemTopicsListResult
}

SystemTopicsClientListBySubscriptionResponse contains the response from method SystemTopicsClient.NewListBySubscriptionPager.

type SystemTopicsClientUpdateResponse 

type SystemTopicsClientUpdateResponse struct {
	// EventGrid System Topic.
	SystemTopic
}

SystemTopicsClientUpdateResponse contains the response from method SystemTopicsClient.BeginUpdate.

type SystemTopicsListResult 

type SystemTopicsListResult struct {
	// A link for the next page of topics.
	NextLink *string

	// A collection of system Topics.
	Value []*SystemTopic
}

SystemTopicsListResult - Result of the List System topics operation.

func (SystemTopicsListResult) MarshalJSON added in v2.1.0 

func (s SystemTopicsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemTopicsListResult.

func (*SystemTopicsListResult) UnmarshalJSON added in v2.1.0 

func (s *SystemTopicsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemTopicsListResult.

type Topic 

type Topic struct {
	// REQUIRED; Location of the resource.
	Location *string

	// Identity information for the resource.
	Identity *IdentityInfo

	// Properties of the topic.
	Properties *TopicProperties

	// Tags of the resource.
	Tags map[string]*string

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to Topic resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

Topic - EventGrid Topic

func (Topic) MarshalJSON 

func (t Topic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Topic.

func (*Topic) UnmarshalJSON added in v2.1.0 

func (t *Topic) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Topic.

type TopicEventSubscriptionsClient 

type TopicEventSubscriptionsClient struct {
	// contains filtered or unexported fields
}

TopicEventSubscriptionsClient contains the methods for the TopicEventSubscriptions group. Don't use this type directly, use NewTopicEventSubscriptionsClient() instead.

func NewTopicEventSubscriptionsClient 

func NewTopicEventSubscriptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*TopicEventSubscriptionsClient, error)

NewTopicEventSubscriptionsClient creates a new instance of TopicEventSubscriptionsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*TopicEventSubscriptionsClient) BeginCreateOrUpdate 

func (client *TopicEventSubscriptionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, topicName string, eventSubscriptionName string, eventSubscriptionInfo EventSubscription, options *TopicEventSubscriptionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[TopicEventSubscriptionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates a new event subscription or updates an existing event subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • eventSubscriptionInfo - Event subscription properties containing the destination and filter information.
  • options - TopicEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the TopicEventSubscriptionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/TopicEventSubscriptions_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTopicEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscription{
	Properties: &armeventgrid.EventSubscriptionProperties{
		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
				EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
			},
		},
		Filter: &armeventgrid.EventSubscriptionFilter{
			IsSubjectCaseSensitive: to.Ptr(false),
			SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
			SubjectEndsWith:        to.Ptr("ExampleSuffix"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("exampleEventSubscriptionName1"),
// 	Type: to.Ptr("Microsoft.EventGrid/topics/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampleTopic1/eventSubscriptions/exampleEventSubscriptionName1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
// 			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
// 				EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
// 			},
// 		},
// 		EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IsSubjectCaseSensitive: to.Ptr(false),
// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 		},
// 		ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 		RetryPolicy: &armeventgrid.RetryPolicy{
// 			EventTimeToLiveInMinutes: to.Ptr[int32](1440),
// 			MaxDeliveryAttempts: to.Ptr[int32](30),
// 		},
// 		Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampleTopic1"),
// 	},
// }

Output:

func (*TopicEventSubscriptionsClient) BeginDelete 

func (client *TopicEventSubscriptionsClient) BeginDelete(ctx context.Context, resourceGroupName string, topicName string, eventSubscriptionName string, options *TopicEventSubscriptionsClientBeginDeleteOptions) (*runtime.Poller[TopicEventSubscriptionsClientDeleteResponse], error)

BeginDelete - Delete an existing event subscription for a topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the topic.
  • eventSubscriptionName - Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - TopicEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the TopicEventSubscriptionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/TopicEventSubscriptions_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTopicEventSubscriptionsClient().BeginDelete(ctx, "examplerg", "exampleTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*TopicEventSubscriptionsClient) BeginUpdate 

func (client *TopicEventSubscriptionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, topicName string, eventSubscriptionName string, eventSubscriptionUpdateParameters EventSubscriptionUpdateParameters, options *TopicEventSubscriptionsClientBeginUpdateOptions) (*runtime.Poller[TopicEventSubscriptionsClientUpdateResponse], error)

BeginUpdate - Update an existing event subscription for a topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the domain.
  • eventSubscriptionName - Name of the event subscription to be updated.
  • eventSubscriptionUpdateParameters - Updated event subscription information.
  • options - TopicEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the TopicEventSubscriptionsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/TopicEventSubscriptions_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTopicEventSubscriptionsClient().BeginUpdate(ctx, "examplerg", "exampleTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscriptionUpdateParameters{
	Destination: &armeventgrid.WebHookEventSubscriptionDestination{
		EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
		Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
			EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
		},
	},
	Filter: &armeventgrid.EventSubscriptionFilter{
		IsSubjectCaseSensitive: to.Ptr(true),
		SubjectBeginsWith:      to.Ptr("existingPrefix"),
		SubjectEndsWith:        to.Ptr("newSuffix"),
	},
	Labels: []*string{
		to.Ptr("label1"),
		to.Ptr("label2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*TopicEventSubscriptionsClient) Get 

func (client *TopicEventSubscriptionsClient) Get(ctx context.Context, resourceGroupName string, topicName string, eventSubscriptionName string, options *TopicEventSubscriptionsClientGetOptions) (TopicEventSubscriptionsClientGetResponse, error)

Get - Get properties of an event subscription of a topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the partner topic.
  • eventSubscriptionName - Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
  • options - TopicEventSubscriptionsClientGetOptions contains the optional parameters for the TopicEventSubscriptionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/TopicEventSubscriptions_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewTopicEventSubscriptionsClient().Get(ctx, "examplerg", "exampleTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscription = armeventgrid.EventSubscription{
// 	Name: to.Ptr("examplesubscription1"),
// 	Type: to.Ptr("Microsoft.EventGrid/topics/eventSubscriptions"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampleTopic1/eventSubscriptions/examplesubscription1"),
// 	Properties: &armeventgrid.EventSubscriptionProperties{
// 		Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
// 			Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
// 				QueueName: to.Ptr("que"),
// 				ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
// 			},
// 		},
// 		EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
// 		Filter: &armeventgrid.EventSubscriptionFilter{
// 			IncludedEventTypes: []*string{
// 				to.Ptr("Microsoft.Storage.BlobCreated"),
// 				to.Ptr("Microsoft.Storage.BlobDeleted")},
// 				IsSubjectCaseSensitive: to.Ptr(false),
// 				SubjectBeginsWith: to.Ptr("ExamplePrefix"),
// 				SubjectEndsWith: to.Ptr("ExampleSuffix"),
// 			},
// 			Labels: []*string{
// 				to.Ptr("label1"),
// 				to.Ptr("label2")},
// 				ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
// 				RetryPolicy: &armeventgrid.RetryPolicy{
// 					EventTimeToLiveInMinutes: to.Ptr[int32](1440),
// 					MaxDeliveryAttempts: to.Ptr[int32](30),
// 				},
// 				Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampleTopic1"),
// 			},
// 		}

Output:

func (*TopicEventSubscriptionsClient) GetDeliveryAttributes 

func (client *TopicEventSubscriptionsClient) GetDeliveryAttributes(ctx context.Context, resourceGroupName string, topicName string, eventSubscriptionName string, options *TopicEventSubscriptionsClientGetDeliveryAttributesOptions) (TopicEventSubscriptionsClientGetDeliveryAttributesResponse, error)

GetDeliveryAttributes - Get all delivery attributes for an event subscription for topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - TopicEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the TopicEventSubscriptionsClient.GetDeliveryAttributes method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/TopicEventSubscriptions_GetDeliveryAttributes.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewTopicEventSubscriptionsClient().GetDeliveryAttributes(ctx, "examplerg", "exampleTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeliveryAttributeListResult = armeventgrid.DeliveryAttributeListResult{
// 	Value: []armeventgrid.DeliveryAttributeMappingClassification{
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header1"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 			Properties: &armeventgrid.StaticDeliveryAttributeMappingProperties{
// 				IsSecret: to.Ptr(false),
// 				Value: to.Ptr("NormalValue"),
// 			},
// 		},
// 		&armeventgrid.DynamicDeliveryAttributeMapping{
// 			Name: to.Ptr("header2"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeDynamic),
// 			Properties: &armeventgrid.DynamicDeliveryAttributeMappingProperties{
// 				SourceField: to.Ptr("data.foo"),
// 			},
// 		},
// 		&armeventgrid.StaticDeliveryAttributeMapping{
// 			Name: to.Ptr("header3"),
// 			Type: to.Ptr(armeventgrid.DeliveryAttributeMappingTypeStatic),
// 			Properties: &armeventgrid.StaticDeliveryAttributeMappingProperties{
// 				IsSecret: to.Ptr(true),
// 				Value: to.Ptr("mySecretValue"),
// 			},
// 	}},
// }

Output:

func (*TopicEventSubscriptionsClient) GetFullURL 

func (client *TopicEventSubscriptionsClient) GetFullURL(ctx context.Context, resourceGroupName string, topicName string, eventSubscriptionName string, options *TopicEventSubscriptionsClientGetFullURLOptions) (TopicEventSubscriptionsClientGetFullURLResponse, error)

GetFullURL - Get the full endpoint URL for an event subscription for topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the domain topic.
  • eventSubscriptionName - Name of the event subscription.
  • options - TopicEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the TopicEventSubscriptionsClient.GetFullURL method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/TopicEventSubscriptions_GetFullUrl.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewTopicEventSubscriptionsClient().GetFullURL(ctx, "examplerg", "exampleTopic1", "examplesubscription1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EventSubscriptionFullURL = armeventgrid.EventSubscriptionFullURL{
// 	EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
// }

Output:

func (*TopicEventSubscriptionsClient) NewListPager 

func (client *TopicEventSubscriptionsClient) NewListPager(resourceGroupName string, topicName string, options *TopicEventSubscriptionsClientListOptions) *runtime.Pager[TopicEventSubscriptionsClientListResponse]

NewListPager - List all event subscriptions that have been created for a specific topic.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the topic.
  • options - TopicEventSubscriptionsClientListOptions contains the optional parameters for the TopicEventSubscriptionsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/TopicEventSubscriptions_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewTopicEventSubscriptionsClient().NewListPager("examplerg", "exampleTopic1", &armeventgrid.TopicEventSubscriptionsClientListOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventSubscriptionsListResult = armeventgrid.EventSubscriptionsListResult{
	// 	Value: []*armeventgrid.EventSubscription{
	// 		{
	// 			Name: to.Ptr("examplesubscription1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topics/eventSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampleTopic1/eventSubscriptions/examplesubscription1"),
	// 			Properties: &armeventgrid.EventSubscriptionProperties{
	// 				Destination: &armeventgrid.StorageQueueEventSubscriptionDestination{
	// 					EndpointType: to.Ptr(armeventgrid.EndpointTypeStorageQueue),
	// 					Properties: &armeventgrid.StorageQueueEventSubscriptionDestinationProperties{
	// 						QueueName: to.Ptr("que"),
	// 						ResourceID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource"),
	// 					},
	// 				},
	// 				EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
	// 				Filter: &armeventgrid.EventSubscriptionFilter{
	// 					IncludedEventTypes: []*string{
	// 						to.Ptr("Microsoft.Storage.BlobCreated"),
	// 						to.Ptr("Microsoft.Storage.BlobDeleted")},
	// 						IsSubjectCaseSensitive: to.Ptr(false),
	// 						SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 						SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 					},
	// 					Labels: []*string{
	// 						to.Ptr("label1"),
	// 						to.Ptr("label2")},
	// 						ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 						RetryPolicy: &armeventgrid.RetryPolicy{
	// 							EventTimeToLiveInMinutes: to.Ptr[int32](1440),
	// 							MaxDeliveryAttempts: to.Ptr[int32](30),
	// 						},
	// 						Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampleTopic1"),
	// 					},
	// 			}},
	// 		}
}

Output:

type TopicEventSubscriptionsClientBeginCreateOrUpdateOptions 

type TopicEventSubscriptionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TopicEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the TopicEventSubscriptionsClient.BeginCreateOrUpdate method.

type TopicEventSubscriptionsClientBeginDeleteOptions 

type TopicEventSubscriptionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TopicEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the TopicEventSubscriptionsClient.BeginDelete method.

type TopicEventSubscriptionsClientBeginUpdateOptions 

type TopicEventSubscriptionsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TopicEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the TopicEventSubscriptionsClient.BeginUpdate method.

type TopicEventSubscriptionsClientCreateOrUpdateResponse 

type TopicEventSubscriptionsClientCreateOrUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

TopicEventSubscriptionsClientCreateOrUpdateResponse contains the response from method TopicEventSubscriptionsClient.BeginCreateOrUpdate.

type TopicEventSubscriptionsClientDeleteResponse 

type TopicEventSubscriptionsClientDeleteResponse struct {
}

TopicEventSubscriptionsClientDeleteResponse contains the response from method TopicEventSubscriptionsClient.BeginDelete.

type TopicEventSubscriptionsClientGetDeliveryAttributesOptions 

type TopicEventSubscriptionsClientGetDeliveryAttributesOptions struct {
}

TopicEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the TopicEventSubscriptionsClient.GetDeliveryAttributes method.

type TopicEventSubscriptionsClientGetDeliveryAttributesResponse 

type TopicEventSubscriptionsClientGetDeliveryAttributesResponse struct {
	// Result of the Get delivery attributes operation.
	DeliveryAttributeListResult
}

TopicEventSubscriptionsClientGetDeliveryAttributesResponse contains the response from method TopicEventSubscriptionsClient.GetDeliveryAttributes.

type TopicEventSubscriptionsClientGetFullURLOptions 

type TopicEventSubscriptionsClientGetFullURLOptions struct {
}

TopicEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the TopicEventSubscriptionsClient.GetFullURL method.

type TopicEventSubscriptionsClientGetFullURLResponse 

type TopicEventSubscriptionsClientGetFullURLResponse struct {
	// Full endpoint url of an event subscription
	EventSubscriptionFullURL
}

TopicEventSubscriptionsClientGetFullURLResponse contains the response from method TopicEventSubscriptionsClient.GetFullURL.

type TopicEventSubscriptionsClientGetOptions 

type TopicEventSubscriptionsClientGetOptions struct {
}

TopicEventSubscriptionsClientGetOptions contains the optional parameters for the TopicEventSubscriptionsClient.Get method.

type TopicEventSubscriptionsClientGetResponse 

type TopicEventSubscriptionsClientGetResponse struct {
	// Event Subscription
	EventSubscription
}

TopicEventSubscriptionsClientGetResponse contains the response from method TopicEventSubscriptionsClient.Get.

type TopicEventSubscriptionsClientListOptions 

type TopicEventSubscriptionsClientListOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

TopicEventSubscriptionsClientListOptions contains the optional parameters for the TopicEventSubscriptionsClient.NewListPager method.

type TopicEventSubscriptionsClientListResponse 

type TopicEventSubscriptionsClientListResponse struct {
	// Result of the List EventSubscriptions operation
	EventSubscriptionsListResult
}

TopicEventSubscriptionsClientListResponse contains the response from method TopicEventSubscriptionsClient.NewListPager.

type TopicEventSubscriptionsClientUpdateResponse 

type TopicEventSubscriptionsClientUpdateResponse struct {
	// Event Subscription
	EventSubscription
}

TopicEventSubscriptionsClientUpdateResponse contains the response from method TopicEventSubscriptionsClient.BeginUpdate.

type TopicProperties 

type TopicProperties struct {
	// Data Residency Boundary of the resource.
	DataResidencyBoundary *DataResidencyBoundary

	// This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD
	// token will be used to authenticate if user is allowed to publish to the topic.
	DisableLocalAuth *bool

	// This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess
	// is enabled.
	InboundIPRules []*InboundIPRule

	// This determines the format that Event Grid should expect for incoming events published to the topic.
	InputSchema *InputSchema

	// This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of
	// a source schema to various required properties of the EventGridEvent schema.
	InputSchemaMapping InputSchemaMappingClassification

	// This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific
	// IPs by configuring
	PublicNetworkAccess *PublicNetworkAccess

	// READ-ONLY; Endpoint for the topic.
	Endpoint *string

	// READ-ONLY; Metric resource id for the topic.
	MetricResourceID *string

	// READ-ONLY
	PrivateEndpointConnections []*PrivateEndpointConnection

	// READ-ONLY; Provisioning state of the topic.
	ProvisioningState *TopicProvisioningState
}

TopicProperties - Properties of the Topic.

func (TopicProperties) MarshalJSON 

func (t TopicProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopicProperties.

func (*TopicProperties) UnmarshalJSON 

func (t *TopicProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopicProperties.

type TopicProvisioningState 

type TopicProvisioningState string

TopicProvisioningState - Provisioning state of the topic. 

const (
	TopicProvisioningStateCanceled  TopicProvisioningState = "Canceled"
	TopicProvisioningStateCreating  TopicProvisioningState = "Creating"
	TopicProvisioningStateDeleting  TopicProvisioningState = "Deleting"
	TopicProvisioningStateFailed    TopicProvisioningState = "Failed"
	TopicProvisioningStateSucceeded TopicProvisioningState = "Succeeded"
	TopicProvisioningStateUpdating  TopicProvisioningState = "Updating"
)

func PossibleTopicProvisioningStateValues 

func PossibleTopicProvisioningStateValues() []TopicProvisioningState

PossibleTopicProvisioningStateValues returns the possible values for the TopicProvisioningState const type.

type TopicRegenerateKeyRequest 

type TopicRegenerateKeyRequest struct {
	// REQUIRED; Key name to regenerate key1 or key2
	KeyName *string
}

TopicRegenerateKeyRequest - Topic regenerate share access key request

func (TopicRegenerateKeyRequest) MarshalJSON added in v2.1.0 

func (t TopicRegenerateKeyRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopicRegenerateKeyRequest.

func (*TopicRegenerateKeyRequest) UnmarshalJSON added in v2.1.0 

func (t *TopicRegenerateKeyRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopicRegenerateKeyRequest.

type TopicSharedAccessKeys 

type TopicSharedAccessKeys struct {
	// Shared access key1 for the topic.
	Key1 *string

	// Shared access key2 for the topic.
	Key2 *string
}

TopicSharedAccessKeys - Shared access keys of the Topic

func (TopicSharedAccessKeys) MarshalJSON added in v2.1.0 

func (t TopicSharedAccessKeys) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopicSharedAccessKeys.

func (*TopicSharedAccessKeys) UnmarshalJSON added in v2.1.0 

func (t *TopicSharedAccessKeys) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopicSharedAccessKeys.

type TopicTypeInfo 

type TopicTypeInfo struct {
	// Properties of the topic type info
	Properties *TopicTypeProperties

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; Type of the resource.
	Type *string
}

TopicTypeInfo - Properties of a topic type info.

func (TopicTypeInfo) MarshalJSON added in v2.1.0 

func (t TopicTypeInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopicTypeInfo.

func (*TopicTypeInfo) UnmarshalJSON added in v2.1.0 

func (t *TopicTypeInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopicTypeInfo.

type TopicTypeProperties 

type TopicTypeProperties struct {
	// Description of the topic type.
	Description *string

	// Display Name for the topic type.
	DisplayName *string

	// Namespace of the provider of the topic type.
	Provider *string

	// Provisioning state of the topic type
	ProvisioningState *TopicTypeProvisioningState

	// Region type of the resource.
	ResourceRegionType *ResourceRegionType

	// Source resource format.
	SourceResourceFormat *string

	// List of locations supported by this topic type.
	SupportedLocations []*string

	// Supported source scopes.
	SupportedScopesForSource []*TopicTypeSourceScope
}

TopicTypeProperties - Properties of a topic type.

func (TopicTypeProperties) MarshalJSON 

func (t TopicTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopicTypeProperties.

func (*TopicTypeProperties) UnmarshalJSON added in v2.1.0 

func (t *TopicTypeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopicTypeProperties.

type TopicTypeProvisioningState 

type TopicTypeProvisioningState string

TopicTypeProvisioningState - Provisioning state of the topic type 

const (
	TopicTypeProvisioningStateCanceled  TopicTypeProvisioningState = "Canceled"
	TopicTypeProvisioningStateCreating  TopicTypeProvisioningState = "Creating"
	TopicTypeProvisioningStateDeleting  TopicTypeProvisioningState = "Deleting"
	TopicTypeProvisioningStateFailed    TopicTypeProvisioningState = "Failed"
	TopicTypeProvisioningStateSucceeded TopicTypeProvisioningState = "Succeeded"
	TopicTypeProvisioningStateUpdating  TopicTypeProvisioningState = "Updating"
)

func PossibleTopicTypeProvisioningStateValues 

func PossibleTopicTypeProvisioningStateValues() []TopicTypeProvisioningState

PossibleTopicTypeProvisioningStateValues returns the possible values for the TopicTypeProvisioningState const type.

type TopicTypeSourceScope 

type TopicTypeSourceScope string
const (
	TopicTypeSourceScopeAzureSubscription TopicTypeSourceScope = "AzureSubscription"
	TopicTypeSourceScopeManagementGroup   TopicTypeSourceScope = "ManagementGroup"
	TopicTypeSourceScopeResource          TopicTypeSourceScope = "Resource"
	TopicTypeSourceScopeResourceGroup     TopicTypeSourceScope = "ResourceGroup"
)

func PossibleTopicTypeSourceScopeValues 

func PossibleTopicTypeSourceScopeValues() []TopicTypeSourceScope

PossibleTopicTypeSourceScopeValues returns the possible values for the TopicTypeSourceScope const type.

type TopicTypesClient 

type TopicTypesClient struct {
	// contains filtered or unexported fields
}

TopicTypesClient contains the methods for the TopicTypes group. Don't use this type directly, use NewTopicTypesClient() instead.

func NewTopicTypesClient 

func NewTopicTypesClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*TopicTypesClient, error)

NewTopicTypesClient creates a new instance of TopicTypesClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*TopicTypesClient) Get 

func (client *TopicTypesClient) Get(ctx context.Context, topicTypeName string, options *TopicTypesClientGetOptions) (TopicTypesClientGetResponse, error)

Get - Get information about a topic type. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • topicTypeName - Name of the topic type.
  • options - TopicTypesClientGetOptions contains the optional parameters for the TopicTypesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/TopicTypes_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewTopicTypesClient().Get(ctx, "Microsoft.Storage.StorageAccounts", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TopicTypeInfo = armeventgrid.TopicTypeInfo{
// 	Name: to.Ptr("Microsoft.Storage.StorageAccounts"),
// 	Type: to.Ptr("Microsoft.EventGrid/topicTypes"),
// 	ID: to.Ptr("providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts"),
// 	Properties: &armeventgrid.TopicTypeProperties{
// 		Description: to.Ptr("Microsoft Storage service events."),
// 		DisplayName: to.Ptr("Storage Accounts"),
// 		Provider: to.Ptr("Microsoft.Storage"),
// 		ProvisioningState: to.Ptr(armeventgrid.TopicTypeProvisioningStateSucceeded),
// 		ResourceRegionType: to.Ptr(armeventgrid.ResourceRegionTypeRegionalResource),
// 	},
// }

Output:

func (*TopicTypesClient) NewListEventTypesPager 

func (client *TopicTypesClient) NewListEventTypesPager(topicTypeName string, options *TopicTypesClientListEventTypesOptions) *runtime.Pager[TopicTypesClientListEventTypesResponse]

NewListEventTypesPager - List event types for a topic type.

Generated from API version 2022-06-15

  • topicTypeName - Name of the topic type.
  • options - TopicTypesClientListEventTypesOptions contains the optional parameters for the TopicTypesClient.NewListEventTypesPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/TopicTypes_ListEventTypes.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewTopicTypesClient().NewListEventTypesPager("Microsoft.Storage.StorageAccounts", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventTypesListResult = armeventgrid.EventTypesListResult{
	// 	Value: []*armeventgrid.EventType{
	// 		{
	// 			Name: to.Ptr("Microsoft.Storage.BlobCreated"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topicTypes/eventTypes"),
	// 			ID: to.Ptr("providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobCreated"),
	// 			Properties: &armeventgrid.EventTypeProperties{
	// 				Description: to.Ptr("Raised when a blob is created."),
	// 				DisplayName: to.Ptr("Blob Created"),
	// 				SchemaURL: to.Ptr("tbd"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.Storage.BlobDeleted"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topicTypes/eventTypes"),
	// 			ID: to.Ptr("providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobDeleted"),
	// 			Properties: &armeventgrid.EventTypeProperties{
	// 				Description: to.Ptr("Raised when a blob is deleted."),
	// 				DisplayName: to.Ptr("Blob Deleted"),
	// 				SchemaURL: to.Ptr("tbd"),
	// 			},
	// 	}},
	// }
}

Output:

func (*TopicTypesClient) NewListPager 

func (client *TopicTypesClient) NewListPager(options *TopicTypesClientListOptions) *runtime.Pager[TopicTypesClientListResponse]

NewListPager - List all registered topic types.

Generated from API version 2022-06-15

  • options - TopicTypesClientListOptions contains the optional parameters for the TopicTypesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/TopicTypes_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewTopicTypesClient().NewListPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.TopicTypesListResult = armeventgrid.TopicTypesListResult{
	// 	Value: []*armeventgrid.TopicTypeInfo{
	// 		{
	// 			Name: to.Ptr("Microsoft.Eventhub.Namespaces"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topicTypes"),
	// 			ID: to.Ptr("providers/Microsoft.EventGrid/topicTypes/Microsoft.Eventhub.Namespaces"),
	// 			Properties: &armeventgrid.TopicTypeProperties{
	// 				Description: to.Ptr("Microsoft EventHubs service events."),
	// 				DisplayName: to.Ptr("EventHubs Namespace"),
	// 				Provider: to.Ptr("Microsoft.Eventhub"),
	// 				ProvisioningState: to.Ptr(armeventgrid.TopicTypeProvisioningStateSucceeded),
	// 				ResourceRegionType: to.Ptr(armeventgrid.ResourceRegionTypeRegionalResource),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.Storage.StorageAccounts"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topicTypes"),
	// 			ID: to.Ptr("providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts"),
	// 			Properties: &armeventgrid.TopicTypeProperties{
	// 				Description: to.Ptr("Microsoft Storage service events."),
	// 				DisplayName: to.Ptr("Storage Accounts"),
	// 				Provider: to.Ptr("Microsoft.Storage"),
	// 				ProvisioningState: to.Ptr(armeventgrid.TopicTypeProvisioningStateSucceeded),
	// 				ResourceRegionType: to.Ptr(armeventgrid.ResourceRegionTypeRegionalResource),
	// 			},
	// 	}},
	// }
}

Output:

type TopicTypesClientGetOptions 

type TopicTypesClientGetOptions struct {
}

TopicTypesClientGetOptions contains the optional parameters for the TopicTypesClient.Get method.

type TopicTypesClientGetResponse 

type TopicTypesClientGetResponse struct {
	// Properties of a topic type info.
	TopicTypeInfo
}

TopicTypesClientGetResponse contains the response from method TopicTypesClient.Get.

type TopicTypesClientListEventTypesOptions 

type TopicTypesClientListEventTypesOptions struct {
}

TopicTypesClientListEventTypesOptions contains the optional parameters for the TopicTypesClient.NewListEventTypesPager method.

type TopicTypesClientListEventTypesResponse 

type TopicTypesClientListEventTypesResponse struct {
	// Result of the List Event Types operation
	EventTypesListResult
}

TopicTypesClientListEventTypesResponse contains the response from method TopicTypesClient.NewListEventTypesPager.

type TopicTypesClientListOptions 

type TopicTypesClientListOptions struct {
}

TopicTypesClientListOptions contains the optional parameters for the TopicTypesClient.NewListPager method.

type TopicTypesClientListResponse 

type TopicTypesClientListResponse struct {
	// Result of the List Topic Types operation
	TopicTypesListResult
}

TopicTypesClientListResponse contains the response from method TopicTypesClient.NewListPager.

type TopicTypesListResult 

type TopicTypesListResult struct {
	// A collection of topic types
	Value []*TopicTypeInfo
}

TopicTypesListResult - Result of the List Topic Types operation

func (TopicTypesListResult) MarshalJSON added in v2.1.0 

func (t TopicTypesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopicTypesListResult.

func (*TopicTypesListResult) UnmarshalJSON added in v2.1.0 

func (t *TopicTypesListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopicTypesListResult.

type TopicUpdateParameterProperties 

type TopicUpdateParameterProperties struct {
	// The data residency boundary for the topic.
	DataResidencyBoundary *DataResidencyBoundary

	// This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD
	// token will be used to authenticate if user is allowed to publish to the topic.
	DisableLocalAuth *bool

	// This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess
	// is enabled.
	InboundIPRules []*InboundIPRule

	// This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific
	// IPs by configuring
	PublicNetworkAccess *PublicNetworkAccess
}

TopicUpdateParameterProperties - Information of topic update parameter properties.

func (TopicUpdateParameterProperties) MarshalJSON 

func (t TopicUpdateParameterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopicUpdateParameterProperties.

func (*TopicUpdateParameterProperties) UnmarshalJSON added in v2.1.0 

func (t *TopicUpdateParameterProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopicUpdateParameterProperties.

type TopicUpdateParameters 

type TopicUpdateParameters struct {
	// Topic resource identity information.
	Identity *IdentityInfo

	// Properties of the Topic resource.
	Properties *TopicUpdateParameterProperties

	// Tags of the Topic resource.
	Tags map[string]*string
}

TopicUpdateParameters - Properties of the Topic update

func (TopicUpdateParameters) MarshalJSON 

func (t TopicUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopicUpdateParameters.

func (*TopicUpdateParameters) UnmarshalJSON added in v2.1.0 

func (t *TopicUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopicUpdateParameters.

type TopicsClient 

type TopicsClient struct {
	// contains filtered or unexported fields
}

TopicsClient contains the methods for the Topics group. Don't use this type directly, use NewTopicsClient() instead.

func NewTopicsClient 

func NewTopicsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*TopicsClient, error)

NewTopicsClient creates a new instance of TopicsClient with the specified values.

  • subscriptionID - Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*TopicsClient) BeginCreateOrUpdate 

func (client *TopicsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, topicName string, topicInfo Topic, options *TopicsClientBeginCreateOrUpdateOptions) (*runtime.Poller[TopicsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Asynchronously creates a new topic with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the topic.
  • topicInfo - Topic information.
  • options - TopicsClientBeginCreateOrUpdateOptions contains the optional parameters for the TopicsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTopicsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampletopic1", armeventgrid.Topic{
	Location: to.Ptr("westus2"),
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
	Properties: &armeventgrid.TopicProperties{
		InboundIPRules: []*armeventgrid.InboundIPRule{
			{
				Action: to.Ptr(armeventgrid.IPActionTypeAllow),
				IPMask: to.Ptr("12.18.30.15"),
			},
			{
				Action: to.Ptr(armeventgrid.IPActionTypeAllow),
				IPMask: to.Ptr("12.18.176.1"),
			}},
		PublicNetworkAccess: to.Ptr(armeventgrid.PublicNetworkAccessEnabled),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*TopicsClient) BeginDelete 

func (client *TopicsClient) BeginDelete(ctx context.Context, resourceGroupName string, topicName string, options *TopicsClientBeginDeleteOptions) (*runtime.Poller[TopicsClientDeleteResponse], error)

BeginDelete - Delete existing topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the topic.
  • options - TopicsClientBeginDeleteOptions contains the optional parameters for the TopicsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTopicsClient().BeginDelete(ctx, "examplerg", "exampletopic1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*TopicsClient) BeginRegenerateKey 

func (client *TopicsClient) BeginRegenerateKey(ctx context.Context, resourceGroupName string, topicName string, regenerateKeyRequest TopicRegenerateKeyRequest, options *TopicsClientBeginRegenerateKeyOptions) (*runtime.Poller[TopicsClientRegenerateKeyResponse], error)

BeginRegenerateKey - Regenerate a shared access key for a topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the topic.
  • regenerateKeyRequest - Request body to regenerate key.
  • options - TopicsClientBeginRegenerateKeyOptions contains the optional parameters for the TopicsClient.BeginRegenerateKey method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_RegenerateKey.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTopicsClient().BeginRegenerateKey(ctx, "examplerg", "exampletopic2", armeventgrid.TopicRegenerateKeyRequest{
	KeyName: to.Ptr("key1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TopicSharedAccessKeys = armeventgrid.TopicSharedAccessKeys{
// 	Key1: to.Ptr("<key1>"),
// 	Key2: to.Ptr("<key2>"),
// }

Output:

func (*TopicsClient) BeginUpdate 

func (client *TopicsClient) BeginUpdate(ctx context.Context, resourceGroupName string, topicName string, topicUpdateParameters TopicUpdateParameters, options *TopicsClientBeginUpdateOptions) (*runtime.Poller[TopicsClientUpdateResponse], error)

BeginUpdate - Asynchronously updates a topic with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the topic.
  • topicUpdateParameters - Topic update information.
  • options - TopicsClientBeginUpdateOptions contains the optional parameters for the TopicsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewTopicsClient().BeginUpdate(ctx, "examplerg", "exampletopic1", armeventgrid.TopicUpdateParameters{
	Properties: &armeventgrid.TopicUpdateParameterProperties{
		InboundIPRules: []*armeventgrid.InboundIPRule{
			{
				Action: to.Ptr(armeventgrid.IPActionTypeAllow),
				IPMask: to.Ptr("12.18.30.15"),
			},
			{
				Action: to.Ptr(armeventgrid.IPActionTypeAllow),
				IPMask: to.Ptr("12.18.176.1"),
			}},
		PublicNetworkAccess: to.Ptr(armeventgrid.PublicNetworkAccessEnabled),
	},
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*TopicsClient) Get 

func (client *TopicsClient) Get(ctx context.Context, resourceGroupName string, topicName string, options *TopicsClientGetOptions) (TopicsClientGetResponse, error)

Get - Get properties of a topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the topic.
  • options - TopicsClientGetOptions contains the optional parameters for the TopicsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewTopicsClient().Get(ctx, "examplerg", "exampletopic2", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Topic = armeventgrid.Topic{
// 	Name: to.Ptr("exampletopic2"),
// 	Type: to.Ptr("Microsoft.EventGrid/topics"),
// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2"),
// 	Location: to.Ptr("westcentralus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armeventgrid.TopicProperties{
// 		Endpoint: to.Ptr("https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events"),
// 		ProvisioningState: to.Ptr(armeventgrid.TopicProvisioningStateSucceeded),
// 	},
// }

Output:

func (*TopicsClient) ListSharedAccessKeys 

func (client *TopicsClient) ListSharedAccessKeys(ctx context.Context, resourceGroupName string, topicName string, options *TopicsClientListSharedAccessKeysOptions) (TopicsClientListSharedAccessKeysResponse, error)

ListSharedAccessKeys - List the two keys used to publish to a topic. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • topicName - Name of the topic.
  • options - TopicsClientListSharedAccessKeysOptions contains the optional parameters for the TopicsClient.ListSharedAccessKeys method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_ListSharedAccessKeys.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewTopicsClient().ListSharedAccessKeys(ctx, "examplerg", "exampletopic2", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TopicSharedAccessKeys = armeventgrid.TopicSharedAccessKeys{
// 	Key1: to.Ptr("<key1>"),
// 	Key2: to.Ptr("<key2>"),
// }

Output:

func (*TopicsClient) NewListByResourceGroupPager 

func (client *TopicsClient) NewListByResourceGroupPager(resourceGroupName string, options *TopicsClientListByResourceGroupOptions) *runtime.Pager[TopicsClientListByResourceGroupResponse]

NewListByResourceGroupPager - List all the topics under a resource group.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • options - TopicsClientListByResourceGroupOptions contains the optional parameters for the TopicsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_ListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewTopicsClient().NewListByResourceGroupPager("examplerg", &armeventgrid.TopicsClientListByResourceGroupOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.TopicsListResult = armeventgrid.TopicsListResult{
	// 	Value: []*armeventgrid.Topic{
	// 		{
	// 			Name: to.Ptr("exampletopic1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topics"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"),
	// 			Location: to.Ptr("westus2"),
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 			Properties: &armeventgrid.TopicProperties{
	// 				Endpoint: to.Ptr("https://exampletopic1.westus2-1.eventgrid.azure.net/api/events"),
	// 				ProvisioningState: to.Ptr(armeventgrid.TopicProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("exampletopic2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topics"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2"),
	// 			Location: to.Ptr("westcentralus"),
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 			Properties: &armeventgrid.TopicProperties{
	// 				Endpoint: to.Ptr("https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events"),
	// 				ProvisioningState: to.Ptr(armeventgrid.TopicProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*TopicsClient) NewListBySubscriptionPager 

func (client *TopicsClient) NewListBySubscriptionPager(options *TopicsClientListBySubscriptionOptions) *runtime.Pager[TopicsClientListBySubscriptionResponse]

NewListBySubscriptionPager - List all the topics under an Azure subscription.

Generated from API version 2022-06-15

  • options - TopicsClientListBySubscriptionOptions contains the optional parameters for the TopicsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_ListBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewTopicsClient().NewListBySubscriptionPager(&armeventgrid.TopicsClientListBySubscriptionOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.TopicsListResult = armeventgrid.TopicsListResult{
	// 	Value: []*armeventgrid.Topic{
	// 		{
	// 			Name: to.Ptr("exampletopic1"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topics"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"),
	// 			Location: to.Ptr("westus2"),
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 			Properties: &armeventgrid.TopicProperties{
	// 				Endpoint: to.Ptr("https://exampletopic1.westus2-1.eventgrid.azure.net/api/events"),
	// 				ProvisioningState: to.Ptr(armeventgrid.TopicProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("exampletopic2"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topics"),
	// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2"),
	// 			Location: to.Ptr("westcentralus"),
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 			Properties: &armeventgrid.TopicProperties{
	// 				Endpoint: to.Ptr("https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events"),
	// 				ProvisioningState: to.Ptr(armeventgrid.TopicProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*TopicsClient) NewListEventTypesPager 

func (client *TopicsClient) NewListEventTypesPager(resourceGroupName string, providerNamespace string, resourceTypeName string, resourceName string, options *TopicsClientListEventTypesOptions) *runtime.Pager[TopicsClientListEventTypesResponse]

NewListEventTypesPager - List event types for a topic.

Generated from API version 2022-06-15

  • resourceGroupName - The name of the resource group within the user's subscription.
  • providerNamespace - Namespace of the provider of the topic.
  • resourceTypeName - Name of the topic type.
  • resourceName - Name of the topic.
  • options - TopicsClientListEventTypesOptions contains the optional parameters for the TopicsClient.NewListEventTypesPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_ListEventTypes.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewTopicsClient().NewListEventTypesPager("examplerg", "Microsoft.Storage", "storageAccounts", "ExampleStorageAccount", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EventTypesListResult = armeventgrid.EventTypesListResult{
	// 	Value: []*armeventgrid.EventType{
	// 		{
	// 			Name: to.Ptr("Microsoft.Storage.BlobCreated"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topicTypes/eventTypes"),
	// 			ID: to.Ptr("providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobCreated"),
	// 			Properties: &armeventgrid.EventTypeProperties{
	// 				Description: to.Ptr("Raised when a blob is created."),
	// 				DisplayName: to.Ptr("Blob Created"),
	// 				SchemaURL: to.Ptr("tbd"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.Storage.BlobDeleted"),
	// 			Type: to.Ptr("Microsoft.EventGrid/topicTypes/eventTypes"),
	// 			ID: to.Ptr("providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobDeleted"),
	// 			Properties: &armeventgrid.EventTypeProperties{
	// 				Description: to.Ptr("Raised when a blob is deleted."),
	// 				DisplayName: to.Ptr("Blob Deleted"),
	// 				SchemaURL: to.Ptr("tbd"),
	// 			},
	// 	}},
	// }
}

Output:

type TopicsClientBeginCreateOrUpdateOptions 

type TopicsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TopicsClientBeginCreateOrUpdateOptions contains the optional parameters for the TopicsClient.BeginCreateOrUpdate method.

type TopicsClientBeginDeleteOptions 

type TopicsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TopicsClientBeginDeleteOptions contains the optional parameters for the TopicsClient.BeginDelete method.

type TopicsClientBeginRegenerateKeyOptions 

type TopicsClientBeginRegenerateKeyOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TopicsClientBeginRegenerateKeyOptions contains the optional parameters for the TopicsClient.BeginRegenerateKey method.

type TopicsClientBeginUpdateOptions 

type TopicsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TopicsClientBeginUpdateOptions contains the optional parameters for the TopicsClient.BeginUpdate method.

type TopicsClientCreateOrUpdateResponse 

type TopicsClientCreateOrUpdateResponse struct {
	// EventGrid Topic
	Topic
}

TopicsClientCreateOrUpdateResponse contains the response from method TopicsClient.BeginCreateOrUpdate.

type TopicsClientDeleteResponse 

type TopicsClientDeleteResponse struct {
}

TopicsClientDeleteResponse contains the response from method TopicsClient.BeginDelete.

type TopicsClientGetOptions 

type TopicsClientGetOptions struct {
}

TopicsClientGetOptions contains the optional parameters for the TopicsClient.Get method.

type TopicsClientGetResponse 

type TopicsClientGetResponse struct {
	// EventGrid Topic
	Topic
}

TopicsClientGetResponse contains the response from method TopicsClient.Get.

type TopicsClientListByResourceGroupOptions 

type TopicsClientListByResourceGroupOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

TopicsClientListByResourceGroupOptions contains the optional parameters for the TopicsClient.NewListByResourceGroupPager method.

type TopicsClientListByResourceGroupResponse 

type TopicsClientListByResourceGroupResponse struct {
	// Result of the List Topics operation
	TopicsListResult
}

TopicsClientListByResourceGroupResponse contains the response from method TopicsClient.NewListByResourceGroupPager.

type TopicsClientListBySubscriptionOptions 

type TopicsClientListBySubscriptionOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

TopicsClientListBySubscriptionOptions contains the optional parameters for the TopicsClient.NewListBySubscriptionPager method.

type TopicsClientListBySubscriptionResponse 

type TopicsClientListBySubscriptionResponse struct {
	// Result of the List Topics operation
	TopicsListResult
}

TopicsClientListBySubscriptionResponse contains the response from method TopicsClient.NewListBySubscriptionPager.

type TopicsClientListEventTypesOptions 

type TopicsClientListEventTypesOptions struct {
}

TopicsClientListEventTypesOptions contains the optional parameters for the TopicsClient.NewListEventTypesPager method.

type TopicsClientListEventTypesResponse 

type TopicsClientListEventTypesResponse struct {
	// Result of the List Event Types operation
	EventTypesListResult
}

TopicsClientListEventTypesResponse contains the response from method TopicsClient.NewListEventTypesPager.

type TopicsClientListSharedAccessKeysOptions 

type TopicsClientListSharedAccessKeysOptions struct {
}

TopicsClientListSharedAccessKeysOptions contains the optional parameters for the TopicsClient.ListSharedAccessKeys method.

type TopicsClientListSharedAccessKeysResponse 

type TopicsClientListSharedAccessKeysResponse struct {
	// Shared access keys of the Topic
	TopicSharedAccessKeys
}

TopicsClientListSharedAccessKeysResponse contains the response from method TopicsClient.ListSharedAccessKeys.

type TopicsClientRegenerateKeyResponse 

type TopicsClientRegenerateKeyResponse struct {
	// Shared access keys of the Topic
	TopicSharedAccessKeys
}

TopicsClientRegenerateKeyResponse contains the response from method TopicsClient.BeginRegenerateKey.

type TopicsClientUpdateResponse 

type TopicsClientUpdateResponse struct {
	// EventGrid Topic
	Topic
}

TopicsClientUpdateResponse contains the response from method TopicsClient.BeginUpdate.

type TopicsListResult 

type TopicsListResult struct {
	// A link for the next page of topics
	NextLink *string

	// A collection of Topics
	Value []*Topic
}

TopicsListResult - Result of the List Topics operation

func (TopicsListResult) MarshalJSON added in v2.1.0 

func (t TopicsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopicsListResult.

func (*TopicsListResult) UnmarshalJSON added in v2.1.0 

func (t *TopicsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopicsListResult.

type TrackedResource 

type TrackedResource struct {
	// REQUIRED; Location of the resource.
	Location *string

	// Tags of the resource.
	Tags map[string]*string

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; Type of the resource.
	Type *string
}

TrackedResource - Definition of a Tracked Resource.

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON added in v2.1.0 

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

type UserIdentityProperties 

type UserIdentityProperties struct {
	// The client id of user assigned identity.
	ClientID *string

	// The principal id of user assigned identity.
	PrincipalID *string
}

UserIdentityProperties - The information about the user identity.

func (UserIdentityProperties) MarshalJSON added in v2.1.0 

func (u UserIdentityProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserIdentityProperties.

func (*UserIdentityProperties) UnmarshalJSON added in v2.1.0 

func (u *UserIdentityProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserIdentityProperties.

type VerifiedPartner 

type VerifiedPartner struct {
	// Properties of the verified partner.
	Properties *VerifiedPartnerProperties

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to Verified Partner resource.
	SystemData *SystemData

	// READ-ONLY; Type of the resource.
	Type *string
}

VerifiedPartner - Verified partner information

func (VerifiedPartner) MarshalJSON added in v2.1.0 

func (v VerifiedPartner) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VerifiedPartner.

func (*VerifiedPartner) UnmarshalJSON added in v2.1.0 

func (v *VerifiedPartner) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VerifiedPartner.

type VerifiedPartnerProperties 

type VerifiedPartnerProperties struct {
	// Official name of the Partner.
	OrganizationName *string

	// Display name of the verified partner.
	PartnerDisplayName *string

	// ImmutableId of the corresponding partner registration.
	PartnerRegistrationImmutableID *string

	// Details of the partner topic scenario.
	PartnerTopicDetails *PartnerDetails

	// Provisioning state of the verified partner.
	ProvisioningState *VerifiedPartnerProvisioningState
}

VerifiedPartnerProperties - Properties of the verified partner.

func (VerifiedPartnerProperties) MarshalJSON added in v2.1.0 

func (v VerifiedPartnerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VerifiedPartnerProperties.

func (*VerifiedPartnerProperties) UnmarshalJSON added in v2.1.0 

func (v *VerifiedPartnerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VerifiedPartnerProperties.

type VerifiedPartnerProvisioningState 

type VerifiedPartnerProvisioningState string

VerifiedPartnerProvisioningState - Provisioning state of the verified partner. 

const (
	VerifiedPartnerProvisioningStateCanceled  VerifiedPartnerProvisioningState = "Canceled"
	VerifiedPartnerProvisioningStateCreating  VerifiedPartnerProvisioningState = "Creating"
	VerifiedPartnerProvisioningStateDeleting  VerifiedPartnerProvisioningState = "Deleting"
	VerifiedPartnerProvisioningStateFailed    VerifiedPartnerProvisioningState = "Failed"
	VerifiedPartnerProvisioningStateSucceeded VerifiedPartnerProvisioningState = "Succeeded"
	VerifiedPartnerProvisioningStateUpdating  VerifiedPartnerProvisioningState = "Updating"
)

func PossibleVerifiedPartnerProvisioningStateValues 

func PossibleVerifiedPartnerProvisioningStateValues() []VerifiedPartnerProvisioningState

PossibleVerifiedPartnerProvisioningStateValues returns the possible values for the VerifiedPartnerProvisioningState const type.

type VerifiedPartnersClient 

type VerifiedPartnersClient struct {
	// contains filtered or unexported fields
}

VerifiedPartnersClient contains the methods for the VerifiedPartners group. Don't use this type directly, use NewVerifiedPartnersClient() instead.

func NewVerifiedPartnersClient 

func NewVerifiedPartnersClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*VerifiedPartnersClient, error)

NewVerifiedPartnersClient creates a new instance of VerifiedPartnersClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*VerifiedPartnersClient) Get 

func (client *VerifiedPartnersClient) Get(ctx context.Context, verifiedPartnerName string, options *VerifiedPartnersClientGetOptions) (VerifiedPartnersClientGetResponse, error)

Get - Get properties of a verified partner. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-06-15

  • verifiedPartnerName - Name of the verified partner.
  • options - VerifiedPartnersClientGetOptions contains the optional parameters for the VerifiedPartnersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/VerifiedPartners_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewVerifiedPartnersClient().Get(ctx, "Contoso.Finance", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.VerifiedPartner = armeventgrid.VerifiedPartner{
// 	Name: to.Ptr("Contoso.Finance"),
// 	Type: to.Ptr("Microsoft.EventGrid/verifiedPartners"),
// 	ID: to.Ptr("/providers/Microsoft.EventGrid/verifiedPartners/Contoso.Finance"),
// 	Properties: &armeventgrid.VerifiedPartnerProperties{
// 		OrganizationName: to.Ptr("Contoso"),
// 		PartnerDisplayName: to.Ptr("Contoso - Finance Department"),
// 		PartnerRegistrationImmutableID: to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
// 		PartnerTopicDetails: &armeventgrid.PartnerDetails{
// 			Description: to.Ptr("This is short description"),
// 			LongDescription: to.Ptr("This is really long long... long description"),
// 			SetupURI: to.Ptr("https://www.example.com/"),
// 		},
// 	},
// }

Output:

func (*VerifiedPartnersClient) NewListPager 

func (client *VerifiedPartnersClient) NewListPager(options *VerifiedPartnersClientListOptions) *runtime.Pager[VerifiedPartnersClientListResponse]

NewListPager - Get a list of all verified partners.

Generated from API version 2022-06-15

  • options - VerifiedPartnersClientListOptions contains the optional parameters for the VerifiedPartnersClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/VerifiedPartners_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewVerifiedPartnersClient().NewListPager(&armeventgrid.VerifiedPartnersClientListOptions{Filter: nil,
	Top: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.VerifiedPartnersListResult = armeventgrid.VerifiedPartnersListResult{
	// 	Value: []*armeventgrid.VerifiedPartner{
	// 		{
	// 			Name: to.Ptr("Contoso.Finance"),
	// 			Type: to.Ptr("Microsoft.EventGrid/verifiedPartners"),
	// 			ID: to.Ptr("/providers/Microsoft.EventGrid/verifiedPartners/Contoso.Finance"),
	// 			Properties: &armeventgrid.VerifiedPartnerProperties{
	// 				OrganizationName: to.Ptr("Contoso"),
	// 				PartnerDisplayName: to.Ptr("Contoso - Finance Department"),
	// 				PartnerRegistrationImmutableID: to.Ptr("941892bc-f5d0-4d1c-8fb5-477570fc2b71"),
	// 				PartnerTopicDetails: &armeventgrid.PartnerDetails{
	// 					Description: to.Ptr("This is short description"),
	// 					LongDescription: to.Ptr("This is really long long... long description"),
	// 					SetupURI: to.Ptr("https://www.example.com/"),
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

type VerifiedPartnersClientGetOptions 

type VerifiedPartnersClientGetOptions struct {
}

VerifiedPartnersClientGetOptions contains the optional parameters for the VerifiedPartnersClient.Get method.

type VerifiedPartnersClientGetResponse 

type VerifiedPartnersClientGetResponse struct {
	// Verified partner information
	VerifiedPartner
}

VerifiedPartnersClientGetResponse contains the response from method VerifiedPartnersClient.Get.

type VerifiedPartnersClientListOptions 

type VerifiedPartnersClientListOptions struct {
	// The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and
	// with limited number of OData operations. These operations are: the 'contains'
	// function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic
	// operations are supported. The following is a valid filter example:
	// $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location
	// eq 'westus'.
	Filter *string

	// The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified,
	// the default number of results to be returned is 20 items per page.
	Top *int32
}

VerifiedPartnersClientListOptions contains the optional parameters for the VerifiedPartnersClient.NewListPager method.

type VerifiedPartnersClientListResponse 

type VerifiedPartnersClientListResponse struct {
	// Result of the List verified partners operation
	VerifiedPartnersListResult
}

VerifiedPartnersClientListResponse contains the response from method VerifiedPartnersClient.NewListPager.

type VerifiedPartnersListResult 

type VerifiedPartnersListResult struct {
	// A link for the next page of verified partners if any.
	NextLink *string

	// A collection of verified partners.
	Value []*VerifiedPartner
}

VerifiedPartnersListResult - Result of the List verified partners operation

func (VerifiedPartnersListResult) MarshalJSON added in v2.1.0 

func (v VerifiedPartnersListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VerifiedPartnersListResult.

func (*VerifiedPartnersListResult) UnmarshalJSON added in v2.1.0 

func (v *VerifiedPartnersListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VerifiedPartnersListResult.

type WebHookEventSubscriptionDestination 

type WebHookEventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType

	// WebHook Properties of the event subscription destination.
	Properties *WebHookEventSubscriptionDestinationProperties
}

WebHookEventSubscriptionDestination - Information about the webhook destination for an event subscription.

func (*WebHookEventSubscriptionDestination) GetEventSubscriptionDestination 

func (w *WebHookEventSubscriptionDestination) GetEventSubscriptionDestination() *EventSubscriptionDestination

GetEventSubscriptionDestination implements the EventSubscriptionDestinationClassification interface for type WebHookEventSubscriptionDestination.

func (WebHookEventSubscriptionDestination) MarshalJSON 

func (w WebHookEventSubscriptionDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebHookEventSubscriptionDestination.

func (*WebHookEventSubscriptionDestination) UnmarshalJSON 

func (w *WebHookEventSubscriptionDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebHookEventSubscriptionDestination.

type WebHookEventSubscriptionDestinationProperties 

type WebHookEventSubscriptionDestinationProperties struct {
	// The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery
	// requests.
	AzureActiveDirectoryApplicationIDOrURI *string

	// The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
	AzureActiveDirectoryTenantID *string

	// Delivery attribute details.
	DeliveryAttributeMappings []DeliveryAttributeMappingClassification

	// The URL that represents the endpoint of the destination of an event subscription.
	EndpointURL *string

	// Maximum number of events per batch.
	MaxEventsPerBatch *int32

	// Preferred batch size in Kilobytes.
	PreferredBatchSizeInKilobytes *int32

	// READ-ONLY; The base URL that represents the endpoint of the destination of an event subscription.
	EndpointBaseURL *string
}

WebHookEventSubscriptionDestinationProperties - Information about the webhook destination properties for an event subscription.

func (WebHookEventSubscriptionDestinationProperties) MarshalJSON 

func (w WebHookEventSubscriptionDestinationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebHookEventSubscriptionDestinationProperties.

func (*WebHookEventSubscriptionDestinationProperties) UnmarshalJSON 

func (w *WebHookEventSubscriptionDestinationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebHookEventSubscriptionDestinationProperties.

Source Files

View all Source files

Directories

Path Synopsis

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.