Az.StorageCache

This directory contains the PowerShell module for the StorageCache service.

---

Status

Info

• Modifiable: yes
• Generated: all
• Committed: yes
• Packaged: yes

---

Detail

This module was primarily generated via AutoRest using the PowerShell extension.

Module Requirements

• Az.Accounts module, version 2.7.5 or greater

Authentication

AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent.

Development

For information on how to develop for Az.StorageCache, see how-to.md.

AutoRest Configuration

see https://aka.ms/autorest

commit: 7a65f22cf67826187f75981e914c7e679039257b
require:
  - $(this-folder)/../../readme.azure.noprofile.md
input-file:
  - $(repo)/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/storagecache.json
  - $(repo)/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json

module-version: 0.1.0
title: StorageCache
subject-prefix: $(service-name)

identity-correction-for-post: true
resourcegroup-append: true
nested-object-to-string: true

# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option
use-extension:
  "@autorest/powershell": "3.x"

directive:
  - where:
      subject: ^Cach(.*)
    set:
      subject: $1
  - where:
      subject: ^Info(.*)
    set:
      subject: $1
 
  - where:
      subject: ^SpaceCachAllocation$
    set:
      subject: SpaceAllocation

  - where:
      subject: ^AmlFilesystem$
    set:
      subject: AmlFileSystem

  - where:
      subject: ^ArchiveAmlFilesystem$
    set:
      subject: AmlFileSystemArchive

  - where:
      subject: ^RequiredAmlFSubnetSize$
    set:
      subject: AmlFileSystemSubnetRequiredSize

  - where:
      subject: ^AmlFSubnet$
    set:
      subject: AmlFileSystemSubnet

  - where:
      subject: ^StorageTarget$
    set:
      subject: Target

  - where:
      subject: ^InvalidateStorageTarget$
    set:
      subject: InvalidateTarget

  - where:
      subject: ^StorageTargetDefault$
    set:
      subject: TargetSetting

  - where:
      subject: ^StorageTargetDns$
    set:
      subject: TargetDns

  - from: swagger-document 
    where: $.paths["/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/startPrimingJob"].post.responses
    transform: >-
      return {
        "200": {
          "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"
            }
          }
        },
        "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"
          }
        }
      }

  - from: swagger-document 
    where: $.paths["/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/spaceAllocation"].post.responses
    transform: >-
      return {
        "200": {
          "description": "OK.",
          "headers": {
            "Location": {
              "description": "Location URI to poll for result",
              "type": "string"
            },
            "Azure-AsyncOperation": {
              "description": "URI to poll for the operation status",
              "type": "string"
            }
          }
        },
        "202": {
          "description": "OK.",
          "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"
          }
        }
      }

  - where:
      variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$
    remove: true
  - where:
      subject: ^AmlFileSystemSubnetRequiredSize$
      variant: ^Get$|^GetViaIdentity$
    remove: true
  - where:
      subject: ^PrimingJob$
      variant: ^Start$|^StartViaIdentity$|^Resume$|^ResumeViaIdentity$|^Stop$|^StopViaIdentity$|^Pause$|^PauseViaIdentity$
    remove: true
  - where:
      variant: ^Archive$|^ArchiveViaIdentity$|^Check$|^CheckViaIdentity$
    remove: true

  - where:
      verb: Set
    remove: true

  - where:
      verb: Invoke
      subject: ^SpaceAllocation$
    set:
      verb: Update

  - where:
      parameter-name: EName
    set:
      parameter-name: Name
      alias: CacheName

  - where:
      subject: AmlFileSystemSubnet
      parameter-name: FilesystemSubnet
    set:
      parameter-name: Name

  - where:
      parameter-name: OperationId
    set:
      parameter-name: Id

  - where:
      subject: AscOperation
    hide: true

  # # The following are commented out and their generated cmdlets may be renamed and custom logic
  # - model-cmdlet:
  #     - CacheDirectorySettings
  #     - NfsAccessPolicy
  #     - NfsAccessRule
  #     - NamespaceJunction
  #     - PrimingJob
  #     - StorageTargetSpaceAllocation

  - where:
      model-name: StorageTarget
    set:
      format-table:
        properties:
          - Name
          - Location
          - ResourceGroupName
          - State
  - where:
      model-name: AmlFilesystem
    set:
      format-table:
        properties:
          - Name
          - Location
          - ResourceGroupName
          - HealthState
          - SkuName