common.json

{
  "swagger": "2.0",
  "info": {
    "title": "Storage",
    "description": "Storage Resource Provider API Common Types",
    "version": "2021-09-01"
  },
  "paths": {},
  "definitions": {
    "CorsRules": {
      "properties": {
        "corsRules": {
          "type": "array",
          "items": {
            "description": "Specifies a CORS rule for the Blob service. ",
            "$ref": "#/definitions/CorsRule"
          },
          "description": "The List of CORS rules. You can include up to five CorsRule elements in the request. "
        }
      },
      "description": "Sets the CORS rules. You can include up to five CorsRule elements in the request. "
    },
    "CorsRule": {
      "properties": {
        "allowedOrigins": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or \"*\" to allow all domains"
        },
        "allowedMethods": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "DELETE",
              "GET",
              "HEAD",
              "MERGE",
              "POST",
              "OPTIONS",
              "PUT",
              "PATCH"
            ]
          },
          "description": "Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin."
        },
        "maxAgeInSeconds": {
          "type": "integer",
          "description": "Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response."
        },
        "exposedHeaders": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Required if CorsRule element is present. A list of response headers to expose to CORS clients."
        },
        "allowedHeaders": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request."
        }
      },
      "required": [
        "allowedOrigins",
        "allowedMethods",
        "maxAgeInSeconds",
        "exposedHeaders",
        "allowedHeaders"
      ],
      "description": "Specifies a CORS rule for the Blob service."
    },
    "DeleteRetentionPolicy": {
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether DeleteRetentionPolicy is enabled."
        },
        "days": {
          "type": "integer",
          "minimum": 1,
          "maximum": 365,
          "description": "Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365."
        },
        "allowPermanentDelete": {
          "type": "boolean",
          "description": "This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share."
        }
      },
      "description": "The service properties for soft delete."
    },
    "Sku": {
      "properties": {
        "name": {
          "$ref": "#/definitions/SkuName"
        },
        "tier": {
          "$ref": "#/definitions/Tier"
        }
      },
      "required": [
        "name"
      ],
      "description": "The SKU of the storage account."
    },
    "SkuName": {
      "type": "string",
      "description": "The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.",
      "enum": [
        "Standard_LRS",
        "Standard_GRS",
        "Standard_RAGRS",
        "Standard_ZRS",
        "Premium_LRS",
        "Premium_ZRS",
        "Standard_GZRS",
        "Standard_RAGZRS"
      ],
      "x-ms-enum": {
        "name": "SkuName",
        "modelAsString": true
      }
    },
    "Tier": {
      "readOnly": true,
      "type": "string",
      "description": "The SKU tier. This is based on the SKU name.",
      "enum": [
        "Standard",
        "Premium"
      ],
      "x-ms-enum": {
        "name": "SkuTier",
        "modelAsString": false
      }
    },
    "CloudError": {
      "x-ms-external": true,
      "properties": {
        "error": {
          "$ref": "#/definitions/CloudErrorBody"
        }
      },
      "description": "An error response from the Storage service."
    },
    "CloudErrorBody": {
      "x-ms-external": true,
      "properties": {
        "code": {
          "type": "string",
          "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
        },
        "message": {
          "type": "string",
          "description": "A message describing the error, intended to be suitable for display in a user interface."
        },
        "target": {
          "type": "string",
          "description": "The target of the particular error. For example, the name of the property in error."
        },
        "details": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CloudErrorBody"
          },
          "description": "A list of additional details about the error."
        }
      },
      "description": "An error response from the Storage service."
    },
    "SignedIdentifier": {
      "properties": {
        "id": {
          "type": "string",
          "description": "An unique identifier of the stored access policy."
        },
        "accessPolicy": {
          "$ref": "#/definitions/AccessPolicy",
          "description": "Access policy"
        }
      }
    },
    "AccessPolicy": {
      "properties": {
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "Start time of the access policy"
        },
        "expiryTime": {
          "type": "string",
          "format": "date-time",
          "description": "Expiry time of the access policy"
        },
        "permission": {
          "type": "string",
          "description": "List of abbreviated permissions."
        }
      }
    }
  }
}