Microsoft Azure NetApp Accounts API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NetApp Accounts API
tags:
- name: NetApp Accounts
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts:
    get:
      summary: Microsoft Azure Describe All Netapp Accounts In A Subscription
      description: List and describe all NetApp accounts in the subscription.
      tags:
      - NetApp Accounts
      operationId: microsoftAzureAccountsListbysubscription
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $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/netAppAccountList'
        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:
        Accounts_List:
          $ref: examples/Accounts_List.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts:
    get:
      summary: Microsoft Azure Describe All Netapp Accounts In A Resource Group
      description: List and describe all NetApp accounts in the resource group.
      tags:
      - NetApp Accounts
      operationId: microsoftAzureAccountsList
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $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/netAppAccountList'
        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:
        Accounts_List:
          $ref: examples/Accounts_List.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}:
    get:
      summary: Microsoft Azure Describe A Netapp Account
      description: Get the NetApp account
      tags:
      - NetApp Accounts
      operationId: microsoftAzureAccountsGet
      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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/netAppAccount'
        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:
        Accounts_Get:
          $ref: examples/Accounts_Get.json
    put:
      tags:
      - NetApp Accounts
      operationId: microsoftAzureAccountsCreateorupdate
      summary: Microsoft Azure Create Or Update A Netapp Account
      description: Create or update the specified NetApp account within the resource group
      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
      responses:
        '200':
          description: OK - account updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/netAppAccount'
        '201':
          description: Account created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/netAppAccount'
        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: azure-async-operation
      x-ms-examples:
        Accounts_CreateOrUpdate:
          $ref: examples/Accounts_CreateOrUpdate.json
        Accounts_CreateOrUpdateWithActiveDirectory:
          $ref: examples/Accounts_CreateOrUpdateAD.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/netAppAccount'
        description: NetApp Account object supplied in the body of the operation.
        required: true
    delete:
      tags:
      - NetApp Accounts
      operationId: microsoftAzureAccountsDelete
      summary: Microsoft Azure Delete A Netapp Account
      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
      description: Delete the specified NetApp account
      responses:
        '202':
          description: Accepted -- Delete 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:
        Accounts_Delete:
          $ref: examples/Accounts_Delete.json
    patch:
      tags:
      - NetApp Accounts
      operationId: microsoftAzureAccountsUpdate
      summary: Microsoft Azure Update A Netapp Account
      description: Patch the specified NetApp account
      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
      responses:
        '200':
          description: OK - account updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/netAppAccount'
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/netAppAccount'
        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:
        Accounts_Update:
          $ref: examples/Accounts_Update.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/netAppAccountPatch'
        description: NetApp Account object supplied in the body of the operation.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/renewCredentials
  : post:
      tags:
      - NetApp Accounts
      operationId: microsoftAzureAccountsRenewcredentials
      summary: Microsoft Azure Renew Identity Credentials
      description: Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.
      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
      responses:
        '200':
          description: OK - terminal state
        '202':
          description: Accepted
        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: azure-async-operation
      x-ms-examples:
        Accounts_RenewCredentials:
          $ref: examples/Accounts_RenewCredentials.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateEncryption
  : post:
      tags:
      - NetApp Accounts
      operationId: microsoftAzureAccountsMigrateencryptionkey
      summary: Microsoft Azure Migrate Volumes Encryption Key Source
      description: Migrates all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.
      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
      responses:
        '202':
          description: Accepted
          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:
        Accounts_MigrateEncryptionKey:
          $ref: examples/Accounts_MigrateEncryptionKey.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/encryptionMigrationRequest'
        description: The required parameters to perform encryption migration.
components:
  schemas:
    netAppAccount:
      description: NetApp account resource
      type: object
      required:
      - location
      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: NetApp Account properties
          $ref: '#/components/schemas/accountProperties'
          x-ms-client-flatten: true
        identity:
          description: The identity used for the resource.
          $ref: ../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity
    accountEncryption:
      type: object
      description: Encryption settings
      properties:
        keySource:
          type: string
          description: 'The encryption keySource (provider). Possible values (case-insensitive):  Microsoft.NetApp, Microsoft.KeyVault'
          enum:
          - Microsoft.NetApp
          - Microsoft.KeyVault
          x-ms-enum:
            name: KeySource
            modelAsString: true
            values:
            - value: Microsoft.NetApp
              description: Microsoft-managed key encryption
            - value: Microsoft.KeyVault
              description: Customer-managed key encryption
          default: Microsoft.NetApp
        keyVaultProperties:
          $ref: '#/components/schemas/KeyVaultProperties'
          description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'.
        identity:
          $ref: '#/components/schemas/EncryptionIdentity'
          description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'.
    encryptionMigrationRequest:
      description: Encryption migration request
      type: object
      required:
      - virtualNetworkId
      - privateEndpointId
      properties:
        virtualNetworkId:
          title: virtualNetworkId
          type: string
          description: Identifier for the virtual network
          example: /subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1
        privateEndpointId:
          title: privateEndpointId
          type: string
          description: Identifier of the private endpoint to reach the Azure Key Vault
          example: /subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1
    accountProperties:
      description: NetApp account properties
      type: object
      properties:
        provisioningState:
          type: string
          readOnly: true
          description: Azure lifecycle management
        activeDirectories:
          description: Active Directories
          type: array
          items:
            $ref: '#/components/schemas/activeDirectory'
          x-ms-identifiers:
          - activeDirectoryId
        encryption:
          description: Encryption settings
          $ref: '#/components/schemas/accountEncryption'
        disableShowmount:
          type:
          - boolean
          - 'null'
          readOnly: true
          description: Shows the status of disableShowmount for all volumes under the subscription, null equals false
        nfsV4IDDomain:
          type:
          - string
          - 'null'
          description: Domain for NFSv4 user ID mapping. This property will be set for all NetApp accounts in the subscription and region and only affect non ldap NFSv4 volumes.
          maxLength: 255
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]{0,253}[a-zA-Z0-9]$
          example: defaultv4IDDomain.com
        isMultiAdEnabled:
          type:
          - boolean
          - 'null'
          readOnly: true
          description: This will have true value only if account is Multiple AD enabled.
    ldapSearchScopeOpt:
      type: object
      description: 'LDAP search scope '
      properties:
        userDN:
          type: string
          description: This specifies the user DN, which overrides the base DN for user lookups.
          maxLength: 255
          example: OU=fin,OU=hr,dc=domain,dc=com
        groupDN:
          type: string
          description: This specifies the group DN, which overrides the base DN for group lookups.
          maxLength: 255
          example: OU=fin,OU=hr,dc=domain,dc=com
        groupMembershipFilter:
          type: string
          description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server.
          maxLength: 255
          example: cn=*99
    resourceTags:
      type: object
      additionalProperties:
        type: string
      description: Tags are a list of key-value pairs that describe the resource
    activeDirectory:
      description: Active Directory
      type: object
      properties:
        activeDirectoryId:
          type:
          - string
          - 'null'
          description: Id of the Active Directory
        username:
          type: string
          description: A domain user account with permission to create machine accounts
        password:
          type: string
          x-ms-secret: true
          maxLength: 64
          description: Plain text password of Active Directory domain administrator, value is masked in the response
        domain:
          type: string
          description: Name of the Active Directory domain
        dns:
          type: string
          description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain
          pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$
          example: 101.102.103.104,101.102.103.105
        status:
          type: string
          description: Status of the Active Directory
          readOnly: true
          enum:
          - Created
          - Updating
          - InUse
          - Deleted
          - Error
          x-ms-enum:
            name: ActiveDirectoryStatus
            modelAsString: true
            values:
            - value: Created
              description: Active Directory created but not in use
            - value: InUse
              description: Active Directory in use by SMB Volume
            - value: Deleted
              description: Active Directory Deleted
            - value: Error
              description: Error with the Active Directory
            - value: Updating
              description: Active Directory Updating
        statusDetails:
          type: string
          description: Any details in regards to the Status of the Active Directory
          readOnly: true
        smbServerName:
          type: string
          description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes
        organizationalUnit:
          type: string
          default: CN=Computers
          description: The Organizational Unit (OU) within the Windows Active Directory
        site:
          type: string
          description: The Active Directory site the service will limit Domain Controller discovery to
        backupOperators:
          description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier
          type: array
          items:
            type: string
            maxLength: 255
            minLength: 1
          example:
          - user1
          - user2
        administrators:
          description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier
          type: array
          items:
            type: string
            maxLength: 255
            minLength: 1
          example:
          - user1
          - user2
        kdcIP:
          type: string
          pattern: ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$
          description: kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.
          example: 101.102.103.104
        adName:
          type: string
          maxLength: 64
          minLength: 1
          description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume
          example: ADServerName
        serverRootCACertificate:
          type: string
          maxLength: 10240
          minLength: 1
          description: When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.
          x-ms-secret: true
          example: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuVENDQW9XZ0F3SUJBZ0lRR3FXdnRxeHBvSTFJV3Z4VGdJbElWREFOQmdrcWhraUc5dzBCQVFzRkFEQlYKTVJNd0VRWUtDWkltaVpQeUxHUUJHUllEWTI5dE1SY3dGUVlLQ1pJbWlaUHlMR1FCR1JZSGFHRnlhV3R5WWpFbApNQ01HQTFVRUF4TWNhR0Z5YVd0eVlpMVhTVTR0TWtKUFZrRkZTMEkwTkVJdFEwRXRNakFlRncweU1EQTFNRFV3Ck56TTVORGxhRncweU1EQTFNRFl3TnpRNU5EaGFNRlV4RXpBUkJnb0praWFKay9Jc1pBRVpGZ05qYjIweEZ6QVYKQmdvSmtpYUprL0lzWkFFWkZnZG9ZWEpwYTNKaU1TVXdJd1lEVlFRREV4eG9ZWEpwYTNKaUxWZEpUaTB5UWs5VwpRVVZMUWpRMFFpMURRUzB5TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqMHByCnhaaXpNaDBqYnRwN1ZOc0JrRVJ2MVpZT0MzMEtqaGRWdEExRm1MeFM2cXlycmpMZUdXOXRSd2ZnUkR0eVBodTIKZVJTcVpTUjF6Z1hZR0s0Nys3Y3F0YnB2UElOektCb0dOWERIVTNxVWlleXJWSjFDVzRKNjJodUdrbUV1VVVkMApKMXBxNTVxbjk1SmRUbWh1dmZlTUxxeHB5c01nbGVnY281ZFhoN0hsQkhwaTNKMFN4ZnhVWmxKMVZiOFJZVEZhCkJiMGFlTVZaRzRKeVREaktiMlR1TmFXOG1aUE5vOFBMRDRocjdndFNZUEQvQ1dVVGV5QlpoZC9LTzNPczlWVEIKYmpLUGtWd0J2WEs2SlFMSGprNFBHS3VYZDhaWVFyajBtOWNIZDNmcWNYTXlQUnQ2TlJ4ak0yMTUxckFzSkVhNgpWZC9ta056akpXalBrT2VZUVFJREFRQUJvMmt3WnpBVEJna3JCZ0VFQVlJM0ZBSUVCaDRFQUVNQVFUQU9CZ05WCkhROEJBZjhFQkFNQ0FZWXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVVDVEc2ODJSay9kMysKWGtHa0VMakRFMjI4ZjNnd0VBWUpLd1lCQkFHQ054VUJCQU1DQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQgpBR1RjTTNnWExIU05wS014RHEvUFpZbWZCMmNlN3VhMmxxbXpzZSt4QmthSTE0WXdzZE5ZQjZBVTNFWDM3QWpZCjd3bm9xQzY1N0U2RVhTODVDckoyNXJNTHo4OEtONGI3cUg5RUowSS9XVHg5YTdUT0ZENENWQThuL0xwNGh1Ym4KNlBFalY5NFlZWXBXTG1hTkkvbGFReWsxSHVJbDFSTCttVDFnSWQ4ZWZXZ1UvNmlVVEw3eGMrdjkyNHBuTHhISwpOSnNTV3c0NFk5a0R5SU9KOXFjWUlBN1lhTkxPZTRjSysvQlRvdDh0dVVKT1hHLzdBRmtxR2EyQVA4MmFZOStKCnkwSmU2OG5nTHJ1dVU4VHpneVpqdkFHcTRrVEVOdWFoaFdHVC9KWkEzOXhSNUV4MmNMUUplcE5NdnlZbUZ3Z1UKME8zYlA0OWNBVFVCMXoyQ3Y5aTRQbVk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
        aesEncryption:
          type: boolean
          description: If enabled, AES encryption will be enabled for SMB communication.
        ldapSigning:
          type: boolean
          description: Specifies whether or not the LDAP traffic needs to be signed.
        securityOperators:
          type: array
          description: Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier
          items:
            type: string
            maxLength: 255
            minLength: 1
          example:
          - user1
          - user2
        ldapOverTLS:
          type: boolean
          description: Specifies whether or not the LDAP traffic needs to be secured via TLS.
        allowLocalNfsUsersWithLdap:
          type: boolean
          description: ' If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.'
        encryptDCConnections:
          type: boolean
          description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted.
        ldapSearchScope:
          description: LDAP Search scope options
          $ref: '#/components/schemas/ldapSearchScopeOpt'
        preferredServersForLdapClient:
          type: string
          maxLength: 32
          pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))?)?$
          description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.
          example: 101.102.103.104, 101.102.103.105
    KeyVaultProperties:
      description: Properties of key vault.
      type: object
      required:
      - keyVaultUri
      - keyName
      - keyVaultResourceId
      properties:
        keyVaultId:
          type: string
          description: UUID v4 used to identify the Azure Key Vault configuration
          readOnly: true
          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-020073ca7778
        keyVaultUri:
          type: string
          description: The Uri of KeyVault.
        keyName:
          type: string
          description: The name of KeyVault key.
        keyVaultResourceId:
          type: string
          description: The resource ID of KeyVault.
        status:
          type: string
          description: Status of the KeyVault connection.
          readOnly: true
          enum:
          - Created
          - Updating
          - InUse
          - Deleted
          - Error
          x-ms-enum:
            name: KeyVaultStatus
            modelAsString: true
            values:
            - value: Created
              description: KeyVault connection created but not in use
            - value: InUse
              description: KeyVault connection in use by SMB Volume
            - value: Deleted
              description: KeyVault connection Deleted
            - value: Error
              description: Error with the KeyVault connection
            - value: Updating
              description: KeyVault connection Updating
    netAppAccountList:
      description: List of NetApp account resources
      type: object
      properties:
        value:
          type: array
          description: Multiple NetApp accounts
          items:
            $ref: '#/components/schemas/netAppAccount'
        nextLink:
          type: string
          description: URL to get the next set of results.
    netAppAccountPatch:
      description: NetApp account patch resource
      type: object
      x-ms-azure-resource: true
      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: NetApp Account properties
          $ref: '#/components/schemas/accountProperties'
          x-ms-client-flatten: true
        identity:
          description: The identity used for the resource.
          $ref: ../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity
    EncryptionIdentity:
      description: Identity used to authenticate with key vault.
      type: object
      properties:
        principalId:
          type: string
          description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only.
          readOnly: true
        userAssignedIdentity:
          type: string
          description: The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities.
  parameters:
    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}$
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'