armeventgrid

package module
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: May 17, 2022 License: MIT Imports: 17 Imported by: 5

README

Azure Event Grid Module for Go

PkgGoDev

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

Source code

Getting started

Prerequisites

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

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.

Clients

Azure Event Grid modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armeventgrid.NewPartnerNamespacesClient(<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,
    },
}
client, err := armeventgrid.NewPartnerNamespacesClient(<subscription ID>, cred, &options)

More sample code

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`
}

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.

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 `json:"endpointType,omitempty"`

	// Azure Function Properties of the event subscription destination.
	Properties *AzureFunctionEventSubscriptionDestinationProperties `json:"properties,omitempty"`
}

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

func (*AzureFunctionEventSubscriptionDestination) GetEventSubscriptionDestination added in v0.3.0 

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 `json:"deliveryAttributeMappings,omitempty"`

	// Maximum number of events per batch.
	MaxEventsPerBatch *int32 `json:"maxEventsPerBatch,omitempty"`

	// Preferred batch size in Kilobytes.
	PreferredBatchSizeInKilobytes *int32 `json:"preferredBatchSizeInKilobytes,omitempty"`

	// The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription.
	ResourceID *string `json:"resourceId,omitempty"`
}

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The boolean filter value.
	Value *bool `json:"value,omitempty"`
}

BoolEqualsAdvancedFilter - BoolEquals Advanced Filter.

func (*BoolEqualsAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 ConnectionState 

type ConnectionState struct {
	// Actions required (if any).
	ActionsRequired *string `json:"actionsRequired,omitempty"`

	// Description of the connection state.
	Description *string `json:"description,omitempty"`

	// Status of the connection.
	Status *PersistedConnectionStatus `json:"status,omitempty"`
}

ConnectionState information.

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 DeadLetterDestination 

type DeadLetterDestination struct {
	// REQUIRED; Type of the endpoint for the dead letter destination
	EndpointType *DeadLetterEndPointType `json:"endpointType,omitempty"`
}

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.

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 `json:"deadLetterDestination,omitempty"`

	// The identity to use when dead-lettering events.
	Identity *EventSubscriptionIdentity `json:"identity,omitempty"`
}

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 `json:"value,omitempty"`
}

DeliveryAttributeListResult - Result of the Get delivery attributes operation.

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 `json:"type,omitempty"`

	// Name of the delivery attribute or header.
	Name *string `json:"name,omitempty"`
}

DeliveryAttributeMapping - Delivery attribute mapping details.

func (*DeliveryAttributeMapping) GetDeliveryAttributeMapping 

func (d *DeliveryAttributeMapping) GetDeliveryAttributeMapping() *DeliveryAttributeMapping

GetDeliveryAttributeMapping implements the DeliveryAttributeMappingClassification 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 `json:"destination,omitempty"`

	// The identity to use when delivering events.
	Identity *EventSubscriptionIdentity `json:"identity,omitempty"`
}

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 `json:"location,omitempty"`

	// Identity information for the Event Grid Domain resource.
	Identity *IdentityInfo `json:"identity,omitempty"`

	// Properties of the Event Grid Domain resource.
	Properties *DomainProperties `json:"properties,omitempty"`

	// Tags of the resource.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The system metadata relating to Domain resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Domain - EventGrid Domain.

func (Domain) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Domain.

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 `json:"autoCreateTopicWithFirstSubscription,omitempty"`

	// 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 `json:"autoDeleteTopicWithLastSubscription,omitempty"`

	// 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 `json:"disableLocalAuth,omitempty"`

	// 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 `json:"inboundIpRules,omitempty"`

	// This determines the format that Event Grid should expect for incoming events published to the domain.
	InputSchema *InputSchema `json:"inputSchema,omitempty"`

	// Information about the InputSchemaMapping which specified the info about mapping event payload.
	InputSchemaMapping InputSchemaMappingClassification `json:"inputSchemaMapping,omitempty"`

	// 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 `json:"publicNetworkAccess,omitempty"`

	// READ-ONLY; Endpoint for the domain.
	Endpoint *string `json:"endpoint,omitempty" azure:"ro"`

	// READ-ONLY; Metric resource id for the domain.
	MetricResourceID *string `json:"metricResourceId,omitempty" azure:"ro"`

	// READ-ONLY; List of private endpoint connections.
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the Event Grid Domain Resource.
	ProvisioningState *DomainProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

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 `json:"keyName,omitempty"`
}

DomainRegenerateKeyRequest - Domain regenerate share access key request.

type DomainSharedAccessKeys 

type DomainSharedAccessKeys struct {
	// Shared access key1 for the domain.
	Key1 *string `json:"key1,omitempty"`

	// Shared access key2 for the domain.
	Key2 *string `json:"key2,omitempty"`
}

DomainSharedAccessKeys - Shared access keys of the Domain.

type DomainTopic 

type DomainTopic struct {
	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Properties of the Domain Topic.
	Properties *DomainTopicProperties `json:"properties,omitempty" azure:"ro"`

	// READ-ONLY; The system metadata relating to Domain Topic resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DomainTopic - Domain Topic.

type DomainTopicProperties 

type DomainTopicProperties struct {
	// READ-ONLY; Provisioning state of the domain topic.
	ProvisioningState *DomainTopicProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

DomainTopicProperties - Properties of the Domain Topic.

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/DomainTopics_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/DomainTopics_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/DomainTopics_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"examplerg",
		"exampledomain2",
		"topic1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DomainTopicsClient) NewListByDomainPager added in v0.5.0 

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

NewListByDomainPager - List all the topics in a domain. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. domainName - Domain name. options - DomainTopicsClientListByDomainOptions contains the optional parameters for the DomainTopicsClient.ListByDomain method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/DomainTopics_ListByDomain.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByDomainPager("examplerg",
		"exampledomain2",
		&armeventgrid.DomainTopicsClientListByDomainOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type DomainTopicsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

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

type DomainTopicsClientBeginDeleteOptions added in v0.3.0 

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

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

type DomainTopicsClientCreateOrUpdateResponse added in v0.3.0 

type DomainTopicsClientCreateOrUpdateResponse struct {
	DomainTopic
}

DomainTopicsClientCreateOrUpdateResponse contains the response from method DomainTopicsClient.CreateOrUpdate.

type DomainTopicsClientDeleteResponse added in v0.3.0 

type DomainTopicsClientDeleteResponse struct {
}

DomainTopicsClientDeleteResponse contains the response from method DomainTopicsClient.Delete.

type DomainTopicsClientGetOptions added in v0.3.0 

type DomainTopicsClientGetOptions struct {
}

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

type DomainTopicsClientGetResponse added in v0.3.0 

type DomainTopicsClientGetResponse struct {
	DomainTopic
}

DomainTopicsClientGetResponse contains the response from method DomainTopicsClient.Get.

type DomainTopicsClientListByDomainOptions added in v0.3.0 

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.ListByDomain method.

type DomainTopicsClientListByDomainResponse added in v0.3.0 

type DomainTopicsClientListByDomainResponse struct {
	DomainTopicsListResult
}

DomainTopicsClientListByDomainResponse contains the response from method DomainTopicsClient.ListByDomain.

type DomainTopicsListResult 

type DomainTopicsListResult struct {
	// A link for the next page of domain topics.
	NextLink *string `json:"nextLink,omitempty"`

	// A collection of Domain Topics.
	Value []*DomainTopic `json:"value,omitempty"`
}

DomainTopicsListResult - Result of the List Domain Topics operation.

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 `json:"autoCreateTopicWithFirstSubscription,omitempty"`

	// 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 `json:"autoDeleteTopicWithLastSubscription,omitempty"`

	// 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 `json:"disableLocalAuth,omitempty"`

	// 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 `json:"inboundIpRules,omitempty"`

	// 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 `json:"publicNetworkAccess,omitempty"`
}

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.

type DomainUpdateParameters 

type DomainUpdateParameters struct {
	// Identity information for the resource.
	Identity *IdentityInfo `json:"identity,omitempty"`

	// Properties of the resource.
	Properties *DomainUpdateParameterProperties `json:"properties,omitempty"`

	// Tags of the domains resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

DomainUpdateParameters - Properties of the Domain update.

func (DomainUpdateParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller 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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Domains_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Domains_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Domains_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Domains_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"examplerg",
		"exampledomain2",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Domains_ListSharedAccessKeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListSharedAccessKeys(ctx,
		"examplerg",
		"exampledomain2",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DomainsClient) NewListByResourceGroupPager added in v0.5.0 

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

NewListByResourceGroupPager - List all the domains under a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. options - DomainsClientListByResourceGroupOptions contains the optional parameters for the DomainsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Domains_ListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("examplerg",
		&armeventgrid.DomainsClientListByResourceGroupOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*DomainsClient) NewListBySubscriptionPager added in v0.5.0 

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

NewListBySubscriptionPager - List all the domains under an Azure subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 options - DomainsClientListBySubscriptionOptions contains the optional parameters for the DomainsClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Domains_ListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(&armeventgrid.DomainsClientListBySubscriptionOptions{Filter: nil,
		Top: nil,
	})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Domains_RegenerateKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewDomainsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.RegenerateKey(ctx,
		"examplerg",
		"exampledomain2",
		armeventgrid.DomainRegenerateKeyRequest{
			KeyName: to.Ptr("key1"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type DomainsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

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

type DomainsClientBeginDeleteOptions added in v0.3.0 

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

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

type DomainsClientBeginUpdateOptions added in v0.3.0 

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

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

type DomainsClientCreateOrUpdateResponse added in v0.3.0 

type DomainsClientCreateOrUpdateResponse struct {
	Domain
}

DomainsClientCreateOrUpdateResponse contains the response from method DomainsClient.CreateOrUpdate.

type DomainsClientDeleteResponse added in v0.3.0 

type DomainsClientDeleteResponse struct {
}

DomainsClientDeleteResponse contains the response from method DomainsClient.Delete.

type DomainsClientGetOptions added in v0.3.0 

type DomainsClientGetOptions struct {
}

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

type DomainsClientGetResponse added in v0.3.0 

type DomainsClientGetResponse struct {
	Domain
}

DomainsClientGetResponse contains the response from method DomainsClient.Get.

type DomainsClientListByResourceGroupOptions added in v0.3.0 

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.ListByResourceGroup method.

type DomainsClientListByResourceGroupResponse added in v0.3.0 

type DomainsClientListByResourceGroupResponse struct {
	DomainsListResult
}

DomainsClientListByResourceGroupResponse contains the response from method DomainsClient.ListByResourceGroup.

type DomainsClientListBySubscriptionOptions added in v0.3.0 

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.ListBySubscription method.

type DomainsClientListBySubscriptionResponse added in v0.3.0 

type DomainsClientListBySubscriptionResponse struct {
	DomainsListResult
}

DomainsClientListBySubscriptionResponse contains the response from method DomainsClient.ListBySubscription.

type DomainsClientListSharedAccessKeysOptions added in v0.3.0 

type DomainsClientListSharedAccessKeysOptions struct {
}

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

type DomainsClientListSharedAccessKeysResponse added in v0.3.0 

type DomainsClientListSharedAccessKeysResponse struct {
	DomainSharedAccessKeys
}

DomainsClientListSharedAccessKeysResponse contains the response from method DomainsClient.ListSharedAccessKeys.

type DomainsClientRegenerateKeyOptions added in v0.3.0 

type DomainsClientRegenerateKeyOptions struct {
}

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

type DomainsClientRegenerateKeyResponse added in v0.3.0 

type DomainsClientRegenerateKeyResponse struct {
	DomainSharedAccessKeys
}

DomainsClientRegenerateKeyResponse contains the response from method DomainsClient.RegenerateKey.

type DomainsClientUpdateResponse added in v0.3.0 

type DomainsClientUpdateResponse struct {
	Domain
}

DomainsClientUpdateResponse contains the response from method DomainsClient.Update.

type DomainsListResult 

type DomainsListResult struct {
	// A link for the next page of domains.
	NextLink *string `json:"nextLink,omitempty"`

	// A collection of Domains.
	Value []*Domain `json:"value,omitempty"`
}

DomainsListResult - Result of the List Domains operation.

type DynamicDeliveryAttributeMapping 

type DynamicDeliveryAttributeMapping struct {
	// REQUIRED; Type of the delivery attribute or header name.
	Type *DeliveryAttributeMappingType `json:"type,omitempty"`

	// Name of the delivery attribute or header.
	Name *string `json:"name,omitempty"`

	// Properties of dynamic delivery attribute mapping.
	Properties *DynamicDeliveryAttributeMappingProperties `json:"properties,omitempty"`
}

DynamicDeliveryAttributeMapping - Dynamic delivery attribute mapping details.

func (*DynamicDeliveryAttributeMapping) GetDeliveryAttributeMapping added in v0.3.0 

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 `json:"sourceField,omitempty"`
}

DynamicDeliveryAttributeMappingProperties - Properties of dynamic delivery attribute mapping.

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 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 `json:"endpointType,omitempty"`

	// Event Hub Properties of the event subscription destination.
	Properties *EventHubEventSubscriptionDestinationProperties `json:"properties,omitempty"`
}

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

func (*EventHubEventSubscriptionDestination) GetEventSubscriptionDestination added in v0.3.0 

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 `json:"deliveryAttributeMappings,omitempty"`

	// The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.
	ResourceID *string `json:"resourceId,omitempty"`
}

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 `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The system metadata relating to Event Subscription resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

EventSubscription - Event Subscription

type EventSubscriptionDestination 

type EventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType `json:"endpointType,omitempty"`
}

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.

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 `json:"advancedFilters,omitempty"`

	// Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.
	EnableAdvancedFilteringOnArrays *bool `json:"enableAdvancedFilteringOnArrays,omitempty"`

	// 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 `json:"includedEventTypes,omitempty"`

	// Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive
	// manner.
	IsSubjectCaseSensitive *bool `json:"isSubjectCaseSensitive,omitempty"`

	// 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 `json:"subjectBeginsWith,omitempty"`

	// 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 `json:"subjectEndsWith,omitempty"`
}

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 `json:"endpointUrl,omitempty"`
}

EventSubscriptionFullURL - Full endpoint url of an event subscription

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 `json:"type,omitempty"`

	// The user identity associated with the resource.
	UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}

EventSubscriptionIdentity - The identity information with the event subscription.

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 DeadLetter destination of the event subscription.
	DeadLetterDestination DeadLetterDestinationClassification `json:"deadLetterDestination,omitempty"`

	// 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 `json:"deadLetterWithResourceIdentity,omitempty"`

	// 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 `json:"deliveryWithResourceIdentity,omitempty"`

	// Information about the destination where events have to be delivered for the event subscription.
	Destination EventSubscriptionDestinationClassification `json:"destination,omitempty"`

	// The event delivery schema for the event subscription.
	EventDeliverySchema *EventDeliverySchema `json:"eventDeliverySchema,omitempty"`

	// Expiration time of the event subscription.
	ExpirationTimeUTC *time.Time `json:"expirationTimeUtc,omitempty"`

	// Information about the filter for the event subscription.
	Filter *EventSubscriptionFilter `json:"filter,omitempty"`

	// List of user defined labels.
	Labels []*string `json:"labels,omitempty"`

	// The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
	RetryPolicy *RetryPolicy `json:"retryPolicy,omitempty"`

	// READ-ONLY; Provisioning state of the event subscription.
	ProvisioningState *EventSubscriptionProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Name of the topic of the event subscription.
	Topic *string `json:"topic,omitempty" azure:"ro"`
}

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 DeadLetter destination of the event subscription.
	DeadLetterDestination DeadLetterDestinationClassification `json:"deadLetterDestination,omitempty"`

	// 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 `json:"deadLetterWithResourceIdentity,omitempty"`

	// 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 `json:"deliveryWithResourceIdentity,omitempty"`

	// Information about the destination where events have to be delivered for the event subscription.
	Destination EventSubscriptionDestinationClassification `json:"destination,omitempty"`

	// The event delivery schema for the event subscription.
	EventDeliverySchema *EventDeliverySchema `json:"eventDeliverySchema,omitempty"`

	// Information about the expiration time for the event subscription.
	ExpirationTimeUTC *time.Time `json:"expirationTimeUtc,omitempty"`

	// Information about the filter for the event subscription.
	Filter *EventSubscriptionFilter `json:"filter,omitempty"`

	// List of user defined labels.
	Labels []*string `json:"labels,omitempty"`

	// The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
	RetryPolicy *RetryPolicy `json:"retryPolicy,omitempty"`
}

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 2021-12-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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:

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 2021-12-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_DeleteForCustomTopic.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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:

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 2021-12-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_UpdateForCustomTopic.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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:

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 2021-12-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_GetForCustomTopic.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.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)
	}
	// TODO: use response item
	_ = res
}

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_GetDeliveryAttributes.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetDeliveryAttributes(ctx,
		"aaaaaaaaaaaaaaaaaaaaaaaaa",
		"aaaaaaaaaaaaaaaaaa",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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 2021-12-01 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.

func (*EventSubscriptionsClient) NewListByDomainTopicPager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 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.ListByDomainTopic method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_ListByDomainTopic.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByDomainTopicPager("examplerg",
		"domain1",
		"topic1",
		&armeventgrid.EventSubscriptionsClientListByDomainTopicOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*EventSubscriptionsClient) NewListByResourcePager added in v0.5.0 

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 topic. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 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.ListByResource method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_ListByResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourcePager("examplerg",
		"Microsoft.EventGrid",
		"topics",
		"exampletopic2",
		&armeventgrid.EventSubscriptionsClientListByResourceOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*EventSubscriptionsClient) NewListGlobalByResourceGroupForTopicTypePager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 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.ListGlobalByResourceGroupForTopicType method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListGlobalByResourceGroupForTopicTypePager("examplerg",
		"Microsoft.Resources.ResourceGroups",
		&armeventgrid.EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*EventSubscriptionsClient) NewListGlobalByResourceGroupPager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. options - EventSubscriptionsClientListGlobalByResourceGroupOptions contains the optional parameters for the EventSubscriptionsClient.ListGlobalByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_ListGlobalByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListGlobalByResourceGroupPager("examplerg",
		&armeventgrid.EventSubscriptionsClientListGlobalByResourceGroupOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*EventSubscriptionsClient) NewListGlobalBySubscriptionForTopicTypePager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 topicTypeName - Name of the topic type. options - EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeOptions contains the optional parameters for the EventSubscriptionsClient.ListGlobalBySubscriptionForTopicType method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListGlobalBySubscriptionForTopicTypePager("Microsoft.Resources.Subscriptions",
		&armeventgrid.EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*EventSubscriptionsClient) NewListGlobalBySubscriptionPager added in v0.5.0 

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

NewListGlobalBySubscriptionPager - List all aggregated global event subscriptions under a specific Azure subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 options - EventSubscriptionsClientListGlobalBySubscriptionOptions contains the optional parameters for the EventSubscriptionsClient.ListGlobalBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_ListGlobalBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListGlobalBySubscriptionPager(&armeventgrid.EventSubscriptionsClientListGlobalBySubscriptionOptions{Filter: nil,
		Top: nil,
	})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*EventSubscriptionsClient) NewListRegionalByResourceGroupForTopicTypePager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 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.ListRegionalByResourceGroupForTopicType method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListRegionalByResourceGroupForTopicTypePager("examplerg",
		"westus2",
		"Microsoft.EventHub.namespaces",
		&armeventgrid.EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*EventSubscriptionsClient) NewListRegionalByResourceGroupPager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 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.ListRegionalByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_ListRegionalByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListRegionalByResourceGroupPager("examplerg",
		"westus2",
		&armeventgrid.EventSubscriptionsClientListRegionalByResourceGroupOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*EventSubscriptionsClient) NewListRegionalBySubscriptionForTopicTypePager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 location - Name of the location. topicTypeName - Name of the topic type. options - EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeOptions contains the optional parameters for the EventSubscriptionsClient.ListRegionalBySubscriptionForTopicType method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListRegionalBySubscriptionForTopicTypePager("westus2",
		"Microsoft.EventHub.namespaces",
		&armeventgrid.EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*EventSubscriptionsClient) NewListRegionalBySubscriptionPager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 location - Name of the location. options - EventSubscriptionsClientListRegionalBySubscriptionOptions contains the optional parameters for the EventSubscriptionsClient.ListRegionalBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/EventSubscriptions_ListRegionalBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListRegionalBySubscriptionPager("westus2",
		&armeventgrid.EventSubscriptionsClientListRegionalBySubscriptionOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type EventSubscriptionsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

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

type EventSubscriptionsClientBeginDeleteOptions added in v0.3.0 

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

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

type EventSubscriptionsClientBeginUpdateOptions added in v0.3.0 

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

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

type EventSubscriptionsClientCreateOrUpdateResponse added in v0.3.0 

type EventSubscriptionsClientCreateOrUpdateResponse struct {
	EventSubscription
}

EventSubscriptionsClientCreateOrUpdateResponse contains the response from method EventSubscriptionsClient.CreateOrUpdate.

type EventSubscriptionsClientDeleteResponse added in v0.3.0 

type EventSubscriptionsClientDeleteResponse struct {
}

EventSubscriptionsClientDeleteResponse contains the response from method EventSubscriptionsClient.Delete.

type EventSubscriptionsClientGetDeliveryAttributesOptions added in v0.3.0 

type EventSubscriptionsClientGetDeliveryAttributesOptions struct {
}

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

type EventSubscriptionsClientGetDeliveryAttributesResponse added in v0.3.0 

type EventSubscriptionsClientGetDeliveryAttributesResponse struct {
	DeliveryAttributeListResult
}

EventSubscriptionsClientGetDeliveryAttributesResponse contains the response from method EventSubscriptionsClient.GetDeliveryAttributes.

type EventSubscriptionsClientGetFullURLOptions added in v0.3.0 

type EventSubscriptionsClientGetFullURLOptions struct {
}

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

type EventSubscriptionsClientGetFullURLResponse added in v0.3.0 

type EventSubscriptionsClientGetFullURLResponse struct {
	EventSubscriptionFullURL
}

EventSubscriptionsClientGetFullURLResponse contains the response from method EventSubscriptionsClient.GetFullURL.

type EventSubscriptionsClientGetOptions added in v0.3.0 

type EventSubscriptionsClientGetOptions struct {
}

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

type EventSubscriptionsClientGetResponse added in v0.3.0 

type EventSubscriptionsClientGetResponse struct {
	EventSubscription
}

EventSubscriptionsClientGetResponse contains the response from method EventSubscriptionsClient.Get.

type EventSubscriptionsClientListByDomainTopicOptions added in v0.3.0 

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.ListByDomainTopic method.

type EventSubscriptionsClientListByDomainTopicResponse added in v0.3.0 

type EventSubscriptionsClientListByDomainTopicResponse struct {
	EventSubscriptionsListResult
}

EventSubscriptionsClientListByDomainTopicResponse contains the response from method EventSubscriptionsClient.ListByDomainTopic.

type EventSubscriptionsClientListByResourceOptions added in v0.3.0 

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.ListByResource method.

type EventSubscriptionsClientListByResourceResponse added in v0.3.0 

type EventSubscriptionsClientListByResourceResponse struct {
	EventSubscriptionsListResult
}

EventSubscriptionsClientListByResourceResponse contains the response from method EventSubscriptionsClient.ListByResource.

type EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeOptions added in v0.3.0 

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.ListGlobalByResourceGroupForTopicType method.

type EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeResponse added in v0.3.0 

type EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeResponse struct {
	EventSubscriptionsListResult
}

EventSubscriptionsClientListGlobalByResourceGroupForTopicTypeResponse contains the response from method EventSubscriptionsClient.ListGlobalByResourceGroupForTopicType.

type EventSubscriptionsClientListGlobalByResourceGroupOptions added in v0.3.0 

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.ListGlobalByResourceGroup method.

type EventSubscriptionsClientListGlobalByResourceGroupResponse added in v0.3.0 

type EventSubscriptionsClientListGlobalByResourceGroupResponse struct {
	EventSubscriptionsListResult
}

EventSubscriptionsClientListGlobalByResourceGroupResponse contains the response from method EventSubscriptionsClient.ListGlobalByResourceGroup.

type EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeOptions added in v0.3.0 

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.ListGlobalBySubscriptionForTopicType method.

type EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeResponse added in v0.3.0 

type EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeResponse struct {
	EventSubscriptionsListResult
}

EventSubscriptionsClientListGlobalBySubscriptionForTopicTypeResponse contains the response from method EventSubscriptionsClient.ListGlobalBySubscriptionForTopicType.

type EventSubscriptionsClientListGlobalBySubscriptionOptions added in v0.3.0 

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.ListGlobalBySubscription method.

type EventSubscriptionsClientListGlobalBySubscriptionResponse added in v0.3.0 

type EventSubscriptionsClientListGlobalBySubscriptionResponse struct {
	EventSubscriptionsListResult
}

EventSubscriptionsClientListGlobalBySubscriptionResponse contains the response from method EventSubscriptionsClient.ListGlobalBySubscription.

type EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeOptions added in v0.3.0 

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.ListRegionalByResourceGroupForTopicType method.

type EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeResponse added in v0.3.0 

type EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeResponse struct {
	EventSubscriptionsListResult
}

EventSubscriptionsClientListRegionalByResourceGroupForTopicTypeResponse contains the response from method EventSubscriptionsClient.ListRegionalByResourceGroupForTopicType.

type EventSubscriptionsClientListRegionalByResourceGroupOptions added in v0.3.0 

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.ListRegionalByResourceGroup method.

type EventSubscriptionsClientListRegionalByResourceGroupResponse added in v0.3.0 

type EventSubscriptionsClientListRegionalByResourceGroupResponse struct {
	EventSubscriptionsListResult
}

EventSubscriptionsClientListRegionalByResourceGroupResponse contains the response from method EventSubscriptionsClient.ListRegionalByResourceGroup.

type EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeOptions added in v0.3.0 

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.ListRegionalBySubscriptionForTopicType method.

type EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeResponse added in v0.3.0 

type EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeResponse struct {
	EventSubscriptionsListResult
}

EventSubscriptionsClientListRegionalBySubscriptionForTopicTypeResponse contains the response from method EventSubscriptionsClient.ListRegionalBySubscriptionForTopicType.

type EventSubscriptionsClientListRegionalBySubscriptionOptions added in v0.3.0 

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.ListRegionalBySubscription method.

type EventSubscriptionsClientListRegionalBySubscriptionResponse added in v0.3.0 

type EventSubscriptionsClientListRegionalBySubscriptionResponse struct {
	EventSubscriptionsListResult
}

EventSubscriptionsClientListRegionalBySubscriptionResponse contains the response from method EventSubscriptionsClient.ListRegionalBySubscription.

type EventSubscriptionsClientUpdateResponse added in v0.3.0 

type EventSubscriptionsClientUpdateResponse struct {
	EventSubscription
}

EventSubscriptionsClientUpdateResponse contains the response from method EventSubscriptionsClient.Update.

type EventSubscriptionsListResult 

type EventSubscriptionsListResult struct {
	// A link for the next page of event subscriptions
	NextLink *string `json:"nextLink,omitempty"`

	// A collection of EventSubscriptions
	Value []*EventSubscription `json:"value,omitempty"`
}

EventSubscriptionsListResult - Result of the List EventSubscriptions operation

type EventType 

type EventType struct {
	// Properties of the event type.
	Properties *EventTypeProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

EventType - Event Type for a subject under a topic

type EventTypeProperties 

type EventTypeProperties struct {
	// Description of the event type.
	Description *string `json:"description,omitempty"`

	// Display name of the event type.
	DisplayName *string `json:"displayName,omitempty"`

	// IsInDefaultSet flag of the event type.
	IsInDefaultSet *bool `json:"isInDefaultSet,omitempty"`

	// Url of the schema for this event type.
	SchemaURL *string `json:"schemaUrl,omitempty"`
}

EventTypeProperties - Properties of the event type

type EventTypesListResult 

type EventTypesListResult struct {
	// A collection of event types
	Value []*EventType `json:"value,omitempty"`
}

EventTypesListResult - Result of the List Event Types operation

type ExtensionTopic 

type ExtensionTopic struct {
	// Properties of the extension topic
	Properties *ExtensionTopicProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The system metadata relating to the Extension Topic resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

type ExtensionTopicProperties 

type ExtensionTopicProperties struct {
	// Description of the extension topic.
	Description *string `json:"description,omitempty"`

	// System topic resource id which is mapped to the source.
	SystemTopic *string `json:"systemTopic,omitempty"`
}

ExtensionTopicProperties - Properties of the Extension Topic

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/ExtensionTopics_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewExtensionTopicsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.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)
	}
	// TODO: use response item
	_ = res
}

Output:

type ExtensionTopicsClientGetOptions added in v0.3.0 

type ExtensionTopicsClientGetOptions struct {
}

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

type ExtensionTopicsClientGetResponse added in v0.3.0 

type ExtensionTopicsClientGetResponse struct {
	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 `json:"endpointType,omitempty"`

	// Hybrid connection Properties of the event subscription destination.
	Properties *HybridConnectionEventSubscriptionDestinationProperties `json:"properties,omitempty"`
}

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

func (*HybridConnectionEventSubscriptionDestination) GetEventSubscriptionDestination added in v0.3.0 

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 `json:"deliveryAttributeMappings,omitempty"`

	// The Azure Resource ID of an hybrid connection that is the destination of an event subscription.
	ResourceID *string `json:"resourceId,omitempty"`
}

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 `json:"principalId,omitempty"`

	// The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty"`

	// 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 `json:"type,omitempty"`

	// 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 `json:"userAssignedIdentities,omitempty"`
}

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.

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 `json:"action,omitempty"`

	// IP Address in CIDR notation e.g., 10.0.0.0/8.
	IPMask *string `json:"ipMask,omitempty"`
}

type InputSchema 

type InputSchema string

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

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 `json:"inputSchemaMappingType,omitempty"`
}

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.

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`
}

IsNotNullAdvancedFilter - IsNotNull Advanced Filter.

func (*IsNotNullAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`
}

IsNullOrUndefinedAdvancedFilter - IsNullOrUndefined Advanced Filter.

func (*IsNullOrUndefinedAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 added in v0.3.0 

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 `json:"sourceField,omitempty"`
}

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.

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 `json:"defaultValue,omitempty"`

	// Name of a field in the input event schema that's to be used as the source of a mapping.
	SourceField *string `json:"sourceField,omitempty"`
}

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.

type JSONInputSchemaMapping 

type JSONInputSchemaMapping struct {
	// REQUIRED; Type of the custom mapping
	InputSchemaMappingType *InputSchemaMappingType `json:"inputSchemaMappingType,omitempty"`

	// JSON Properties of the input schema mapping
	Properties *JSONInputSchemaMappingProperties `json:"properties,omitempty"`
}

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 added in v0.3.0 

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 `json:"dataVersion,omitempty"`

	// The mapping information for the EventTime property of the Event Grid Event.
	EventTime *JSONField `json:"eventTime,omitempty"`

	// The mapping information for the EventType property of the Event Grid Event.
	EventType *JSONFieldWithDefault `json:"eventType,omitempty"`

	// The mapping information for the Id property of the Event Grid Event.
	ID *JSONField `json:"id,omitempty"`

	// The mapping information for the Subject property of the Event Grid Event.
	Subject *JSONFieldWithDefault `json:"subject,omitempty"`

	// The mapping information for the Topic property of the Event Grid Event.
	Topic *JSONField `json:"topic,omitempty"`
}

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.

type NumberGreaterThanAdvancedFilter 

type NumberGreaterThanAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The filter value.
	Value *float64 `json:"value,omitempty"`
}

NumberGreaterThanAdvancedFilter - NumberGreaterThan Advanced Filter.

func (*NumberGreaterThanAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The filter value.
	Value *float64 `json:"value,omitempty"`
}

NumberGreaterThanOrEqualsAdvancedFilter - NumberGreaterThanOrEquals Advanced Filter.

func (*NumberGreaterThanOrEqualsAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values []*float64 `json:"values,omitempty"`
}

NumberInAdvancedFilter - NumberIn Advanced Filter.

func (*NumberInAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values [][]*float64 `json:"values,omitempty"`
}

NumberInRangeAdvancedFilter - NumberInRange Advanced Filter.

func (*NumberInRangeAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The filter value.
	Value *float64 `json:"value,omitempty"`
}

NumberLessThanAdvancedFilter - NumberLessThan Advanced Filter.

func (*NumberLessThanAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The filter value.
	Value *float64 `json:"value,omitempty"`
}

NumberLessThanOrEqualsAdvancedFilter - NumberLessThanOrEquals Advanced Filter.

func (*NumberLessThanOrEqualsAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values []*float64 `json:"values,omitempty"`
}

NumberNotInAdvancedFilter - NumberNotIn Advanced Filter.

func (*NumberNotInAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values [][]*float64 `json:"values,omitempty"`
}

NumberNotInRangeAdvancedFilter - NumberNotInRange Advanced Filter.

func (*NumberNotInRangeAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"display,omitempty"`

	// This Boolean is used to determine if the operation is a data plane action or not.
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// Name of the operation.
	Name *string `json:"name,omitempty"`

	// Origin of the operation.
	Origin *string `json:"origin,omitempty"`

	// Properties of the operation.
	Properties interface{} `json:"properties,omitempty"`
}

Operation - Represents an operation returned by the GetOperations request.

type OperationInfo 

type OperationInfo struct {
	// Description of the operation
	Description *string `json:"description,omitempty"`

	// Name of the operation
	Operation *string `json:"operation,omitempty"`

	// Name of the provider
	Provider *string `json:"provider,omitempty"`

	// Name of the resource type
	Resource *string `json:"resource,omitempty"`
}

OperationInfo - Information about an operation

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 added in v0.5.0 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - List the available operations supported by the Microsoft.EventGrid resource provider. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Operations_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewOperationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type OperationsClientListOptions added in v0.3.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.3.0 

type OperationsClientListResponse struct {
	OperationsListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsListResult 

type OperationsListResult struct {
	// A collection of operations
	Value []*Operation `json:"value,omitempty"`
}

OperationsListResult - Result of the List Operations operation

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 `json:"id,omitempty"`
}

PrivateEndpoint information.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Properties of the PrivateEndpointConnection.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// A link for the next page of private endpoint connection resources.
	NextLink *string `json:"nextLink,omitempty"`

	// A collection of private endpoint connection resources.
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - Result of the list of all private endpoint connections operation.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// GroupIds from the private link service resource.
	GroupIDs []*string `json:"groupIds,omitempty"`

	// The Private Endpoint resource for this Connection.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`

	// Details about the state of the connection.
	PrivateLinkServiceConnectionState *ConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// Provisioning state of the Private Endpoint Connection.
	ProvisioningState *ResourceProvisioningState `json:"provisioningState,omitempty"`
}

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.

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 or domain. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'. parentName - The name of the parent resource (namely, either, the topic name or domain 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/PrivateEndpointConnections_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewPrivateEndpointConnectionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 or domain. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'. parentName - The name of the parent resource (namely, either, the topic name or domain 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/PrivateEndpointConnections_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewPrivateEndpointConnectionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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)
	}
	// TODO: use response item
	_ = res
}

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 or domain. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'. parentName - The name of the parent resource (namely, either, the topic name or domain 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/PrivateEndpointConnections_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewPrivateEndpointConnectionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.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)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*PrivateEndpointConnectionsClient) NewListByResourcePager added in v0.5.0 

func (client *PrivateEndpointConnectionsClient) NewListByResourcePager(resourceGroupName string, parentType PrivateEndpointConnectionsParentType, parentName string, options *PrivateEndpointConnectionsClientListByResourceOptions) *runtime.Pager[PrivateEndpointConnectionsClientListByResourceResponse]

NewListByResourcePager - Get all private endpoint connections under a topic or domain. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'. parentName - The name of the parent resource (namely, either, the topic name or domain name). options - PrivateEndpointConnectionsClientListByResourceOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByResource method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/PrivateEndpointConnections_ListByResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewPrivateEndpointConnectionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourcePager("examplerg",
		armeventgrid.PrivateEndpointConnectionsParentTypeTopics,
		"exampletopic1",
		&armeventgrid.PrivateEndpointConnectionsClientListByResourceOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type PrivateEndpointConnectionsClientBeginDeleteOptions added in v0.3.0 

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

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientBeginUpdateOptions added in v0.3.0 

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

PrivateEndpointConnectionsClientBeginUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginUpdate method.

type PrivateEndpointConnectionsClientDeleteResponse added in v0.3.0 

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions added in v0.3.0 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.3.0 

type PrivateEndpointConnectionsClientGetResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListByResourceOptions added in v0.3.0 

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.ListByResource method.

type PrivateEndpointConnectionsClientListByResourceResponse added in v0.3.0 

type PrivateEndpointConnectionsClientListByResourceResponse struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListByResourceResponse contains the response from method PrivateEndpointConnectionsClient.ListByResource.

type PrivateEndpointConnectionsClientUpdateResponse added in v0.3.0 

type PrivateEndpointConnectionsClientUpdateResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientUpdateResponse contains the response from method PrivateEndpointConnectionsClient.Update.

type PrivateEndpointConnectionsParentType added in v1.0.0 

type PrivateEndpointConnectionsParentType string
const (
	PrivateEndpointConnectionsParentTypeDomains PrivateEndpointConnectionsParentType = "domains"
	PrivateEndpointConnectionsParentTypeTopics  PrivateEndpointConnectionsParentType = "topics"
)

func PossiblePrivateEndpointConnectionsParentTypeValues added in v1.0.0 

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 `json:"id,omitempty"`

	// Name of the resource.
	Name *string `json:"name,omitempty"`

	// Properties of the private link resource.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`

	// Type of the resource.
	Type *string `json:"type,omitempty"`
}

PrivateLinkResource - Information of the private link resource.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	DisplayName       *string   `json:"displayName,omitempty"`
	GroupID           *string   `json:"groupId,omitempty"`
	RequiredMembers   []*string `json:"requiredMembers,omitempty"`
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`
}

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 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'. parentName - The name of the parent resource (namely, either, the topic name or domain 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/PrivateLinkResources_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewPrivateLinkResourcesClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"examplerg",
		"topics",
		"exampletopic1",
		"topic",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*PrivateLinkResourcesClient) NewListByResourcePager added in v0.5.0 

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 or domain. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'. parentName - The name of the parent resource (namely, either, the topic name or domain name). options - PrivateLinkResourcesClientListByResourceOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByResource method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/PrivateLinkResources_ListByResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewPrivateLinkResourcesClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourcePager("examplerg",
		"topics",
		"exampletopic1",
		&armeventgrid.PrivateLinkResourcesClientListByResourceOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type PrivateLinkResourcesClientGetOptions added in v0.3.0 

type PrivateLinkResourcesClientGetOptions struct {
}

PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

type PrivateLinkResourcesClientGetResponse added in v0.3.0 

type PrivateLinkResourcesClientGetResponse struct {
	PrivateLinkResource
}

PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientListByResourceOptions added in v0.3.0 

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.ListByResource method.

type PrivateLinkResourcesClientListByResourceResponse added in v0.3.0 

type PrivateLinkResourcesClientListByResourceResponse struct {
	PrivateLinkResourcesListResult
}

PrivateLinkResourcesClientListByResourceResponse contains the response from method PrivateLinkResourcesClient.ListByResource.

type PrivateLinkResourcesListResult 

type PrivateLinkResourcesListResult struct {
	// A link for the next page of private link resources.
	NextLink *string `json:"nextLink,omitempty"`

	// A collection of private link resources
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourcesListResult - Result of the List private link resources operation.

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 Resource 

type Resource struct {
	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Definition of a 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 `json:"eventTimeToLiveInMinutes,omitempty"`

	// Maximum number of delivery retry attempts for events.
	MaxDeliveryAttempts *int32 `json:"maxDeliveryAttempts,omitempty"`
}

RetryPolicy - Information about the retry policy for an event subscription.

type ServiceBusQueueEventSubscriptionDestination 

type ServiceBusQueueEventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType `json:"endpointType,omitempty"`

	// Service Bus Properties of the event subscription destination.
	Properties *ServiceBusQueueEventSubscriptionDestinationProperties `json:"properties,omitempty"`
}

ServiceBusQueueEventSubscriptionDestination - Information about the service bus destination for an event subscription.

func (*ServiceBusQueueEventSubscriptionDestination) GetEventSubscriptionDestination added in v0.3.0 

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 `json:"deliveryAttributeMappings,omitempty"`

	// The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.
	ResourceID *string `json:"resourceId,omitempty"`
}

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 `json:"endpointType,omitempty"`

	// Service Bus Topic Properties of the event subscription destination.
	Properties *ServiceBusTopicEventSubscriptionDestinationProperties `json:"properties,omitempty"`
}

ServiceBusTopicEventSubscriptionDestination - Information about the service bus topic destination for an event subscription.

func (*ServiceBusTopicEventSubscriptionDestination) GetEventSubscriptionDestination added in v0.3.0 

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 `json:"deliveryAttributeMappings,omitempty"`

	// The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription.
	ResourceID *string `json:"resourceId,omitempty"`
}

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 `json:"type,omitempty"`

	// Name of the delivery attribute or header.
	Name *string `json:"name,omitempty"`

	// Properties of static delivery attribute mapping.
	Properties *StaticDeliveryAttributeMappingProperties `json:"properties,omitempty"`
}

StaticDeliveryAttributeMapping - Static delivery attribute mapping details.

func (*StaticDeliveryAttributeMapping) GetDeliveryAttributeMapping added in v0.3.0 

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 `json:"isSecret,omitempty"`

	// Value of the delivery attribute.
	Value *string `json:"value,omitempty"`
}

StaticDeliveryAttributeMappingProperties - Properties of static delivery attribute mapping.

type StorageBlobDeadLetterDestination 

type StorageBlobDeadLetterDestination struct {
	// REQUIRED; Type of the endpoint for the dead letter destination
	EndpointType *DeadLetterEndPointType `json:"endpointType,omitempty"`

	// The properties of the Storage Blob based deadletter destination
	Properties *StorageBlobDeadLetterDestinationProperties `json:"properties,omitempty"`
}

StorageBlobDeadLetterDestination - Information about the storage blob based dead letter destination.

func (*StorageBlobDeadLetterDestination) GetDeadLetterDestination added in v0.3.0 

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 `json:"blobContainerName,omitempty"`

	// The Azure Resource ID of the storage account that is the destination of the deadletter events
	ResourceID *string `json:"resourceId,omitempty"`
}

StorageBlobDeadLetterDestinationProperties - Properties of the storage blob based dead letter destination.

type StorageQueueEventSubscriptionDestination 

type StorageQueueEventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType `json:"endpointType,omitempty"`

	// Storage Queue Properties of the event subscription destination.
	Properties *StorageQueueEventSubscriptionDestinationProperties `json:"properties,omitempty"`
}

StorageQueueEventSubscriptionDestination - Information about the storage queue destination for an event subscription.

func (*StorageQueueEventSubscriptionDestination) GetEventSubscriptionDestination added in v0.3.0 

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 `json:"queueMessageTimeToLiveInSeconds,omitempty"`

	// The name of the Storage queue under a storage account that is the destination of an event subscription.
	QueueName *string `json:"queueName,omitempty"`

	// The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.
	ResourceID *string `json:"resourceId,omitempty"`
}

StorageQueueEventSubscriptionDestinationProperties - The properties for a storage queue destination.

type StringBeginsWithAdvancedFilter 

type StringBeginsWithAdvancedFilter struct {
	// REQUIRED; The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
	OperatorType *AdvancedFilterOperatorType `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values []*string `json:"values,omitempty"`
}

StringBeginsWithAdvancedFilter - StringBeginsWith Advanced Filter.

func (*StringBeginsWithAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values []*string `json:"values,omitempty"`
}

StringContainsAdvancedFilter - StringContains Advanced Filter.

func (*StringContainsAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values []*string `json:"values,omitempty"`
}

StringEndsWithAdvancedFilter - StringEndsWith Advanced Filter.

func (*StringEndsWithAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values []*string `json:"values,omitempty"`
}

StringInAdvancedFilter - StringIn Advanced Filter.

func (*StringInAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values []*string `json:"values,omitempty"`
}

StringNotBeginsWithAdvancedFilter - StringNotBeginsWith Advanced Filter.

func (*StringNotBeginsWithAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values []*string `json:"values,omitempty"`
}

StringNotContainsAdvancedFilter - StringNotContains Advanced Filter.

func (*StringNotContainsAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values []*string `json:"values,omitempty"`
}

StringNotEndsWithAdvancedFilter - StringNotEndsWith Advanced Filter.

func (*StringNotEndsWithAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"operatorType,omitempty"`

	// The field/property in the event based on which you want to filter.
	Key *string `json:"key,omitempty"`

	// The set of filter values.
	Values []*string `json:"values,omitempty"`
}

StringNotInAdvancedFilter - StringNotIn Advanced Filter.

func (*StringNotInAdvancedFilter) GetAdvancedFilter added in v0.3.0 

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 `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

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 `json:"location,omitempty"`

	// Identity information for the resource.
	Identity *IdentityInfo `json:"identity,omitempty"`

	// Properties of the system topic.
	Properties *SystemTopicProperties `json:"properties,omitempty"`

	// Tags of the resource.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The system metadata relating to System Topic resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

SystemTopic - EventGrid System Topic.

func (SystemTopic) MarshalJSON 

func (s SystemTopic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller 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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 event subscription of a system topic. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopicEventSubscriptions_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 event subscription of a system topic. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopicEventSubscriptions_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopicEventSubscriptions_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"examplerg",
		"exampleSystemTopic1",
		"examplesubscription1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopicEventSubscriptions_GetDeliveryAttributes.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetDeliveryAttributes(ctx,
		"examplerg",
		"exampleSystemTopic1",
		"examplesubscription1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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 2021-12-01 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.

func (*SystemTopicEventSubscriptionsClient) NewListBySystemTopicPager added in v0.5.0 

func (client *SystemTopicEventSubscriptionsClient) NewListBySystemTopicPager(resourceGroupName string, systemTopicName string, options *SystemTopicEventSubscriptionsClientListBySystemTopicOptions) *runtime.Pager[SystemTopicEventSubscriptionsClientListBySystemTopicResponse]

NewListBySystemTopicPager - List event subscriptions that belong to a specific system topic. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 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.ListBySystemTopic method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopicEventSubscriptions_ListBySystemTopic.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicEventSubscriptionsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySystemTopicPager("examplerg",
		"exampleSystemTopic1",
		&armeventgrid.SystemTopicEventSubscriptionsClientListBySystemTopicOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type SystemTopicEventSubscriptionsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

SystemTopicEventSubscriptionsClientBeginCreateOrUpdateOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.BeginCreateOrUpdate method.

type SystemTopicEventSubscriptionsClientBeginDeleteOptions added in v0.3.0 

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

SystemTopicEventSubscriptionsClientBeginDeleteOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.BeginDelete method.

type SystemTopicEventSubscriptionsClientBeginUpdateOptions added in v0.3.0 

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

SystemTopicEventSubscriptionsClientBeginUpdateOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.BeginUpdate method.

type SystemTopicEventSubscriptionsClientCreateOrUpdateResponse added in v0.3.0 

type SystemTopicEventSubscriptionsClientCreateOrUpdateResponse struct {
	EventSubscription
}

SystemTopicEventSubscriptionsClientCreateOrUpdateResponse contains the response from method SystemTopicEventSubscriptionsClient.CreateOrUpdate.

type SystemTopicEventSubscriptionsClientDeleteResponse added in v0.3.0 

type SystemTopicEventSubscriptionsClientDeleteResponse struct {
}

SystemTopicEventSubscriptionsClientDeleteResponse contains the response from method SystemTopicEventSubscriptionsClient.Delete.

type SystemTopicEventSubscriptionsClientGetDeliveryAttributesOptions added in v0.3.0 

type SystemTopicEventSubscriptionsClientGetDeliveryAttributesOptions struct {
}

SystemTopicEventSubscriptionsClientGetDeliveryAttributesOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.GetDeliveryAttributes method.

type SystemTopicEventSubscriptionsClientGetDeliveryAttributesResponse added in v0.3.0 

type SystemTopicEventSubscriptionsClientGetDeliveryAttributesResponse struct {
	DeliveryAttributeListResult
}

SystemTopicEventSubscriptionsClientGetDeliveryAttributesResponse contains the response from method SystemTopicEventSubscriptionsClient.GetDeliveryAttributes.

type SystemTopicEventSubscriptionsClientGetFullURLOptions added in v0.3.0 

type SystemTopicEventSubscriptionsClientGetFullURLOptions struct {
}

SystemTopicEventSubscriptionsClientGetFullURLOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.GetFullURL method.

type SystemTopicEventSubscriptionsClientGetFullURLResponse added in v0.3.0 

type SystemTopicEventSubscriptionsClientGetFullURLResponse struct {
	EventSubscriptionFullURL
}

SystemTopicEventSubscriptionsClientGetFullURLResponse contains the response from method SystemTopicEventSubscriptionsClient.GetFullURL.

type SystemTopicEventSubscriptionsClientGetOptions added in v0.3.0 

type SystemTopicEventSubscriptionsClientGetOptions struct {
}

SystemTopicEventSubscriptionsClientGetOptions contains the optional parameters for the SystemTopicEventSubscriptionsClient.Get method.

type SystemTopicEventSubscriptionsClientGetResponse added in v0.3.0 

type SystemTopicEventSubscriptionsClientGetResponse struct {
	EventSubscription
}

SystemTopicEventSubscriptionsClientGetResponse contains the response from method SystemTopicEventSubscriptionsClient.Get.

type SystemTopicEventSubscriptionsClientListBySystemTopicOptions added in v0.3.0 

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.ListBySystemTopic method.

type SystemTopicEventSubscriptionsClientListBySystemTopicResponse added in v0.3.0 

type SystemTopicEventSubscriptionsClientListBySystemTopicResponse struct {
	EventSubscriptionsListResult
}

SystemTopicEventSubscriptionsClientListBySystemTopicResponse contains the response from method SystemTopicEventSubscriptionsClient.ListBySystemTopic.

type SystemTopicEventSubscriptionsClientUpdateResponse added in v0.3.0 

type SystemTopicEventSubscriptionsClientUpdateResponse struct {
	EventSubscription
}

SystemTopicEventSubscriptionsClientUpdateResponse contains the response from method SystemTopicEventSubscriptionsClient.Update.

type SystemTopicProperties 

type SystemTopicProperties struct {
	// Source for the system topic.
	Source *string `json:"source,omitempty"`

	// TopicType for the system topic.
	TopicType *string `json:"topicType,omitempty"`

	// READ-ONLY; Metric resource id for the system topic.
	MetricResourceID *string `json:"metricResourceId,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the system topic.
	ProvisioningState *ResourceProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

SystemTopicProperties - Properties of the System Topic.

type SystemTopicUpdateParameters 

type SystemTopicUpdateParameters struct {
	// Resource identity information.
	Identity *IdentityInfo `json:"identity,omitempty"`

	// Tags of the system topic.
	Tags map[string]*string `json:"tags,omitempty"`
}

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.

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopics_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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)
	}
	// TODO: use response item
	_ = res
}

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopics_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopics_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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)
	}
	// TODO: use response item
	_ = res
}

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopics_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"examplerg",
		"exampleSystemTopic2",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SystemTopicsClient) NewListByResourceGroupPager added in v0.5.0 

func (client *SystemTopicsClient) NewListByResourceGroupPager(resourceGroupName string, options *SystemTopicsClientListByResourceGroupOptions) *runtime.Pager[SystemTopicsClientListByResourceGroupResponse]

NewListByResourceGroupPager - List all the system topics under a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. options - SystemTopicsClientListByResourceGroupOptions contains the optional parameters for the SystemTopicsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopics_ListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("examplerg",
		&armeventgrid.SystemTopicsClientListByResourceGroupOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*SystemTopicsClient) NewListBySubscriptionPager added in v0.5.0 

func (client *SystemTopicsClient) NewListBySubscriptionPager(options *SystemTopicsClientListBySubscriptionOptions) *runtime.Pager[SystemTopicsClientListBySubscriptionResponse]

NewListBySubscriptionPager - List all the system topics under an Azure subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 options - SystemTopicsClientListBySubscriptionOptions contains the optional parameters for the SystemTopicsClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/SystemTopics_ListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewSystemTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(&armeventgrid.SystemTopicsClientListBySubscriptionOptions{Filter: nil,
		Top: nil,
	})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type SystemTopicsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

SystemTopicsClientBeginCreateOrUpdateOptions contains the optional parameters for the SystemTopicsClient.BeginCreateOrUpdate method.

type SystemTopicsClientBeginDeleteOptions added in v0.3.0 

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

SystemTopicsClientBeginDeleteOptions contains the optional parameters for the SystemTopicsClient.BeginDelete method.

type SystemTopicsClientBeginUpdateOptions added in v0.3.0 

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

SystemTopicsClientBeginUpdateOptions contains the optional parameters for the SystemTopicsClient.BeginUpdate method.

type SystemTopicsClientCreateOrUpdateResponse added in v0.3.0 

type SystemTopicsClientCreateOrUpdateResponse struct {
	SystemTopic
}

SystemTopicsClientCreateOrUpdateResponse contains the response from method SystemTopicsClient.CreateOrUpdate.

type SystemTopicsClientDeleteResponse added in v0.3.0 

type SystemTopicsClientDeleteResponse struct {
}

SystemTopicsClientDeleteResponse contains the response from method SystemTopicsClient.Delete.

type SystemTopicsClientGetOptions added in v0.3.0 

type SystemTopicsClientGetOptions struct {
}

SystemTopicsClientGetOptions contains the optional parameters for the SystemTopicsClient.Get method.

type SystemTopicsClientGetResponse added in v0.3.0 

type SystemTopicsClientGetResponse struct {
	SystemTopic
}

SystemTopicsClientGetResponse contains the response from method SystemTopicsClient.Get.

type SystemTopicsClientListByResourceGroupOptions added in v0.3.0 

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.ListByResourceGroup method.

type SystemTopicsClientListByResourceGroupResponse added in v0.3.0 

type SystemTopicsClientListByResourceGroupResponse struct {
	SystemTopicsListResult
}

SystemTopicsClientListByResourceGroupResponse contains the response from method SystemTopicsClient.ListByResourceGroup.

type SystemTopicsClientListBySubscriptionOptions added in v0.3.0 

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.ListBySubscription method.

type SystemTopicsClientListBySubscriptionResponse added in v0.3.0 

type SystemTopicsClientListBySubscriptionResponse struct {
	SystemTopicsListResult
}

SystemTopicsClientListBySubscriptionResponse contains the response from method SystemTopicsClient.ListBySubscription.

type SystemTopicsClientUpdateResponse added in v0.3.0 

type SystemTopicsClientUpdateResponse struct {
	SystemTopic
}

SystemTopicsClientUpdateResponse contains the response from method SystemTopicsClient.Update.

type SystemTopicsListResult 

type SystemTopicsListResult struct {
	// A link for the next page of topics.
	NextLink *string `json:"nextLink,omitempty"`

	// A collection of system Topics.
	Value []*SystemTopic `json:"value,omitempty"`
}

SystemTopicsListResult - Result of the List System topics operation.

type Topic 

type Topic struct {
	// REQUIRED; Location of the resource.
	Location *string `json:"location,omitempty"`

	// Identity information for the resource.
	Identity *IdentityInfo `json:"identity,omitempty"`

	// Properties of the topic.
	Properties *TopicProperties `json:"properties,omitempty"`

	// Tags of the resource.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The system metadata relating to Topic resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Topic - EventGrid Topic

func (Topic) MarshalJSON 

func (t Topic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Topic.

type TopicProperties 

type TopicProperties 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 topic.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// 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 `json:"inboundIpRules,omitempty"`

	// This determines the format that Event Grid should expect for incoming events published to the topic.
	InputSchema *InputSchema `json:"inputSchema,omitempty"`

	// 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 `json:"inputSchemaMapping,omitempty"`

	// 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 `json:"publicNetworkAccess,omitempty"`

	// READ-ONLY; Endpoint for the topic.
	Endpoint *string `json:"endpoint,omitempty" azure:"ro"`

	// READ-ONLY; Metric resource id for the topic.
	MetricResourceID *string `json:"metricResourceId,omitempty" azure:"ro"`

	// READ-ONLY
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the topic.
	ProvisioningState *TopicProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

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 `json:"keyName,omitempty"`
}

TopicRegenerateKeyRequest - Topic regenerate share access key request

type TopicSharedAccessKeys 

type TopicSharedAccessKeys struct {
	// Shared access key1 for the topic.
	Key1 *string `json:"key1,omitempty"`

	// Shared access key2 for the topic.
	Key2 *string `json:"key2,omitempty"`
}

TopicSharedAccessKeys - Shared access keys of the Topic

type TopicTypeInfo 

type TopicTypeInfo struct {
	// Properties of the topic type info
	Properties *TopicTypeProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

TopicTypeInfo - Properties of a topic type info.

type TopicTypeProperties 

type TopicTypeProperties struct {
	// Description of the topic type.
	Description *string `json:"description,omitempty"`

	// Display Name for the topic type.
	DisplayName *string `json:"displayName,omitempty"`

	// Namespace of the provider of the topic type.
	Provider *string `json:"provider,omitempty"`

	// Provisioning state of the topic type
	ProvisioningState *TopicTypeProvisioningState `json:"provisioningState,omitempty"`

	// Region type of the resource.
	ResourceRegionType *ResourceRegionType `json:"resourceRegionType,omitempty"`

	// Source resource format.
	SourceResourceFormat *string `json:"sourceResourceFormat,omitempty"`

	// List of locations supported by this topic type.
	SupportedLocations []*string `json:"supportedLocations,omitempty"`

	// Supported source scopes.
	SupportedScopesForSource []*TopicTypePropertiesSupportedScopesForSourceItem `json:"supportedScopesForSource,omitempty"`
}

TopicTypeProperties - Properties of a topic type.

func (TopicTypeProperties) MarshalJSON 

func (t TopicTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopicTypeProperties.

type TopicTypePropertiesSupportedScopesForSourceItem 

type TopicTypePropertiesSupportedScopesForSourceItem string
const (
	TopicTypePropertiesSupportedScopesForSourceItemAzureSubscription TopicTypePropertiesSupportedScopesForSourceItem = "AzureSubscription"
	TopicTypePropertiesSupportedScopesForSourceItemResource          TopicTypePropertiesSupportedScopesForSourceItem = "Resource"
	TopicTypePropertiesSupportedScopesForSourceItemResourceGroup     TopicTypePropertiesSupportedScopesForSourceItem = "ResourceGroup"
)

func PossibleTopicTypePropertiesSupportedScopesForSourceItemValues 

func PossibleTopicTypePropertiesSupportedScopesForSourceItemValues() []TopicTypePropertiesSupportedScopesForSourceItem

PossibleTopicTypePropertiesSupportedScopesForSourceItemValues returns the possible values for the TopicTypePropertiesSupportedScopesForSourceItem const type.

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 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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/TopicTypes_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicTypesClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"Microsoft.Storage.StorageAccounts",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*TopicTypesClient) NewListEventTypesPager added in v0.5.0 

func (client *TopicTypesClient) NewListEventTypesPager(topicTypeName string, options *TopicTypesClientListEventTypesOptions) *runtime.Pager[TopicTypesClientListEventTypesResponse]

NewListEventTypesPager - List event types for a topic type. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 topicTypeName - Name of the topic type. options - TopicTypesClientListEventTypesOptions contains the optional parameters for the TopicTypesClient.ListEventTypes method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/TopicTypes_ListEventTypes.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicTypesClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListEventTypesPager("Microsoft.Storage.StorageAccounts",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*TopicTypesClient) NewListPager added in v0.5.0 

func (client *TopicTypesClient) NewListPager(options *TopicTypesClientListOptions) *runtime.Pager[TopicTypesClientListResponse]

NewListPager - List all registered topic types. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 options - TopicTypesClientListOptions contains the optional parameters for the TopicTypesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/TopicTypes_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicTypesClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type TopicTypesClientGetOptions added in v0.3.0 

type TopicTypesClientGetOptions struct {
}

TopicTypesClientGetOptions contains the optional parameters for the TopicTypesClient.Get method.

type TopicTypesClientGetResponse added in v0.3.0 

type TopicTypesClientGetResponse struct {
	TopicTypeInfo
}

TopicTypesClientGetResponse contains the response from method TopicTypesClient.Get.

type TopicTypesClientListEventTypesOptions added in v0.3.0 

type TopicTypesClientListEventTypesOptions struct {
}

TopicTypesClientListEventTypesOptions contains the optional parameters for the TopicTypesClient.ListEventTypes method.

type TopicTypesClientListEventTypesResponse added in v0.3.0 

type TopicTypesClientListEventTypesResponse struct {
	EventTypesListResult
}

TopicTypesClientListEventTypesResponse contains the response from method TopicTypesClient.ListEventTypes.

type TopicTypesClientListOptions added in v0.3.0 

type TopicTypesClientListOptions struct {
}

TopicTypesClientListOptions contains the optional parameters for the TopicTypesClient.List method.

type TopicTypesClientListResponse added in v0.3.0 

type TopicTypesClientListResponse struct {
	TopicTypesListResult
}

TopicTypesClientListResponse contains the response from method TopicTypesClient.List.

type TopicTypesListResult 

type TopicTypesListResult struct {
	// A collection of topic types
	Value []*TopicTypeInfo `json:"value,omitempty"`
}

TopicTypesListResult - Result of the List Topic Types operation

type TopicUpdateParameterProperties 

type TopicUpdateParameterProperties 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 topic.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// 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 `json:"inboundIpRules,omitempty"`

	// 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 `json:"publicNetworkAccess,omitempty"`
}

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.

type TopicUpdateParameters 

type TopicUpdateParameters struct {
	// Topic resource identity information.
	Identity *IdentityInfo `json:"identity,omitempty"`

	// Properties of the resource.
	Properties *TopicUpdateParameterProperties `json:"properties,omitempty"`

	// Tags of the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

TopicUpdateParameters - Properties of the Topic update

func (TopicUpdateParameters) MarshalJSON 

func (t TopicUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller 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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Topics_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Topics_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Topics_RegenerateKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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)
	}
	// TODO: use response item
	_ = res
}

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Topics_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Topics_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"examplerg",
		"exampletopic2",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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 2021-12-01 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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Topics_ListSharedAccessKeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListSharedAccessKeys(ctx,
		"examplerg",
		"exampletopic2",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*TopicsClient) NewListByResourceGroupPager added in v0.5.0 

func (client *TopicsClient) NewListByResourceGroupPager(resourceGroupName string, options *TopicsClientListByResourceGroupOptions) *runtime.Pager[TopicsClientListByResourceGroupResponse]

NewListByResourceGroupPager - List all the topics under a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 resourceGroupName - The name of the resource group within the user's subscription. options - TopicsClientListByResourceGroupOptions contains the optional parameters for the TopicsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Topics_ListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("examplerg",
		&armeventgrid.TopicsClientListByResourceGroupOptions{Filter: nil,
			Top: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*TopicsClient) NewListBySubscriptionPager added in v0.5.0 

func (client *TopicsClient) NewListBySubscriptionPager(options *TopicsClientListBySubscriptionOptions) *runtime.Pager[TopicsClientListBySubscriptionResponse]

NewListBySubscriptionPager - List all the topics under an Azure subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 options - TopicsClientListBySubscriptionOptions contains the optional parameters for the TopicsClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Topics_ListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(&armeventgrid.TopicsClientListBySubscriptionOptions{Filter: nil,
		Top: nil,
	})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*TopicsClient) NewListEventTypesPager added in v0.5.0 

func (client *TopicsClient) NewListEventTypesPager(resourceGroupName string, providerNamespace string, resourceTypeName string, resourceName string, options *TopicsClientListEventTypesOptions) *runtime.Pager[TopicsClientListEventTypesResponse]

NewListEventTypesPager - List event types for a topic. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-12-01 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.ListEventTypes method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2021-12-01/examples/Topics_ListEventTypes.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewTopicsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListEventTypesPager("examplerg",
		"Microsoft.Storage",
		"storageAccounts",
		"ExampleStorageAccount",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type TopicsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

TopicsClientBeginCreateOrUpdateOptions contains the optional parameters for the TopicsClient.BeginCreateOrUpdate method.

type TopicsClientBeginDeleteOptions added in v0.3.0 

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

TopicsClientBeginDeleteOptions contains the optional parameters for the TopicsClient.BeginDelete method.

type TopicsClientBeginRegenerateKeyOptions added in v0.3.0 

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

TopicsClientBeginRegenerateKeyOptions contains the optional parameters for the TopicsClient.BeginRegenerateKey method.

type TopicsClientBeginUpdateOptions added in v0.3.0 

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

TopicsClientBeginUpdateOptions contains the optional parameters for the TopicsClient.BeginUpdate method.

type TopicsClientCreateOrUpdateResponse added in v0.3.0 

type TopicsClientCreateOrUpdateResponse struct {
	Topic
}

TopicsClientCreateOrUpdateResponse contains the response from method TopicsClient.CreateOrUpdate.

type TopicsClientDeleteResponse added in v0.3.0 

type TopicsClientDeleteResponse struct {
}

TopicsClientDeleteResponse contains the response from method TopicsClient.Delete.

type TopicsClientGetOptions added in v0.3.0 

type TopicsClientGetOptions struct {
}

TopicsClientGetOptions contains the optional parameters for the TopicsClient.Get method.

type TopicsClientGetResponse added in v0.3.0 

type TopicsClientGetResponse struct {
	Topic
}

TopicsClientGetResponse contains the response from method TopicsClient.Get.

type TopicsClientListByResourceGroupOptions added in v0.3.0 

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.ListByResourceGroup method.

type TopicsClientListByResourceGroupResponse added in v0.3.0 

type TopicsClientListByResourceGroupResponse struct {
	TopicsListResult
}

TopicsClientListByResourceGroupResponse contains the response from method TopicsClient.ListByResourceGroup.

type TopicsClientListBySubscriptionOptions added in v0.3.0 

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.ListBySubscription method.

type TopicsClientListBySubscriptionResponse added in v0.3.0 

type TopicsClientListBySubscriptionResponse struct {
	TopicsListResult
}

TopicsClientListBySubscriptionResponse contains the response from method TopicsClient.ListBySubscription.

type TopicsClientListEventTypesOptions added in v0.3.0 

type TopicsClientListEventTypesOptions struct {
}

TopicsClientListEventTypesOptions contains the optional parameters for the TopicsClient.ListEventTypes method.

type TopicsClientListEventTypesResponse added in v0.3.0 

type TopicsClientListEventTypesResponse struct {
	EventTypesListResult
}

TopicsClientListEventTypesResponse contains the response from method TopicsClient.ListEventTypes.

type TopicsClientListSharedAccessKeysOptions added in v0.3.0 

type TopicsClientListSharedAccessKeysOptions struct {
}

TopicsClientListSharedAccessKeysOptions contains the optional parameters for the TopicsClient.ListSharedAccessKeys method.

type TopicsClientListSharedAccessKeysResponse added in v0.3.0 

type TopicsClientListSharedAccessKeysResponse struct {
	TopicSharedAccessKeys
}

TopicsClientListSharedAccessKeysResponse contains the response from method TopicsClient.ListSharedAccessKeys.

type TopicsClientRegenerateKeyResponse added in v0.3.0 

type TopicsClientRegenerateKeyResponse struct {
	TopicSharedAccessKeys
}

TopicsClientRegenerateKeyResponse contains the response from method TopicsClient.RegenerateKey.

type TopicsClientUpdateResponse added in v0.3.0 

type TopicsClientUpdateResponse struct {
	Topic
}

TopicsClientUpdateResponse contains the response from method TopicsClient.Update.

type TopicsListResult 

type TopicsListResult struct {
	// A link for the next page of topics
	NextLink *string `json:"nextLink,omitempty"`

	// A collection of Topics
	Value []*Topic `json:"value,omitempty"`
}

TopicsListResult - Result of the List Topics operation

type TrackedResource 

type TrackedResource struct {
	// REQUIRED; Location of the resource.
	Location *string `json:"location,omitempty"`

	// Tags of the resource.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified identifier of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

TrackedResource - Definition of a Tracked Resource.

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

type UserIdentityProperties 

type UserIdentityProperties struct {
	// The client id of user assigned identity.
	ClientID *string `json:"clientId,omitempty"`

	// The principal id of user assigned identity.
	PrincipalID *string `json:"principalId,omitempty"`
}

UserIdentityProperties - The information about the user identity.

type WebHookEventSubscriptionDestination 

type WebHookEventSubscriptionDestination struct {
	// REQUIRED; Type of the endpoint for the event subscription destination.
	EndpointType *EndpointType `json:"endpointType,omitempty"`

	// WebHook Properties of the event subscription destination.
	Properties *WebHookEventSubscriptionDestinationProperties `json:"properties,omitempty"`
}

WebHookEventSubscriptionDestination - Information about the webhook destination for an event subscription.

func (*WebHookEventSubscriptionDestination) GetEventSubscriptionDestination added in v0.3.0 

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 `json:"azureActiveDirectoryApplicationIdOrUri,omitempty"`

	// The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
	AzureActiveDirectoryTenantID *string `json:"azureActiveDirectoryTenantId,omitempty"`

	// Delivery attribute details.
	DeliveryAttributeMappings []DeliveryAttributeMappingClassification `json:"deliveryAttributeMappings,omitempty"`

	// The URL that represents the endpoint of the destination of an event subscription.
	EndpointURL *string `json:"endpointUrl,omitempty"`

	// Maximum number of events per batch.
	MaxEventsPerBatch *int32 `json:"maxEventsPerBatch,omitempty"`

	// Preferred batch size in Kilobytes.
	PreferredBatchSizeInKilobytes *int32 `json:"preferredBatchSizeInKilobytes,omitempty"`

	// READ-ONLY; The base URL that represents the endpoint of the destination of an event subscription.
	EndpointBaseURL *string `json:"endpointBaseUrl,omitempty" azure:"ro"`
}

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

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.