Microsoft Azure ProtectedItems API

openapi: 3.2.0
info:
  version: 2022-09-30-preview
  title: Microsoft Azure RecoveryServicesBackupClient Protected…
  x-ms-code-generation-settings:
    internalConstructors: false
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ProtectedItems
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
  : get:
      tags:
      - ProtectedItems
      description: 'Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,

        call the GetItemOperationResult API.'
      operationId: microsoftAzureProtecteditemsGet
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/VaultName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name associated with the backed up item.
        required: true
        schema:
          type: string
      - name: containerName
        in: path
        description: Container name associated with the backed up item.
        required: true
        schema:
          type: string
      - name: protectedItemName
        in: path
        description: Backed up item name whose details are to be fetched.
        required: true
        schema:
          type: string
      - name: $filter
        in: query
        description: OData filter options.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectedItemResource'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-odata: '#/definitions/GetProtectedItemQueryObject'
      x-ms-examples:
        Get Protected Classic Virtual Machine Details:
          $ref: ./examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json
        Get Protected Virtual Machine Details:
          $ref: ./examples/AzureIaasVm/Compute_ProtectedItem_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - ProtectedItems
      description: 'Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an

        asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.'
      operationId: microsoftAzureProtecteditemsCreateorupdate
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/VaultName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name associated with the backup item.
        required: true
        schema:
          type: string
      - name: containerName
        in: path
        description: Container name associated with the backup item.
        required: true
        schema:
          type: string
      - name: protectedItemName
        in: path
        description: Item name to be backed up.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectedItemResource'
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Enable Protection on Azure IaasVm:
          $ref: ./examples/AzureIaasVm/ConfigureProtection.json
        Stop Protection with retain data on Azure IaasVm:
          $ref: ./examples/AzureIaasVm/StopProtection.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtectedItemResource'
        description: resource backed up item
        required: true
    delete:
      tags:
      - ProtectedItems
      description: 'Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the

        request, call the GetItemOperationResult API.'
      operationId: microsoftAzureProtecteditemsDelete
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/VaultName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name associated with the backed up item.
        required: true
        schema:
          type: string
      - name: containerName
        in: path
        description: Container name associated with the backed up item.
        required: true
        schema:
          type: string
      - name: protectedItemName
        in: path
        description: Backed up item to be deleted.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: NoContent
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Delete Protection from Azure Virtual Machine:
          $ref: ./examples/Common/ProtectedItem_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    ProtectedItem:
      description: Base class for backup items.
      required:
      - protectedItemType
      type: object
      properties:
        protectedItemType:
          description: backup item type.
          type: string
        backupManagementType:
          description: Type of backup management for the backed up item.
          enum:
          - Invalid
          - AzureIaasVM
          - MAB
          - DPM
          - AzureBackupServer
          - AzureSql
          - AzureStorage
          - AzureWorkload
          - DefaultBackup
          type: string
          x-ms-enum:
            name: BackupManagementType
            modelAsString: true
          readOnly: true
        workloadType:
          description: Type of workload this item represents.
          enum:
          - Invalid
          - VM
          - FileFolder
          - AzureSqlDb
          - SQLDB
          - Exchange
          - Sharepoint
          - VMwareVM
          - SystemState
          - Client
          - GenericDataSource
          - SQLDataBase
          - AzureFileShare
          - SAPHanaDatabase
          - SAPAseDatabase
          - SAPHanaDBInstance
          type: string
          x-ms-enum:
            name: DataSourceType
            modelAsString: true
          readOnly: true
        containerName:
          description: Unique name of container
          type: string
        sourceResourceId:
          description: ARM ID of the resource to be backed up.
          type: string
        policyId:
          description: ID of the backup policy with which this item is backed up.
          type: string
        lastRecoveryPoint:
          format: date-time
          description: Timestamp when the last (latest) backup copy was created for this backup item.
          type: string
        backupSetName:
          description: Name of the backup set the backup item belongs to
          type: string
        createMode:
          description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
          enum:
          - Invalid
          - Default
          - Recover
          type: string
          x-ms-enum:
            name: CreateMode
            modelAsString: true
        deferredDeleteTimeInUTC:
          format: date-time
          description: Time for deferred deletion in UTC
          type: string
        isScheduledForDeferredDelete:
          description: Flag to identify whether the DS is scheduled for deferred delete
          type: boolean
        deferredDeleteTimeRemaining:
          description: Time remaining before the DS marked for deferred delete is permanently deleted
          type: string
        isDeferredDeleteScheduleUpcoming:
          description: Flag to identify whether the deferred deleted DS is to be purged soon
          type: boolean
        isRehydrate:
          description: Flag to identify that deferred deleted DS is to be moved into Pause state
          type: boolean
        resourceGuardOperationRequests:
          description: ResourceGuardOperationRequests on which LAC check will be performed
          type: array
          items:
            type: string
        isArchiveEnabled:
          description: Flag to identify whether datasource is protected in archive
          type: boolean
        policyName:
          description: Name of the policy used for protection
          type: string
        softDeleteRetentionPeriod:
          format: int32
          description: Soft delete retention period in days
          type: integer
      discriminator:
        propertyName: protectedItemType
    CloudError:
      x-ms-external: true
      properties:
        error:
          type: object
          $ref: '#/components/schemas/CloudErrorBody'
          description: The error object.
      description: An error response from the Container Instance service.
    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: '#/components/schemas/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.
    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
    ProtectedItemResource:
      description: Base class for backup items.
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          $ref: '#/components/schemas/ProtectedItem'
          description: ProtectedItemResource properties
  parameters:
    ResourceGroupName:
      name: resourceGroupName
      in: path
      description: The name of the resource group where the recovery services vault is present.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    SubscriptionId:
      name: subscriptionId
      in: path
      description: The subscription Id.
      required: true
      schema:
        type: string
    ApiVersion:
      name: api-version
      in: query
      description: Client Api Version.
      required: true
      schema:
        type: string
    VaultName:
      name: vaultName
      in: path
      description: The name of the recovery services vault.
      required: true
      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