Microsoft Azure NetApp Resource API

openapi: 3.2.0
info:
  title: Microsoft Azure Microsoft NetApp NetApp Resource 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: NetApp Resource
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability:
    post:
      tags:
      - NetApp Resource
      summary: Microsoft Azure Check Resource Name Availability
      description: Check if a resource name is available.
      operationId: microsoftAzureNetappresourceChecknameavailability
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckAvailabilityResponse'
        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:
        CheckNameAvailability:
          $ref: examples/CheckNameAvailability.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceNameAvailabilityRequest'
        description: Name availability request.
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability:
    post:
      tags:
      - NetApp Resource
      summary: Microsoft Azure Check File Path Availability
      description: Check if a file path is available.
      operationId: microsoftAzureNetappresourceCheckfilepathavailability
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckAvailabilityResponse'
        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:
        CheckFilePathAvailability:
          $ref: examples/CheckFilePathAvailability.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilePathAvailabilityRequest'
        description: File path availability request.
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability:
    post:
      tags:
      - NetApp Resource
      summary: Microsoft Azure Check Quota Availability
      description: Check if a quota is available.
      operationId: microsoftAzureNetappresourceCheckquotaavailability
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckAvailabilityResponse'
        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:
        CheckQuotaAvailability:
          $ref: examples/CheckQuotaAvailability.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuotaAvailabilityRequest'
        description: Quota availability request.
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits:
    get:
      tags:
      - NetApp Resource
      summary: Microsoft Azure Get Quota Limits
      description: Get the default and current limits for quotas
      operationId: microsoftAzureNetappresourcequotalimitsList
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $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/SubscriptionQuotaItemList'
        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:
        QuotaLimits:
          $ref: examples/QuotaLimits_List.json
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}:
    get:
      tags:
      - NetApp Resource
      summary: Microsoft Azure Get Quota Limits
      description: Get the default and current subscription quota limit
      operationId: microsoftAzureNetappresourcequotalimitsGet
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: '#/components/parameters/QuotaLimitName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionQuotaItem'
        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:
        QuotaLimits:
          $ref: examples/QuotaLimits_Get.json
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos:
    get:
      summary: Microsoft Azure Describes Region Specific Information
      description: Provides region specific information.
      tags:
      - NetApp Resource
      operationId: microsoftAzureNetappresourceregioninfosList
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/regionInfosList'
        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:
        RegionInfos_List:
          $ref: examples/RegionInfos_List.json
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default:
    get:
      summary: Microsoft Azure Describes Region Specific Information
      description: Provides storage to network proximity and logical zone mapping information.
      tags:
      - NetApp Resource
      operationId: microsoftAzureNetappresourceregioninfosGet
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/regionInfoResource'
        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-pageable:
        nextLinkName: null
      x-ms-examples:
        RegionInfos_Get:
          $ref: examples/RegionInfos_Get.json
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo:
    get:
      summary: Microsoft Azure Describes Region Specific Information
      description: Provides storage to network proximity and logical zone mapping information.
      tags:
      - NetApp Resource
      operationId: microsoftAzureNetappresourceQueryregioninfo
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/regionInfo'
        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:
        RegionInfo_Query:
          $ref: examples/RegionInfo.json
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet:
    post:
      tags:
      - NetApp Resource
      summary: Microsoft Azure Describe A Network Sibling Set
      description: Get details of the specified network sibling set.
      operationId: microsoftAzureNetappresourceQuerynetworksiblingset
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/networkSiblingSet'
        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:
        NetworkSiblingSet_Query:
          $ref: examples/NetworkSiblingSet_Query.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryNetworkSiblingSetRequest'
        description: Network sibling set to query.
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet:
    post:
      tags:
      - NetApp Resource
      summary: Microsoft Azure Update The Network Features Of A Network Sibling Set
      description: Update the network features of the specified network sibling set.
      operationId: microsoftAzureNetappresourceUpdatenetworksiblingset
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/networkSiblingSet'
        '202':
          description: Accepted -- Update request accepted; operation will complete asynchronously
          headers:
            Location:
              schema:
                type: string
        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:
        NetworkFeatures_Update:
          $ref: examples/NetworkSiblingSet_Update.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNetworkSiblingSetRequest'
        description: Update for the specified network sibling set.
        required: true
components:
  schemas:
    SubscriptionQuotaItemProperties:
      description: SubscriptionQuotaItem Properties
      type: object
      properties:
        current:
          description: The current quota value.
          readOnly: true
          type: integer
          format: int32
        default:
          description: The default quota value.
          readOnly: true
          type: integer
          format: int32
    SubscriptionQuotaItem:
      description: Information regarding Subscription Quota Item.
      type: object
      allOf:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
      properties:
        properties:
          description: SubscriptionQuotaItem properties
          $ref: '#/components/schemas/SubscriptionQuotaItemProperties'
          x-ms-client-flatten: true
    QueryNetworkSiblingSetRequest:
      title: QueryNetworkSiblingSetRequest
      description: Network sibling set query.
      type: object
      required:
      - networkSiblingSetId
      - subnetId
      properties:
        networkSiblingSetId:
          $ref: '#/components/schemas/networkSiblingSetId'
        subnetId:
          $ref: '#/components/schemas/subnetId'
    CheckAvailabilityResponse:
      description: Information regarding availability of a resource.
      type: object
      properties:
        isAvailable:
          description: <code>true</code> indicates name is valid and available. <code>false</code> indicates the name is invalid, unavailable, or both.
          type: boolean
        reason:
          description: <code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable.
          enum:
          - Invalid
          - AlreadyExists
          type: string
          x-ms-enum:
            name: InAvailabilityReasonType
            modelAsString: true
        message:
          description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.
          type: string
    nicInfo:
      title: NIC information
      description: NIC information and list of volumes for which the NIC has the primary mount ip address.
      type: object
      properties:
        ipAddress:
          $ref: '#/components/schemas/ipAddress'
        volumeResourceIds:
          $ref: '#/components/schemas/volumeResourceIds'
    regionInfosList:
      description: List of regionInfo resources
      type: object
      properties:
        value:
          description: A list of regionInfo resources
          type: array
          items:
            $ref: '#/components/schemas/regionInfoResource'
        nextLink:
          type: string
          description: URL to get the next set of results.
    SubscriptionQuotaItemList:
      description: List of Subscription Quota Items
      type: object
      properties:
        value:
          description: A list of SubscriptionQuotaItems
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionQuotaItem'
    regionInfo:
      description: Provides region specific information.
      type: object
      properties:
        storageToNetworkProximity:
          title: Storage to Network Proximity
          description: Provides storage to network proximity information in the region.
          type: string
          enum:
          - Default
          - T1
          - T2
          - AcrossT2
          - T1AndT2
          - T1AndAcrossT2
          - T2AndAcrossT2
          - T1AndT2AndAcrossT2
          x-ms-enum:
            name: RegionStorageToNetworkProximity
            modelAsString: true
            values:
            - value: Default
              description: Basic network connectivity.
            - value: T1
              description: Standard T1 network connectivity.
            - value: T2
              description: Standard T2 network connectivity.
            - value: AcrossT2
              description: Standard AcrossT2 network connectivity.
            - value: T1AndT2
              description: Standard T1 and T2 network connectivity.
            - value: T1AndAcrossT2
              description: Standard T1 and AcrossT2 network connectivity.
            - value: T2AndAcrossT2
              description: Standard T2 and AcrossT2 network connectivity.
            - value: T1AndT2AndAcrossT2
              description: Standard T1, T2 and AcrossT2 network connectivity.
          example: T2
        availabilityZoneMappings:
          title: Logical availability zone mappings.
          description: Provides logical availability zone mappings for the subscription for a region.
          type: array
          x-ms-identifiers:
          - availabilityZone
          items:
            type: object
            properties:
              availabilityZone:
                description: Logical availability zone.
                type: string
                example: '1'
              isAvailable:
                description: Available availability zone
                type: boolean
                example: true
    networkFeatures:
      title: Network features
      description: Network features available to the volume, or current state of update.
      type: string
      enum:
      - Basic
      - Standard
      - Basic_Standard
      - Standard_Basic
      x-ms-enum:
        name: NetworkFeatures
        modelAsString: true
        values:
        - value: Basic
          description: Basic network features.
        - value: Standard
          description: Standard network features.
        - value: Basic_Standard
          description: Updating from Basic to Standard network features.
        - value: Standard_Basic
          description: Updating from Standard to Basic network features.
      example: Standard
      default: Basic
    networkSiblingSetId:
      title: Network Sibling Set ID
      description: Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.
      type: string
      pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
      maxLength: 36
      minLength: 36
      example: 9760acf5-4638-11e7-9bdb-020073ca3333
    ipAddress:
      title: ipAddress
      type: string
      readOnly: true
      example: 1.2.3.4
    regionInfoResource:
      description: Information regarding regionInfo Item.
      type: object
      allOf:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
      properties:
        properties:
          description: regionInfo properties
          $ref: '#/components/schemas/regionInfo'
          x-ms-client-flatten: true
    QuotaAvailabilityRequest:
      description: Quota availability request content.
      required:
      - name
      - type
      - resourceGroup
      type: object
      properties:
        name:
          description: Name of the resource to verify.
          type: string
        type:
          description: Resource type used for verification.
          enum:
          - Microsoft.NetApp/netAppAccounts
          - Microsoft.NetApp/netAppAccounts/capacityPools
          - Microsoft.NetApp/netAppAccounts/capacityPools/volumes
          - Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots
          type: string
          x-ms-enum:
            name: CheckQuotaNameResourceTypes
            modelAsString: true
        resourceGroup:
          description: Resource group name.
          type: string
    ResourceNameAvailabilityRequest:
      description: Resource name availability request content.
      required:
      - name
      - type
      - resourceGroup
      type: object
      properties:
        name:
          description: Resource name to verify.
          type: string
        type:
          description: Resource type used for verification.
          enum:
          - Microsoft.NetApp/netAppAccounts
          - Microsoft.NetApp/netAppAccounts/capacityPools
          - Microsoft.NetApp/netAppAccounts/capacityPools/volumes
          - Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots
          type: string
          x-ms-enum:
            name: CheckNameResourceTypes
            modelAsString: true
        resourceGroup:
          description: Resource group name.
          type: string
    networkSiblingSetProvisioningState:
      readOnly: true
      type: string
      description: Gets the status of the NetworkSiblingSet at the time the operation was called.
      enum:
      - Succeeded
      - Failed
      - Canceled
      - Updating
      x-ms-enum:
        name: NetworkSiblingSetProvisioningState
        modelAsString: true
    volumeResourceIds:
      title: Volume resource Ids
      type: array
      items:
        title: Resource Id of volume
        type: string
        format: arm-id
        x-ms-arm-id-details:
          allowedResources:
          - type: Microsoft.NetApp/netAppAccounts/capacityPools/volumes
    networkSiblingSetStateId:
      title: Network sibling set state Id
      description: Network sibling set state Id identifying the current state of the sibling set.
      type: string
      example: '12345_44420.8001578125'
    networkSiblingSet:
      title: Network sibling set
      description: Describes the contents of a network sibling set.
      type: object
      properties:
        networkSiblingSetId:
          $ref: '#/components/schemas/networkSiblingSetId'
        subnetId:
          $ref: '#/components/schemas/subnetId'
        networkSiblingSetStateId:
          $ref: '#/components/schemas/networkSiblingSetStateId'
        networkFeatures:
          $ref: '#/components/schemas/networkFeatures'
        provisioningState:
          $ref: '#/components/schemas/networkSiblingSetProvisioningState'
        nicInfoList:
          type: array
          x-ms-identifiers: []
          description: List of NIC information
          items:
            $ref: '#/components/schemas/nicInfo'
    UpdateNetworkSiblingSetRequest:
      title: UpdateNetworkSiblingSetRequest
      description: Network sibling set update.
      type: object
      required:
      - networkSiblingSetId
      - subnetId
      - networkSiblingSetStateId
      - networkFeatures
      properties:
        networkSiblingSetId:
          $ref: '#/components/schemas/networkSiblingSetId'
        subnetId:
          $ref: '#/components/schemas/subnetId'
        networkSiblingSetStateId:
          $ref: '#/components/schemas/networkSiblingSetStateId'
        networkFeatures:
          $ref: '#/components/schemas/networkFeatures'
          description: Network features available to the volume
    subnetId:
      title: Subnet resource Id
      description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}
      type: string
      format: arm-id
      x-ms-arm-id-details:
        allowedResources:
        - type: Microsoft.Network/virtualNetworks/subnets
    FilePathAvailabilityRequest:
      description: File path availability request content - availability is based on the name and the subnetId.
      required:
      - name
      - subnetId
      type: object
      properties:
        name:
          description: File path to verify.
          type: string
        subnetId:
          type: string
          description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
        availabilityZone:
          title: Logical availability zone
          type:
          - string
          - 'null'
          example: '1'
          description: The Azure Resource logical availability zone which is used within zone mapping lookup for the subscription and region. The lookup will retrieve the physical zone where volume is placed.
  parameters:
    QuotaLimitName:
      name: quotaLimitName
      in: path
      required: true
      description: The name of the Quota Limit
      x-ms-parameter-location: method
      schema:
        type: string
  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