Documentation ¶
Overview ¶
Package eventgrid implements the Azure ARM Eventgrid service API version 2017-06-15-preview.
Azure EventGrid Management Client
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type EndpointType
- type EventSubscription
- type EventSubscriptionDestination
- type EventSubscriptionDestinationProperties
- type EventSubscriptionFilter
- type EventSubscriptionFullURL
- type EventSubscriptionProperties
- type EventSubscriptionProvisioningState
- type EventSubscriptionUpdateParameters
- type EventSubscriptionsClient
- func (client EventSubscriptionsClient) Create(ctx context.Context, scope string, eventSubscriptionName string, ...) (result EventSubscriptionsCreateFuture, err error)
- func (client EventSubscriptionsClient) CreatePreparer(ctx context.Context, scope string, eventSubscriptionName string, ...) (*http.Request, error)
- func (client EventSubscriptionsClient) CreateResponder(resp *http.Response) (result EventSubscription, err error)
- func (client EventSubscriptionsClient) CreateSender(req *http.Request) (future EventSubscriptionsCreateFuture, err error)
- func (client EventSubscriptionsClient) Delete(ctx context.Context, scope string, eventSubscriptionName string) (result EventSubscriptionsDeleteFuture, err error)
- func (client EventSubscriptionsClient) DeletePreparer(ctx context.Context, scope string, eventSubscriptionName string) (*http.Request, error)
- func (client EventSubscriptionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client EventSubscriptionsClient) DeleteSender(req *http.Request) (future EventSubscriptionsDeleteFuture, err error)
- func (client EventSubscriptionsClient) Get(ctx context.Context, scope string, eventSubscriptionName string) (result EventSubscription, err error)
- func (client EventSubscriptionsClient) GetFullURL(ctx context.Context, scope string, eventSubscriptionName string) (result EventSubscriptionFullURL, err error)
- func (client EventSubscriptionsClient) GetFullURLPreparer(ctx context.Context, scope string, eventSubscriptionName string) (*http.Request, error)
- func (client EventSubscriptionsClient) GetFullURLResponder(resp *http.Response) (result EventSubscriptionFullURL, err error)
- func (client EventSubscriptionsClient) GetFullURLSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) GetPreparer(ctx context.Context, scope string, eventSubscriptionName string) (*http.Request, error)
- func (client EventSubscriptionsClient) GetResponder(resp *http.Response) (result EventSubscription, err error)
- func (client EventSubscriptionsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) ListByResource(ctx context.Context, resourceGroupName string, providerNamespace string, ...) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListByResourcePreparer(ctx context.Context, resourceGroupName string, providerNamespace string, ...) (*http.Request, error)
- func (client EventSubscriptionsClient) ListByResourceResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListByResourceSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) ListGlobalByResourceGroup(ctx context.Context, resourceGroupName string) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListGlobalByResourceGroupForTopicType(ctx context.Context, resourceGroupName string, topicTypeName string) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypePreparer(ctx context.Context, resourceGroupName string, topicTypeName string) (*http.Request, error)
- func (client EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypeResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypeSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) ListGlobalByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client EventSubscriptionsClient) ListGlobalByResourceGroupResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListGlobalByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) ListGlobalBySubscription(ctx context.Context) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListGlobalBySubscriptionForTopicType(ctx context.Context, topicTypeName string) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypePreparer(ctx context.Context, topicTypeName string) (*http.Request, error)
- func (client EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypeResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypeSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) ListGlobalBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
- func (client EventSubscriptionsClient) ListGlobalBySubscriptionResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListGlobalBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) ListRegionalByResourceGroup(ctx context.Context, resourceGroupName string, location string) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListRegionalByResourceGroupForTopicType(ctx context.Context, resourceGroupName string, location string, ...) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypePreparer(ctx context.Context, resourceGroupName string, location string, ...) (*http.Request, error)
- func (client EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypeResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypeSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) ListRegionalByResourceGroupPreparer(ctx context.Context, resourceGroupName string, location string) (*http.Request, error)
- func (client EventSubscriptionsClient) ListRegionalByResourceGroupResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListRegionalByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) ListRegionalBySubscription(ctx context.Context, location string) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListRegionalBySubscriptionForTopicType(ctx context.Context, location string, topicTypeName string) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypePreparer(ctx context.Context, location string, topicTypeName string) (*http.Request, error)
- func (client EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypeResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypeSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) ListRegionalBySubscriptionPreparer(ctx context.Context, location string) (*http.Request, error)
- func (client EventSubscriptionsClient) ListRegionalBySubscriptionResponder(resp *http.Response) (result EventSubscriptionsListResult, err error)
- func (client EventSubscriptionsClient) ListRegionalBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client EventSubscriptionsClient) Update(ctx context.Context, scope string, eventSubscriptionName string, ...) (result EventSubscriptionsUpdateFuture, err error)
- func (client EventSubscriptionsClient) UpdatePreparer(ctx context.Context, scope string, eventSubscriptionName string, ...) (*http.Request, error)
- func (client EventSubscriptionsClient) UpdateResponder(resp *http.Response) (result EventSubscription, err error)
- func (client EventSubscriptionsClient) UpdateSender(req *http.Request) (future EventSubscriptionsUpdateFuture, err error)
- type EventSubscriptionsCreateFuture
- type EventSubscriptionsDeleteFuture
- type EventSubscriptionsListResult
- type EventSubscriptionsUpdateFuture
- type EventType
- type EventTypeProperties
- type EventTypesListResult
- type Operation
- type OperationInfo
- type OperationOrigin
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationsListResult, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationsListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type OperationsListResult
- type Resource
- type ResourceRegionType
- type Topic
- type TopicProperties
- type TopicProvisioningState
- type TopicRegenerateKeyRequest
- type TopicSharedAccessKeys
- type TopicTypeInfo
- type TopicTypeProperties
- type TopicTypeProvisioningState
- type TopicTypesClient
- func (client TopicTypesClient) Get(ctx context.Context, topicTypeName string) (result TopicTypeInfo, err error)
- func (client TopicTypesClient) GetPreparer(ctx context.Context, topicTypeName string) (*http.Request, error)
- func (client TopicTypesClient) GetResponder(resp *http.Response) (result TopicTypeInfo, err error)
- func (client TopicTypesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client TopicTypesClient) List(ctx context.Context) (result TopicTypesListResult, err error)
- func (client TopicTypesClient) ListEventTypes(ctx context.Context, topicTypeName string) (result EventTypesListResult, err error)
- func (client TopicTypesClient) ListEventTypesPreparer(ctx context.Context, topicTypeName string) (*http.Request, error)
- func (client TopicTypesClient) ListEventTypesResponder(resp *http.Response) (result EventTypesListResult, err error)
- func (client TopicTypesClient) ListEventTypesSender(req *http.Request) (*http.Response, error)
- func (client TopicTypesClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client TopicTypesClient) ListResponder(resp *http.Response) (result TopicTypesListResult, err error)
- func (client TopicTypesClient) ListSender(req *http.Request) (*http.Response, error)
- type TopicTypesListResult
- type TopicsClient
- func (client TopicsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, topicName string, ...) (result TopicsCreateOrUpdateFuture, err error)
- func (client TopicsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, topicName string, ...) (*http.Request, error)
- func (client TopicsClient) CreateOrUpdateResponder(resp *http.Response) (result Topic, err error)
- func (client TopicsClient) CreateOrUpdateSender(req *http.Request) (future TopicsCreateOrUpdateFuture, err error)
- func (client TopicsClient) Delete(ctx context.Context, resourceGroupName string, topicName string) (result TopicsDeleteFuture, err error)
- func (client TopicsClient) DeletePreparer(ctx context.Context, resourceGroupName string, topicName string) (*http.Request, error)
- func (client TopicsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client TopicsClient) DeleteSender(req *http.Request) (future TopicsDeleteFuture, err error)
- func (client TopicsClient) Get(ctx context.Context, resourceGroupName string, topicName string) (result Topic, err error)
- func (client TopicsClient) GetPreparer(ctx context.Context, resourceGroupName string, topicName string) (*http.Request, error)
- func (client TopicsClient) GetResponder(resp *http.Response) (result Topic, err error)
- func (client TopicsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client TopicsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result TopicsListResult, err error)
- func (client TopicsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client TopicsClient) ListByResourceGroupResponder(resp *http.Response) (result TopicsListResult, err error)
- func (client TopicsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client TopicsClient) ListBySubscription(ctx context.Context) (result TopicsListResult, err error)
- func (client TopicsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
- func (client TopicsClient) ListBySubscriptionResponder(resp *http.Response) (result TopicsListResult, err error)
- func (client TopicsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client TopicsClient) ListEventTypes(ctx context.Context, resourceGroupName string, providerNamespace string, ...) (result EventTypesListResult, err error)
- func (client TopicsClient) ListEventTypesPreparer(ctx context.Context, resourceGroupName string, providerNamespace string, ...) (*http.Request, error)
- func (client TopicsClient) ListEventTypesResponder(resp *http.Response) (result EventTypesListResult, err error)
- func (client TopicsClient) ListEventTypesSender(req *http.Request) (*http.Response, error)
- func (client TopicsClient) ListSharedAccessKeys(ctx context.Context, resourceGroupName string, topicName string) (result TopicSharedAccessKeys, err error)
- func (client TopicsClient) ListSharedAccessKeysPreparer(ctx context.Context, resourceGroupName string, topicName string) (*http.Request, error)
- func (client TopicsClient) ListSharedAccessKeysResponder(resp *http.Response) (result TopicSharedAccessKeys, err error)
- func (client TopicsClient) ListSharedAccessKeysSender(req *http.Request) (*http.Response, error)
- func (client TopicsClient) RegenerateKey(ctx context.Context, resourceGroupName string, topicName string, ...) (result TopicSharedAccessKeys, err error)
- func (client TopicsClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, topicName string, ...) (*http.Request, error)
- func (client TopicsClient) RegenerateKeyResponder(resp *http.Response) (result TopicSharedAccessKeys, err error)
- func (client TopicsClient) RegenerateKeySender(req *http.Request) (*http.Response, error)
- type TopicsCreateOrUpdateFuture
- type TopicsDeleteFuture
- type TopicsListResult
- type TrackedResource
Constants ¶
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 BaseClient ¶
BaseClient is the base client for Eventgrid.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type EndpointType ¶
type EndpointType string
EndpointType enumerates the values for endpoint type.
const ( // WebHook ... WebHook EndpointType = "WebHook" )
func PossibleEndpointTypeValues ¶
func PossibleEndpointTypeValues() []EndpointType
PossibleEndpointTypeValues returns an array of possible values for the EndpointType const type.
type EventSubscription ¶
type EventSubscription struct { autorest.Response `json:"-"` // EventSubscriptionProperties - Properties of the event subscription *EventSubscriptionProperties `json:"properties,omitempty"` // ID - READ-ONLY; Fully qualified identifier of the resource ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of the resource Type *string `json:"type,omitempty"` }
EventSubscription event Subscription
func (EventSubscription) MarshalJSON ¶
func (es EventSubscription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EventSubscription.
func (*EventSubscription) UnmarshalJSON ¶
func (es *EventSubscription) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for EventSubscription struct.
type EventSubscriptionDestination ¶
type EventSubscriptionDestination struct { // EndpointType - Type of the endpoint for the event subscription destination. Possible values include: 'WebHook' EndpointType EndpointType `json:"endpointType,omitempty"` // EventSubscriptionDestinationProperties - Properties of the event subscription destination *EventSubscriptionDestinationProperties `json:"properties,omitempty"` }
EventSubscriptionDestination information about the destination for an event subscription
func (EventSubscriptionDestination) MarshalJSON ¶
func (esd EventSubscriptionDestination) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EventSubscriptionDestination.
func (*EventSubscriptionDestination) UnmarshalJSON ¶
func (esd *EventSubscriptionDestination) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for EventSubscriptionDestination struct.
type EventSubscriptionDestinationProperties ¶
type EventSubscriptionDestinationProperties struct { // EndpointURL - The URL that represents the endpoint of the destination of an event subscription. EndpointURL *string `json:"endpointUrl,omitempty"` // EndpointBaseURL - READ-ONLY; The base URL that represents the endpoint of the destination of an event subscription. EndpointBaseURL *string `json:"endpointBaseUrl,omitempty"` }
EventSubscriptionDestinationProperties properties of the event subscription destination
type EventSubscriptionFilter ¶
type EventSubscriptionFilter struct { // SubjectBeginsWith - 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"` // SubjectEndsWith - 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"` // IncludedEventTypes - A list of applicable event types that need to be part of the event subscription. // If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list. IncludedEventTypes *[]string `json:"includedEventTypes,omitempty"` // IsSubjectCaseSensitive - Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter // should be compared in a case sensitive manner. IsSubjectCaseSensitive *bool `json:"isSubjectCaseSensitive,omitempty"` }
EventSubscriptionFilter filter for the Event Subscription
type EventSubscriptionFullURL ¶
type EventSubscriptionFullURL struct { autorest.Response `json:"-"` // EndpointURL - 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 EventSubscriptionProperties ¶
type EventSubscriptionProperties struct { // Topic - READ-ONLY; Name of the topic of the event subscription. Topic *string `json:"topic,omitempty"` // ProvisioningState - READ-ONLY; Provisioning state of the event subscription. Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Canceled', 'Failed' ProvisioningState EventSubscriptionProvisioningState `json:"provisioningState,omitempty"` // Destination - Information about the destination where events have to be delivered for the event subscription. Destination *EventSubscriptionDestination `json:"destination,omitempty"` // Filter - Information about the filter for the event subscription. Filter *EventSubscriptionFilter `json:"filter,omitempty"` // Labels - List of user defined labels. Labels *[]string `json:"labels,omitempty"` }
EventSubscriptionProperties properties of the Event Subscription
type EventSubscriptionProvisioningState ¶
type EventSubscriptionProvisioningState string
EventSubscriptionProvisioningState enumerates the values for event subscription provisioning state.
const ( // Canceled ... Canceled EventSubscriptionProvisioningState = "Canceled" // Creating ... Creating EventSubscriptionProvisioningState = "Creating" // Deleting ... Deleting EventSubscriptionProvisioningState = "Deleting" // Failed ... Failed EventSubscriptionProvisioningState = "Failed" // Succeeded ... Succeeded EventSubscriptionProvisioningState = "Succeeded" // Updating ... Updating EventSubscriptionProvisioningState = "Updating" )
func PossibleEventSubscriptionProvisioningStateValues ¶
func PossibleEventSubscriptionProvisioningStateValues() []EventSubscriptionProvisioningState
PossibleEventSubscriptionProvisioningStateValues returns an array of possible values for the EventSubscriptionProvisioningState const type.
type EventSubscriptionUpdateParameters ¶
type EventSubscriptionUpdateParameters struct { // Destination - Information about the destination where events have to be delivered for the event subscription. Destination *EventSubscriptionDestination `json:"destination,omitempty"` // Filter - Information about the filter for the event subscription. Filter *EventSubscriptionFilter `json:"filter,omitempty"` // Labels - List of user defined labels. Labels *[]string `json:"labels,omitempty"` }
EventSubscriptionUpdateParameters properties of the Event Subscription update
type EventSubscriptionsClient ¶
type EventSubscriptionsClient struct {
BaseClient
}
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (EventSubscriptionsClient) Create ¶
func (client EventSubscriptionsClient) Create(ctx context.Context, scope string, eventSubscriptionName string, eventSubscriptionInfo EventSubscription) (result EventSubscriptionsCreateFuture, err 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. Parameters: scope - 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 - 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 - event subscription properties containing the destination and filter information
func (EventSubscriptionsClient) CreatePreparer ¶
func (client EventSubscriptionsClient) CreatePreparer(ctx context.Context, scope string, eventSubscriptionName string, eventSubscriptionInfo EventSubscription) (*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) (future EventSubscriptionsCreateFuture, err 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(ctx context.Context, scope string, eventSubscriptionName string) (result EventSubscriptionsDeleteFuture, err error)
Delete delete an existing event subscription Parameters: 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
func (EventSubscriptionsClient) DeletePreparer ¶
func (client EventSubscriptionsClient) DeletePreparer(ctx context.Context, scope string, eventSubscriptionName string) (*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) (future EventSubscriptionsDeleteFuture, err 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(ctx context.Context, scope string, eventSubscriptionName string) (result EventSubscription, err error)
Get get properties of an event subscription Parameters: 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
func (EventSubscriptionsClient) GetFullURL ¶
func (client EventSubscriptionsClient) GetFullURL(ctx context.Context, scope string, eventSubscriptionName string) (result EventSubscriptionFullURL, err error)
GetFullURL get the full endpoint URL for an event subscription Parameters: 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
func (EventSubscriptionsClient) GetFullURLPreparer ¶
func (client EventSubscriptionsClient) GetFullURLPreparer(ctx context.Context, 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 ¶
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(ctx context.Context, 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 ¶
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(ctx context.Context, 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 Parameters: 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
func (EventSubscriptionsClient) ListByResourcePreparer ¶
func (client EventSubscriptionsClient) ListByResourcePreparer(ctx context.Context, 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(ctx context.Context, resourceGroupName string) (result EventSubscriptionsListResult, err error)
ListGlobalByResourceGroup list all global event subscriptions under a specific Azure subscription and resource group Parameters: resourceGroupName - the name of the resource group within the user's subscription.
func (EventSubscriptionsClient) ListGlobalByResourceGroupForTopicType ¶
func (client EventSubscriptionsClient) ListGlobalByResourceGroupForTopicType(ctx context.Context, resourceGroupName string, topicTypeName string) (result EventSubscriptionsListResult, err error)
ListGlobalByResourceGroupForTopicType list all global event subscriptions under a resource group for a specific topic type. Parameters: resourceGroupName - the name of the resource group within the user's subscription. topicTypeName - name of the topic type
func (EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypePreparer ¶
func (client EventSubscriptionsClient) ListGlobalByResourceGroupForTopicTypePreparer(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context) (result EventSubscriptionsListResult, err error)
ListGlobalBySubscription list all aggregated global event subscriptions under a specific Azure subscription
func (EventSubscriptionsClient) ListGlobalBySubscriptionForTopicType ¶
func (client EventSubscriptionsClient) ListGlobalBySubscriptionForTopicType(ctx context.Context, topicTypeName string) (result EventSubscriptionsListResult, err error)
ListGlobalBySubscriptionForTopicType list all global event subscriptions under an Azure subscription for a topic type. Parameters: topicTypeName - name of the topic type
func (EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypePreparer ¶
func (client EventSubscriptionsClient) ListGlobalBySubscriptionForTopicTypePreparer(ctx context.Context, 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(ctx context.Context) (*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(ctx context.Context, 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 Parameters: resourceGroupName - the name of the resource group within the user's subscription. location - name of the location
func (EventSubscriptionsClient) ListRegionalByResourceGroupForTopicType ¶
func (client EventSubscriptionsClient) ListRegionalByResourceGroupForTopicType(ctx context.Context, 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 Parameters: resourceGroupName - the name of the resource group within the user's subscription. location - name of the location topicTypeName - name of the topic type
func (EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypePreparer ¶
func (client EventSubscriptionsClient) ListRegionalByResourceGroupForTopicTypePreparer(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, location string) (result EventSubscriptionsListResult, err error)
ListRegionalBySubscription list all event subscriptions from the given location under a specific Azure subscription Parameters: location - name of the location
func (EventSubscriptionsClient) ListRegionalBySubscriptionForTopicType ¶
func (client EventSubscriptionsClient) ListRegionalBySubscriptionForTopicType(ctx context.Context, 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. Parameters: location - name of the location topicTypeName - name of the topic type
func (EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypePreparer ¶
func (client EventSubscriptionsClient) ListRegionalBySubscriptionForTopicTypePreparer(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, scope string, eventSubscriptionName string, eventSubscriptionUpdateParameters EventSubscriptionUpdateParameters) (result EventSubscriptionsUpdateFuture, err error)
Update asynchronously updates an existing event subscription. Parameters: 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 created eventSubscriptionUpdateParameters - updated event subscription information
func (EventSubscriptionsClient) UpdatePreparer ¶
func (client EventSubscriptionsClient) UpdatePreparer(ctx context.Context, scope string, eventSubscriptionName string, eventSubscriptionUpdateParameters EventSubscriptionUpdateParameters) (*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) (future EventSubscriptionsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type EventSubscriptionsCreateFuture ¶
EventSubscriptionsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*EventSubscriptionsCreateFuture) Result ¶
func (future *EventSubscriptionsCreateFuture) Result(client EventSubscriptionsClient) (es EventSubscription, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type EventSubscriptionsDeleteFuture ¶
EventSubscriptionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*EventSubscriptionsDeleteFuture) Result ¶
func (future *EventSubscriptionsDeleteFuture) Result(client EventSubscriptionsClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type EventSubscriptionsListResult ¶
type EventSubscriptionsListResult struct { autorest.Response `json:"-"` // Value - A collection of EventSubscriptions Value *[]EventSubscription `json:"value,omitempty"` }
EventSubscriptionsListResult result of the List EventSubscriptions operation
type EventSubscriptionsUpdateFuture ¶
EventSubscriptionsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*EventSubscriptionsUpdateFuture) Result ¶
func (future *EventSubscriptionsUpdateFuture) Result(client EventSubscriptionsClient) (es EventSubscription, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type EventType ¶
type EventType struct { // EventTypeProperties - Properties of the event type. *EventTypeProperties `json:"properties,omitempty"` // ID - READ-ONLY; Fully qualified identifier of the resource ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of the resource Type *string `json:"type,omitempty"` }
EventType event Type for a subject under a topic
func (EventType) MarshalJSON ¶
MarshalJSON is the custom marshaler for EventType.
func (*EventType) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for EventType struct.
type EventTypeProperties ¶
type EventTypeProperties struct { // DisplayName - Display name of the event type. DisplayName *string `json:"displayName,omitempty"` // Description - Description of the event type. Description *string `json:"description,omitempty"` // SchemaURL - Url of the schema for this event type. SchemaURL *string `json:"schemaUrl,omitempty"` }
EventTypeProperties properties of the event type
type EventTypesListResult ¶
type EventTypesListResult struct { autorest.Response `json:"-"` // Value - A collection of event types Value *[]EventType `json:"value,omitempty"` }
EventTypesListResult result of the List Event Types operation
type Operation ¶
type Operation struct { // Name - Name of the operation Name *string `json:"name,omitempty"` // Display - Display name of the operation Display *OperationInfo `json:"display,omitempty"` // Origin - Origin of the operation. Possible values include: 'User', 'System', 'UserAndSystem' Origin OperationOrigin `json:"origin,omitempty"` // Properties - Properties of the operation Properties interface{} `json:"properties,omitempty"` }
Operation represents an operation returned by the GetOperations request
type OperationInfo ¶
type OperationInfo struct { // Provider - Name of the provider Provider *string `json:"provider,omitempty"` // Resource - Name of the resource type Resource *string `json:"resource,omitempty"` // Operation - Name of the operation Operation *string `json:"operation,omitempty"` // Description - Description of the operation Description *string `json:"description,omitempty"` }
OperationInfo information about an operation
type OperationOrigin ¶
type OperationOrigin string
OperationOrigin enumerates the values for operation origin.
const ( // System ... System OperationOrigin = "System" // User ... User OperationOrigin = "User" // UserAndSystem ... UserAndSystem OperationOrigin = "UserAndSystem" )
func PossibleOperationOriginValues ¶
func PossibleOperationOriginValues() []OperationOrigin
PossibleOperationOriginValues returns an array of possible values for the OperationOrigin const type.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationsListResult, err error)
List list the available operations supported by the Microsoft.EventGrid resource provider
func (OperationsClient) ListPreparer ¶
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 ¶
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 - A collection of operations Value *[]Operation `json:"value,omitempty"` }
OperationsListResult result of the List Operations operation
type Resource ¶
type Resource struct { // ID - READ-ONLY; Fully qualified identifier of the resource ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of the resource Type *string `json:"type,omitempty"` }
Resource definition of a Resource
type ResourceRegionType ¶
type ResourceRegionType string
ResourceRegionType enumerates the values for resource region type.
const ( // GlobalResource ... GlobalResource ResourceRegionType = "GlobalResource" // RegionalResource ... RegionalResource ResourceRegionType = "RegionalResource" )
func PossibleResourceRegionTypeValues ¶
func PossibleResourceRegionTypeValues() []ResourceRegionType
PossibleResourceRegionTypeValues returns an array of possible values for the ResourceRegionType const type.
type Topic ¶
type Topic struct { autorest.Response `json:"-"` // TopicProperties - Properties of the topic *TopicProperties `json:"properties,omitempty"` // Location - Location of the resource Location *string `json:"location,omitempty"` // Tags - Tags of the resource Tags map[string]*string `json:"tags"` // ID - READ-ONLY; Fully qualified identifier of the resource ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of the resource Type *string `json:"type,omitempty"` }
Topic eventGrid Topic
func (Topic) MarshalJSON ¶
MarshalJSON is the custom marshaler for Topic.
func (*Topic) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Topic struct.
type TopicProperties ¶
type TopicProperties struct { // ProvisioningState - READ-ONLY; Provisioning state of the topic. Possible values include: 'TopicProvisioningStateCreating', 'TopicProvisioningStateUpdating', 'TopicProvisioningStateDeleting', 'TopicProvisioningStateSucceeded', 'TopicProvisioningStateCanceled', 'TopicProvisioningStateFailed' ProvisioningState TopicProvisioningState `json:"provisioningState,omitempty"` // Endpoint - READ-ONLY; Endpoint for the topic. Endpoint *string `json:"endpoint,omitempty"` }
TopicProperties properties of the Topic
type TopicProvisioningState ¶
type TopicProvisioningState string
TopicProvisioningState enumerates the values for topic provisioning state.
const ( // TopicProvisioningStateCanceled ... TopicProvisioningStateCanceled TopicProvisioningState = "Canceled" // TopicProvisioningStateCreating ... TopicProvisioningStateCreating TopicProvisioningState = "Creating" // TopicProvisioningStateDeleting ... TopicProvisioningStateDeleting TopicProvisioningState = "Deleting" // TopicProvisioningStateFailed ... TopicProvisioningStateFailed TopicProvisioningState = "Failed" // TopicProvisioningStateSucceeded ... TopicProvisioningStateSucceeded TopicProvisioningState = "Succeeded" // TopicProvisioningStateUpdating ... TopicProvisioningStateUpdating TopicProvisioningState = "Updating" )
func PossibleTopicProvisioningStateValues ¶
func PossibleTopicProvisioningStateValues() []TopicProvisioningState
PossibleTopicProvisioningStateValues returns an array of possible values for the TopicProvisioningState const type.
type TopicRegenerateKeyRequest ¶
type TopicRegenerateKeyRequest struct { // KeyName - Key name to regenerate key1 or key2 KeyName *string `json:"keyName,omitempty"` }
TopicRegenerateKeyRequest topic regenerate share access key request
type TopicSharedAccessKeys ¶
type TopicSharedAccessKeys struct { string `json:"key1,omitempty"` Key2 *string `json:"key2,omitempty"` }Key1 *
TopicSharedAccessKeys shared access keys of the Topic
type TopicTypeInfo ¶
type TopicTypeInfo struct { autorest.Response `json:"-"` // TopicTypeProperties - Properties of the topic type info *TopicTypeProperties `json:"properties,omitempty"` // ID - READ-ONLY; Fully qualified identifier of the resource ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of the resource Type *string `json:"type,omitempty"` }
TopicTypeInfo properties of a topic type info.
func (TopicTypeInfo) MarshalJSON ¶
func (tti TopicTypeInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TopicTypeInfo.
func (*TopicTypeInfo) UnmarshalJSON ¶
func (tti *TopicTypeInfo) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TopicTypeInfo struct.
type TopicTypeProperties ¶
type TopicTypeProperties struct { // Provider - Namespace of the provider of the topic type. Provider *string `json:"provider,omitempty"` // DisplayName - Display Name for the topic type. DisplayName *string `json:"displayName,omitempty"` // Description - Description of the topic type. Description *string `json:"description,omitempty"` // ResourceRegionType - Region type of the resource. Possible values include: 'RegionalResource', 'GlobalResource' ResourceRegionType ResourceRegionType `json:"resourceRegionType,omitempty"` // ProvisioningState - Provisioning state of the topic type. Possible values include: 'TopicTypeProvisioningStateCreating', 'TopicTypeProvisioningStateUpdating', 'TopicTypeProvisioningStateDeleting', 'TopicTypeProvisioningStateSucceeded', 'TopicTypeProvisioningStateCanceled', 'TopicTypeProvisioningStateFailed' ProvisioningState TopicTypeProvisioningState `json:"provisioningState,omitempty"` }
TopicTypeProperties properties of a topic type.
type TopicTypeProvisioningState ¶
type TopicTypeProvisioningState string
TopicTypeProvisioningState enumerates the values for topic type provisioning state.
const ( // TopicTypeProvisioningStateCanceled ... TopicTypeProvisioningStateCanceled TopicTypeProvisioningState = "Canceled" // TopicTypeProvisioningStateCreating ... TopicTypeProvisioningStateCreating TopicTypeProvisioningState = "Creating" // TopicTypeProvisioningStateDeleting ... TopicTypeProvisioningStateDeleting TopicTypeProvisioningState = "Deleting" // TopicTypeProvisioningStateFailed ... TopicTypeProvisioningStateFailed TopicTypeProvisioningState = "Failed" // TopicTypeProvisioningStateSucceeded ... TopicTypeProvisioningStateSucceeded TopicTypeProvisioningState = "Succeeded" // TopicTypeProvisioningStateUpdating ... TopicTypeProvisioningStateUpdating TopicTypeProvisioningState = "Updating" )
func PossibleTopicTypeProvisioningStateValues ¶
func PossibleTopicTypeProvisioningStateValues() []TopicTypeProvisioningState
PossibleTopicTypeProvisioningStateValues returns an array of possible values for the TopicTypeProvisioningState const type.
type TopicTypesClient ¶
type TopicTypesClient struct {
BaseClient
}
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (TopicTypesClient) Get ¶
func (client TopicTypesClient) Get(ctx context.Context, topicTypeName string) (result TopicTypeInfo, err error)
Get get information about a topic type Parameters: topicTypeName - name of the topic type
func (TopicTypesClient) GetPreparer ¶
func (client TopicTypesClient) GetPreparer(ctx context.Context, 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 ¶
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(ctx context.Context) (result TopicTypesListResult, err error)
List list all registered topic types
func (TopicTypesClient) ListEventTypes ¶
func (client TopicTypesClient) ListEventTypes(ctx context.Context, topicTypeName string) (result EventTypesListResult, err error)
ListEventTypes list event types for a topic type Parameters: topicTypeName - name of the topic type
func (TopicTypesClient) ListEventTypesPreparer ¶
func (client TopicTypesClient) ListEventTypesPreparer(ctx context.Context, 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 ¶
ListEventTypesSender sends the ListEventTypes request. The method will close the http.Response Body if it receives an error.
func (TopicTypesClient) ListPreparer ¶
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 ¶
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 - A collection of topic types Value *[]TopicTypeInfo `json:"value,omitempty"` }
TopicTypesListResult result of the List Topic Types operation
type TopicsClient ¶
type TopicsClient struct {
BaseClient
}
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (TopicsClient) CreateOrUpdate ¶
func (client TopicsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, topicName string, topicInfo Topic) (result TopicsCreateOrUpdateFuture, err error)
CreateOrUpdate asynchronously creates a new topic with the specified parameters. Parameters: resourceGroupName - the name of the resource group within the user's subscription. topicName - name of the topic topicInfo - topic information
func (TopicsClient) CreateOrUpdatePreparer ¶
func (client TopicsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, topicName string, topicInfo Topic) (*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) (future TopicsCreateOrUpdateFuture, err 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(ctx context.Context, resourceGroupName string, topicName string) (result TopicsDeleteFuture, err error)
Delete delete existing topic Parameters: resourceGroupName - the name of the resource group within the user's subscription. topicName - name of the topic
func (TopicsClient) DeletePreparer ¶
func (client TopicsClient) DeletePreparer(ctx context.Context, resourceGroupName string, topicName string) (*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) (future TopicsDeleteFuture, err 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(ctx context.Context, resourceGroupName string, topicName string) (result Topic, err error)
Get get properties of a topic Parameters: resourceGroupName - the name of the resource group within the user's subscription. topicName - name of the topic
func (TopicsClient) GetPreparer ¶
func (client TopicsClient) GetPreparer(ctx context.Context, 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 ¶
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(ctx context.Context, resourceGroupName string) (result TopicsListResult, err error)
ListByResourceGroup list all the topics under a resource group Parameters: resourceGroupName - the name of the resource group within the user's subscription.
func (TopicsClient) ListByResourceGroupPreparer ¶
func (client TopicsClient) ListByResourceGroupPreparer(ctx context.Context, 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 ¶
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(ctx context.Context) (result TopicsListResult, err error)
ListBySubscription list all the topics under an Azure subscription
func (TopicsClient) ListBySubscriptionPreparer ¶
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 ¶
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(ctx context.Context, resourceGroupName string, providerNamespace string, resourceTypeName string, resourceName string) (result EventTypesListResult, err error)
ListEventTypes list event types for a topic Parameters: 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
func (TopicsClient) ListEventTypesPreparer ¶
func (client TopicsClient) ListEventTypesPreparer(ctx context.Context, 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 ¶
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(ctx context.Context, resourceGroupName string, topicName string) (result TopicSharedAccessKeys, err error)
ListSharedAccessKeys list the two keys used to publish to a topic Parameters: resourceGroupName - the name of the resource group within the user's subscription. topicName - name of the topic
func (TopicsClient) ListSharedAccessKeysPreparer ¶
func (client TopicsClient) ListSharedAccessKeysPreparer(ctx context.Context, 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 ¶
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(ctx context.Context, resourceGroupName string, topicName string, regenerateKeyRequest TopicRegenerateKeyRequest) (result TopicSharedAccessKeys, err error)
RegenerateKey regenerate a shared access key for a topic Parameters: resourceGroupName - the name of the resource group within the user's subscription. topicName - name of the topic regenerateKeyRequest - request body to regenerate key
func (TopicsClient) RegenerateKeyPreparer ¶
func (client TopicsClient) RegenerateKeyPreparer(ctx context.Context, 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 ¶
RegenerateKeySender sends the RegenerateKey request. The method will close the http.Response Body if it receives an error.
type TopicsCreateOrUpdateFuture ¶
TopicsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*TopicsCreateOrUpdateFuture) Result ¶
func (future *TopicsCreateOrUpdateFuture) Result(client TopicsClient) (t Topic, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type TopicsDeleteFuture ¶
TopicsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*TopicsDeleteFuture) Result ¶
func (future *TopicsDeleteFuture) Result(client TopicsClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type TopicsListResult ¶
type TopicsListResult struct { autorest.Response `json:"-"` // Value - A collection of Topics Value *[]Topic `json:"value,omitempty"` }
TopicsListResult result of the List Topics operation
type TrackedResource ¶
type TrackedResource struct { // Location - Location of the resource Location *string `json:"location,omitempty"` // Tags - Tags of the resource Tags map[string]*string `json:"tags"` // ID - READ-ONLY; Fully qualified identifier of the resource ID *string `json:"id,omitempty"` // Name - READ-ONLY; Name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; Type of the resource Type *string `json:"type,omitempty"` }
TrackedResource definition of a Tracked Resource
func (TrackedResource) MarshalJSON ¶
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.