eventgrid

package
v10.3.1-beta+incompatible Latest Latest
Warning

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

Go to latest
Published: Sep 6, 2017 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package eventgrid implements the Azure ARM Eventgrid service API version 2017-06-15-preview.

Azure EventGrid Management Client

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Eventgrid
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type EndpointType

type EndpointType string

EndpointType enumerates the values for endpoint type.

const (
	// WebHook specifies the web hook state for endpoint type.
	WebHook EndpointType = "WebHook"
)

type EventSubscription

type EventSubscription struct {
	autorest.Response            `json:"-"`
	ID                           *string `json:"id,omitempty"`
	Name                         *string `json:"name,omitempty"`
	Type                         *string `json:"type,omitempty"`
	*EventSubscriptionProperties `json:"properties,omitempty"`
}

EventSubscription is event Subscription

type EventSubscriptionDestination

type EventSubscriptionDestination struct {
	EndpointType                            EndpointType `json:"endpointType,omitempty"`
	*EventSubscriptionDestinationProperties `json:"properties,omitempty"`
}

EventSubscriptionDestination is information about the destination for an event subscription

type EventSubscriptionDestinationProperties

type EventSubscriptionDestinationProperties struct {
	EndpointURL     *string `json:"endpointUrl,omitempty"`
	EndpointBaseURL *string `json:"endpointBaseUrl,omitempty"`
}

EventSubscriptionDestinationProperties is properties of the event subscription destination

type EventSubscriptionFilter

type EventSubscriptionFilter struct {
	SubjectBeginsWith      *string   `json:"subjectBeginsWith,omitempty"`
	SubjectEndsWith        *string   `json:"subjectEndsWith,omitempty"`
	IncludedEventTypes     *[]string `json:"includedEventTypes,omitempty"`
	IsSubjectCaseSensitive *bool     `json:"isSubjectCaseSensitive,omitempty"`
}

EventSubscriptionFilter is filter for the Event Subscription

type EventSubscriptionFullURL

type EventSubscriptionFullURL struct {
	autorest.Response `json:"-"`
	EndpointURL       *string `json:"endpointUrl,omitempty"`
}

EventSubscriptionFullURL is full endpoint url of an event subscription

type EventSubscriptionProperties

type EventSubscriptionProperties struct {
	Topic             *string                            `json:"topic,omitempty"`
	ProvisioningState EventSubscriptionProvisioningState `json:"provisioningState,omitempty"`
	Destination       *EventSubscriptionDestination      `json:"destination,omitempty"`
	Filter            *EventSubscriptionFilter           `json:"filter,omitempty"`
	Labels            *[]string                          `json:"labels,omitempty"`
}

EventSubscriptionProperties is properties of the Event Subscription

type EventSubscriptionProvisioningState

type EventSubscriptionProvisioningState string

EventSubscriptionProvisioningState enumerates the values for event subscription provisioning state.

const (
	// Canceled specifies the canceled state for event subscription provisioning state.
	Canceled EventSubscriptionProvisioningState = "Canceled"
	// Creating specifies the creating state for event subscription provisioning state.
	Creating EventSubscriptionProvisioningState = "Creating"
	// Deleting specifies the deleting state for event subscription provisioning state.
	Deleting EventSubscriptionProvisioningState = "Deleting"
	// Failed specifies the failed state for event subscription provisioning state.
	Failed EventSubscriptionProvisioningState = "Failed"
	// Succeeded specifies the succeeded state for event subscription provisioning state.
	Succeeded EventSubscriptionProvisioningState = "Succeeded"
	// Updating specifies the updating state for event subscription provisioning state.
	Updating EventSubscriptionProvisioningState = "Updating"
)

type EventSubscriptionUpdateParameters

type EventSubscriptionUpdateParameters struct {
	Destination *EventSubscriptionDestination `json:"destination,omitempty"`
	Filter      *EventSubscriptionFilter      `json:"filter,omitempty"`
	Labels      *[]string                     `json:"labels,omitempty"`
}

EventSubscriptionUpdateParameters is properties of the Event Subscription update

type EventSubscriptionsClient

type EventSubscriptionsClient struct {
	ManagementClient
}

EventSubscriptionsClient is the azure EventGrid Management Client

func NewEventSubscriptionsClient

func NewEventSubscriptionsClient(subscriptionID string) EventSubscriptionsClient

NewEventSubscriptionsClient creates an instance of the EventSubscriptionsClient client.

func NewEventSubscriptionsClientWithBaseURI

func NewEventSubscriptionsClientWithBaseURI(baseURI string, subscriptionID string) EventSubscriptionsClient

NewEventSubscriptionsClientWithBaseURI creates an instance of the EventSubscriptionsClient client.

func (EventSubscriptionsClient) Create

func (client EventSubscriptionsClient) Create(scope string, eventSubscriptionName string, eventSubscriptionInfo EventSubscription, cancel <-chan struct{}) (<-chan EventSubscription, <-chan error)

Create asynchronously creates a new event subscription to the specified scope. Existing event subscriptions cannot be updated with this API and should instead use the Update event subscription API. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

scope is the scope of the resource to which the event subscription needs to be created. 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 is name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only. eventSubscriptionInfo is event subscription properties containing the destination and filter information

func (EventSubscriptionsClient) CreatePreparer

func (client EventSubscriptionsClient) CreatePreparer(scope string, eventSubscriptionName string, eventSubscriptionInfo EventSubscription, cancel <-chan struct{}) (*http.Request, error)

CreatePreparer prepares the Create request.

func (EventSubscriptionsClient) CreateResponder

func (client EventSubscriptionsClient) CreateResponder(resp *http.Response) (result EventSubscription, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) CreateSender

func (client EventSubscriptionsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) Delete

func (client EventSubscriptionsClient) Delete(scope string, eventSubscriptionName string, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)

Delete delete an existing event subscription This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

scope is 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 is name of the event subscription

func (EventSubscriptionsClient) DeletePreparer

func (client EventSubscriptionsClient) DeletePreparer(scope string, eventSubscriptionName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (EventSubscriptionsClient) DeleteResponder

func (client EventSubscriptionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) DeleteSender

func (client EventSubscriptionsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) Get

func (client EventSubscriptionsClient) Get(scope string, eventSubscriptionName string) (result EventSubscription, err error)

Get get properties of an event subscription

scope is 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 is name of the event subscription

func (EventSubscriptionsClient) GetFullURL

func (client EventSubscriptionsClient) GetFullURL(scope string, eventSubscriptionName string) (result EventSubscriptionFullURL, err error)

GetFullURL get the full endpoint URL for an event subscription

scope is 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 is name of the event subscription

func (EventSubscriptionsClient) GetFullURLPreparer

func (client EventSubscriptionsClient) GetFullURLPreparer(scope string, eventSubscriptionName string) (*http.Request, error)

GetFullURLPreparer prepares the GetFullURL request.

func (EventSubscriptionsClient) GetFullURLResponder

func (client EventSubscriptionsClient) GetFullURLResponder(resp *http.Response) (result EventSubscriptionFullURL, err error)

GetFullURLResponder handles the response to the GetFullURL request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) GetFullURLSender

func (client EventSubscriptionsClient) GetFullURLSender(req *http.Request) (*http.Response, error)

GetFullURLSender sends the GetFullURL request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) GetPreparer

func (client EventSubscriptionsClient) GetPreparer(scope string, eventSubscriptionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (EventSubscriptionsClient) GetResponder

func (client EventSubscriptionsClient) GetResponder(resp *http.Response) (result EventSubscription, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) GetSender

func (client EventSubscriptionsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) ListByResource

func (client EventSubscriptionsClient) ListByResource(resourceGroupName string, providerNamespace string, resourceTypeName string, resourceName string) (result EventSubscriptionsListResult, err error)

ListByResource list all event subscriptions that have been created for a specific topic

resourceGroupName is the name of the resource group within the user's subscription. providerNamespace is namespace of the provider of the topic resourceTypeName is name of the resource type resourceName is name of the resource

func (EventSubscriptionsClient) ListByResourcePreparer

func (client EventSubscriptionsClient) ListByResourcePreparer(resourceGroupName string, providerNamespace string, resourceTypeName string, resourceName string) (*http.Request, error)

ListByResourcePreparer prepares the ListByResource request.

func (EventSubscriptionsClient) ListByResourceResponder

func (client EventSubscriptionsClient) ListByResourceResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)

ListByResourceResponder handles the response to the ListByResource request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) ListByResourceSender

func (client EventSubscriptionsClient) ListByResourceSender(req *http.Request) (*http.Response, error)

ListByResourceSender sends the ListByResource request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) ListGlobalByResourceGroup

func (client EventSubscriptionsClient) ListGlobalByResourceGroup(resourceGroupName string) (result EventSubscriptionsListResult, err error)

ListGlobalByResourceGroup list all global event subscriptions under a specific Azure subscription and resource group

resourceGroupName is the name of the resource group within the user's subscription.

func (EventSubscriptionsClient) ListGlobalByResourceGroupForTopicType

func (client EventSubscriptionsClient) ListGlobalByResourceGroupForTopicType(resourceGroupName string, topicTypeName string) (result EventSubscriptionsListResult, err error)

ListGlobalByResourceGroupForTopicType list all global event subscriptions under a resource group for a specific topic type.

resourceGroupName is the name of the resource group within the user's subscription. topicTypeName is name of the topic type

func (EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypePreparer

func (client EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypePreparer(resourceGroupName string, topicTypeName string) (*http.Request, error)

ListGlobalByResourceGroupForTopicTypePreparer prepares the ListGlobalByResourceGroupForTopicType request.

func (EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypeResponder

func (client EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypeResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)

ListGlobalByResourceGroupForTopicTypeResponder handles the response to the ListGlobalByResourceGroupForTopicType request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypeSender

func (client EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypeSender(req *http.Request) (*http.Response, error)

ListGlobalByResourceGroupForTopicTypeSender sends the ListGlobalByResourceGroupForTopicType request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) ListGlobalByResourceGroupPreparer

func (client EventSubscriptionsClient) ListGlobalByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)

ListGlobalByResourceGroupPreparer prepares the ListGlobalByResourceGroup request.

func (EventSubscriptionsClient) ListGlobalByResourceGroupResponder

func (client EventSubscriptionsClient) ListGlobalByResourceGroupResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)

ListGlobalByResourceGroupResponder handles the response to the ListGlobalByResourceGroup request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) ListGlobalByResourceGroupSender

func (client EventSubscriptionsClient) ListGlobalByResourceGroupSender(req *http.Request) (*http.Response, error)

ListGlobalByResourceGroupSender sends the ListGlobalByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) ListGlobalBySubscription

func (client EventSubscriptionsClient) ListGlobalBySubscription() (result EventSubscriptionsListResult, err error)

ListGlobalBySubscription list all aggregated global event subscriptions under a specific Azure subscription

func (EventSubscriptionsClient) ListGlobalBySubscriptionForTopicType

func (client EventSubscriptionsClient) ListGlobalBySubscriptionForTopicType(topicTypeName string) (result EventSubscriptionsListResult, err error)

ListGlobalBySubscriptionForTopicType list all global event subscriptions under an Azure subscription for a topic type.

topicTypeName is name of the topic type

func (EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypePreparer

func (client EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypePreparer(topicTypeName string) (*http.Request, error)

ListGlobalBySubscriptionForTopicTypePreparer prepares the ListGlobalBySubscriptionForTopicType request.

func (EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypeResponder

func (client EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypeResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)

ListGlobalBySubscriptionForTopicTypeResponder handles the response to the ListGlobalBySubscriptionForTopicType request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypeSender

func (client EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypeSender(req *http.Request) (*http.Response, error)

ListGlobalBySubscriptionForTopicTypeSender sends the ListGlobalBySubscriptionForTopicType request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) ListGlobalBySubscriptionPreparer

func (client EventSubscriptionsClient) ListGlobalBySubscriptionPreparer() (*http.Request, error)

ListGlobalBySubscriptionPreparer prepares the ListGlobalBySubscription request.

func (EventSubscriptionsClient) ListGlobalBySubscriptionResponder

func (client EventSubscriptionsClient) ListGlobalBySubscriptionResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)

ListGlobalBySubscriptionResponder handles the response to the ListGlobalBySubscription request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) ListGlobalBySubscriptionSender

func (client EventSubscriptionsClient) ListGlobalBySubscriptionSender(req *http.Request) (*http.Response, error)

ListGlobalBySubscriptionSender sends the ListGlobalBySubscription request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) ListRegionalByResourceGroup

func (client EventSubscriptionsClient) ListRegionalByResourceGroup(resourceGroupName string, location string) (result EventSubscriptionsListResult, err error)

ListRegionalByResourceGroup list all event subscriptions from the given location under a specific Azure subscription and resource group

resourceGroupName is the name of the resource group within the user's subscription. location is name of the location

func (EventSubscriptionsClient) ListRegionalByResourceGroupForTopicType

func (client EventSubscriptionsClient) ListRegionalByResourceGroupForTopicType(resourceGroupName string, location string, topicTypeName string) (result EventSubscriptionsListResult, err error)

ListRegionalByResourceGroupForTopicType list all event subscriptions from the given location under a specific Azure subscription and resource group and topic type

resourceGroupName is the name of the resource group within the user's subscription. location is name of the location topicTypeName is name of the topic type

func (EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypePreparer

func (client EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypePreparer(resourceGroupName string, location string, topicTypeName string) (*http.Request, error)

ListRegionalByResourceGroupForTopicTypePreparer prepares the ListRegionalByResourceGroupForTopicType request.

func (EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypeResponder

func (client EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypeResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)

ListRegionalByResourceGroupForTopicTypeResponder handles the response to the ListRegionalByResourceGroupForTopicType request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypeSender

func (client EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypeSender(req *http.Request) (*http.Response, error)

ListRegionalByResourceGroupForTopicTypeSender sends the ListRegionalByResourceGroupForTopicType request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) ListRegionalByResourceGroupPreparer

func (client EventSubscriptionsClient) ListRegionalByResourceGroupPreparer(resourceGroupName string, location string) (*http.Request, error)

ListRegionalByResourceGroupPreparer prepares the ListRegionalByResourceGroup request.

func (EventSubscriptionsClient) ListRegionalByResourceGroupResponder

func (client EventSubscriptionsClient) ListRegionalByResourceGroupResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)

ListRegionalByResourceGroupResponder handles the response to the ListRegionalByResourceGroup request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) ListRegionalByResourceGroupSender

func (client EventSubscriptionsClient) ListRegionalByResourceGroupSender(req *http.Request) (*http.Response, error)

ListRegionalByResourceGroupSender sends the ListRegionalByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) ListRegionalBySubscription

func (client EventSubscriptionsClient) ListRegionalBySubscription(location string) (result EventSubscriptionsListResult, err error)

ListRegionalBySubscription list all event subscriptions from the given location under a specific Azure subscription

location is name of the location

func (EventSubscriptionsClient) ListRegionalBySubscriptionForTopicType

func (client EventSubscriptionsClient) ListRegionalBySubscriptionForTopicType(location string, topicTypeName string) (result EventSubscriptionsListResult, err error)

ListRegionalBySubscriptionForTopicType list all event subscriptions from the given location under a specific Azure subscription and topic type.

location is name of the location topicTypeName is name of the topic type

func (EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypePreparer

func (client EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypePreparer(location string, topicTypeName string) (*http.Request, error)

ListRegionalBySubscriptionForTopicTypePreparer prepares the ListRegionalBySubscriptionForTopicType request.

func (EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypeResponder

func (client EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypeResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)

ListRegionalBySubscriptionForTopicTypeResponder handles the response to the ListRegionalBySubscriptionForTopicType request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypeSender

func (client EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypeSender(req *http.Request) (*http.Response, error)

ListRegionalBySubscriptionForTopicTypeSender sends the ListRegionalBySubscriptionForTopicType request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) ListRegionalBySubscriptionPreparer

func (client EventSubscriptionsClient) ListRegionalBySubscriptionPreparer(location string) (*http.Request, error)

ListRegionalBySubscriptionPreparer prepares the ListRegionalBySubscription request.

func (EventSubscriptionsClient) ListRegionalBySubscriptionResponder

func (client EventSubscriptionsClient) ListRegionalBySubscriptionResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)

ListRegionalBySubscriptionResponder handles the response to the ListRegionalBySubscription request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) ListRegionalBySubscriptionSender

func (client EventSubscriptionsClient) ListRegionalBySubscriptionSender(req *http.Request) (*http.Response, error)

ListRegionalBySubscriptionSender sends the ListRegionalBySubscription request. The method will close the http.Response Body if it receives an error.

func (EventSubscriptionsClient) Update

func (client EventSubscriptionsClient) Update(scope string, eventSubscriptionName string, eventSubscriptionUpdateParameters EventSubscriptionUpdateParameters, cancel <-chan struct{}) (<-chan EventSubscription, <-chan error)

Update asynchronously updates an existing event subscription. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

scope is 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 is name of the event subscription to be created eventSubscriptionUpdateParameters is updated event subscription information

func (EventSubscriptionsClient) UpdatePreparer

func (client EventSubscriptionsClient) UpdatePreparer(scope string, eventSubscriptionName string, eventSubscriptionUpdateParameters EventSubscriptionUpdateParameters, cancel <-chan struct{}) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (EventSubscriptionsClient) UpdateResponder

func (client EventSubscriptionsClient) UpdateResponder(resp *http.Response) (result EventSubscription, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (EventSubscriptionsClient) UpdateSender

func (client EventSubscriptionsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type EventSubscriptionsListResult

type EventSubscriptionsListResult struct {
	autorest.Response `json:"-"`
	Value             *[]EventSubscription `json:"value,omitempty"`
}

EventSubscriptionsListResult is result of the List EventSubscriptions operation

type EventType

type EventType struct {
	ID                   *string `json:"id,omitempty"`
	Name                 *string `json:"name,omitempty"`
	Type                 *string `json:"type,omitempty"`
	*EventTypeProperties `json:"properties,omitempty"`
}

EventType is event Type for a subject under a topic

type EventTypeProperties

type EventTypeProperties struct {
	DisplayName *string `json:"displayName,omitempty"`
	Description *string `json:"description,omitempty"`
	SchemaURL   *string `json:"schemaUrl,omitempty"`
}

EventTypeProperties is properties of the event type

type EventTypesListResult

type EventTypesListResult struct {
	autorest.Response `json:"-"`
	Value             *[]EventType `json:"value,omitempty"`
}

EventTypesListResult is result of the List Event Types operation

type ManagementClient

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

ManagementClient is the base client for Eventgrid.

func New

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type Operation

type Operation struct {
	Name       *string                 `json:"name,omitempty"`
	Display    *OperationInfo          `json:"display,omitempty"`
	Origin     OperationOrigin         `json:"origin,omitempty"`
	Properties *map[string]interface{} `json:"properties,omitempty"`
}

Operation is represents an operation returned by the GetOperations request

type OperationInfo

type OperationInfo struct {
	Provider    *string `json:"provider,omitempty"`
	Resource    *string `json:"resource,omitempty"`
	Operation   *string `json:"operation,omitempty"`
	Description *string `json:"description,omitempty"`
}

OperationInfo is information about an operation

type OperationOrigin

type OperationOrigin string

OperationOrigin enumerates the values for operation origin.

const (
	// System specifies the system state for operation origin.
	System OperationOrigin = "System"
	// User specifies the user state for operation origin.
	User OperationOrigin = "User"
	// UserAndSystem specifies the user and system state for operation origin.
	UserAndSystem OperationOrigin = "UserAndSystem"
)

type OperationsClient

type OperationsClient struct {
	ManagementClient
}

OperationsClient is the azure EventGrid Management Client

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List

func (client OperationsClient) List() (result OperationsListResult, err error)

List list the available operations supported by the Microsoft.EventGrid resource provider

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationsListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type OperationsListResult

type OperationsListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Operation `json:"value,omitempty"`
}

OperationsListResult is result of the List Operations operation

type Resource

type Resource struct {
	ID   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

Resource is definition of a Resource

type ResourceRegionType

type ResourceRegionType string

ResourceRegionType enumerates the values for resource region type.

const (
	// GlobalResource specifies the global resource state for resource region type.
	GlobalResource ResourceRegionType = "GlobalResource"
	// RegionalResource specifies the regional resource state for resource region type.
	RegionalResource ResourceRegionType = "RegionalResource"
)

type Topic

type Topic struct {
	autorest.Response `json:"-"`
	ID                *string             `json:"id,omitempty"`
	Name              *string             `json:"name,omitempty"`
	Type              *string             `json:"type,omitempty"`
	Location          *string             `json:"location,omitempty"`
	Tags              *map[string]*string `json:"tags,omitempty"`
	*TopicProperties  `json:"properties,omitempty"`
}

Topic is eventGrid Topic

type TopicProperties

type TopicProperties struct {
	ProvisioningState TopicProvisioningState `json:"provisioningState,omitempty"`
	Endpoint          *string                `json:"endpoint,omitempty"`
}

TopicProperties is properties of the Topic

type TopicProvisioningState

type TopicProvisioningState string

TopicProvisioningState enumerates the values for topic provisioning state.

const (
	// TopicProvisioningStateCanceled specifies the topic provisioning state canceled state for topic provisioning
	// state.
	TopicProvisioningStateCanceled TopicProvisioningState = "Canceled"
	// TopicProvisioningStateCreating specifies the topic provisioning state creating state for topic provisioning
	// state.
	TopicProvisioningStateCreating TopicProvisioningState = "Creating"
	// TopicProvisioningStateDeleting specifies the topic provisioning state deleting state for topic provisioning
	// state.
	TopicProvisioningStateDeleting TopicProvisioningState = "Deleting"
	// TopicProvisioningStateFailed specifies the topic provisioning state failed state for topic provisioning state.
	TopicProvisioningStateFailed TopicProvisioningState = "Failed"
	// TopicProvisioningStateSucceeded specifies the topic provisioning state succeeded state for topic provisioning
	// state.
	TopicProvisioningStateSucceeded TopicProvisioningState = "Succeeded"
	// TopicProvisioningStateUpdating specifies the topic provisioning state updating state for topic provisioning
	// state.
	TopicProvisioningStateUpdating TopicProvisioningState = "Updating"
)

type TopicRegenerateKeyRequest

type TopicRegenerateKeyRequest struct {
	KeyName *string `json:"keyName,omitempty"`
}

TopicRegenerateKeyRequest is topic regenerate share access key key request

type TopicSharedAccessKeys

type TopicSharedAccessKeys struct {
	autorest.Response `json:"-"`
	Key1              *string `json:"key1,omitempty"`
	Key2              *string `json:"key2,omitempty"`
}

TopicSharedAccessKeys is shared access keys of the Topic

type TopicTypeInfo

type TopicTypeInfo struct {
	autorest.Response    `json:"-"`
	ID                   *string `json:"id,omitempty"`
	Name                 *string `json:"name,omitempty"`
	Type                 *string `json:"type,omitempty"`
	*TopicTypeProperties `json:"properties,omitempty"`
}

TopicTypeInfo is properties of a topic type info.

type TopicTypeProperties

type TopicTypeProperties struct {
	Provider           *string                    `json:"provider,omitempty"`
	DisplayName        *string                    `json:"displayName,omitempty"`
	Description        *string                    `json:"description,omitempty"`
	ResourceRegionType ResourceRegionType         `json:"resourceRegionType,omitempty"`
	ProvisioningState  TopicTypeProvisioningState `json:"provisioningState,omitempty"`
}

TopicTypeProperties is properties of a topic type.

type TopicTypeProvisioningState

type TopicTypeProvisioningState string

TopicTypeProvisioningState enumerates the values for topic type provisioning state.

const (
	// TopicTypeProvisioningStateCanceled specifies the topic type provisioning state canceled state for topic type
	// provisioning state.
	TopicTypeProvisioningStateCanceled TopicTypeProvisioningState = "Canceled"
	// TopicTypeProvisioningStateCreating specifies the topic type provisioning state creating state for topic type
	// provisioning state.
	TopicTypeProvisioningStateCreating TopicTypeProvisioningState = "Creating"
	// TopicTypeProvisioningStateDeleting specifies the topic type provisioning state deleting state for topic type
	// provisioning state.
	TopicTypeProvisioningStateDeleting TopicTypeProvisioningState = "Deleting"
	// TopicTypeProvisioningStateFailed specifies the topic type provisioning state failed state for topic type
	// provisioning state.
	TopicTypeProvisioningStateFailed TopicTypeProvisioningState = "Failed"
	// TopicTypeProvisioningStateSucceeded specifies the topic type provisioning state succeeded state for topic type
	// provisioning state.
	TopicTypeProvisioningStateSucceeded TopicTypeProvisioningState = "Succeeded"
	// TopicTypeProvisioningStateUpdating specifies the topic type provisioning state updating state for topic type
	// provisioning state.
	TopicTypeProvisioningStateUpdating TopicTypeProvisioningState = "Updating"
)

type TopicTypesClient

type TopicTypesClient struct {
	ManagementClient
}

TopicTypesClient is the azure EventGrid Management Client

func NewTopicTypesClient

func NewTopicTypesClient(subscriptionID string) TopicTypesClient

NewTopicTypesClient creates an instance of the TopicTypesClient client.

func NewTopicTypesClientWithBaseURI

func NewTopicTypesClientWithBaseURI(baseURI string, subscriptionID string) TopicTypesClient

NewTopicTypesClientWithBaseURI creates an instance of the TopicTypesClient client.

func (TopicTypesClient) Get

func (client TopicTypesClient) Get(topicTypeName string) (result TopicTypeInfo, err error)

Get get information about a topic type

topicTypeName is name of the topic type

func (TopicTypesClient) GetPreparer

func (client TopicTypesClient) GetPreparer(topicTypeName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TopicTypesClient) GetResponder

func (client TopicTypesClient) GetResponder(resp *http.Response) (result TopicTypeInfo, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (TopicTypesClient) GetSender

func (client TopicTypesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (TopicTypesClient) List

func (client TopicTypesClient) List() (result TopicTypesListResult, err error)

List list all registered topic types

func (TopicTypesClient) ListEventTypes

func (client TopicTypesClient) ListEventTypes(topicTypeName string) (result EventTypesListResult, err error)

ListEventTypes list event types for a topic type

topicTypeName is name of the topic type

func (TopicTypesClient) ListEventTypesPreparer

func (client TopicTypesClient) ListEventTypesPreparer(topicTypeName string) (*http.Request, error)

ListEventTypesPreparer prepares the ListEventTypes request.

func (TopicTypesClient) ListEventTypesResponder

func (client TopicTypesClient) ListEventTypesResponder(resp *http.Response) (result EventTypesListResult, err error)

ListEventTypesResponder handles the response to the ListEventTypes request. The method always closes the http.Response Body.

func (TopicTypesClient) ListEventTypesSender

func (client TopicTypesClient) ListEventTypesSender(req *http.Request) (*http.Response, error)

ListEventTypesSender sends the ListEventTypes request. The method will close the http.Response Body if it receives an error.

func (TopicTypesClient) ListPreparer

func (client TopicTypesClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (TopicTypesClient) ListResponder

func (client TopicTypesClient) ListResponder(resp *http.Response) (result TopicTypesListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (TopicTypesClient) ListSender

func (client TopicTypesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type TopicTypesListResult

type TopicTypesListResult struct {
	autorest.Response `json:"-"`
	Value             *[]TopicTypeInfo `json:"value,omitempty"`
}

TopicTypesListResult is result of the List Topic Types operation

type TopicsClient

type TopicsClient struct {
	ManagementClient
}

TopicsClient is the azure EventGrid Management Client

func NewTopicsClient

func NewTopicsClient(subscriptionID string) TopicsClient

NewTopicsClient creates an instance of the TopicsClient client.

func NewTopicsClientWithBaseURI

func NewTopicsClientWithBaseURI(baseURI string, subscriptionID string) TopicsClient

NewTopicsClientWithBaseURI creates an instance of the TopicsClient client.

func (TopicsClient) CreateOrUpdate

func (client TopicsClient) CreateOrUpdate(resourceGroupName string, topicName string, topicInfo Topic, cancel <-chan struct{}) (<-chan Topic, <-chan error)

CreateOrUpdate asynchronously creates a new topic with the specified parameters. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group within the user's subscription. topicName is name of the topic topicInfo is topic information

func (TopicsClient) CreateOrUpdatePreparer

func (client TopicsClient) CreateOrUpdatePreparer(resourceGroupName string, topicName string, topicInfo Topic, cancel <-chan struct{}) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (TopicsClient) CreateOrUpdateResponder

func (client TopicsClient) CreateOrUpdateResponder(resp *http.Response) (result Topic, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (TopicsClient) CreateOrUpdateSender

func (client TopicsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (TopicsClient) Delete

func (client TopicsClient) Delete(resourceGroupName string, topicName string, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)

Delete delete existing topic This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group within the user's subscription. topicName is name of the topic

func (TopicsClient) DeletePreparer

func (client TopicsClient) DeletePreparer(resourceGroupName string, topicName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (TopicsClient) DeleteResponder

func (client TopicsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (TopicsClient) DeleteSender

func (client TopicsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (TopicsClient) Get

func (client TopicsClient) Get(resourceGroupName string, topicName string) (result Topic, err error)

Get get properties of a topic

resourceGroupName is the name of the resource group within the user's subscription. topicName is name of the topic

func (TopicsClient) GetPreparer

func (client TopicsClient) GetPreparer(resourceGroupName string, topicName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TopicsClient) GetResponder

func (client TopicsClient) GetResponder(resp *http.Response) (result Topic, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (TopicsClient) GetSender

func (client TopicsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (TopicsClient) ListByResourceGroup

func (client TopicsClient) ListByResourceGroup(resourceGroupName string) (result TopicsListResult, err error)

ListByResourceGroup list all the topics under a resource group

resourceGroupName is the name of the resource group within the user's subscription.

func (TopicsClient) ListByResourceGroupPreparer

func (client TopicsClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (TopicsClient) ListByResourceGroupResponder

func (client TopicsClient) ListByResourceGroupResponder(resp *http.Response) (result TopicsListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (TopicsClient) ListByResourceGroupSender

func (client TopicsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (TopicsClient) ListBySubscription

func (client TopicsClient) ListBySubscription() (result TopicsListResult, err error)

ListBySubscription list all the topics under an Azure subscription

func (TopicsClient) ListBySubscriptionPreparer

func (client TopicsClient) ListBySubscriptionPreparer() (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (TopicsClient) ListBySubscriptionResponder

func (client TopicsClient) ListBySubscriptionResponder(resp *http.Response) (result TopicsListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (TopicsClient) ListBySubscriptionSender

func (client TopicsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (TopicsClient) ListEventTypes

func (client TopicsClient) ListEventTypes(resourceGroupName string, providerNamespace string, resourceTypeName string, resourceName string) (result EventTypesListResult, err error)

ListEventTypes list event types for a topic

resourceGroupName is the name of the resource group within the user's subscription. providerNamespace is namespace of the provider of the topic resourceTypeName is name of the topic type resourceName is name of the topic

func (TopicsClient) ListEventTypesPreparer

func (client TopicsClient) ListEventTypesPreparer(resourceGroupName string, providerNamespace string, resourceTypeName string, resourceName string) (*http.Request, error)

ListEventTypesPreparer prepares the ListEventTypes request.

func (TopicsClient) ListEventTypesResponder

func (client TopicsClient) ListEventTypesResponder(resp *http.Response) (result EventTypesListResult, err error)

ListEventTypesResponder handles the response to the ListEventTypes request. The method always closes the http.Response Body.

func (TopicsClient) ListEventTypesSender

func (client TopicsClient) ListEventTypesSender(req *http.Request) (*http.Response, error)

ListEventTypesSender sends the ListEventTypes request. The method will close the http.Response Body if it receives an error.

func (TopicsClient) ListSharedAccessKeys

func (client TopicsClient) ListSharedAccessKeys(resourceGroupName string, topicName string) (result TopicSharedAccessKeys, err error)

ListSharedAccessKeys list the two keys used to publish to a topic

resourceGroupName is the name of the resource group within the user's subscription. topicName is name of the topic

func (TopicsClient) ListSharedAccessKeysPreparer

func (client TopicsClient) ListSharedAccessKeysPreparer(resourceGroupName string, topicName string) (*http.Request, error)

ListSharedAccessKeysPreparer prepares the ListSharedAccessKeys request.

func (TopicsClient) ListSharedAccessKeysResponder

func (client TopicsClient) ListSharedAccessKeysResponder(resp *http.Response) (result TopicSharedAccessKeys, err error)

ListSharedAccessKeysResponder handles the response to the ListSharedAccessKeys request. The method always closes the http.Response Body.

func (TopicsClient) ListSharedAccessKeysSender

func (client TopicsClient) ListSharedAccessKeysSender(req *http.Request) (*http.Response, error)

ListSharedAccessKeysSender sends the ListSharedAccessKeys request. The method will close the http.Response Body if it receives an error.

func (TopicsClient) RegenerateKey

func (client TopicsClient) RegenerateKey(resourceGroupName string, topicName string, regenerateKeyRequest TopicRegenerateKeyRequest) (result TopicSharedAccessKeys, err error)

RegenerateKey regenerate a shared access key for a topic

resourceGroupName is the name of the resource group within the user's subscription. topicName is name of the topic regenerateKeyRequest is request body to regenerate key

func (TopicsClient) RegenerateKeyPreparer

func (client TopicsClient) RegenerateKeyPreparer(resourceGroupName string, topicName string, regenerateKeyRequest TopicRegenerateKeyRequest) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (TopicsClient) RegenerateKeyResponder

func (client TopicsClient) RegenerateKeyResponder(resp *http.Response) (result TopicSharedAccessKeys, err error)

RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.

func (TopicsClient) RegenerateKeySender

func (client TopicsClient) RegenerateKeySender(req *http.Request) (*http.Response, error)

RegenerateKeySender sends the RegenerateKey request. The method will close the http.Response Body if it receives an error.

type TopicsListResult

type TopicsListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Topic `json:"value,omitempty"`
}

TopicsListResult is result of the List Topics operation

type TrackedResource

type TrackedResource struct {
	ID       *string             `json:"id,omitempty"`
	Name     *string             `json:"name,omitempty"`
	Type     *string             `json:"type,omitempty"`
	Location *string             `json:"location,omitempty"`
	Tags     *map[string]*string `json:"tags,omitempty"`
}

TrackedResource is definition of a Tracked Resource

Jump to

Keyboard shortcuts

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