Storage.json

{
  "swagger": "2.0",
  "info": {
    "version": "2018-01-01",
    "title": "Schema of Azure Storage events published to Azure Event Grid",
    "description": "Describes the schema of the Azure Storage events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent."
  },
  "paths": {},
  "definitions": {
    "StorageBlobCreatedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobCreated event.",
      "type": "object",
      "properties": {
        "api": {
          "description": "The name of the API/operation that triggered this event.",
          "type": "string"
        },
        "clientRequestId": {
          "description": "A request id provided by the client of the storage API operation that triggered this event.",
          "type": "string"
        },
        "requestId": {
          "description": "The request id generated by the Storage service for the storage API operation that triggered this event.",
          "type": "string"
        },
        "eTag": {
          "description": "The etag of the blob at the time this event was triggered.",
          "type": "string"
        },
        "contentType": {
          "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.",
          "type": "string"
        },
        "contentLength": {
          "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob.",
          "type": "integer",
          "format": "int64"
        },
        "contentOffset": {
          "description": "The offset of the blob in bytes.",
          "type": "integer",
          "format": "int64"
        },
        "blobType": {
          "description": "The type of blob.",
          "type": "string"
        },
        "url": {
          "description": "The path to the blob.",
          "type": "string"
        },
        "sequencer": {
          "description": "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.",
          "type": "string"
        },
        "identity": {
          "description": "The identity of the requester that triggered this event.",
          "type": "string"
        },
        "storageDiagnostics": {
          "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.",
          "type": "object"
        }
      }
    },
    "StorageBlobDeletedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobDeleted event.",
      "type": "object",
      "properties": {
        "api": {
          "description": "The name of the API/operation that triggered this event.",
          "type": "string"
        },
        "clientRequestId": {
          "description": "A request id provided by the client of the storage API operation that triggered this event.",
          "type": "string"
        },
        "requestId": {
          "description": "The request id generated by the Storage service for the storage API operation that triggered this event.",
          "type": "string"
        },
        "contentType": {
          "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.",
          "type": "string"
        },
        "blobType": {
          "description": "The type of blob.",
          "type": "string"
        },
        "url": {
          "description": "The path to the blob.",
          "type": "string"
        },
        "sequencer": {
          "description": "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.",
          "type": "string"
        },
        "identity": {
          "description": "The identity of the requester that triggered this event.",
          "type": "string"
        },
        "storageDiagnostics": {
          "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.",
          "type": "object"
        }
      }
    },
    "StorageDirectoryCreatedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryCreated event.",
      "type": "object",
      "properties": {
        "api": {
          "description": "The name of the API/operation that triggered this event.",
          "type": "string"
        },
        "clientRequestId": {
          "description": "A request id provided by the client of the storage API operation that triggered this event.",
          "type": "string"
        },
        "requestId": {
          "description": "The request id generated by the storage service for the storage API operation that triggered this event.",
          "type": "string"
        },
        "eTag": {
          "description": "The etag of the directory at the time this event was triggered.",
          "type": "string"
        },
        "url": {
          "description": "The path to the directory.",
          "type": "string"
        },
        "sequencer": {
          "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name.",
          "type": "string"
        },
        "identity": {
          "description": "The identity of the requester that triggered this event.",
          "type": "string"
        },
        "storageDiagnostics": {
          "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.",
          "type": "object"
        }
      }
    },
    "StorageDirectoryDeletedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryDeleted event.",
      "type": "object",
      "properties": {
        "api": {
          "description": "The name of the API/operation that triggered this event.",
          "type": "string"
        },
        "clientRequestId": {
          "description": "A request id provided by the client of the storage API operation that triggered this event.",
          "type": "string"
        },
        "requestId": {
          "description": "The request id generated by the storage service for the storage API operation that triggered this event.",
          "type": "string"
        },
        "url": {
          "description": "The path to the deleted directory.",
          "type": "string"
        },
        "recursive": {
          "description": "Is this event for a recursive delete operation.",
          "type": "string"
        },
        "sequencer": {
          "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name.",
          "type": "string"
        },
        "identity": {
          "description": "The identity of the requester that triggered this event.",
          "type": "string"
        },
        "storageDiagnostics": {
          "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.",
          "type": "object"
        }
      }
    },
    "StorageBlobRenamedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobRenamed event.",
      "type": "object",
      "properties": {
        "api": {
          "description": "The name of the API/operation that triggered this event.",
          "type": "string"
        },
        "clientRequestId": {
          "description": "A request id provided by the client of the storage API operation that triggered this event.",
          "type": "string"
        },
        "requestId": {
          "description": "The request id generated by the storage service for the storage API operation that triggered this event.",
          "type": "string"
        },
        "sourceUrl": {
          "description": "The path to the blob that was renamed.",
          "type": "string"
        },
        "destinationUrl": {
          "description": "The new path to the blob after the rename operation.",
          "type": "string"
        },
        "sequencer": {
          "description": "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.",
          "type": "string"
        },
        "identity": {
          "description": "The identity of the requester that triggered this event.",
          "type": "string"
        },
        "storageDiagnostics": {
          "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.",
          "type": "object"
        }
      }
    },
    "StorageDirectoryRenamedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryRenamed event.",
      "type": "object",
      "properties": {
        "api": {
          "description": "The name of the API/operation that triggered this event.",
          "type": "string"
        },
        "clientRequestId": {
          "description": "A request id provided by the client of the storage API operation that triggered this event.",
          "type": "string"
        },
        "requestId": {
          "description": "The request id generated by the storage service for the storage API operation that triggered this event.",
          "type": "string"
        },
        "sourceUrl": {
          "description": "The path to the directory that was renamed.",
          "type": "string"
        },
        "destinationUrl": {
          "description": "The new path to the directory after the rename operation.",
          "type": "string"
        },
        "sequencer": {
          "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name.",
          "type": "string"
        },
        "identity": {
          "description": "The identity of the requester that triggered this event.",
          "type": "string"
        },
        "storageDiagnostics": {
          "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.",
          "type": "object"
        }
      }
    },
    "StorageLifecyclePolicyCompletedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.LifecyclePolicyCompleted event.",
      "type": "object",
      "properties": {
        "scheduleTime": {
          "description": "The time the policy task was scheduled.",
          "type": "string"
        },
        "deleteSummary": {
          "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail"
        },
        "tierToCoolSummary": {
          "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail"
        },
        "tierToArchiveSummary": {
          "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail"
        }
      }
    },
    "StorageLifecyclePolicyActionSummaryDetail": {
      "description": "Execution statistics of a specific policy action in a Blob Management cycle.",
      "type": "object",
      "properties": {
        "totalObjectsCount": {
          "description": "Total number of objects to be acted on by this action.",
          "type": "integer",
          "format": "int64"
        },
        "successCount": {
          "description": "Number of success operations of this action.",
          "type": "integer",
          "format": "int64"
        },
        "errorList": {
          "description": "Error messages of this action if any.",
          "type": "string"
        }
      }
    },
    "StorageBlobTierChangedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobTierChanged event.",
      "type": "object",
      "properties": {
        "api": {
          "description": "The name of the API/operation that triggered this event.",
          "type": "string"
        },
        "clientRequestId": {
          "description": "A request id provided by the client of the storage API operation that triggered this event.",
          "type": "string"
        },
        "requestId": {
          "description": "The request id generated by the Storage service for the storage API operation that triggered this event.",
          "type": "string"
        },
        "contentType": {
          "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.",
          "type": "string"
        },
        "contentLength": {
          "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob.",
          "type": "integer",
          "format": "int64"
        },
        "blobType": {
          "description": "The type of blob.",
          "type": "string"
        },
        "url": {
          "description": "The path to the blob.",
          "type": "string"
        },
        "sequencer": {
          "description": "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.",
          "type": "string"
        },
        "identity": {
          "description": "The identity of the requester that triggered this event.",
          "type": "string"
        },
        "storageDiagnostics": {
          "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.",
          "type": "object"
        }
      }
    },
    "StorageAsyncOperationInitiatedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.AsyncOperationInitiated event.",
      "type": "object",
      "properties": {
        "api": {
          "description": "The name of the API/operation that triggered this event.",
          "type": "string"
        },
        "clientRequestId": {
          "description": "A request id provided by the client of the storage API operation that triggered this event.",
          "type": "string"
        },
        "requestId": {
          "description": "The request id generated by the Storage service for the storage API operation that triggered this event.",
          "type": "string"
        },
        "contentType": {
          "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.",
          "type": "string"
        },
        "contentLength": {
          "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob.",
          "type": "integer",
          "format": "int64"
        },
        "blobType": {
          "description": "The type of blob.",
          "type": "string"
        },
        "url": {
          "description": "The path to the blob.",
          "type": "string"
        },
        "sequencer": {
          "description": "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.",
          "type": "string"
        },
        "identity": {
          "description": "The identity of the requester that triggered this event.",
          "type": "string"
        },
        "storageDiagnostics": {
          "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.",
          "type": "object"
        }
      }
    },
    "StorageBlobInventoryPolicyCompletedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobInventoryPolicyCompleted event.",
      "type": "object",
      "properties": {
        "scheduleDateTime": {
          "description": "The time at which inventory policy was scheduled.",
          "format": "date-time",
          "type": "string"
        },
        "accountName": {
          "description": "The account name for which inventory policy is registered.",
          "type": "string"
        },
        "ruleName": {
          "description": "The rule name for inventory policy.",
          "type": "string"
        },
        "policyRunStatus": {
          "description": "The status of inventory run, it can be Succeeded/PartiallySucceeded/Failed.",
          "type": "string"
        },
        "policyRunStatusMessage": {
          "description": "The status message for inventory run.",
          "type": "string"
        },
        "policyRunId": {
          "description": "The policy run id for inventory run.",
          "type": "string"
        },
        "manifestBlobUrl": {
          "description": "The blob URL for manifest file for inventory run.",
          "type": "string"
        }
      }
    },
    "StorageTaskQueuedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskQueued event.",
      "type": "object",
      "properties": {
        "queuedDateTime": {
          "description": "The time at which a storage task was queued.",
          "format": "date-time",
          "type": "string"
        },
        "taskExecutionId": {
          "description": "The execution id for a storage task.",
          "type": "string"
        }
      },
      "x-ms-examples": {
        "StorageTaskQueuedCloudEventsSchema": {
          "$ref": "./examples/cloud-events-schema/storage_task_queued.json"
        },
        "StorageTaskQueuedEventGridSchema": {
          "$ref": "./examples/event-grid-schema/storage_task_queued.json"
        }
      }
    },
    "StorageTaskCompletedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskCompleted event.",
      "type": "object",
      "properties": {
        "status": {
          "description": "The status for a storage task.",
          "type": "string",
          "enum": [
            "Succeeded",
            "Failed"
          ],
          "x-ms-enum": {
            "name": "StorageTaskCompletedStatus",
            "modelAsString": true
          }
        },
        "completedDateTime": {
          "description": "The time at which a storage task was completed.",
          "format": "date-time",
          "type": "string"
        },
        "taskExecutionId": {
          "description": "The execution id for a storage task.",
          "type": "string"
        },
        "taskName": {
          "description": "The task name for a storage task.",
          "type": "string"
        },
        "summaryReportBlobUrl": {
          "description": "The summary report blob url for a storage task",
          "format": "url",
          "type": "string"
        }
      },
      "x-ms-examples": {
        "StorageTaskCompletedCloudEventsSchema": {
          "$ref": "./examples/cloud-events-schema/storage_task_completed.json"
        },
        "StorageTaskCompletedEventGridSchema": {
          "$ref": "./examples/event-grid-schema/storage_task_completed.json"
        }
      }
    },
    "StorageTaskAssignmentQueuedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentQueued event.",
      "type": "object",
      "properties": {
        "queuedDateTime": {
          "description": "The time at which a storage task was queued.",
          "format": "date-time",
          "type": "string",
          "x-ms-client-name": "queuedOn"
        },
        "taskExecutionId": {
          "description": "The execution id for a storage task.",
          "type": "string"
        }
      },
      "x-ms-examples": {
        "StorageTaskAssignmentQueuedCloudEventsSchema": {
          "$ref": "./examples/cloud-events-schema/storage_task_assignment_queued.json"
        },
        "StorageTaskAssignmentQueuedEventGridSchema": {
          "$ref": "./examples/event-grid-schema/storage_task_assignment_queued.json"
        }
      }
    },
    "StorageTaskAssignmentCompletedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentCompleted event.",
      "type": "object",
      "properties": {
        "status": {
          "description": "The status for a storage task.",
          "type": "string",
          "enum": [
            "Succeeded",
            "Failed"
          ],
          "x-ms-enum": {
            "name": "StorageTaskAssignmentCompletedStatus",
            "modelAsString": true
          }
        },
        "completedDateTime": {
          "description": "The time at which a storage task was completed.",
          "format": "date-time",
          "type": "string",
          "x-ms-client-name": "completedOn"
        },
        "taskExecutionId": {
          "description": "The execution id for a storage task.",
          "type": "string"
        },
        "taskName": {
          "description": "The task name for a storage task.",
          "type": "string"
        },
        "summaryReportBlobUrl": {
          "description": "The summary report blob url for a storage task",
          "format": "url",
          "type": "string",
          "x-ms-client-name": "summaryReportBlobUri"
        }
      },
      "x-ms-examples": {
        "StorageTaskAssignmentCompletedCloudEventsSchema": {
          "$ref": "./examples/cloud-events-schema/storage_task_assignment_completed.json"
        },
        "StorageTaskAssignmentCompletedEventGridSchema": {
          "$ref": "./examples/event-grid-schema/storage_task_assignment_completed.json"
        }
      }
    }
  }
}