Microsoft Azure
Microsoft Azure Caches API

The Caches API from Microsoft Azure — 13 operation(s) for caches.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Caches API
schemes:
- https
tags:
- name: Caches
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches:
    get:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: A list of cache objects. Note that entity references might replace complete cache objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference
          schema:
            $ref: '#/definitions/CachesListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Caches_List:
          $ref: ./examples/Caches_List.json
      tags:
      - Caches
      description: Returns all caches the user has access to under a subscription.
      operationId: microsoftAzureCachesList
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Storagecache Caches
  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches:
    get:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: A list of cache objects. Note that entity references might replace complete cache objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference
          schema:
            $ref: '#/definitions/CachesListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Caches_ListByResourceGroup:
          $ref: ./examples/Caches_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Caches
      description: Returns all caches the user has access to under a resource group.
      operationId: microsoftAzureCachesListbyresourcegroup
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches
  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}:
    delete:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/CacheNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Cache deleted.
        '202':
          description: Started the cache's transition to Deleted state. Poll the cache to monitor.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        '204':
          description: Cache deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Caches_Delete:
          $ref: ./examples/Caches_Delete.json
      x-ms-long-running-operation: true
      tags:
      - Caches
      description: Schedules a cache for deletion.
      operationId: microsoftAzureCachesDelete
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename
    get:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/CacheNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Returns the cache object corresponding to cache name.
          schema:
            $ref: '#/definitions/Cache'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Caches_Get:
          $ref: ./examples/Caches_Get.json
      tags:
      - Caches
      description: Returns a cache.
      operationId: microsoftAzureCachesGet
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename
    put:
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/CacheNameParameter'
      - description: Object containing the user-selectable properties of the new cache. If read-only properties are included, they must match the existing values of those properties.
        in: body
        name: cache
        required: true
        schema:
          $ref: '#/definitions/Cache'
      responses:
        '200':
          description: Cache created or updated.
          schema:
            $ref: '#/definitions/Cache'
        '201':
          description: Cache creation or update has been initiated. Poll the cache's provisioningState property to monitor creation/update progress.
          schema:
            $ref: '#/definitions/Cache'
        '202':
          description: Cache creation or update has been initiated. Poll the cache's provisioningState property to monitor creation/update progress.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Caches_CreateOrUpdate:
          $ref: ./examples/Caches_CreateOrUpdate.json
        Caches_CreateOrUpdate_ldap_only:
          $ref: ./examples/Caches_CreateOrUpdate_ldap_only.json
      x-ms-long-running-operation: true
      tags:
      - Caches
      description: Create or update a cache.
      operationId: microsoftAzureCachesCreateorupdate
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename
    patch:
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/CacheNameParameter'
      - description: Object containing the user-selectable properties of the cache. If read-only properties are included, they must match the existing values of those properties.
        in: body
        name: cache
        schema:
          $ref: '#/definitions/Cache'
      responses:
        '200':
          description: Updated the cache.
          schema:
            $ref: '#/definitions/Cache'
        '202':
          description: Cache update has been initiated.  Poll the cache's provisioningState property to monitor update progress.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Caches_Update:
          $ref: ./examples/Caches_Update.json
        Caches_Update_ldap_only:
          $ref: ./examples/Caches_Update_ldap_only.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Update a cache instance.
      operationId: microsoftAzureCachesUpdate
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/debugInfo
  : post:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/CacheNameParameter'
      responses:
        '200':
          description: Cache has started generating debug info.
        '202':
          description: Cache has started generating debug info.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        '204':
          description: Cache has started generating debug info.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Caches_DebugInfo:
          $ref: ./examples/Caches_DebugInfo.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Tells a cache to write generate debug info for support to process.
      operationId: microsoftAzureCachesDebuginfo
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Debuginfo
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/flush
  : post:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/CacheNameParameter'
      responses:
        '200':
          description: All cached data has been flushed to the Storage Target(s).
        '202':
          description: Cache has started flushing to its Storage Target(s). Poll the cache's state field to monitor.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        '204':
          description: Cache flush already in progress or has completed.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Caches_Flush:
          $ref: ./examples/Caches_Flush.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Tells a cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.
      operationId: microsoftAzureCachesFlush
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Flush
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/start
  : post:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/CacheNameParameter'
      responses:
        '200':
          description: Cache is Active.
        '202':
          description: Cache has started the transition to Active. Poll the cache's state field to monitor.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        '204':
          description: Restarted VMs associated with the cache.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Caches_Start:
          $ref: ./examples/Caches_Start.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Tells a Stopped state cache to transition to Active state.
      operationId: microsoftAzureCachesStart
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Start
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stop
  : post:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/CacheNameParameter'
      responses:
        '200':
          description: Cache is stopped.
        '202':
          description: Cache has started the transition to Stopped. Poll the cache's state field to monitor.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        '204':
          description: Stopped VMs associated with the cache.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Caches_Stop:
          $ref: ./examples/Caches_Stop.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Tells an Active cache to transition to Stopped state.
      operationId: microsoftAzureCachesStop
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Stop
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/startPrimingJob
  : post:
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/CacheNameParameter'
      - description: Object containing the definition of a priming job.
        in: body
        name: primingjob
        schema:
          $ref: '#/definitions/PrimingJob'
      responses:
        '202':
          description: The priming job is being created and will complete asynchronously.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        StartPrimingJob:
          $ref: ./examples/StartPrimingJob.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Create a priming job. This operation is only allowed when the cache is healthy.
      operationId: microsoftAzureCachesStartprimingjob
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Startprimingjob
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stopPrimingJob
  : post:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/CacheNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - description: Object containing the priming job ID.
        in: body
        name: primingJobId
        schema:
          $ref: '#/definitions/PrimingJobIdParameter'
      responses:
        '202':
          description: Started priming job deletion.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        '204':
          description: The priming job is being deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        StopPrimingJob:
          $ref: ./examples/StopPrimingJob.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Schedule a priming job for deletion.
      operationId: microsoftAzureCachesStopprimingjob
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Stopprimingjob
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/pausePrimingJob
  : post:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/CacheNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - description: Object containing the priming job ID.
        in: body
        name: primingJobId
        schema:
          $ref: '#/definitions/PrimingJobIdParameter'
      responses:
        '202':
          description: Priming job is being paused.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        '204':
          description: The priming job is paused.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        PausePrimingJob:
          $ref: ./examples/PausePrimingJob.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Schedule a priming job to be paused.
      operationId: microsoftAzureCachesPauseprimingjob
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Pauseprimingjob
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/resumePrimingJob
  : post:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/CacheNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - description: Object containing the priming job ID.
        in: body
        name: primingJobId
        schema:
          $ref: '#/definitions/PrimingJobIdParameter'
      responses:
        '202':
          description: Priming job is being resumed.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        '204':
          description: The priming job is running.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        ResumePrimingJob:
          $ref: ./examples/ResumePrimingJob.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Resumes a paused priming job.
      operationId: microsoftAzureCachesResumeprimingjob
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Resumeprimingjob
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/upgrade
  : post:
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/CacheNameParameter'
      responses:
        '201':
          description: Cache firmware is up to date.
        '202':
          description: Cache has started the upgrade. Poll the cache's state field to monitor.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        '204':
          description: Cache firmware is up to date.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Caches_UpgradeFirmware:
          $ref: ./examples/Caches_UpgradeFirmware.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.
      operationId: microsoftAzureCachesUpgradefirmware
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Upgrade
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/spaceAllocation
  : post:
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/CacheNameParameter'
      - description: List containing storage target cache space percentage allocations.
        in: body
        name: spaceAllocation
        schema:
          $ref: '#/definitions/SpaceAllocationParameter'
      responses:
        '202':
          description: Error response describing why the operation failed.
          headers:
            Location:
              description: Location URI to poll for result
              type: string
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        SpaceAllocation_Post:
          $ref: ./examples/SpaceAllocation_Post.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      tags:
      - Caches
      description: Update cache space allocation.
      operationId: microsoftAzureCachesSpaceallocation
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Spaceallocation
definitions:
  KeyVaultKeyReference:
    type: object
    description: Describes a reference to key vault key.
    properties:
      keyUrl:
        type: string
        description: The URL referencing a key encryption key in key vault.
      sourceVault:
        type: object
        description: Describes a resource Id to source key vault.
        properties:
          id:
            type: string
            description: Resource Id.
    required:
    - keyUrl
    - sourceVault
  NfsAccessPolicy:
    type: object
    description: A set of rules describing access policies applied to NFSv3 clients of the cache.
    properties:
      name:
        description: Name identifying this policy. Access Policy names are not case sensitive.
        type: string
      accessRules:
        description: The set of rules describing client accesses allowed under this policy.
        type: array
        items:
          $ref: '#/definitions/NfsAccessRule'
        x-ms-identifiers: []
    required:
    - name
    - accessRules
  CacheHealth:
    type: object
    description: An indication of cache health. Gives more information about health than just that related to provisioning.
    properties:
      state:
        description: List of cache health states. Down is when the cluster is not responding.  Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings.
        enum:
        - Unknown
        - Healthy
        - Degraded
        - Down
        - Transitioning
        - Stopping
        - Stopped
        - Upgrading
        - Flushing
        - WaitingForKey
        - StartFailed
        - UpgradeFailed
        x-ms-enum:
          name: HealthStateType
          modelAsString: true
        type: string
      statusDescription:
        description: Describes explanation of state.
        type: string
      conditions:
        description: Outstanding conditions that need to be investigated and resolved.
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/Condition'
        x-ms-identifiers: []
  Condition:
    type: object
    description: Outstanding conditions that will need to be resolved.
    properties:
      timestamp:
        readOnly: true
        type: string
        format: date-time
        description: The time when the condition was raised.
      message:
        readOnly: true
        type: string
        description: The issue requiring attention.
  CloudErrorBody:
    description: An error response.
    properties:
      code:
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        type: string
      details:
        description: A list of additional details about the error.
        items:
          $ref: '#/definitions/CloudErrorBody'
        type: array
        x-ms-identifiers: []
      message:
        description: A message describing the error, intended to be suitable for display in a user interface.
        type: string
      target:
        description: The target of the particular error. For example, the name of the property in error.
        type: string
    type: object
  PrimingJob:
    description: A priming job instance.
    properties:
      primingJobName:
        description: The priming job name.
        $ref: '#/definitions/ResourceName'
        x-ms-mutability:
        - read
        - create
      primingManifestUrl:
        description: The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob.
        type: string
        x-ms-mutability:
        - create
        x-ms-secret: true
      primingJobId:
        description: The unique identifier of the priming job.
        pattern: ^[-0-9a-zA-Z_]{1,80}$
        readOnly: true
        type: string
      primingJobState:
        description: The state of the priming operation.
        enum:
        - Queued
        - Running
        - Paused
        - Complete
        readOnly: true
        type: string
        x-ms-enum:
          name: PrimingJobState
          modelAsString: true
      primingJobStatus:
        description: The status code of the priming job.
        type: string
        readOnly: true
      primingJobDetails:
      

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-caches-api-openapi.yml
Microsoft Azure Caches API

Documentation

Specifications

Other Resources

OpenAPI Specification
