swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector IscsiTargets API
  description: APIs for iSCSI target operations.
schemes:
- https
tags:
- name: IscsiTargets
  description: APIs for iSCSI target operations.
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets
  : get:
      tags:
      - IscsiTargets
      description: Get iSCSI Targets in a Disk pool.
      operationId: microsoftAzureIscsitargetsListbydiskpool
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Operation completed successfully; retrieved iSCSI Targets in a Disk pool.
          schema:
            $ref: '#/definitions/IscsiTargetList'
        default:
          description: Error from the RP
          schema:
            $ref: '#/definitions/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List Disk Pools by Resource Group:
          $ref: ./examples/IscsiTargets_ListByDiskPool.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname Iscsitargets
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/iscsiTargets/{iscsiTargetName}
  : put:
      tags:
      - IscsiTargets
      description: Create or Update an iSCSI Target.
      operationId: microsoftAzureIscsitargetsCreateorupdate
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/IscsiTargetName'
      - $ref: '#/parameters/IscsiTargetCreate'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK -- Returned when the create or update operation is successfully completed.
          schema:
            $ref: '#/definitions/IscsiTarget'
        '201':
          description: Accepted -- Create or update request accepted; operation will complete asynchronously.
          schema:
            $ref: '#/definitions/IscsiTarget'
        default:
          description: Error from the RP.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Create or Update iSCSI Target:
          $ref: ./examples/IscsiTargets_Put.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname Iscsitargets Iscsitargetname
    patch:
      tags:
      - IscsiTargets
      description: Update an iSCSI Target.
      operationId: microsoftAzureIscsitargetsUpdate
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/IscsiTargetName'
      - $ref: '#/parameters/IscsiTargetUpdate'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK -- Returned when the update operation is successfully completed.
          schema:
            $ref: '#/definitions/IscsiTarget'
        '202':
          description: Accepted -- Update request accepted; operation will complete asynchronously.
        default:
          description: Error from the RP.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Update iSCSI Target:
          $ref: ./examples/IscsiTargets_Patch.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname Iscsitargets Iscsitargetname
    delete:
      tags:
      - IscsiTargets
      description: Delete an iSCSI Target.
      operationId: microsoftAzureIscsitargetsDelete
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/IscsiTargetName'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Delete operation completed successfully.
        '202':
          description: Delete request accepted; operation will complete asynchronously.
        '204':
          description: Resource does not exist in the subscription.
        default:
          description: Error from the RP
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Delete iSCSI Target:
          $ref: ./examples/IscsiTargets_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname Iscsitargets Iscsitargetname
    get:
      tags:
      - IscsiTargets
      description: Get an iSCSI Target.
      operationId: microsoftAzureIscsitargetsGet
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/IscsiTargetName'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Operation completed successfully; retrieved iSCSI Target.
          schema:
            $ref: '#/definitions/IscsiTarget'
        default:
          description: Error from the RP.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get iSCSI Target:
          $ref: ./examples/IscsiTargets_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname Iscsitargets Iscsitargetname
definitions:
  ProxyResource:
    description: The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
    allOf:
    - $ref: '#/definitions/Resource'
  ErrorAdditionalInfo:
    properties:
      type:
        readOnly: true
        type: string
        description: The additional info type.
      info:
        readOnly: true
        type: object
        description: The additional info.
    description: The resource management error additional info.
  IscsiTargetUpdate:
    type: object
    description: Payload for iSCSI Target update requests.
    required:
    - properties
    properties:
      properties:
        x-ms-client-flatten: true
        description: Properties for iSCSI Target update request.
        $ref: '#/definitions/IscsiTargetUpdateProperties'
    allOf:
    - $ref: '#/definitions/ProxyResource'
  Resource:
    description: ARM resource model definition.
    properties:
      id:
        readOnly: true
        type: string
        description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
      name:
        readOnly: true
        type: string
        description: The name of the resource
      type:
        readOnly: true
        type: string
        description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
    x-ms-azure-resource: true
  IscsiLun:
    type: object
    required:
    - name
    - managedDiskAzureResourceId
    description: LUN to expose the Azure Managed Disk.
    additionalProperties: false
    properties:
      name:
        type: string
        minimum: 1
        maximum: 90
        description: 'User defined name for iSCSI LUN; example: "lun0"'
      managedDiskAzureResourceId:
        type: string
        description: Azure Resource ID of the Managed Disk.
      lun:
        type: integer
        format: int32
        readOnly: true
        description: Specifies the Logical Unit Number of the iSCSI LUN.
  IscsiTargetCreateProperties:
    type: object
    description: Properties for iSCSI Target create or update request.
    required:
    - aclMode
    properties:
      aclMode:
        description: Mode for Target connectivity.
        type: string
        $ref: '#/definitions/AclMode'
      targetIqn:
        type: string
        description: 'iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".'
      staticAcls:
        type: array
        description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy
        items:
          $ref: '#/definitions/Acl'
      luns:
        type: array
        description: List of LUNs to be exposed through iSCSI Target.
        items:
          $ref: '#/definitions/IscsiLun'
  Error:
    type: object
    description: The resource management error response.
    properties:
      error:
        type: object
        description: RP error response.
        $ref: '#/definitions/ErrorResponse'
  IscsiTarget:
    type: object
    description: Response for iSCSI Target requests.
    required:
    - properties
    properties:
      properties:
        x-ms-client-flatten: true
        description: Properties for iSCSI Target operations.
        $ref: '#/definitions/IscsiTargetProperties'
      systemData:
        description: Resource metadata required by ARM RPC
        $ref: '#/definitions/SystemMetadata'
    allOf:
    - $ref: '#/definitions/ProxyResource'
  OperationalStatus:
    type: string
    enum:
    - Invalid
    - Unknown
    - Healthy
    - Unhealthy
    - Updating
    - Running
    - Stopped
    - Stopped (deallocated)
    x-ms-enum:
      name: OperationalStatus
      modelAsString: true
    description: Operational status of the resource.
  ErrorResponse:
    properties:
      code:
        readOnly: true
        type: string
        description: The error code.
      message:
        readOnly: true
        type: string
        description: The error message.
      target:
        readOnly: true
        type: string
        description: The error target.
      details:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ErrorResponse'
        description: The error details.
      additionalInfo:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ErrorAdditionalInfo'
        description: The error additional info.
    description: The resource management error response.
  IscsiTargetCreate:
    type: object
    description: Payload for iSCSI Target create or update requests.
    required:
    - properties
    properties:
      properties:
        x-ms-client-flatten: true
        description: Properties for iSCSI Target create request.
        $ref: '#/definitions/IscsiTargetCreateProperties'
    allOf:
    - $ref: '#/definitions/ProxyResource'
  Acl:
    type: object
    description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy
    required:
    - initiatorIqn
    - mappedLuns
    properties:
      initiatorIqn:
        type: string
        description: 'iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client".'
      mappedLuns:
        type: array
        description: List of LUN names mapped to the ACL.
        items:
          type: string
  AclMode:
    type: string
    enum:
    - Dynamic
    - Static
    x-ms-enum:
      name: IscsiTargetAclMode
      modelAsString: true
    description: ACL mode for iSCSI Target.
  IscsiTargetProperties:
    type: object
    description: Response properties for iSCSI Target operations.
    required:
    - targetIqn
    - provisioningState
    - status
    - aclMode
    properties:
      aclMode:
        description: Mode for Target connectivity.
        type: string
        $ref: '#/definitions/AclMode'
      staticAcls:
        type: array
        description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy
        items:
          $ref: '#/definitions/Acl'
      luns:
        type: array
        description: List of LUNs to be exposed through iSCSI Target.
        items:
          $ref: '#/definitions/IscsiLun'
      targetIqn:
        type: string
        description: 'iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".'
      provisioningState:
        description: State of the operation on the resource.
        type: string
        $ref: '#/definitions/ProvisioningState'
      status:
        type: string
        $ref: '#/definitions/OperationalStatus'
        description: Operational status of the iSCSI Target.
      endpoints:
        description: List of private IPv4 addresses to connect to the iSCSI Target.
        type: array
        items:
          type: string
      port:
        type: integer
        format: int32
        description: The port used by iSCSI Target portal group.
  ProvisioningState:
    type: string
    enum:
    - Invalid
    - Succeeded
    - Failed
    - Canceled
    - Pending
    - Creating
    - Updating
    - Deleting
    x-ms-enum:
      name: ProvisioningStates
      modelAsString: true
    description: Provisioning state of the iSCSI Target.
    readOnly: true
  SystemMetadata:
    description: Metadata pertaining to creation and last modification of the resource.
    type: object
    readOnly: true
    properties:
      createdBy:
        type: string
        description: The identity that created the resource.
      createdByType:
        type: string
        description: The type of identity that created the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        x-ms-enum:
          name: createdByType
          modelAsString: true
      createdAt:
        type: string
        format: date-time
        description: The timestamp of resource creation (UTC).
      lastModifiedBy:
        type: string
        description: The identity that last modified the resource.
      lastModifiedByType:
        type: string
        description: The type of identity that last modified the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        x-ms-enum:
          name: createdByType
          modelAsString: true
      lastModifiedAt:
        type: string
        format: date-time
        description: The type of identity that last modified the resource.
  IscsiTargetUpdateProperties:
    type: object
    description: Properties for iSCSI Target update request.
    properties:
      staticAcls:
        type: array
        description: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy
        items:
          $ref: '#/definitions/Acl'
      luns:
        type: array
        description: List of LUNs to be exposed through iSCSI Target.
        items:
          $ref: '#/definitions/IscsiLun'
  IscsiTargetList:
    type: object
    required:
    - value
    description: List of iSCSI Targets.
    additionalProperties: false
    properties:
      value:
        type: array
        description: An array of iSCSI Targets in a Disk Pool.
        items:
          $ref: '#/definitions/IscsiTarget'
      nextLink:
        description: URI to fetch the next section of the paginated response.
        type: string
        readOnly: true
parameters:
  IscsiTargetCreate:
    name: iscsiTargetCreatePayload
    required: true
    in: body
    description: Request payload for iSCSI Target create operation.
    schema:
      $ref: '#/definitions/IscsiTargetCreate'
    x-ms-parameter-location: method
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to use for this operation.
    minLength: 1
  IscsiTargetUpdate:
    name: iscsiTargetUpdatePayload
    required: true
    in: body
    description: Request payload for iSCSI Target update operation.
    schema:
      $ref: '#/definitions/IscsiTargetUpdate'
    x-ms-parameter-location: method
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group. The name is case insensitive.
    pattern: ^[-\w\._]*[0-9A-Za-z]$
    minLength: 1
    maxLength: 90
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The ID of the target subscription.
    minLength: 1
  IscsiTargetName:
    name: iscsiTargetName
    type: string
    required: true
    in: path
    description: The name of the iSCSI Target.
    x-ms-parameter-location: method
  DiskPoolName:
    name: diskPoolName
    in: path
    required: true
    type: string
    description: The name of the Disk Pool.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'