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:
        description: The job details or error information if any.
        type: string
        readOnly: true
      primingJobPercentComplete:
        description: The current progress of the priming job, as a percentage.
        type: number
        format: double
        maximum: 100
        minimum: 0
        readOnly: true
    required:
    - primingJobName
    - primingManifestUrl
    type: object
  PrimingJobList:
    description: The list of priming jobs defined for the cache.
    items:
      $ref: '#/definitions/PrimingJob'
    type: array
    x-ms-identifiers:
    - primingJobId
    readOnly: true
  CacheActiveDirectorySettings:
    description: Active Directory settings used to join a cache to a domain.
    properties:
      primaryDnsIpAddress:
        description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.
        type: string
      secondaryDnsIpAddress:
        description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.
        type: string
      domainName:
        description: The fully qualified domain name of the Active Directory domain controller.
        type: string
      domainNetBiosName:
        description: The Active Directory domain's NetBIOS name.
        type: string
      cacheNetBiosName:
        description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].
        pattern: ^[-0-9a-zA-Z]{1,15}$
        type: string
      domainJoined:
        description: True if the HPC Cache is joined to the Active Directory domain.
        type: string
        readOnly: true
        enum:
        - 'Yes'
        - 'No'
        - Error
        x-ms-enum:
          name: DomainJoinedType
          modelAsString: true
      credentials:
        type: object
        description: Active Directory admin credentials used to join the HPC Cache to a domain.
        properties:
          username:
            description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.
            type: string
          password:
            description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.
            x-ms-secret: true
            type: string
            x-ms-mutability:
            - read
            - create
            - update
        required:
        - username
    type: object
    required:
    - primaryDnsIpAddress
    - domainNetBiosName
    - domainName
    - cacheNetBiosName
  Cache:
    description: 'A cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md'
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags.
      id:
        description: Resource ID of the cache.
        readOnly: true
        $ref: '#/definitions/URLString'
      location:
        description: Region name string.
        type: string
        x-ms-mutability:
        - read
        - create
      name:
        description: Name of cache.
        readOnly: true
        $ref: '#/definitions/ResourceName'
      type:
        description: Type of the cache; Microsoft.StorageCache/Cache
        readOnly: true
        type: string
      identity:
        $ref: '#/definitions/CacheIdentity'
        description: The identity of the cache, if configured.
      systemData:
        readOnly: true
        description: The system meta data relating to this resource.
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
      properties:
        x-ms-client-flatten: true
        description: Properties of the cache.
        properties:
          cacheSizeGB:
            description: The size of this cache, in GB, when scalingFactor is 1.0. Values depend on the cache SKU - <a href="https://learn.microsoft.com/en-us/rest/api/storagecache/skus/list?tabs=HTTP">List SKUs</a>.
            type: integer
            format: int32
            x-ms-mutability:
            - read
            - create
          scalingFactor:
            description: Multiplier that sets the current storage and throughput capacity of the cache. Values depend on the cache SKU - <a href="https://learn.microsoft.com/en-us/rest/api/storagecache/skus/list?tabs=HTTP">List SKUs</a>. Values above 1.0 increase the cache size and throughput - for example, the scaling factor 1.33 gives a cache that's 33% larger than its base size.
            type: number
            format: double
            default: 1
          health:
            description: Health of the cache.
            readOnly: true
            $ref: '#/definitions/CacheHealth'
          mountAddresses:
            description: Array of IPv4 addresses that can be used by clients mounting this cache.
            readOnly: true
            items:
              type: string
            type: array
          provisioningState:
            description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
            enum:
            - Succeeded
            - Failed
            - Canceled
            - Creating
            - Deleting
            - Updating
            x-ms-enum:
              name: ProvisioningStateType
              modelAsString: true
            type: string
            readOnly: true
          subnet:
            description: Subnet used for the cache.
            $ref: '#/definitions/URLString'
            x-ms-mutability:
            - read
            - create
          upgradeStatus:
            description: Upgrade status of the cache.
            $ref: '#/definitions/CacheUpgradeStatus'
            readOnly: true
          upgradeSettings:
            description: Upgrade settings of the cache.
            $ref: '#/definitions/CacheUpgradeSettings'
          networkSettings:
            $ref: '#/definitions/CacheNetworkSettings'
            description: Specifies network settings of the cache.
          encryptionSettings:
            $ref: '#/definitions/CacheEncryptionSettings'
            description: Specifies encryption settings of the cache.
          securitySettings:
            $ref: '#/definitions/CacheSecuritySettings'
            description: Specifies security settings of the cache.
          directoryServicesSettings:
            $ref: '#/definitions/CacheDirectorySettings'
            description: Specifies Directory Services settings of the cache.
          zones:
            type: array
            items:
              type: string
            description: Availability zones for resources. This field should only contain a single element in the array.
            x-ms-mutability:
            - read
            - create
          primingJobs:
            $ref: '#/definitions/PrimingJobList'
            description: Specifies the priming jobs defined in the cache.
          spaceAllocation:
            $ref: '#/definitions/SpaceAllocationList'
            description: Specifies the space allocation percentage for each storage target in the cache.
        type: object
      sku:
        x-ms-mutability:
        - read
        - create
        description: SKU for the cache.
        properties:
          name:
            description: SKU name for this cache.
            type: string
        type: object
    x-ms-azure-resource: true
    type: object
  CacheDirectorySettings:
    description: Cache Directory Services settings.
    type: object
    properties:
      activeDirectory:
        $ref: '#/definitions/CacheActiveDirectorySettings'
        description: Specifies settings for joining the HPC Cache to an Active Directory domain.
      usernameDownload:
        $ref: '#/definitions/CacheUsernameDownloadSettings'
        description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups.
  StorageTargetSpaceAllocation:
    description: Storage Target space allocation properties.
    properties:
      name:
        description: Name of the storage target.
        $ref: '#/definitions/ResourceName'
      allocationPercentage:
        description: The percentage of cache space allocated for this storage target
        type: integer
        format: int32
        minimum: 1
        maximum: 100
    type: object
  CacheIdentity:
    type: object
    description: Cache identity properties.
    x-ms-mutability:
    - read
    - create
    properties:
      principalId:
        readOnly: true
        type: string
        description: The principal ID for the system-assigned identity of the cache.
      tenantId:
        readOnly: true
        type: string
        description: The tenant ID associated with the cache.
      type:
        type: string
        description: The type of identity used for the cache
        enum:
        - SystemAssigned
        - UserAssigned
        - SystemAssigned, UserAssigned
        - None
        x-ms-enum:
          name: CacheIdentityType
          modelAsString: false
      userAssignedIdentities:
        type: object
        description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary.
        additionalProperties:
          type: object
          x-ms-client-name: userAssignedIdentitiesValue
          properties:
            principalId:
              readOnly: true
              type: string
              description: The principal ID of the user-assigned identity.
            clientId:
              readOnly: true
              type: string
              description: The client ID of the user-assigned identity.
  ResourceName:
    description: Schema for the name of resources served by this provider. Note that objects will contain an odata @id annotation as appropriate. This will contain the complete resource id of the object. These names are case-preserving, but not case sensitive.
    pattern: ^[-0-9a-zA-Z_]{1,80}$
    type: string
  CacheSecuritySettings:
    type: object
    description: Cache security settings.
    properties:
      accessPolicies:
        description: NFS access policies defined for this cache.
        items:
          $ref: '#/definitions/NfsAccessPolicy'
        type: array
        x-ms-identifiers:
        - name
  CachesListResult:
    description: Result of the request to list caches. It contains a list of caches and a URL link to get the next set of results.
    properties:
      nextLink:
        description: URL to get the next set of cache list results, if there are any.
        type: string
      value:
        description: List of Caches.
        items:
          $ref: '#/definitions/Cache'
        type: array
    type: object
  URLString:
    description: A fully qualified URL.
    type: string
  CacheUpgradeSettings:
    description: Cache Upgrade Settings.
    properties:
      upgradeScheduleEnabled:
        description: True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.
        type: boolean
      scheduledTime:
        description: When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache.
        format: date-time
        type: string
    type: object
  CacheEncryptionSettings:
    type: object
    description: Cache encryption settings.
    properties:
      keyEncryptionKey:
        x-ms-secret: true
        $ref: '#/definitions/KeyVaultKeyReference'
        description: Specifies the location of the key encryption key in key vault.
      rotationToLatestKeyVersionEnabled:
        type: boolean
        description: Specifies whether the service will automatically rotate to the newest version of the key in the key vault.
  CacheNetworkSettings:
    type: object
    description: Cache network settings.
    properties:
      mtu:
        description: The IPv4 maximum transmission unit configured for the subnet.
        type: integer
        format: int32
        minimum: 576
        maximum: 1500
        default: 1500
      utilityAddresses:
        description: Array of additional IP addresses used by this cache.
        readOnly: true
        items:
          type: string
        type: array
      dnsServers:
        description: DNS servers for the cache to use.  It will be set from the network configuration if no value is provided.
        type: array
        items:
          type: string
      dnsSearchDomain:
        description: DNS search domain
        type: string
      ntpServer:
        description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.
        type: string
        default: time.windows.com
  PrimingJobIdParameter:
    description: Object containing the priming job ID.
    properties:
      primingJobId:
        description: The unique identifier of the priming job.
        pattern: ^[-0-9a-zA-Z_]{1,80}$
        type: string
    required:
    - primingJobId
    type: object
  SpaceAllocationParameter:
    description: List of storage target space allocations.
    items:
      $ref: '#/definitions/StorageTargetSpaceAllocation'
    type: array
    x-ms-identifiers:
    - name
  CloudError:
    x-ms-external: true
    description: An error response.
    properties:
      error:
        description: The body of the error.
        $ref: '#/definitions/CloudErrorBody'
    type: object
  NfsAccessRule:
    type: object
    description: Rule to place restrictions on portions of the cache namespace being presented to clients.
    properties:
      scope:
        description: Scope for this rule. The scope and filter determine which clients match the rule.
        type: string
        enum:
        - default
        - network
        - host
        x-ms-enum:
          name: NfsAccessRuleScope
          modelAsString: true
      filter:
        description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied.
        type: string
      access:
        description: Access allowed by this rule.
        type: string
        enum:
        - 'no'
        - ro
        - rw
        x-ms-enum:
          name: NfsAccessRuleAccess
          modelAsString: true
      suid:
        description: Allow SUID semantics.
        type: boolean
      submountAccess:
        description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'.
        type: boolean
      rootSquash:
        description: Map root accesses to anonymousUID and anonymousGID.
        type: boolean
      anonymousUID:
        description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided.
        type: string
      anonymousGID:
        description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided.
        type: string
    required:
    - scope
    - access
  SpaceAllocationList:
    description: List of storage target space allocations.
    items:
      $ref: '#/definitions/StorageTargetSpaceAllocation'
    type: array
    x-ms-identifiers:
    - name
    readOnly: true
  CacheUsernameDownloadSettings:
    description: Settings for Extended Groups username and group download.
    type: object
    properties:
      extendedGroups:
        type: boolean
        description: Whether or not Extended Groups is enabled.
      usernameSource:
        description: This setting determines how the cache gets username and group names for clients.
        enum:
        - AD
        - LDAP
        - File
        - None
        x-ms-enum:
          name: UsernameSource
          modelAsString: true
        type: string
        default: None
      groupFileURI:
        type: string
        description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
      userFileURI:
        type: string
        description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
      ldapServer:
        type: string
        description: The fully qualified domain name or IP address of the LDAP server to use.
      ldapBaseDN:
        type: string
        description: The base distinguished name for the LDAP domain.
      encryptLdapConnection:
        type: boolean
        description: Whether or not the LDAP connection should be encrypted.
        default: false
      requireValidCertificate:
        type: boolean
        description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
        default: false
      autoDownloadCertificate:
        type: boolean
        description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
        default: false
      caCertificateURI:
        type: string
        description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
      usernameDownloaded:
        description: Indicates whether or not the HPC Cache has performed the username download successfully.
        type: string
        readOnly: true
        enum:
        - 'Yes'
        - 'No'
        - Error
        x-ms-enum:
          name: UsernameDownloadedType
          modelAsString: true
      credentials:
        type: object
        description: When present, these are the credentials for the secure LDAP connection.
        properties:
          bindDn:
            type: string
            description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.
            x-ms-mutability:
            - read
            - create
            - update
          bindPassword:
            type: string
            x-ms-secret: true
            description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.
  CacheUpgradeStatus:
    description: Properties describing the software upgrade state of the cache.
    properties:
      currentFirmwareVersion:
        description: Version string of the firmware currently installed on this cache.
        type: string
        readOnly: true
      firmwareUpdateStatus:
        description: True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.
        enum:
        - available
        - unavailable
        x-ms-enum:
          name: FirmwareStatusType
          modelAsString: true
        readOnly: true
        type: string
      firmwareUpdateDeadline:
        description: Time at which the pending firmware update will automatically be installed on the cache.
        format: date-time
        type: string
        readOnly: true
      lastFirmwareUpdate:
        description: Time of the last successful firmware update.
        format: date-time
        type: string
        readOnly: true
      pendingFirmwareVersion:
        description: When firmwareUpdateAvailable is true, this field holds the version string for the update.
        type: string
        readOnly: true
    type: object
parameters:
  CacheNameParameter:
    description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
    in: path
    name: cacheName
    pattern: ^[-0-9a-zA-Z_]{1,80}$
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'