Microsoft Azure Snapshot Policy API

openapi: 3.2.0
info:
  title: Microsoft Azure Microsoft NetApp Snapshot Policy API
  description: Microsoft NetApp Azure Resource Provider specification
  version: 2023-07-01-preview
  x-ms-code-generation-settings:
    name: AzureNetAppFilesManagementClient
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Snapshot Policy
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies
  : get:
      operationId: microsoftAzureSnapshotpoliciesList
      description: List snapshot policy
      tags:
      - Snapshot Policy
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/AccountName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      x-ms-pageable:
        nextLinkName: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snapshotPoliciesList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SnapshotPolicies_List:
          $ref: examples/SnapshotPolicies_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}
  : get:
      operationId: microsoftAzureSnapshotpoliciesGet
      description: Get a snapshot Policy
      tags:
      - Snapshot Policy
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/AccountName'
      - $ref: '#/components/parameters/SnapshotPolicyName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snapshotPolicy'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SnapshotPolicies_Get:
          $ref: examples/SnapshotPolicies_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      operationId: microsoftAzureSnapshotpoliciesCreate
      description: Create a snapshot policy
      tags:
      - Snapshot Policy
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/AccountName'
      - $ref: '#/components/parameters/SnapshotPolicyName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK - snapshot Policy updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snapshotPolicy'
        '201':
          description: Snapshot Policy created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snapshotPolicy'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: false
      x-ms-examples:
        SnapshotPolicies_Create:
          $ref: examples/SnapshotPolicies_Create.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/snapshotPolicy'
        description: Snapshot policy object supplied in the body of the operation.
        required: true
    patch:
      tags:
      - Snapshot Policy
      operationId: microsoftAzureSnapshotpoliciesUpdate
      description: Patch a snapshot policy
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/AccountName'
      - $ref: '#/components/parameters/SnapshotPolicyName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snapshotPolicy'
        '202':
          description: Accepted -- Create or update request accepted; operation will complete asynchronously
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snapshotPolicy'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        SnapshotPolicies_Update:
          $ref: examples/SnapshotPolicies_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/snapshotPolicyPatch'
        description: Snapshot policy object supplied in the body of the operation.
        required: true
    delete:
      operationId: microsoftAzureSnapshotpoliciesDelete
      description: Delete snapshot policy
      tags:
      - Snapshot Policy
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/AccountName'
      - $ref: '#/components/parameters/SnapshotPolicyName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
        '202':
          description: Accepted -- Create or update request accepted; operation will complete asynchronously
        '204':
          description: NoContent -- Resource does not exist.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        SnapshotPolicies_Delete:
          $ref: examples/SnapshotPolicies_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    snapshotPolicy:
      description: Snapshot policy information
      type: object
      required:
      - location
      - properties
      allOf:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
      properties:
        etag:
          readOnly: true
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
        properties:
          description: Snapshot policy Properties
          $ref: '#/components/schemas/snapshotPolicyProperties'
          x-ms-client-flatten: true
    monthlySchedule:
      description: Monthly Schedule properties
      type: object
      properties:
        snapshotsToKeep:
          type: integer
          description: Monthly snapshot count to keep
          format: int32
        daysOfMonth:
          type: string
          description: Indicates which days of the month snapshot should be taken. A comma delimited string.
          example: 1,11,21
        hour:
          type: integer
          description: Indicates which hour in UTC timezone a snapshot should be taken
          example: 11
          format: int32
        minute:
          type: integer
          description: Indicates which minute snapshot should be taken
          example: 30
          format: int32
        usedBytes:
          type: integer
          description: Resource size in bytes, current storage usage for the volume in bytes
          format: int64
    dailySchedule:
      description: Daily Schedule properties
      type: object
      properties:
        snapshotsToKeep:
          type: integer
          description: Daily snapshot count to keep
          format: int32
        hour:
          type: integer
          description: Indicates which hour in UTC timezone a snapshot should be taken
          example: 11
          format: int32
        minute:
          type: integer
          description: Indicates which minute snapshot should be taken
          example: 30
          format: int32
        usedBytes:
          type: integer
          description: Resource size in bytes, current storage usage for the volume in bytes
          format: int64
    snapshotPoliciesList:
      description: List of Snapshot Policies
      type: object
      properties:
        value:
          description: A list of snapshot policies
          type: array
          items:
            $ref: '#/components/schemas/snapshotPolicy'
    snapshotPolicyProperties:
      description: Snapshot policy properties
      type: object
      properties:
        hourlySchedule:
          title: hourlySchedule
          description: Schedule for hourly snapshots
          type: object
          $ref: '#/components/schemas/hourlySchedule'
        dailySchedule:
          title: dailySchedule
          description: Schedule for daily snapshots
          type: object
          $ref: '#/components/schemas/dailySchedule'
        weeklySchedule:
          title: weeklySchedule
          description: Schedule for weekly snapshots
          type: object
          $ref: '#/components/schemas/weeklySchedule'
        monthlySchedule:
          title: monthlySchedule
          description: Schedule for monthly snapshots
          type: object
          $ref: '#/components/schemas/monthlySchedule'
        enabled:
          type: boolean
          description: The property to decide policy is enabled or not
        provisioningState:
          type: string
          readOnly: true
          description: Azure lifecycle management
    hourlySchedule:
      description: Hourly Schedule properties
      type: object
      properties:
        snapshotsToKeep:
          type: integer
          description: Hourly snapshot count to keep
          format: int32
        minute:
          type: integer
          description: Indicates which minute snapshot should be taken
          example: 30
          format: int32
        usedBytes:
          type: integer
          description: Resource size in bytes, current storage usage for the volume in bytes
          format: int64
    snapshotPolicyPatch:
      description: Snapshot policy Details for create and update
      type: object
      properties:
        location:
          type: string
          description: Resource location
        id:
          type: string
          readOnly: true
          description: Resource Id
        name:
          type: string
          readOnly: true
          description: Resource name
        type:
          type: string
          readOnly: true
          description: Resource type
        tags:
          description: Resource tags
          $ref: '#/components/schemas/resourceTags'
        properties:
          description: Snapshot Policy properties
          $ref: '#/components/schemas/snapshotPolicyProperties'
          x-ms-client-flatten: true
    resourceTags:
      type: object
      additionalProperties:
        type: string
      description: Tags are a list of key-value pairs that describe the resource
    weeklySchedule:
      description: Weekly Schedule properties, make a snapshot every week at a specific day or days
      type: object
      properties:
        snapshotsToKeep:
          type: integer
          description: Weekly snapshot count to keep
          format: int32
        day:
          type: string
          description: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english
          example: Sunday,Monday
        hour:
          type: integer
          description: Indicates which hour in UTC timezone a snapshot should be taken
          example: 11
          format: int32
        minute:
          type: integer
          description: Indicates which minute snapshot should be taken
          example: 30
          format: int32
        usedBytes:
          type: integer
          description: Resource size in bytes, current storage usage for the volume in bytes
          format: int64
  parameters:
    SnapshotPolicyName:
      name: snapshotPolicyName
      in: path
      required: true
      description: The name of the snapshot policy
      x-ms-parameter-location: method
      schema:
        type: string
    AccountName:
      name: accountName
      in: path
      required: true
      description: The name of the NetApp account
      x-ms-parameter-location: method
      schema:
        type: string
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow