swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NetApp Resource API
schemes:
- https
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:
      - name: body
        in: body
        description: Name availability request.
        required: true
        schema:
          $ref: '#/definitions/ResourceNameAvailabilityRequest'
        x-ms-client-flatten: true
      - $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
          schema:
            $ref: '#/definitions/CheckAvailabilityResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        CheckNameAvailability:
          $ref: examples/CheckNameAvailability.json
  /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:
      - name: body
        in: body
        description: File path availability request.
        required: true
        schema:
          $ref: '#/definitions/FilePathAvailabilityRequest'
        x-ms-client-flatten: true
      - $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
          schema:
            $ref: '#/definitions/CheckAvailabilityResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        CheckFilePathAvailability:
          $ref: examples/CheckFilePathAvailability.json
  /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:
      - name: body
        in: body
        description: Quota availability request.
        required: true
        schema:
          $ref: '#/definitions/QuotaAvailabilityRequest'
        x-ms-client-flatten: true
      - $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
          schema:
            $ref: '#/definitions/CheckAvailabilityResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        CheckQuotaAvailability:
          $ref: examples/CheckQuotaAvailability.json
  /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
          schema:
            $ref: '#/definitions/SubscriptionQuotaItemList'
        default:
          description: Error response describing why the operation failed.
          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: '#/parameters/QuotaLimitName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SubscriptionQuotaItem'
        default:
          description: Error response describing why the operation failed.
          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
          schema:
            $ref: '#/definitions/regionInfosList'
        default:
          description: Error response describing why the operation failed.
          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
          schema:
            $ref: '#/definitions/regionInfoResource'
        default:
          description: Error response describing why the operation failed.
          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
          schema:
            $ref: '#/definitions/regionInfo'
        default:
          description: Error response describing why the operation failed.
          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:
      - name: body
        in: body
        description: Network sibling set to query.
        required: true
        schema:
          $ref: '#/definitions/QueryNetworkSiblingSetRequest'
        x-ms-client-flatten: true
      - $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
          schema:
            $ref: '#/definitions/networkSiblingSet'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        NetworkSiblingSet_Query:
          $ref: examples/NetworkSiblingSet_Query.json
  /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:
      - name: body
        in: body
        description: Update for the specified network sibling set.
        required: true
        schema:
          $ref: '#/definitions/UpdateNetworkSiblingSetRequest'
        x-ms-client-flatten: true
      - $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
          schema:
            $ref: '#/definitions/networkSiblingSet'
        '202':
          description: Accepted -- Update request accepted; operation will complete asynchronously
          headers:
            Location:
              type: string
        default:
          description: Error response describing why the operation failed.
          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
definitions:
  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: '#/definitions/regionInfo'
        x-ms-client-flatten: true
  QueryNetworkSiblingSetRequest:
    title: QueryNetworkSiblingSetRequest
    description: Network sibling set query.
    type: object
    required:
    - networkSiblingSetId
    - subnetId
    properties:
      networkSiblingSetId:
        $ref: '#/definitions/networkSiblingSetId'
      subnetId:
        $ref: '#/definitions/subnetId'
  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
  regionInfosList:
    description: List of regionInfo resources
    type: object
    properties:
      value:
        description: A list of regionInfo resources
        type: array
        items:
          $ref: '#/definitions/regionInfoResource'
      nextLink:
        type: string
        description: URL to get the next set of results.
  ipAddress:
    title: ipAddress
    type: string
    readOnly: true
    example: 1.2.3.4
  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: '#/definitions/ipAddress'
      volumeResourceIds:
        $ref: '#/definitions/volumeResourceIds'
  UpdateNetworkSiblingSetRequest:
    title: UpdateNetworkSiblingSetRequest
    description: Network sibling set update.
    type: object
    required:
    - networkSiblingSetId
    - subnetId
    - networkSiblingSetStateId
    - networkFeatures
    properties:
      networkSiblingSetId:
        $ref: '#/definitions/networkSiblingSetId'
      subnetId:
        $ref: '#/definitions/subnetId'
      networkSiblingSetStateId:
        $ref: '#/definitions/networkSiblingSetStateId'
      networkFeatures:
        $ref: '#/definitions/networkFeatures'
        description: Network features available to the volume
  SubscriptionQuotaItemList:
    description: List of Subscription Quota Items
    type: object
    properties:
      value:
        description: A list of SubscriptionQuotaItems
        type: array
        items:
          $ref: '#/definitions/SubscriptionQuotaItem'
  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
  networkSiblingSet:
    title: Network sibling set
    description: Describes the contents of a network sibling set.
    type: object
    properties:
      networkSiblingSetId:
        $ref: '#/definitions/networkSiblingSetId'
      subnetId:
        $ref: '#/definitions/subnetId'
      networkSiblingSetStateId:
        $ref: '#/definitions/networkSiblingSetStateId'
      networkFeatures:
        $ref: '#/definitions/networkFeatures'
      provisioningState:
        $ref: '#/definitions/networkSiblingSetProvisioningState'
      nicInfoList:
        type: array
        x-ms-identifiers: []
        description: List of NIC information
        items:
          $ref: '#/definitions/nicInfo'
  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
  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
  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
  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
        example: '1'
        x-nullable: true
        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.
  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
  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
  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
  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'
  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
  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: '#/definitions/SubscriptionQuotaItemProperties'
        x-ms-client-flatten: 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
parameters:
  QuotaLimitName:
    name: quotaLimitName
    type: string
    in: path
    required: true
    description: The name of the Quota Limit
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'