swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ItemLevelRecoveryConnections API
schemes:
- https
tags:
- name: ItemLevelRecoveryConnections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/provisionInstantItemRecovery
  : post:
      tags:
      - ItemLevelRecoveryConnections
      description: Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file<br>explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of<br>provisioning, call GetProtectedItemOperationResult API.
      operationId: microsoftAzureItemlevelrecoveryconnectionsProvision
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/VaultName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name associated with the backed up items.
        required: true
        type: string
      - name: containerName
        in: path
        description: Container name associated with the backed up items.
        required: true
        type: string
      - name: protectedItemName
        in: path
        description: Backed up item name whose files/folders are to be restored.
        required: true
        type: string
      - name: recoveryPointId
        in: path
        description: "Recovery point ID which represents backed up data. iSCSI connection will be provisioned\r\nfor this backed up data."
        required: true
        type: string
      - name: parameters
        in: body
        description: resource ILR request
        required: true
        schema:
          $ref: '#/definitions/ILRRequestResource'
      responses:
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Provision Instant Item Level Recovery for Azure Vm:
          $ref: ./examples/AzureIaasVm/Provision_Ilr.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Recoverypoints Recoverypointid Provisioninstantitemrecovery
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/revokeInstantItemRecovery
  : post:
      tags:
      - ItemLevelRecoveryConnections
      description: Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer<br>displaying all recoverable files and folders. This is an asynchronous operation.
      operationId: microsoftAzureItemlevelrecoveryconnectionsRevoke
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/VaultName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name associated with the backed up items.
        required: true
        type: string
      - name: containerName
        in: path
        description: Container name associated with the backed up items.
        required: true
        type: string
      - name: protectedItemName
        in: path
        description: Backed up item name whose files/folders are to be restored.
        required: true
        type: string
      - name: recoveryPointId
        in: path
        description: "Recovery point ID which represents backed up data. iSCSI connection will be revoked for\r\nthis backed up data."
        required: true
        type: string
      responses:
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Revoke Instant Item Level Recovery for Azure Vm:
          $ref: ./examples/AzureIaasVm/Revoke_Ilr.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Recoverypoints Recoverypointid Revokeinstantitemrecovery
definitions:
  Resource:
    description: ARM Resource.
    type: object
    properties:
      id:
        description: Resource Id represents the complete path to the resource.
        type: string
        readOnly: true
      name:
        description: Resource name associated with the resource.
        type: string
        readOnly: true
      type:
        description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
        type: string
        readOnly: true
      location:
        description: Resource location.
        type: string
      tags:
        description: Resource tags.
        type: object
        additionalProperties:
          type: string
      eTag:
        description: Optional ETag.
        type: string
    x-ms-azure-resource: true
  CloudError:
    x-ms-external: true
    properties:
      error:
        type: object
        $ref: '#/definitions/CloudErrorBody'
        description: The error object.
    description: An error response from the Container Instance service.
  ILRRequest:
    description: Parameters to Provision ILR API.
    required:
    - objectType
    type: object
    properties:
      objectType:
        description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
        type: string
    discriminator: objectType
  CloudErrorBody:
    x-ms-external: true
    properties:
      code:
        readOnly: true
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        readOnly: true
        type: string
        description: A message describing the error, intended to be suitable for display in a user interface.
      target:
        readOnly: true
        type: string
        description: The target of the particular error. For example, the name of the property in error.
      details:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers:
        - code
        description: A list of additional details about the error.
      additionalInfo:
        readOnly: true
        type: array
        items:
          $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo
        x-ms-identifiers: []
        description: The error additional info.
    description: An error response from the Container Instance service.
  ILRRequestResource:
    description: Parameters to Provision ILR API.
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ILRRequest'
        description: ILRRequestResource properties
parameters:
  ResourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group where the recovery services vault is present.
    required: true
    type: string
    x-ms-parameter-location: method
  VaultName:
    name: vaultName
    in: path
    description: The name of the recovery services vault.
    required: true
    type: string
    x-ms-parameter-location: method
  ApiVersion:
    name: api-version
    in: query
    description: Client Api Version.
    required: true
    type: string
  SubscriptionId:
    name: subscriptionId
    in: path
    description: The subscription Id.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'