Microsoft Azure Microsoft Azure Blob Storage API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Blob Storage API
  description: Azure Blob Storage is Microsoft's object storage solution for the cloud. Blob Storage is optimized for storing massive amounts of unstructured data such as text or binary data. The REST API provides operations for working with containers and blobs in storage accounts, including creating, reading, updating, and deleting blobs and containers, managing metadata and properties, and performing lease and snapshot operations.
  version: '2024-05-04'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
    email: azuresupport@microsoft.com
  license:
    name: Microsoft API License
    url: https://learn.microsoft.com/en-us/legal/
  x-logo:
    url: https://azure.microsoft.com/svghandler/azure-logo.png
servers:
- url: https://{accountName}.blob.core.windows.net
  description: Azure Blob Storage account endpoint
  variables:
    accountName:
      default: mystorageaccount
      description: The name of the Azure storage account.
security:
- sharedKey: []
- oauth2:
  - https://storage.azure.com/.default
- sasToken: []
tags:
- name: Microsoft Azure Azure Blob Storage API
paths:
  /:
    get:
      operationId: Service_GetProperties
      summary: Microsoft Azure Get Blob Service Properties
      description: Gets the properties of a storage account's Blob service, including properties for Storage Analytics and CORS rules.
      tags:
      - Microsoft Azure Azure Blob Storage API
      parameters:
      - name: restype
        in: query
        required: true
        schema:
          type: string
          enum:
          - service
        example: service
      - name: comp
        in: query
        required: true
        schema:
          type: string
          enum:
          - properties
        example: properties
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the service properties.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageServiceProperties'
              examples:
                ServiceGetproperties200Example:
                  summary: Default Service_GetProperties 200 response
                  x-microcks-default: true
                  value:
                    Logging:
                      Version: example_value
                      Delete: true
                      Read: true
                      Write: true
                      RetentionPolicy:
                        Enabled: true
                        Days: 10
                    HourMetrics:
                      Version: example_value
                      Enabled: true
                      IncludeAPIs: true
                    MinuteMetrics:
                      Version: example_value
                      Enabled: true
                      IncludeAPIs: true
                    Cors:
                      CorsRule:
                      - {}
                    DefaultServiceVersion: example_value
                    DeleteRetentionPolicy:
                      Enabled: true
                      Days: 10
                    StaticWebsite:
                      Enabled: true
                      IndexDocument: example_value
                      ErrorDocument404Path: example_value
        default:
          description: An error occurred.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
              examples:
                ServiceGetpropertiesdefaultExample:
                  summary: Default Service_GetProperties default response
                  x-microcks-default: true
                  value:
                    Code: example_value
                    Message: example_value
                    AuthenticationErrorDetail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CorsRule:
      type: object
      description: CORS rule for the Blob service.
      properties:
        AllowedOrigins:
          type: string
          description: Comma-separated list of origin domains that are allowed via CORS.
          example: example_value
        AllowedMethods:
          type: string
          description: Comma-separated list of HTTP methods that are allowed. Options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT.
          example: example_value
        AllowedHeaders:
          type: string
          description: Comma-separated list of headers allowed to be part of the cross-origin request.
          example: example_value
        ExposedHeaders:
          type: string
          description: Comma-separated list of response headers to expose to CORS clients.
          example: example_value
        MaxAgeInSeconds:
          type: integer
          minimum: 0
          description: The maximum amount of time in seconds that a browser should cache the preflight OPTIONS request.
          example: 10
      required:
      - AllowedOrigins
      - AllowedMethods
      - AllowedHeaders
      - ExposedHeaders
      - MaxAgeInSeconds
    RetentionPolicy:
      type: object
      description: The retention policy.
      properties:
        Enabled:
          type: boolean
          description: Indicates whether a retention policy is enabled.
          example: true
        Days:
          type: integer
          minimum: 1
          maximum: 365
          description: The number of days that metrics or logging data should be retained.
          example: 10
    StorageServiceProperties:
      type: object
      description: Storage service properties.
      properties:
        Logging:
          type: object
          description: Azure Analytics logging settings.
          properties:
            Version:
              type: string
              description: The version of Storage Analytics to configure.
            Delete:
              type: boolean
              description: Indicates whether all delete requests should be logged.
            Read:
              type: boolean
              description: Indicates whether all read requests should be logged.
            Write:
              type: boolean
              description: Indicates whether all write requests should be logged.
            RetentionPolicy:
              $ref: '#/components/schemas/RetentionPolicy'
          example: example_value
        HourMetrics:
          $ref: '#/components/schemas/Metrics'
        MinuteMetrics:
          $ref: '#/components/schemas/Metrics'
        Cors:
          type: object
          description: The set of CORS rules.
          properties:
            CorsRule:
              type: array
              items:
                $ref: '#/components/schemas/CorsRule'
          example: example_value
        DefaultServiceVersion:
          type: string
          description: The default version to use for requests to the Blob service.
          example: example_value
        DeleteRetentionPolicy:
          $ref: '#/components/schemas/RetentionPolicy'
        StaticWebsite:
          type: object
          description: The properties that enable static website hosting.
          properties:
            Enabled:
              type: boolean
            IndexDocument:
              type: string
            ErrorDocument404Path:
              type: string
          example: example_value
    StorageError:
      type: object
      description: Storage service error response.
      properties:
        Code:
          type: string
          description: The error code.
          example: example_value
        Message:
          type: string
          description: The error message.
          example: example_value
        AuthenticationErrorDetail:
          type: string
          description: Additional details for authentication errors.
          example: example_value
    Metrics:
      type: object
      description: Storage analytics metrics settings.
      properties:
        Version:
          type: string
          example: example_value
        Enabled:
          type: boolean
          example: true
        IncludeAPIs:
          type: boolean
          example: true
        RetentionPolicy:
          $ref: '#/components/schemas/RetentionPolicy'
  parameters:
    ApiVersionParameter:
      name: x-ms-version
      in: header
      required: true
      description: Specifies the version of the operation to use for this request.
      schema:
        type: string
        default: '2024-05-04'
  securitySchemes:
    sharedKey:
      type: apiKey
      name: Authorization
      in: header
      description: Azure Storage shared key authorization.
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            https://storage.azure.com/.default: Access Azure Storage
    sasToken:
      type: apiKey
      name: sig
      in: query
      description: Shared Access Signature token.