azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/eventgrid/2018-01-01/eventgrid Index | Files | Directories

package eventgrid

import "github.com/Azure/azure-sdk-for-go/services/eventgrid/2018-01-01/eventgrid"

Package eventgrid implements the Azure ARM Eventgrid service API version 2018-01-01.

EventGrid Client

Index

Package Files

client.go models.go version.go

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type AppConfigurationKeyValueDeletedEventData Uses

type AppConfigurationKeyValueDeletedEventData struct {
    // Key - The key used to identify the key-value that was deleted.
    Key *string `json:"key,omitempty"`
    // Label - The label, if any, used to identify the key-value that was deleted.
    Label *string `json:"label,omitempty"`
    // Etag - The etag representing the key-value that was deleted.
    Etag *string `json:"etag,omitempty"`
}

AppConfigurationKeyValueDeletedEventData schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueDeleted event.

type AppConfigurationKeyValueModifiedEventData Uses

type AppConfigurationKeyValueModifiedEventData struct {
    // Key - The key used to identify the key-value that was modified.
    Key *string `json:"key,omitempty"`
    // Label - The label, if any, used to identify the key-value that was modified.
    Label *string `json:"label,omitempty"`
    // Etag - The etag representing the new state of the key-value.
    Etag *string `json:"etag,omitempty"`
}

AppConfigurationKeyValueModifiedEventData schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueModified event.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
}

BaseClient is the base client for Eventgrid.

func New Uses

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults Uses

func NewWithoutDefaults() BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

func (BaseClient) PublishEvents Uses

func (client BaseClient) PublishEvents(ctx context.Context, topicHostname string, events []Event) (result autorest.Response, err error)

PublishEvents publishes a batch of events to an Azure Event Grid topic. Parameters: topicHostname - the host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net events - an array of events to be published to Event Grid.

func (BaseClient) PublishEventsPreparer Uses

func (client BaseClient) PublishEventsPreparer(ctx context.Context, topicHostname string, events []Event) (*http.Request, error)

PublishEventsPreparer prepares the PublishEvents request.

func (BaseClient) PublishEventsResponder Uses

func (client BaseClient) PublishEventsResponder(resp *http.Response) (result autorest.Response, err error)

PublishEventsResponder handles the response to the PublishEvents request. The method always closes the http.Response Body.

func (BaseClient) PublishEventsSender Uses

func (client BaseClient) PublishEventsSender(req *http.Request) (*http.Response, error)

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

type BasicMediaJobOutput Uses

type BasicMediaJobOutput interface {
    AsMediaJobOutputAsset() (*MediaJobOutputAsset, bool)
    AsMediaJobOutput() (*MediaJobOutput, bool)
}

BasicMediaJobOutput the event data for a Job output.

type ContainerRegistryArtifactEventData Uses

type ContainerRegistryArtifactEventData struct {
    // ID - The event ID.
    ID  *string `json:"id,omitempty"`
    // Timestamp - The time at which the event occurred.
    Timestamp *date.Time `json:"timestamp,omitempty"`
    // Action - The action that encompasses the provided event.
    Action *string `json:"action,omitempty"`
    // Target - The target of the event.
    Target *ContainerRegistryArtifactEventTarget `json:"target,omitempty"`
}

ContainerRegistryArtifactEventData the content of the event request message.

type ContainerRegistryArtifactEventTarget Uses

type ContainerRegistryArtifactEventTarget struct {
    // MediaType - The MIME type of the artifact.
    MediaType *string `json:"mediaType,omitempty"`
    // Size - The size in bytes of the artifact.
    Size *int64 `json:"size,omitempty"`
    // Digest - The digest of the artifact.
    Digest *string `json:"digest,omitempty"`
    // Repository - The repository name of the artifact.
    Repository *string `json:"repository,omitempty"`
    // Tag - The tag of the artifact.
    Tag *string `json:"tag,omitempty"`
    // Name - The name of the artifact.
    Name *string `json:"name,omitempty"`
    // Version - The version of the artifact.
    Version *string `json:"version,omitempty"`
}

ContainerRegistryArtifactEventTarget the target of the event.

type ContainerRegistryChartDeletedEventData Uses

type ContainerRegistryChartDeletedEventData struct {
    // ID - The event ID.
    ID  *string `json:"id,omitempty"`
    // Timestamp - The time at which the event occurred.
    Timestamp *date.Time `json:"timestamp,omitempty"`
    // Action - The action that encompasses the provided event.
    Action *string `json:"action,omitempty"`
    // Target - The target of the event.
    Target *ContainerRegistryArtifactEventTarget `json:"target,omitempty"`
}

ContainerRegistryChartDeletedEventData schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.

type ContainerRegistryChartPushedEventData Uses

type ContainerRegistryChartPushedEventData struct {
    // ID - The event ID.
    ID  *string `json:"id,omitempty"`
    // Timestamp - The time at which the event occurred.
    Timestamp *date.Time `json:"timestamp,omitempty"`
    // Action - The action that encompasses the provided event.
    Action *string `json:"action,omitempty"`
    // Target - The target of the event.
    Target *ContainerRegistryArtifactEventTarget `json:"target,omitempty"`
}

ContainerRegistryChartPushedEventData schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.

type ContainerRegistryEventActor Uses

type ContainerRegistryEventActor struct {
    // Name - The subject or username associated with the request context that generated the event.
    Name *string `json:"name,omitempty"`
}

ContainerRegistryEventActor the agent that initiated the event. For most situations, this could be from the authorization context of the request.

type ContainerRegistryEventData Uses

type ContainerRegistryEventData struct {
    // ID - The event ID.
    ID  *string `json:"id,omitempty"`
    // Timestamp - The time at which the event occurred.
    Timestamp *date.Time `json:"timestamp,omitempty"`
    // Action - The action that encompasses the provided event.
    Action *string `json:"action,omitempty"`
    // Target - The target of the event.
    Target *ContainerRegistryEventTarget `json:"target,omitempty"`
    // Request - The request that generated the event.
    Request *ContainerRegistryEventRequest `json:"request,omitempty"`
    // Actor - The agent that initiated the event. For most situations, this could be from the authorization context of the request.
    Actor *ContainerRegistryEventActor `json:"actor,omitempty"`
    // Source - The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
    Source *ContainerRegistryEventSource `json:"source,omitempty"`
}

ContainerRegistryEventData the content of the event request message.

type ContainerRegistryEventRequest Uses

type ContainerRegistryEventRequest struct {
    // ID - The ID of the request that initiated the event.
    ID  *string `json:"id,omitempty"`
    // Addr - The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request.
    Addr *string `json:"addr,omitempty"`
    // Host - The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests.
    Host *string `json:"host,omitempty"`
    // Method - The request method that generated the event.
    Method *string `json:"method,omitempty"`
    // Useragent - The user agent header of the request.
    Useragent *string `json:"useragent,omitempty"`
}

ContainerRegistryEventRequest the request that generated the event.

type ContainerRegistryEventSource Uses

type ContainerRegistryEventSource struct {
    // Addr - The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port.
    Addr *string `json:"addr,omitempty"`
    // InstanceID - The running instance of an application. Changes after each restart.
    InstanceID *string `json:"instanceID,omitempty"`
}

ContainerRegistryEventSource the registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.

type ContainerRegistryEventTarget Uses

type ContainerRegistryEventTarget struct {
    // MediaType - The MIME type of the referenced object.
    MediaType *string `json:"mediaType,omitempty"`
    // Size - The number of bytes of the content. Same as Length field.
    Size *int64 `json:"size,omitempty"`
    // Digest - The digest of the content, as defined by the Registry V2 HTTP API Specification.
    Digest *string `json:"digest,omitempty"`
    // Length - The number of bytes of the content. Same as Size field.
    Length *int64 `json:"length,omitempty"`
    // Repository - The repository name.
    Repository *string `json:"repository,omitempty"`
    // URL - The direct URL to the content.
    URL *string `json:"url,omitempty"`
    // Tag - The tag name.
    Tag *string `json:"tag,omitempty"`
}

ContainerRegistryEventTarget the target of the event.

type ContainerRegistryImageDeletedEventData Uses

type ContainerRegistryImageDeletedEventData struct {
    // ID - The event ID.
    ID  *string `json:"id,omitempty"`
    // Timestamp - The time at which the event occurred.
    Timestamp *date.Time `json:"timestamp,omitempty"`
    // Action - The action that encompasses the provided event.
    Action *string `json:"action,omitempty"`
    // Target - The target of the event.
    Target *ContainerRegistryEventTarget `json:"target,omitempty"`
    // Request - The request that generated the event.
    Request *ContainerRegistryEventRequest `json:"request,omitempty"`
    // Actor - The agent that initiated the event. For most situations, this could be from the authorization context of the request.
    Actor *ContainerRegistryEventActor `json:"actor,omitempty"`
    // Source - The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
    Source *ContainerRegistryEventSource `json:"source,omitempty"`
}

ContainerRegistryImageDeletedEventData schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.

type ContainerRegistryImagePushedEventData Uses

type ContainerRegistryImagePushedEventData struct {
    // ID - The event ID.
    ID  *string `json:"id,omitempty"`
    // Timestamp - The time at which the event occurred.
    Timestamp *date.Time `json:"timestamp,omitempty"`
    // Action - The action that encompasses the provided event.
    Action *string `json:"action,omitempty"`
    // Target - The target of the event.
    Target *ContainerRegistryEventTarget `json:"target,omitempty"`
    // Request - The request that generated the event.
    Request *ContainerRegistryEventRequest `json:"request,omitempty"`
    // Actor - The agent that initiated the event. For most situations, this could be from the authorization context of the request.
    Actor *ContainerRegistryEventActor `json:"actor,omitempty"`
    // Source - The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
    Source *ContainerRegistryEventSource `json:"source,omitempty"`
}

ContainerRegistryImagePushedEventData schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.

type DeviceConnectionStateEventInfo Uses

type DeviceConnectionStateEventInfo struct {
    // SequenceNumber - Sequence number is string representation of a hexadecimal number. string compare can be used to identify the larger number because both in ASCII and HEX numbers come after alphabets. If you are converting the string to hex, then the number is a 256 bit number.
    SequenceNumber *string `json:"sequenceNumber,omitempty"`
}

DeviceConnectionStateEventInfo information about the device connection state event.

type DeviceConnectionStateEventProperties Uses

type DeviceConnectionStateEventProperties struct {
    // DeviceID - The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.
    DeviceID *string `json:"deviceId,omitempty"`
    // ModuleID - The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.
    ModuleID *string `json:"moduleId,omitempty"`
    // HubName - Name of the IoT Hub where the device was created or deleted.
    HubName *string `json:"hubName,omitempty"`
    // DeviceConnectionStateEventInfo - Information about the device connection state event.
    DeviceConnectionStateEventInfo *DeviceConnectionStateEventInfo `json:"deviceConnectionStateEventInfo,omitempty"`
}

DeviceConnectionStateEventProperties schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).

type DeviceLifeCycleEventProperties Uses

type DeviceLifeCycleEventProperties struct {
    // DeviceID - The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.
    DeviceID *string `json:"deviceId,omitempty"`
    // HubName - Name of the IoT Hub where the device was created or deleted.
    HubName *string `json:"hubName,omitempty"`
    // Twin - Information about the device twin, which is the cloud representation of application device metadata.
    Twin *DeviceTwinInfo `json:"twin,omitempty"`
}

DeviceLifeCycleEventProperties schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).

type DeviceTelemetryEventProperties Uses

type DeviceTelemetryEventProperties struct {
    // Body - The content of the message from the device.
    Body interface{} `json:"body,omitempty"`
    // Properties - Application properties are user-defined strings that can be added to the message. These fields are optional.
    Properties map[string]*string `json:"properties"`
    // SystemProperties - System properties help identify contents and source of the messages.
    SystemProperties map[string]*string `json:"systemProperties"`
}

DeviceTelemetryEventProperties schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).

func (DeviceTelemetryEventProperties) MarshalJSON Uses

func (dtep DeviceTelemetryEventProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceTelemetryEventProperties.

type DeviceTwinInfo Uses

type DeviceTwinInfo struct {
    // AuthenticationType - Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority.
    AuthenticationType *string `json:"authenticationType,omitempty"`
    // CloudToDeviceMessageCount - Count of cloud to device messages sent to this device.
    CloudToDeviceMessageCount *float64 `json:"cloudToDeviceMessageCount,omitempty"`
    // ConnectionState - Whether the device is connected or disconnected.
    ConnectionState *string `json:"connectionState,omitempty"`
    // DeviceID - The unique identifier of the device twin.
    DeviceID *string `json:"deviceId,omitempty"`
    // Etag - A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin.
    Etag *string `json:"etag,omitempty"`
    // LastActivityTime - The ISO8601 timestamp of the last activity.
    LastActivityTime *string `json:"lastActivityTime,omitempty"`
    // Properties - Properties JSON element.
    Properties *DeviceTwinInfoProperties `json:"properties,omitempty"`
    // Status - Whether the device twin is enabled or disabled.
    Status *string `json:"status,omitempty"`
    // StatusUpdateTime - The ISO8601 timestamp of the last device twin status update.
    StatusUpdateTime *string `json:"statusUpdateTime,omitempty"`
    // Version - An integer that is incremented by one each time the device twin is updated.
    Version *float64 `json:"version,omitempty"`
    // X509Thumbprint - The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.
    X509Thumbprint *DeviceTwinInfoX509Thumbprint `json:"x509Thumbprint,omitempty"`
}

DeviceTwinInfo information about the device twin, which is the cloud representation of application device metadata.

type DeviceTwinInfoProperties Uses

type DeviceTwinInfoProperties struct {
    // Desired - A portion of the properties that can be written only by the application back-end, and read by the device.
    Desired *DeviceTwinProperties `json:"desired,omitempty"`
    // Reported - A portion of the properties that can be written only by the device, and read by the application back-end.
    Reported *DeviceTwinProperties `json:"reported,omitempty"`
}

DeviceTwinInfoProperties properties JSON element.

type DeviceTwinInfoX509Thumbprint Uses

type DeviceTwinInfoX509Thumbprint struct {
    // PrimaryThumbprint - Primary thumbprint for the x509 certificate.
    PrimaryThumbprint *string `json:"primaryThumbprint,omitempty"`
    // SecondaryThumbprint - Secondary thumbprint for the x509 certificate.
    SecondaryThumbprint *string `json:"secondaryThumbprint,omitempty"`
}

DeviceTwinInfoX509Thumbprint the thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.

type DeviceTwinMetadata Uses

type DeviceTwinMetadata struct {
    // LastUpdated - The ISO8601 timestamp of the last time the properties were updated.
    LastUpdated *string `json:"lastUpdated,omitempty"`
}

DeviceTwinMetadata metadata information for the properties JSON document.

type DeviceTwinProperties Uses

type DeviceTwinProperties struct {
    // Metadata - Metadata information for the properties JSON document.
    Metadata *DeviceTwinMetadata `json:"metadata,omitempty"`
    // Version - Version of device twin properties.
    Version *float64 `json:"version,omitempty"`
}

DeviceTwinProperties a portion of the properties that can be written only by the application back-end, and read by the device.

type Event Uses

type Event struct {
    // ID - An unique identifier for the event.
    ID  *string `json:"id,omitempty"`
    // Topic - The resource path of the event source.
    Topic *string `json:"topic,omitempty"`
    // Subject - A resource path relative to the topic path.
    Subject *string `json:"subject,omitempty"`
    // Data - Event data specific to the event type.
    Data interface{} `json:"data,omitempty"`
    // EventType - The type of the event that occurred.
    EventType *string `json:"eventType,omitempty"`
    // EventTime - The time (in UTC) the event was generated.
    EventTime *date.Time `json:"eventTime,omitempty"`
    // MetadataVersion - READ-ONLY; The schema version of the event metadata.
    MetadataVersion *string `json:"metadataVersion,omitempty"`
    // DataVersion - The schema version of the data object.
    DataVersion *string `json:"dataVersion,omitempty"`
}

Event properties of an event published to an Event Grid topic.

type EventHubCaptureFileCreatedEventData Uses

type EventHubCaptureFileCreatedEventData struct {
    // Fileurl - The path to the capture file.
    Fileurl *string `json:"fileurl,omitempty"`
    // FileType - The file type of the capture file.
    FileType *string `json:"fileType,omitempty"`
    // PartitionID - The shard ID.
    PartitionID *string `json:"partitionId,omitempty"`
    // SizeInBytes - The file size.
    SizeInBytes *int32 `json:"sizeInBytes,omitempty"`
    // EventCount - The number of events in the file.
    EventCount *int32 `json:"eventCount,omitempty"`
    // FirstSequenceNumber - The smallest sequence number from the queue.
    FirstSequenceNumber *int32 `json:"firstSequenceNumber,omitempty"`
    // LastSequenceNumber - The last sequence number from the queue.
    LastSequenceNumber *int32 `json:"lastSequenceNumber,omitempty"`
    // FirstEnqueueTime - The first time from the queue.
    FirstEnqueueTime *date.Time `json:"firstEnqueueTime,omitempty"`
    // LastEnqueueTime - The last time from the queue.
    LastEnqueueTime *date.Time `json:"lastEnqueueTime,omitempty"`
}

EventHubCaptureFileCreatedEventData schema of the Data property of an EventGridEvent for an Microsoft.EventHub.CaptureFileCreated event.

type IotHubDeviceConnectedEventData Uses

type IotHubDeviceConnectedEventData struct {
    // DeviceID - The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.
    DeviceID *string `json:"deviceId,omitempty"`
    // ModuleID - The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.
    ModuleID *string `json:"moduleId,omitempty"`
    // HubName - Name of the IoT Hub where the device was created or deleted.
    HubName *string `json:"hubName,omitempty"`
    // DeviceConnectionStateEventInfo - Information about the device connection state event.
    DeviceConnectionStateEventInfo *DeviceConnectionStateEventInfo `json:"deviceConnectionStateEventInfo,omitempty"`
}

IotHubDeviceConnectedEventData event data for Microsoft.Devices.DeviceConnected event.

type IotHubDeviceCreatedEventData Uses

type IotHubDeviceCreatedEventData struct {
    // DeviceID - The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.
    DeviceID *string `json:"deviceId,omitempty"`
    // HubName - Name of the IoT Hub where the device was created or deleted.
    HubName *string `json:"hubName,omitempty"`
    // Twin - Information about the device twin, which is the cloud representation of application device metadata.
    Twin *DeviceTwinInfo `json:"twin,omitempty"`
}

IotHubDeviceCreatedEventData event data for Microsoft.Devices.DeviceCreated event.

type IotHubDeviceDeletedEventData Uses

type IotHubDeviceDeletedEventData struct {
    // DeviceID - The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.
    DeviceID *string `json:"deviceId,omitempty"`
    // HubName - Name of the IoT Hub where the device was created or deleted.
    HubName *string `json:"hubName,omitempty"`
    // Twin - Information about the device twin, which is the cloud representation of application device metadata.
    Twin *DeviceTwinInfo `json:"twin,omitempty"`
}

IotHubDeviceDeletedEventData event data for Microsoft.Devices.DeviceDeleted event.

type IotHubDeviceDisconnectedEventData Uses

type IotHubDeviceDisconnectedEventData struct {
    // DeviceID - The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.
    DeviceID *string `json:"deviceId,omitempty"`
    // ModuleID - The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.
    ModuleID *string `json:"moduleId,omitempty"`
    // HubName - Name of the IoT Hub where the device was created or deleted.
    HubName *string `json:"hubName,omitempty"`
    // DeviceConnectionStateEventInfo - Information about the device connection state event.
    DeviceConnectionStateEventInfo *DeviceConnectionStateEventInfo `json:"deviceConnectionStateEventInfo,omitempty"`
}

IotHubDeviceDisconnectedEventData event data for Microsoft.Devices.DeviceDisconnected event.

type IotHubDeviceTelemetryEventData Uses

type IotHubDeviceTelemetryEventData struct {
    // Body - The content of the message from the device.
    Body interface{} `json:"body,omitempty"`
    // Properties - Application properties are user-defined strings that can be added to the message. These fields are optional.
    Properties map[string]*string `json:"properties"`
    // SystemProperties - System properties help identify contents and source of the messages.
    SystemProperties map[string]*string `json:"systemProperties"`
}

IotHubDeviceTelemetryEventData event data for Microsoft.Devices.DeviceTelemetry event.

func (IotHubDeviceTelemetryEventData) MarshalJSON Uses

func (ihdted IotHubDeviceTelemetryEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubDeviceTelemetryEventData.

type MapsGeofenceEnteredEventData Uses

type MapsGeofenceEnteredEventData struct {
    // ExpiredGeofenceGeometryID - Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
    ExpiredGeofenceGeometryID *[]string `json:"expiredGeofenceGeometryId,omitempty"`
    // Geometries - Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
    Geometries *[]MapsGeofenceGeometry `json:"geometries,omitempty"`
    // InvalidPeriodGeofenceGeometryID - Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
    InvalidPeriodGeofenceGeometryID *[]string `json:"invalidPeriodGeofenceGeometryId,omitempty"`
    // IsEventPublished - True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
    IsEventPublished *bool `json:"isEventPublished,omitempty"`
}

MapsGeofenceEnteredEventData schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.

type MapsGeofenceEventProperties Uses

type MapsGeofenceEventProperties struct {
    // ExpiredGeofenceGeometryID - Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
    ExpiredGeofenceGeometryID *[]string `json:"expiredGeofenceGeometryId,omitempty"`
    // Geometries - Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
    Geometries *[]MapsGeofenceGeometry `json:"geometries,omitempty"`
    // InvalidPeriodGeofenceGeometryID - Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
    InvalidPeriodGeofenceGeometryID *[]string `json:"invalidPeriodGeofenceGeometryId,omitempty"`
    // IsEventPublished - True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
    IsEventPublished *bool `json:"isEventPublished,omitempty"`
}

MapsGeofenceEventProperties schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).

type MapsGeofenceExitedEventData Uses

type MapsGeofenceExitedEventData struct {
    // ExpiredGeofenceGeometryID - Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
    ExpiredGeofenceGeometryID *[]string `json:"expiredGeofenceGeometryId,omitempty"`
    // Geometries - Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
    Geometries *[]MapsGeofenceGeometry `json:"geometries,omitempty"`
    // InvalidPeriodGeofenceGeometryID - Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
    InvalidPeriodGeofenceGeometryID *[]string `json:"invalidPeriodGeofenceGeometryId,omitempty"`
    // IsEventPublished - True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
    IsEventPublished *bool `json:"isEventPublished,omitempty"`
}

MapsGeofenceExitedEventData schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.

type MapsGeofenceGeometry Uses

type MapsGeofenceGeometry struct {
    // DeviceID - ID of the device.
    DeviceID *string `json:"deviceId,omitempty"`
    // Distance - Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.
    Distance *float64 `json:"distance,omitempty"`
    // GeometryID - The unique ID for the geofence geometry.
    GeometryID *string `json:"geometryId,omitempty"`
    // NearestLat - Latitude of the nearest point of the geometry.
    NearestLat *float64 `json:"nearestLat,omitempty"`
    // NearestLon - Longitude of the nearest point of the geometry.
    NearestLon *float64 `json:"nearestLon,omitempty"`
    // UdID - The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.
    UdID *string `json:"udId,omitempty"`
}

MapsGeofenceGeometry the geofence geometry.

type MapsGeofenceResultEventData Uses

type MapsGeofenceResultEventData struct {
    // ExpiredGeofenceGeometryID - Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
    ExpiredGeofenceGeometryID *[]string `json:"expiredGeofenceGeometryId,omitempty"`
    // Geometries - Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
    Geometries *[]MapsGeofenceGeometry `json:"geometries,omitempty"`
    // InvalidPeriodGeofenceGeometryID - Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
    InvalidPeriodGeofenceGeometryID *[]string `json:"invalidPeriodGeofenceGeometryId,omitempty"`
    // IsEventPublished - True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
    IsEventPublished *bool `json:"isEventPublished,omitempty"`
}

MapsGeofenceResultEventData schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.

type MediaJobCanceledEventData Uses

type MediaJobCanceledEventData struct {
    // Outputs - Gets the Job outputs.
    Outputs *[]BasicMediaJobOutput `json:"outputs,omitempty"`
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // State - READ-ONLY; The new state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    State MediaJobState `json:"state,omitempty"`
    // CorrelationData - Gets the Job correlation data.
    CorrelationData map[string]*string `json:"correlationData"`
}

MediaJobCanceledEventData job canceled event data

func (MediaJobCanceledEventData) MarshalJSON Uses

func (mjced MediaJobCanceledEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobCanceledEventData.

func (*MediaJobCanceledEventData) UnmarshalJSON Uses

func (mjced *MediaJobCanceledEventData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaJobCanceledEventData struct.

type MediaJobCancelingEventData Uses

type MediaJobCancelingEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // State - READ-ONLY; The new state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    State MediaJobState `json:"state,omitempty"`
    // CorrelationData - Gets the Job correlation data.
    CorrelationData map[string]*string `json:"correlationData"`
}

MediaJobCancelingEventData job canceling event data

func (MediaJobCancelingEventData) MarshalJSON Uses

func (mjced MediaJobCancelingEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobCancelingEventData.

type MediaJobError Uses

type MediaJobError struct {
    // Code - READ-ONLY; Error code describing the error. Possible values include: 'ServiceError', 'ServiceTransientError', 'DownloadNotAccessible', 'DownloadTransientError', 'UploadNotAccessible', 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', 'ContentUnsupported'
    Code MediaJobErrorCode `json:"code,omitempty"`
    // Message - READ-ONLY; A human-readable language-dependent representation of the error.
    Message *string `json:"message,omitempty"`
    // Category - READ-ONLY; Helps with categorization of errors. Possible values include: 'Service', 'Download', 'Upload', 'Configuration', 'Content'
    Category MediaJobErrorCategory `json:"category,omitempty"`
    // Retry - READ-ONLY; Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. Possible values include: 'DoNotRetry', 'MayRetry'
    Retry MediaJobRetry `json:"retry,omitempty"`
    // Details - READ-ONLY; An array of details about specific errors that led to this reported error.
    Details *[]MediaJobErrorDetail `json:"details,omitempty"`
}

MediaJobError details of JobOutput errors.

type MediaJobErrorCategory Uses

type MediaJobErrorCategory string

MediaJobErrorCategory enumerates the values for media job error category.

const (
    // Configuration The error is configuration related.
    Configuration MediaJobErrorCategory = "Configuration"
    // Content The error is related to data in the input files.
    Content MediaJobErrorCategory = "Content"
    // Download The error is download related.
    Download MediaJobErrorCategory = "Download"
    // Service The error is service related.
    Service MediaJobErrorCategory = "Service"
    // Upload The error is upload related.
    Upload MediaJobErrorCategory = "Upload"
)

func PossibleMediaJobErrorCategoryValues Uses

func PossibleMediaJobErrorCategoryValues() []MediaJobErrorCategory

PossibleMediaJobErrorCategoryValues returns an array of possible values for the MediaJobErrorCategory const type.

type MediaJobErrorCode Uses

type MediaJobErrorCode string

MediaJobErrorCode enumerates the values for media job error code.

const (
    // ConfigurationUnsupported There was a problem with the combination of input files and the configuration
    // settings applied, fix the configuration settings and retry with the same input, or change input to match
    // the configuration.
    ConfigurationUnsupported MediaJobErrorCode = "ConfigurationUnsupported"
    // ContentMalformed There was a problem with the input content (for example: zero byte files, or
    // corrupt/non-decodable files), check the input files.
    ContentMalformed MediaJobErrorCode = "ContentMalformed"
    // ContentUnsupported There was a problem with the format of the input (not valid media file, or an
    // unsupported file/codec), check the validity of the input files.
    ContentUnsupported MediaJobErrorCode = "ContentUnsupported"
    // DownloadNotAccessible While trying to download the input files, the files were not accessible, please
    // check the availability of the source.
    DownloadNotAccessible MediaJobErrorCode = "DownloadNotAccessible"
    // DownloadTransientError While trying to download the input files, there was an issue during transfer
    // (storage service, network errors), see details and check your source.
    DownloadTransientError MediaJobErrorCode = "DownloadTransientError"
    // ServiceError Fatal service error, please contact support.
    ServiceError MediaJobErrorCode = "ServiceError"
    // ServiceTransientError Transient error, please retry, if retry is unsuccessful, please contact support.
    ServiceTransientError MediaJobErrorCode = "ServiceTransientError"
    // UploadNotAccessible While trying to upload the output files, the destination was not reachable, please
    // check the availability of the destination.
    UploadNotAccessible MediaJobErrorCode = "UploadNotAccessible"
    // UploadTransientError While trying to upload the output files, there was an issue during transfer
    // (storage service, network errors), see details and check your destination.
    UploadTransientError MediaJobErrorCode = "UploadTransientError"
)

func PossibleMediaJobErrorCodeValues Uses

func PossibleMediaJobErrorCodeValues() []MediaJobErrorCode

PossibleMediaJobErrorCodeValues returns an array of possible values for the MediaJobErrorCode const type.

type MediaJobErrorDetail Uses

type MediaJobErrorDetail struct {
    // Code - READ-ONLY; Code describing the error detail.
    Code *string `json:"code,omitempty"`
    // Message - READ-ONLY; A human-readable representation of the error.
    Message *string `json:"message,omitempty"`
}

MediaJobErrorDetail details of JobOutput errors.

type MediaJobErroredEventData Uses

type MediaJobErroredEventData struct {
    // Outputs - Gets the Job outputs.
    Outputs *[]BasicMediaJobOutput `json:"outputs,omitempty"`
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // State - READ-ONLY; The new state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    State MediaJobState `json:"state,omitempty"`
    // CorrelationData - Gets the Job correlation data.
    CorrelationData map[string]*string `json:"correlationData"`
}

MediaJobErroredEventData job error state event data

func (MediaJobErroredEventData) MarshalJSON Uses

func (mjeed MediaJobErroredEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobErroredEventData.

func (*MediaJobErroredEventData) UnmarshalJSON Uses

func (mjeed *MediaJobErroredEventData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaJobErroredEventData struct.

type MediaJobFinishedEventData Uses

type MediaJobFinishedEventData struct {
    // Outputs - Gets the Job outputs.
    Outputs *[]BasicMediaJobOutput `json:"outputs,omitempty"`
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // State - READ-ONLY; The new state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    State MediaJobState `json:"state,omitempty"`
    // CorrelationData - Gets the Job correlation data.
    CorrelationData map[string]*string `json:"correlationData"`
}

MediaJobFinishedEventData job finished event data

func (MediaJobFinishedEventData) MarshalJSON Uses

func (mjfed MediaJobFinishedEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobFinishedEventData.

func (*MediaJobFinishedEventData) UnmarshalJSON Uses

func (mjfed *MediaJobFinishedEventData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaJobFinishedEventData struct.

type MediaJobOutput Uses

type MediaJobOutput struct {
    // Error - Gets the Job output error.
    Error *MediaJobError `json:"error,omitempty"`
    // Label - Gets the Job output label.
    Label *string `json:"label,omitempty"`
    // Progress - Gets the Job output progress.
    Progress *int64 `json:"progress,omitempty"`
    // State - Gets the Job output state. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    State MediaJobState `json:"state,omitempty"`
    // OdataType - Possible values include: 'OdataTypeMediaJobOutput', 'OdataTypeMicrosoftMediaJobOutputAsset'
    OdataType OdataType `json:"@odata.type,omitempty"`
}

MediaJobOutput the event data for a Job output.

func (MediaJobOutput) AsBasicMediaJobOutput Uses

func (mjo MediaJobOutput) AsBasicMediaJobOutput() (BasicMediaJobOutput, bool)

AsBasicMediaJobOutput is the BasicMediaJobOutput implementation for MediaJobOutput.

func (MediaJobOutput) AsMediaJobOutput Uses

func (mjo MediaJobOutput) AsMediaJobOutput() (*MediaJobOutput, bool)

AsMediaJobOutput is the BasicMediaJobOutput implementation for MediaJobOutput.

func (MediaJobOutput) AsMediaJobOutputAsset Uses

func (mjo MediaJobOutput) AsMediaJobOutputAsset() (*MediaJobOutputAsset, bool)

AsMediaJobOutputAsset is the BasicMediaJobOutput implementation for MediaJobOutput.

func (MediaJobOutput) MarshalJSON Uses

func (mjo MediaJobOutput) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobOutput.

type MediaJobOutputAsset Uses

type MediaJobOutputAsset struct {
    // AssetName - Gets the Job output asset name.
    AssetName *string `json:"assetName,omitempty"`
    // Error - Gets the Job output error.
    Error *MediaJobError `json:"error,omitempty"`
    // Label - Gets the Job output label.
    Label *string `json:"label,omitempty"`
    // Progress - Gets the Job output progress.
    Progress *int64 `json:"progress,omitempty"`
    // State - Gets the Job output state. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    State MediaJobState `json:"state,omitempty"`
    // OdataType - Possible values include: 'OdataTypeMediaJobOutput', 'OdataTypeMicrosoftMediaJobOutputAsset'
    OdataType OdataType `json:"@odata.type,omitempty"`
}

MediaJobOutputAsset the event data for a Job output asset.

func (MediaJobOutputAsset) AsBasicMediaJobOutput Uses

func (mjoa MediaJobOutputAsset) AsBasicMediaJobOutput() (BasicMediaJobOutput, bool)

AsBasicMediaJobOutput is the BasicMediaJobOutput implementation for MediaJobOutputAsset.

func (MediaJobOutputAsset) AsMediaJobOutput Uses

func (mjoa MediaJobOutputAsset) AsMediaJobOutput() (*MediaJobOutput, bool)

AsMediaJobOutput is the BasicMediaJobOutput implementation for MediaJobOutputAsset.

func (MediaJobOutputAsset) AsMediaJobOutputAsset Uses

func (mjoa MediaJobOutputAsset) AsMediaJobOutputAsset() (*MediaJobOutputAsset, bool)

AsMediaJobOutputAsset is the BasicMediaJobOutput implementation for MediaJobOutputAsset.

func (MediaJobOutputAsset) MarshalJSON Uses

func (mjoa MediaJobOutputAsset) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobOutputAsset.

type MediaJobOutputCanceledEventData Uses

type MediaJobOutputCanceledEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // Output - Gets the output.
    Output BasicMediaJobOutput `json:"output,omitempty"`
    // JobCorrelationData - Gets the Job correlation data.
    JobCorrelationData map[string]*string `json:"jobCorrelationData"`
}

MediaJobOutputCanceledEventData job output canceled event data

func (MediaJobOutputCanceledEventData) MarshalJSON Uses

func (mjoced MediaJobOutputCanceledEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobOutputCanceledEventData.

func (*MediaJobOutputCanceledEventData) UnmarshalJSON Uses

func (mjoced *MediaJobOutputCanceledEventData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaJobOutputCanceledEventData struct.

type MediaJobOutputCancelingEventData Uses

type MediaJobOutputCancelingEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // Output - Gets the output.
    Output BasicMediaJobOutput `json:"output,omitempty"`
    // JobCorrelationData - Gets the Job correlation data.
    JobCorrelationData map[string]*string `json:"jobCorrelationData"`
}

MediaJobOutputCancelingEventData job output canceling event data

func (MediaJobOutputCancelingEventData) MarshalJSON Uses

func (mjoced MediaJobOutputCancelingEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobOutputCancelingEventData.

func (*MediaJobOutputCancelingEventData) UnmarshalJSON Uses

func (mjoced *MediaJobOutputCancelingEventData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaJobOutputCancelingEventData struct.

type MediaJobOutputErroredEventData Uses

type MediaJobOutputErroredEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // Output - Gets the output.
    Output BasicMediaJobOutput `json:"output,omitempty"`
    // JobCorrelationData - Gets the Job correlation data.
    JobCorrelationData map[string]*string `json:"jobCorrelationData"`
}

MediaJobOutputErroredEventData job output error event data

func (MediaJobOutputErroredEventData) MarshalJSON Uses

func (mjoeed MediaJobOutputErroredEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobOutputErroredEventData.

func (*MediaJobOutputErroredEventData) UnmarshalJSON Uses

func (mjoeed *MediaJobOutputErroredEventData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaJobOutputErroredEventData struct.

type MediaJobOutputFinishedEventData Uses

type MediaJobOutputFinishedEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // Output - Gets the output.
    Output BasicMediaJobOutput `json:"output,omitempty"`
    // JobCorrelationData - Gets the Job correlation data.
    JobCorrelationData map[string]*string `json:"jobCorrelationData"`
}

MediaJobOutputFinishedEventData job output finished event data

func (MediaJobOutputFinishedEventData) MarshalJSON Uses

func (mjofed MediaJobOutputFinishedEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobOutputFinishedEventData.

func (*MediaJobOutputFinishedEventData) UnmarshalJSON Uses

func (mjofed *MediaJobOutputFinishedEventData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaJobOutputFinishedEventData struct.

type MediaJobOutputProcessingEventData Uses

type MediaJobOutputProcessingEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // Output - Gets the output.
    Output BasicMediaJobOutput `json:"output,omitempty"`
    // JobCorrelationData - Gets the Job correlation data.
    JobCorrelationData map[string]*string `json:"jobCorrelationData"`
}

MediaJobOutputProcessingEventData job output processing event data

func (MediaJobOutputProcessingEventData) MarshalJSON Uses

func (mjoped MediaJobOutputProcessingEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobOutputProcessingEventData.

func (*MediaJobOutputProcessingEventData) UnmarshalJSON Uses

func (mjoped *MediaJobOutputProcessingEventData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaJobOutputProcessingEventData struct.

type MediaJobOutputProgressEventData Uses

type MediaJobOutputProgressEventData struct {
    // Label - Gets the Job output label.
    Label *string `json:"label,omitempty"`
    // Progress - Gets the Job output progress.
    Progress *int64 `json:"progress,omitempty"`
    // JobCorrelationData - Gets the Job correlation data.
    JobCorrelationData map[string]*string `json:"jobCorrelationData"`
}

MediaJobOutputProgressEventData job Output Progress Event Data.

func (MediaJobOutputProgressEventData) MarshalJSON Uses

func (mjoped MediaJobOutputProgressEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobOutputProgressEventData.

type MediaJobOutputScheduledEventData Uses

type MediaJobOutputScheduledEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // Output - Gets the output.
    Output BasicMediaJobOutput `json:"output,omitempty"`
    // JobCorrelationData - Gets the Job correlation data.
    JobCorrelationData map[string]*string `json:"jobCorrelationData"`
}

MediaJobOutputScheduledEventData job output scheduled event data

func (MediaJobOutputScheduledEventData) MarshalJSON Uses

func (mjosed MediaJobOutputScheduledEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobOutputScheduledEventData.

func (*MediaJobOutputScheduledEventData) UnmarshalJSON Uses

func (mjosed *MediaJobOutputScheduledEventData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaJobOutputScheduledEventData struct.

type MediaJobOutputStateChangeEventData Uses

type MediaJobOutputStateChangeEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // Output - Gets the output.
    Output BasicMediaJobOutput `json:"output,omitempty"`
    // JobCorrelationData - Gets the Job correlation data.
    JobCorrelationData map[string]*string `json:"jobCorrelationData"`
}

MediaJobOutputStateChangeEventData schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputStateChange event.

func (MediaJobOutputStateChangeEventData) MarshalJSON Uses

func (mjosced MediaJobOutputStateChangeEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobOutputStateChangeEventData.

func (*MediaJobOutputStateChangeEventData) UnmarshalJSON Uses

func (mjosced *MediaJobOutputStateChangeEventData) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaJobOutputStateChangeEventData struct.

type MediaJobProcessingEventData Uses

type MediaJobProcessingEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // State - READ-ONLY; The new state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    State MediaJobState `json:"state,omitempty"`
    // CorrelationData - Gets the Job correlation data.
    CorrelationData map[string]*string `json:"correlationData"`
}

MediaJobProcessingEventData job processing event data

func (MediaJobProcessingEventData) MarshalJSON Uses

func (mjped MediaJobProcessingEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobProcessingEventData.

type MediaJobRetry Uses

type MediaJobRetry string

MediaJobRetry enumerates the values for media job retry.

const (
    // DoNotRetry Issue needs to be investigated and then the job resubmitted with corrections or retried once
    // the underlying issue has been corrected.
    DoNotRetry MediaJobRetry = "DoNotRetry"
    // MayRetry Issue may be resolved after waiting for a period of time and resubmitting the same Job.
    MayRetry MediaJobRetry = "MayRetry"
)

func PossibleMediaJobRetryValues Uses

func PossibleMediaJobRetryValues() []MediaJobRetry

PossibleMediaJobRetryValues returns an array of possible values for the MediaJobRetry const type.

type MediaJobScheduledEventData Uses

type MediaJobScheduledEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // State - READ-ONLY; The new state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    State MediaJobState `json:"state,omitempty"`
    // CorrelationData - Gets the Job correlation data.
    CorrelationData map[string]*string `json:"correlationData"`
}

MediaJobScheduledEventData job scheduled event data

func (MediaJobScheduledEventData) MarshalJSON Uses

func (mjsed MediaJobScheduledEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobScheduledEventData.

type MediaJobState Uses

type MediaJobState string

MediaJobState enumerates the values for media job state.

const (
    // Canceled The job was canceled. This is a final state for the job.
    Canceled MediaJobState = "Canceled"
    // Canceling The job is in the process of being canceled. This is a transient state for the job.
    Canceling MediaJobState = "Canceling"
    // Error The job has encountered an error. This is a final state for the job.
    Error MediaJobState = "Error"
    // Finished The job is finished. This is a final state for the job.
    Finished MediaJobState = "Finished"
    // Processing The job is processing. This is a transient state for the job.
    Processing MediaJobState = "Processing"
    // Queued The job is in a queued state, waiting for resources to become available. This is a transient
    // state.
    Queued MediaJobState = "Queued"
    // Scheduled The job is being scheduled to run on an available resource. This is a transient state, between
    // queued and processing states.
    Scheduled MediaJobState = "Scheduled"
)

func PossibleMediaJobStateValues Uses

func PossibleMediaJobStateValues() []MediaJobState

PossibleMediaJobStateValues returns an array of possible values for the MediaJobState const type.

type MediaJobStateChangeEventData Uses

type MediaJobStateChangeEventData struct {
    // PreviousState - READ-ONLY; The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    PreviousState MediaJobState `json:"previousState,omitempty"`
    // State - READ-ONLY; The new state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'
    State MediaJobState `json:"state,omitempty"`
    // CorrelationData - Gets the Job correlation data.
    CorrelationData map[string]*string `json:"correlationData"`
}

MediaJobStateChangeEventData schema of the Data property of an EventGridEvent for a Microsoft.Media.JobStateChange event.

func (MediaJobStateChangeEventData) MarshalJSON Uses

func (mjsced MediaJobStateChangeEventData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaJobStateChangeEventData.

type MediaLiveEventConnectionRejectedEventData Uses

type MediaLiveEventConnectionRejectedEventData struct {
    // IngestURL - READ-ONLY; Gets the ingest URL provided by the live event.
    IngestURL *string `json:"ingestUrl,omitempty"`
    // StreamID - READ-ONLY; Gets the stream Id.
    StreamID *string `json:"streamId,omitempty"`
    // EncoderIP - READ-ONLY; Gets the remote IP.
    EncoderIP *string `json:"encoderIp,omitempty"`
    // EncoderPort - READ-ONLY; Gets the remote port.
    EncoderPort *string `json:"encoderPort,omitempty"`
    // ResultCode - READ-ONLY; Gets the result code.
    ResultCode *string `json:"resultCode,omitempty"`
}

MediaLiveEventConnectionRejectedEventData encoder connection rejected event data.

type MediaLiveEventEncoderConnectedEventData Uses

type MediaLiveEventEncoderConnectedEventData struct {
    // IngestURL - READ-ONLY; Gets the ingest URL provided by the live event.
    IngestURL *string `json:"ingestUrl,omitempty"`
    // StreamID - READ-ONLY; Gets the stream Id.
    StreamID *string `json:"streamId,omitempty"`
    // EncoderIP - READ-ONLY; Gets the remote IP.
    EncoderIP *string `json:"encoderIp,omitempty"`
    // EncoderPort - READ-ONLY; Gets the remote port.
    EncoderPort *string `json:"encoderPort,omitempty"`
}

MediaLiveEventEncoderConnectedEventData encoder connect event data.

type MediaLiveEventEncoderDisconnectedEventData Uses

type MediaLiveEventEncoderDisconnectedEventData struct {
    // IngestURL - READ-ONLY; Gets the ingest URL provided by the live event.
    IngestURL *string `json:"ingestUrl,omitempty"`
    // StreamID - READ-ONLY; Gets the stream Id.
    StreamID *string `json:"streamId,omitempty"`
    // EncoderIP - READ-ONLY; Gets the remote IP.
    EncoderIP *string `json:"encoderIp,omitempty"`
    // EncoderPort - READ-ONLY; Gets the remote port.
    EncoderPort *string `json:"encoderPort,omitempty"`
    // ResultCode - READ-ONLY; Gets the result code.
    ResultCode *string `json:"resultCode,omitempty"`
}

MediaLiveEventEncoderDisconnectedEventData encoder disconnected event data.

type MediaLiveEventIncomingDataChunkDroppedEventData Uses

type MediaLiveEventIncomingDataChunkDroppedEventData struct {
    // Timestamp - READ-ONLY; Gets the timestamp of the data chunk dropped.
    Timestamp *string `json:"timestamp,omitempty"`
    // TrackType - READ-ONLY; Gets the type of the track (Audio / Video).
    TrackType *string `json:"trackType,omitempty"`
    // Bitrate - READ-ONLY; Gets the bitrate of the track.
    Bitrate *int64 `json:"bitrate,omitempty"`
    // Timescale - READ-ONLY; Gets the timescale of the Timestamp.
    Timescale *string `json:"timescale,omitempty"`
    // ResultCode - READ-ONLY; Gets the result code for fragment drop operation.
    ResultCode *string `json:"resultCode,omitempty"`
    // TrackName - READ-ONLY; Gets the name of the track for which fragment is dropped.
    TrackName *string `json:"trackName,omitempty"`
}

MediaLiveEventIncomingDataChunkDroppedEventData ingest fragment dropped event data.

type MediaLiveEventIncomingStreamReceivedEventData Uses

type MediaLiveEventIncomingStreamReceivedEventData struct {
    // IngestURL - READ-ONLY; Gets the ingest URL provided by the live event.
    IngestURL *string `json:"ingestUrl,omitempty"`
    // TrackType - READ-ONLY; Gets the type of the track (Audio / Video).
    TrackType *string `json:"trackType,omitempty"`
    // TrackName - READ-ONLY; Gets the track name.
    TrackName *string `json:"trackName,omitempty"`
    // Bitrate - READ-ONLY; Gets the bitrate of the track.
    Bitrate *int64 `json:"bitrate,omitempty"`
    // EncoderIP - READ-ONLY; Gets the remote IP.
    EncoderIP *string `json:"encoderIp,omitempty"`
    // EncoderPort - READ-ONLY; Gets the remote port.
    EncoderPort *string `json:"encoderPort,omitempty"`
    // Timestamp - READ-ONLY; Gets the first timestamp of the data chunk received.
    Timestamp *string `json:"timestamp,omitempty"`
    // Duration - READ-ONLY; Gets the duration of the first data chunk.
    Duration *string `json:"duration,omitempty"`
    // Timescale - READ-ONLY; Gets the timescale in which timestamp is represented.
    Timescale *string `json:"timescale,omitempty"`
}

MediaLiveEventIncomingStreamReceivedEventData encoder connect event data.

type MediaLiveEventIncomingStreamsOutOfSyncEventData Uses

type MediaLiveEventIncomingStreamsOutOfSyncEventData struct {
    // MinLastTimestamp - READ-ONLY; Gets the minimum last timestamp received.
    MinLastTimestamp *string `json:"minLastTimestamp,omitempty"`
    // TypeOfStreamWithMinLastTimestamp - READ-ONLY; Gets the type of stream with minimum last timestamp.
    TypeOfStreamWithMinLastTimestamp *string `json:"typeOfStreamWithMinLastTimestamp,omitempty"`
    // MaxLastTimestamp - READ-ONLY; Gets the maximum timestamp among all the tracks (audio or video).
    MaxLastTimestamp *string `json:"maxLastTimestamp,omitempty"`
    // TypeOfStreamWithMaxLastTimestamp - READ-ONLY; Gets the type of stream with maximum last timestamp.
    TypeOfStreamWithMaxLastTimestamp *string `json:"typeOfStreamWithMaxLastTimestamp,omitempty"`
    // TimescaleOfMinLastTimestamp - READ-ONLY; Gets the timescale in which "MinLastTimestamp" is represented.
    TimescaleOfMinLastTimestamp *string `json:"timescaleOfMinLastTimestamp,omitempty"`
    // TimescaleOfMaxLastTimestamp - READ-ONLY; Gets the timescale in which "MaxLastTimestamp" is represented.
    TimescaleOfMaxLastTimestamp *string `json:"timescaleOfMaxLastTimestamp,omitempty"`
}

MediaLiveEventIncomingStreamsOutOfSyncEventData incoming streams out of sync event data.

type MediaLiveEventIncomingVideoStreamsOutOfSyncEventData Uses

type MediaLiveEventIncomingVideoStreamsOutOfSyncEventData struct {
    // FirstTimestamp - READ-ONLY; Gets the first timestamp received for one of the quality levels.
    FirstTimestamp *string `json:"firstTimestamp,omitempty"`
    // FirstDuration - READ-ONLY; Gets the duration of the data chunk with first timestamp.
    FirstDuration *string `json:"firstDuration,omitempty"`
    // SecondTimestamp - READ-ONLY; Gets the timestamp received for some other quality levels.
    SecondTimestamp *string `json:"secondTimestamp,omitempty"`
    // SecondDuration - READ-ONLY; Gets the duration of the data chunk with second timestamp.
    SecondDuration *string `json:"secondDuration,omitempty"`
    // Timescale - READ-ONLY; Gets the timescale in which both the timestamps and durations are represented.
    Timescale *string `json:"timescale,omitempty"`
}

MediaLiveEventIncomingVideoStreamsOutOfSyncEventData incoming video stream out of synch event data.

type MediaLiveEventIngestHeartbeatEventData Uses

type MediaLiveEventIngestHeartbeatEventData struct {
    // TrackType - READ-ONLY; Gets the type of the track (Audio / Video).
    TrackType *string `json:"trackType,omitempty"`
    // TrackName - READ-ONLY; Gets the track name.
    TrackName *string `json:"trackName,omitempty"`
    // Bitrate - READ-ONLY; Gets the bitrate of the track.
    Bitrate *int64 `json:"bitrate,omitempty"`
    // IncomingBitrate - READ-ONLY; Gets the incoming bitrate.
    IncomingBitrate *int64 `json:"incomingBitrate,omitempty"`
    // LastTimestamp - READ-ONLY; Gets the last timestamp.
    LastTimestamp *string `json:"lastTimestamp,omitempty"`
    // Timescale - READ-ONLY; Gets the timescale of the last timestamp.
    Timescale *string `json:"timescale,omitempty"`
    // OverlapCount - READ-ONLY; Gets the fragment Overlap count.
    OverlapCount *int64 `json:"overlapCount,omitempty"`
    // DiscontinuityCount - READ-ONLY; Gets the fragment Discontinuity count.
    DiscontinuityCount *int64 `json:"discontinuityCount,omitempty"`
    // NonincreasingCount - READ-ONLY; Gets Non increasing count.
    NonincreasingCount *int64 `json:"nonincreasingCount,omitempty"`
    // UnexpectedBitrate - READ-ONLY; Gets a value indicating whether unexpected bitrate is present or not.
    UnexpectedBitrate *bool `json:"unexpectedBitrate,omitempty"`
    // State - READ-ONLY; Gets the state of the live event.
    State *string `json:"state,omitempty"`
    // Healthy - READ-ONLY; Gets a value indicating whether preview is healthy or not.
    Healthy *bool `json:"healthy,omitempty"`
}

MediaLiveEventIngestHeartbeatEventData ingest fragment dropped event data.

type MediaLiveEventTrackDiscontinuityDetectedEventData Uses

type MediaLiveEventTrackDiscontinuityDetectedEventData struct {
    // TrackType - READ-ONLY; Gets the type of the track (Audio / Video).
    TrackType *string `json:"trackType,omitempty"`
    // TrackName - READ-ONLY; Gets the track name.
    TrackName *string `json:"trackName,omitempty"`
    // Bitrate - READ-ONLY; Gets the bitrate.
    Bitrate *int64 `json:"bitrate,omitempty"`
    // PreviousTimestamp - READ-ONLY; Gets the timestamp of the previous fragment.
    PreviousTimestamp *string `json:"previousTimestamp,omitempty"`
    // NewTimestamp - READ-ONLY; Gets the timestamp of the current fragment.
    NewTimestamp *string `json:"newTimestamp,omitempty"`
    // Timescale - READ-ONLY; Gets the timescale in which both timestamps and discontinuity gap are represented.
    Timescale *string `json:"timescale,omitempty"`
    // DiscontinuityGap - READ-ONLY; Gets the discontinuity gap between PreviousTimestamp and NewTimestamp.
    DiscontinuityGap *string `json:"discontinuityGap,omitempty"`
}

MediaLiveEventTrackDiscontinuityDetectedEventData ingest track discontinuity detected event data.

type OdataType Uses

type OdataType string

OdataType enumerates the values for odata type.

const (
    // OdataTypeMediaJobOutput ...
    OdataTypeMediaJobOutput OdataType = "MediaJobOutput"
    // OdataTypeMicrosoftMediaJobOutputAsset ...
    OdataTypeMicrosoftMediaJobOutputAsset OdataType = "#Microsoft.Media.JobOutputAsset"
)

func PossibleOdataTypeValues Uses

func PossibleOdataTypeValues() []OdataType

PossibleOdataTypeValues returns an array of possible values for the OdataType const type.

type ResourceActionCancelData Uses

type ResourceActionCancelData struct {
    // TenantID - The tenant ID of the resource.
    TenantID *string `json:"tenantId,omitempty"`
    // SubscriptionID - The subscription ID of the resource.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The resource group of the resource.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // ResourceProvider - The resource provider performing the operation.
    ResourceProvider *string `json:"resourceProvider,omitempty"`
    // ResourceURI - The URI of the resource in the operation.
    ResourceURI *string `json:"resourceUri,omitempty"`
    // OperationName - The operation that was performed.
    OperationName *string `json:"operationName,omitempty"`
    // Status - The status of the operation.
    Status *string `json:"status,omitempty"`
    // Authorization - The requested authorization for the operation.
    Authorization *string `json:"authorization,omitempty"`
    // Claims - The properties of the claims.
    Claims *string `json:"claims,omitempty"`
    // CorrelationID - An operation ID used for troubleshooting.
    CorrelationID *string `json:"correlationId,omitempty"`
    // HTTPRequest - The details of the operation.
    HTTPRequest *string `json:"httpRequest,omitempty"`
}

ResourceActionCancelData schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.

type ResourceActionFailureData Uses

type ResourceActionFailureData struct {
    // TenantID - The tenant ID of the resource.
    TenantID *string `json:"tenantId,omitempty"`
    // SubscriptionID - The subscription ID of the resource.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The resource group of the resource.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // ResourceProvider - The resource provider performing the operation.
    ResourceProvider *string `json:"resourceProvider,omitempty"`
    // ResourceURI - The URI of the resource in the operation.
    ResourceURI *string `json:"resourceUri,omitempty"`
    // OperationName - The operation that was performed.
    OperationName *string `json:"operationName,omitempty"`
    // Status - The status of the operation.
    Status *string `json:"status,omitempty"`
    // Authorization - The requested authorization for the operation.
    Authorization *string `json:"authorization,omitempty"`
    // Claims - The properties of the claims.
    Claims *string `json:"claims,omitempty"`
    // CorrelationID - An operation ID used for troubleshooting.
    CorrelationID *string `json:"correlationId,omitempty"`
    // HTTPRequest - The details of the operation.
    HTTPRequest *string `json:"httpRequest,omitempty"`
}

ResourceActionFailureData schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.

type ResourceActionSuccessData Uses

type ResourceActionSuccessData struct {
    // TenantID - The tenant ID of the resource.
    TenantID *string `json:"tenantId,omitempty"`
    // SubscriptionID - The subscription ID of the resource.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The resource group of the resource.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // ResourceProvider - The resource provider performing the operation.
    ResourceProvider *string `json:"resourceProvider,omitempty"`
    // ResourceURI - The URI of the resource in the operation.
    ResourceURI *string `json:"resourceUri,omitempty"`
    // OperationName - The operation that was performed.
    OperationName *string `json:"operationName,omitempty"`
    // Status - The status of the operation.
    Status *string `json:"status,omitempty"`
    // Authorization - The requested authorization for the operation.
    Authorization *string `json:"authorization,omitempty"`
    // Claims - The properties of the claims.
    Claims *string `json:"claims,omitempty"`
    // CorrelationID - An operation ID used for troubleshooting.
    CorrelationID *string `json:"correlationId,omitempty"`
    // HTTPRequest - The details of the operation.
    HTTPRequest *string `json:"httpRequest,omitempty"`
}

ResourceActionSuccessData schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.

type ResourceDeleteCancelData Uses

type ResourceDeleteCancelData struct {
    // TenantID - The tenant ID of the resource.
    TenantID *string `json:"tenantId,omitempty"`
    // SubscriptionID - The subscription ID of the resource.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The resource group of the resource.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // ResourceProvider - The resource provider performing the operation.
    ResourceProvider *string `json:"resourceProvider,omitempty"`
    // ResourceURI - The URI of the resource in the operation.
    ResourceURI *string `json:"resourceUri,omitempty"`
    // OperationName - The operation that was performed.
    OperationName *string `json:"operationName,omitempty"`
    // Status - The status of the operation.
    Status *string `json:"status,omitempty"`
    // Authorization - The requested authorization for the operation.
    Authorization *string `json:"authorization,omitempty"`
    // Claims - The properties of the claims.
    Claims *string `json:"claims,omitempty"`
    // CorrelationID - An operation ID used for troubleshooting.
    CorrelationID *string `json:"correlationId,omitempty"`
    // HTTPRequest - The details of the operation.
    HTTPRequest *string `json:"httpRequest,omitempty"`
}

ResourceDeleteCancelData schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.

type ResourceDeleteFailureData Uses

type ResourceDeleteFailureData struct {
    // TenantID - The tenant ID of the resource.
    TenantID *string `json:"tenantId,omitempty"`
    // SubscriptionID - The subscription ID of the resource.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The resource group of the resource.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // ResourceProvider - The resource provider performing the operation.
    ResourceProvider *string `json:"resourceProvider,omitempty"`
    // ResourceURI - The URI of the resource in the operation.
    ResourceURI *string `json:"resourceUri,omitempty"`
    // OperationName - The operation that was performed.
    OperationName *string `json:"operationName,omitempty"`
    // Status - The status of the operation.
    Status *string `json:"status,omitempty"`
    // Authorization - The requested authorization for the operation.
    Authorization *string `json:"authorization,omitempty"`
    // Claims - The properties of the claims.
    Claims *string `json:"claims,omitempty"`
    // CorrelationID - An operation ID used for troubleshooting.
    CorrelationID *string `json:"correlationId,omitempty"`
    // HTTPRequest - The details of the operation.
    HTTPRequest *string `json:"httpRequest,omitempty"`
}

ResourceDeleteFailureData schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.

type ResourceDeleteSuccessData Uses

type ResourceDeleteSuccessData struct {
    // TenantID - The tenant ID of the resource.
    TenantID *string `json:"tenantId,omitempty"`
    // SubscriptionID - The subscription ID of the resource.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The resource group of the resource.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // ResourceProvider - The resource provider performing the operation.
    ResourceProvider *string `json:"resourceProvider,omitempty"`
    // ResourceURI - The URI of the resource in the operation.
    ResourceURI *string `json:"resourceUri,omitempty"`
    // OperationName - The operation that was performed.
    OperationName *string `json:"operationName,omitempty"`
    // Status - The status of the operation.
    Status *string `json:"status,omitempty"`
    // Authorization - The requested authorization for the operation.
    Authorization *string `json:"authorization,omitempty"`
    // Claims - The properties of the claims.
    Claims *string `json:"claims,omitempty"`
    // CorrelationID - An operation ID used for troubleshooting.
    CorrelationID *string `json:"correlationId,omitempty"`
    // HTTPRequest - The details of the operation.
    HTTPRequest *string `json:"httpRequest,omitempty"`
}

ResourceDeleteSuccessData schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.

type ResourceWriteCancelData Uses

type ResourceWriteCancelData struct {
    // TenantID - The tenant ID of the resource.
    TenantID *string `json:"tenantId,omitempty"`
    // SubscriptionID - The subscription ID of the resource.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The resource group of the resource.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // ResourceProvider - The resource provider performing the operation.
    ResourceProvider *string `json:"resourceProvider,omitempty"`
    // ResourceURI - The URI of the resource in the operation.
    ResourceURI *string `json:"resourceUri,omitempty"`
    // OperationName - The operation that was performed.
    OperationName *string `json:"operationName,omitempty"`
    // Status - The status of the operation.
    Status *string `json:"status,omitempty"`
    // Authorization - The requested authorization for the operation.
    Authorization *string `json:"authorization,omitempty"`
    // Claims - The properties of the claims.
    Claims *string `json:"claims,omitempty"`
    // CorrelationID - An operation ID used for troubleshooting.
    CorrelationID *string `json:"correlationId,omitempty"`
    // HTTPRequest - The details of the operation.
    HTTPRequest *string `json:"httpRequest,omitempty"`
}

ResourceWriteCancelData schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled.

type ResourceWriteFailureData Uses

type ResourceWriteFailureData struct {
    // TenantID - The tenant ID of the resource.
    TenantID *string `json:"tenantId,omitempty"`
    // SubscriptionID - The subscription ID of the resource.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The resource group of the resource.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // ResourceProvider - The resource provider performing the operation.
    ResourceProvider *string `json:"resourceProvider,omitempty"`
    // ResourceURI - The URI of the resource in the operation.
    ResourceURI *string `json:"resourceUri,omitempty"`
    // OperationName - The operation that was performed.
    OperationName *string `json:"operationName,omitempty"`
    // Status - The status of the operation.
    Status *string `json:"status,omitempty"`
    // Authorization - The requested authorization for the operation.
    Authorization *string `json:"authorization,omitempty"`
    // Claims - The properties of the claims.
    Claims *string `json:"claims,omitempty"`
    // CorrelationID - An operation ID used for troubleshooting.
    CorrelationID *string `json:"correlationId,omitempty"`
    // HTTPRequest - The details of the operation.
    HTTPRequest *string `json:"httpRequest,omitempty"`
}

ResourceWriteFailureData schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure event. This is raised when a resource create or update operation fails.

type ResourceWriteSuccessData Uses

type ResourceWriteSuccessData struct {
    // TenantID - The tenant ID of the resource.
    TenantID *string `json:"tenantId,omitempty"`
    // SubscriptionID - The subscription ID of the resource.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The resource group of the resource.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // ResourceProvider - The resource provider performing the operation.
    ResourceProvider *string `json:"resourceProvider,omitempty"`
    // ResourceURI - The URI of the resource in the operation.
    ResourceURI *string `json:"resourceUri,omitempty"`
    // OperationName - The operation that was performed.
    OperationName *string `json:"operationName,omitempty"`
    // Status - The status of the operation.
    Status *string `json:"status,omitempty"`
    // Authorization - The requested authorization for the operation.
    Authorization *string `json:"authorization,omitempty"`
    // Claims - The properties of the claims.
    Claims *string `json:"claims,omitempty"`
    // CorrelationID - An operation ID used for troubleshooting.
    CorrelationID *string `json:"correlationId,omitempty"`
    // HTTPRequest - The details of the operation.
    HTTPRequest *string `json:"httpRequest,omitempty"`
}

ResourceWriteSuccessData schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess event. This is raised when a resource create or update operation succeeds.

type ServiceBusActiveMessagesAvailableWithNoListenersEventData Uses

type ServiceBusActiveMessagesAvailableWithNoListenersEventData struct {
    // NamespaceName - The namespace name of the Microsoft.ServiceBus resource.
    NamespaceName *string `json:"namespaceName,omitempty"`
    // RequestURI - The endpoint of the Microsoft.ServiceBus resource.
    RequestURI *string `json:"requestUri,omitempty"`
    // EntityType - The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'.
    EntityType *string `json:"entityType,omitempty"`
    // QueueName - The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null.
    QueueName *string `json:"queueName,omitempty"`
    // TopicName - The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null.
    TopicName *string `json:"topicName,omitempty"`
    // SubscriptionName - The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null.
    SubscriptionName *string `json:"subscriptionName,omitempty"`
}

ServiceBusActiveMessagesAvailableWithNoListenersEventData schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.

type ServiceBusDeadletterMessagesAvailableWithNoListenersEventData Uses

type ServiceBusDeadletterMessagesAvailableWithNoListenersEventData struct {
    // NamespaceName - The namespace name of the Microsoft.ServiceBus resource.
    NamespaceName *string `json:"namespaceName,omitempty"`
    // RequestURI - The endpoint of the Microsoft.ServiceBus resource.
    RequestURI *string `json:"requestUri,omitempty"`
    // EntityType - The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'.
    EntityType *string `json:"entityType,omitempty"`
    // QueueName - The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null.
    QueueName *string `json:"queueName,omitempty"`
    // TopicName - The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null.
    TopicName *string `json:"topicName,omitempty"`
    // SubscriptionName - The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null.
    SubscriptionName *string `json:"subscriptionName,omitempty"`
}

ServiceBusDeadletterMessagesAvailableWithNoListenersEventData schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListenersEvent event.

type SignalRServiceClientConnectionConnectedEventData Uses

type SignalRServiceClientConnectionConnectedEventData struct {
    // Timestamp - The time at which the event occurred.
    Timestamp *date.Time `json:"timestamp,omitempty"`
    // HubName - The hub of connected client connection.
    HubName *string `json:"hubName,omitempty"`
    // ConnectionID - The connection Id of connected client connection.
    ConnectionID *string `json:"connectionId,omitempty"`
    // UserID - The user Id of connected client connection.
    UserID *string `json:"userId,omitempty"`
}

SignalRServiceClientConnectionConnectedEventData schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionConnected event.

type SignalRServiceClientConnectionDisconnectedEventData Uses

type SignalRServiceClientConnectionDisconnectedEventData struct {
    // Timestamp - The time at which the event occurred.
    Timestamp *date.Time `json:"timestamp,omitempty"`
    // HubName - The hub of connected client connection.
    HubName *string `json:"hubName,omitempty"`
    // ConnectionID - The connection Id of connected client connection.
    ConnectionID *string `json:"connectionId,omitempty"`
    // UserID - The user Id of connected client connection.
    UserID *string `json:"userId,omitempty"`
    // ErrorMessage - The message of error that cause the client connection disconnected.
    ErrorMessage *string `json:"errorMessage,omitempty"`
}

SignalRServiceClientConnectionDisconnectedEventData schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionDisconnected event.

type StorageBlobCreatedEventData Uses

type StorageBlobCreatedEventData struct {
    // API - The name of the API/operation that triggered this event.
    API *string `json:"api,omitempty"`
    // ClientRequestID - A request id provided by the client of the storage API operation that triggered this event.
    ClientRequestID *string `json:"clientRequestId,omitempty"`
    // RequestID - The request id generated by the Storage service for the storage API operation that triggered this event.
    RequestID *string `json:"requestId,omitempty"`
    // ETag - The etag of the object at the time this event was triggered.
    ETag *string `json:"eTag,omitempty"`
    // ContentType - The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.
    ContentType *string `json:"contentType,omitempty"`
    // ContentLength - The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob.
    ContentLength *int64 `json:"contentLength,omitempty"`
    // BlobType - The type of blob.
    BlobType *string `json:"blobType,omitempty"`
    // URL - The path to the blob.
    URL *string `json:"url,omitempty"`
    // Sequencer - An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
    Sequencer *string `json:"sequencer,omitempty"`
    // StorageDiagnostics - For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.
    StorageDiagnostics interface{} `json:"storageDiagnostics,omitempty"`
}

StorageBlobCreatedEventData schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobCreated event.

type StorageBlobDeletedEventData Uses

type StorageBlobDeletedEventData struct {
    // API - The name of the API/operation that triggered this event.
    API *string `json:"api,omitempty"`
    // ClientRequestID - A request id provided by the client of the storage API operation that triggered this event.
    ClientRequestID *string `json:"clientRequestId,omitempty"`
    // RequestID - The request id generated by the Storage service for the storage API operation that triggered this event.
    RequestID *string `json:"requestId,omitempty"`
    // ContentType - The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.
    ContentType *string `json:"contentType,omitempty"`
    // BlobType - The type of blob.
    BlobType *string `json:"blobType,omitempty"`
    // URL - The path to the blob.
    URL *string `json:"url,omitempty"`
    // Sequencer - An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
    Sequencer *string `json:"sequencer,omitempty"`
    // StorageDiagnostics - For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.
    StorageDiagnostics interface{} `json:"storageDiagnostics,omitempty"`
}

StorageBlobDeletedEventData schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobDeleted event.

type SubscriptionDeletedEventData Uses

type SubscriptionDeletedEventData struct {
    // EventSubscriptionID - READ-ONLY; The Azure resource ID of the deleted event subscription.
    EventSubscriptionID *string `json:"eventSubscriptionId,omitempty"`
}

SubscriptionDeletedEventData schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionDeletedEvent.

type SubscriptionValidationEventData Uses

type SubscriptionValidationEventData struct {
    // ValidationCode - READ-ONLY; The validation code sent by Azure Event Grid to validate an event subscription. To complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response, or perform a GET request on the validationUrl (available starting version 2018-05-01-preview).
    ValidationCode *string `json:"validationCode,omitempty"`
    // ValidationURL - READ-ONLY; The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview). To complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response, or perform a GET request on the validationUrl (available starting version 2018-05-01-preview).
    ValidationURL *string `json:"validationUrl,omitempty"`
}

SubscriptionValidationEventData schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent.

type SubscriptionValidationResponse Uses

type SubscriptionValidationResponse struct {
    // ValidationResponse - The validation response sent by the subscriber to Azure Event Grid to complete the validation of an event subscription.
    ValidationResponse *string `json:"validationResponse,omitempty"`
}

SubscriptionValidationResponse to complete an event subscription validation handshake, a subscriber can use either the validationCode or the validationUrl received in a SubscriptionValidationEvent. When the validationCode is used, the SubscriptionValidationResponse can be used to build the response.

Directories

PathSynopsis
eventgridapi

Package eventgrid imports 9 packages (graph) and is imported by 4 packages. Updated 2019-07-30. Refresh now. Tools for package owners.