Microsoft Azure Backup Policies API

openapi: 3.2.0
info:
  title: Microsoft Azure Backup Policies API
  x-refined-note:
  - x-ms-code-generation-settings differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged BackupPolicies across 3 of this provider''s published API definitions: dataprotectionbackupclient-openapi-original.yml, recoveryservicesbackupclient-openapi-original.yml, storsimple8000seriesmanagementclient-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Backup Policies
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies
  : get:
      tags:
      - Backup Policies
      description: Returns list of backup policies belonging to a backup vault
      operationId: microsoftAzureBackuppoliciesList
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/VaultName'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseBackupPolicyResourceList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List BackupPolicy:
          $ref: ./examples/PolicyCRUD/ListBackupPolicy.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}
  : get:
      tags:
      - Backup Policies
      operationId: microsoftAzureBackuppoliciesGet
      description: Gets a backup policy belonging to a backup vault
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/VaultName'
      - name: backupPolicyName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseBackupPolicyResource'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Microsoft Azure Gets A Backup Policy Belonging To A Backup Vault
      x-ms-examples:
        Get BackupPolicy:
          $ref: ./examples/PolicyCRUD/GetBackupPolicy.json
    put:
      tags:
      - Backup Policies
      operationId: microsoftAzureBackuppoliciesCreateorupdate
      summary: Microsoft Azure Creates Or Updates A Backup Policy Belonging To A Backup Vault
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/VaultName'
      - name: backupPolicyName
        description: Name of the policy
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseBackupPolicyResource'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        CreateOrUpdate BackupPolicy:
          $ref: ./examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseBackupPolicyResource'
        description: Request body for operation
        required: true
    delete:
      tags:
      - Backup Policies
      operationId: microsoftAzureBackuppoliciesDelete
      summary: Microsoft Azure Deletes A Backup Policy Belonging To A Backup Vault
      parameters:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/VaultName'
      - name: backupPolicyName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: NoContent
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Delete BackupPolicy:
          $ref: ./examples/PolicyCRUD/DeleteBackupPolicy.json
      description: Needs a more full description created.
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies
  : get:
      tags:
      - Backup Policies
      description: 'Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch

        scoped results.'
      operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftRecoveryServicesVaultsByVaultNameBackupPolicies
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/VaultName_2'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: $filter
        in: query
        description: OData filter options.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectionPolicyResourceList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError_2'
      x-ms-odata: '#/definitions/ProtectionPolicyQueryObject'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List protection policies with backupManagementType filter as AzureIaasVm:
          $ref: ./examples/AzureIaasVm/BackupPolicies_List.json
        List protection policies with backupManagementType filter as AzureIaasVm with both V1 and V2 policies:
          $ref: ./examples/AzureIaasVm/V2Policy/v2-List-Policies.json
        List protection policies with backupManagementType filter as AzureWorkload:
          $ref: ./examples/AzureWorkload/BackupPolicies_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureBackuppoliciesList
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies
  : get:
      tags:
      - Backup Policies
      description: Gets all the backup policies in a device.
      operationId: microsoftAzureBackuppoliciesListbydevice
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of backup policies.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupPolicyList'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        BackupPoliciesListByDevice:
          $ref: ./examples/BackupPoliciesListByDevice.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}
  : get:
      tags:
      - Backup Policies
      description: Gets the properties of the specified backup policy name.
      operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftStorSimpleManagersByManagerNameDevicesByDeviceNameBackupPoliciesByBackupPolicyName
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - name: backupPolicyName
        in: path
        description: The name of backup policy to be fetched.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The backup policy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupPolicy'
      deprecated: false
      x-ms-examples:
        BackupPoliciesGet:
          $ref: ./examples/BackupPoliciesGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureBackuppoliciesGet
    put:
      tags:
      - Backup Policies
      description: Creates or updates the backup policy.
      operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftStorSimpleManagersByManagerNameDevicesByDeviceNameBackupPoliciesByBackupPolicyName
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - name: backupPolicyName
        in: path
        description: The name of the backup policy to be created/updated.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the backup policy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupPolicy'
        '202':
          description: Accepted the request to create or update the backup policy.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        BackupPoliciesCreateOrUpdate:
          $ref: ./examples/BackupPoliciesCreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupPolicy'
        description: The backup policy.
        required: true
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureBackuppoliciesCreateorupdate
    delete:
      tags:
      - Backup Policies
      description: Deletes the backup policy.
      operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftStorSimpleManagersByManagerNameDevicesByDeviceNameBackupPoliciesByBackupPolicyName
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - name: backupPolicyName
        in: path
        description: The name of the backup policy.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to delete the backup policy.
        '204':
          description: Successfully deleted the backup policy.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        BackupPoliciesDelete:
          $ref: ./examples/BackupPoliciesDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureBackuppoliciesDelete
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}/backup
  : post:
      tags:
      - Backup Policies
      description: Backup the backup policy now.
      operationId: microsoftAzureBackuppoliciesBackupnow
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - name: backupPolicyName
        in: path
        description: The backup policy name.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - name: backupType
        in: query
        description: The backup Type. This can be cloudSnapshot or localSnapshot.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to backup the backup policy.
        '204':
          description: Successfully completed backup of the backup policy.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        BackupPoliciesBackupNow:
          $ref: ./examples/BackupPoliciesBackupNow.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
    servers:
    - url: https://management.azure.com
components:
  schemas:
    DppResource:
      description: Resource class
      properties:
        id:
          description: Resource Id represents the complete path to the resource.
          readOnly: true
          type: string
        name:
          description: Resource name associated with the resource.
          readOnly: true
          type: string
        type:
          description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
          readOnly: true
          type: string
        systemData:
          $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/systemData
      title: DppResource
      type: object
      x-ms-azure-resource: true
    BaseBackupPolicyResource:
      allOf:
      - $ref: '#/components/schemas/DppResource'
      description: BaseBackupPolicy resource
      properties:
        properties:
          $ref: '#/components/schemas/BaseBackupPolicy'
          description: BaseBackupPolicyResource properties
      title: BaseBackupPolicyResource
    DppResourceList:
      description: ListResource
      properties:
        nextLink:
          description: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
          type: string
      title: List Resource
      type: object
    CloudError:
      description: An error response from Azure Backup.
      properties:
        error:
          $ref: '#/components/schemas/Error'
      title: CloudError
      x-ms-external: true
    Error:
      description: The resource management error response.
      properties:
        additionalInfo:
          description: The error additional info.
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          x-ms-identifiers: []
          readOnly: true
          type: array
        code:
          description: The error code.
          readOnly: true
          type: string
        details:
          description: The error details.
          items:
            $ref: '#/components/schemas/Error'
          x-ms-identifiers: []
          readOnly: true
          type: array
        message:
          description: The error message.
          readOnly: true
          type: string
        target:
          description: The error target.
          readOnly: true
          type: string
    BaseBackupPolicyResourceList:
      allOf:
      - $ref: '#/components/schemas/DppResourceList'
      description: List of BaseBackupPolicy resources
      properties:
        value:
          description: List of resources.
          items:
            $ref: '#/components/schemas/BaseBackupPolicyResource'
          type: array
      title: BaseBackupPolicyResourceList
      type: object
    BaseBackupPolicy:
      description: BackupPolicy base
      discriminator:
        propertyName: objectType
      properties:
        datasourceTypes:
          description: Type of datasource for the backup management
          items:
            type: string
          type: array
        objectType:
          type: string
      required:
      - datasourceTypes
      - objectType
      title: BaseBackupPolicy
      type: object
    ErrorAdditionalInfo:
      description: The resource management error additional info.
      properties:
        info:
          description: The additional info.
          readOnly: true
          type: object
        type:
          description: The additional info type.
          readOnly: true
          type: string
    CloudError_2:
      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.
    ProtectionPolicy:
      description: Base class for backup policy. Workload-specific backup policies are derived from this class.
      required:
      - backupManagementType
      type: object
      properties:
        protectedItemsCount:
          format: int32
          description: Number of items associated with this policy.
          type: integer
        backupManagementType:
          description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
          type: string
        resourceGuardOperationRequests:
          description: ResourceGuard Operation Requests
          type: array
          items:
            type: string
      discriminator:
        propertyName: backupManagementType
    ProtectionPolicyResourceList:
      description: List of ProtectionPolicy resources
      type: object
      allOf:
      - $ref: '#/components/schemas/ResourceList'
      properties:
        value:
          description: List of resources.
          type: array
          items:
            $ref: '#/components/schemas/ProtectionPolicyResource'
    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.
    ResourceList:
      description: Base for all lists of resources.
      type: object
      properties:
        nextLink:
          description: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.
          type: string
    ProtectionPolicyResource:
      description: Base class for backup policy. Workload-specific backup policies are derived from this class.
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          $ref: '#/components/schemas/ProtectionPolicy'
          description: ProtectionPolicyResource properties
    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
    BackupPolicyList:
      description: The collection of backup policies.
      required:
      - value
      type: object
      properties:
        value:
          description: The value.
          type: array
          items:
            $ref: '#/components/schemas/BackupPolicy'
    BackupPolicy:
      description: The backup policy.
      required:
      - properties
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseModel'
      properties:
        properties:
          $ref: '#/components/schemas/BackupPolicyProperties'
          description: The properties of the backup policy.
          x-ms-client-flatten: true
    BackupPolicyProperties:
      description: The properties of the backup policy.
      required:
      - volumeIds
      type: object
      properties:
        volumeIds:
          description: The path IDs of the volumes which are part of the backup policy.
          type: array
          items:
            type: string
        nextBackupTime:
          format: date-time
          description: The time of the next backup for the backup policy.
          type: string
          readOnly: true
        lastBackupTime:
          format: date-time
          description: The time of the last backup for the backup policy.
          type: string
          readOnly: true
        schedulesCount:
          format: int64
          description: The count of schedules the backup policy contains.
          type: integer
          readOnly: true
        scheduledBackupStatus:
          description: Indicates whether at least one of the schedules in the backup policy is active or not.
          enum:
          - Disabled
          - Enabled
          type: string
          readOnly: true
          x-ms-enum:
            name: ScheduledBackupStatus
            modelAsString: false
        backupPolicyCreationType:
          description: The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager.
          enum:
          - BySaaS
          - BySSM
          type: string
          readOnly: true
          x-ms-enum:
            name: BackupPolicyCreationType
            modelAsString: false
        ssmHostName:
          description: If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager.
          type: string
          readOnly: true
    BaseModel:
      description: Represents the base class for all other ARM object models
      type: object
      properties:
        id:
          description: The path ID that uniquely identifies the object.
          type: string
          readOnly: true
        name:
          description: The name of the object.
          type: string
          readOnly: true
        type:
          description: The hierarchical type of the object.
          type: string
          readOnly: true
        kind:
          description: The Kind of the object. Currently only Series8000 is supported
          enum:
          - Series8000
          type: string
          x-ms-enum:
            name: Kind
            modelAsString: false
  parameters:
    VaultName:
      name: vaultName
      in: path
      description: The name of the backup vault.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    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
    VaultName_2:
      name: vaultName
      in: path
      description: The name of the recovery services vault.
      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
    resourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The resource group name
      required: true
      x-ms-parameter-location: method
      x-ms-skip-url-encoding: true
      schema:
        type: string
    managerNameParameter:
      name: managerName
      in: path
      description: The manager name
      required: true
      x-ms-parameter-location: method
      x-ms-skip-url-encoding: true
      schema:
        type: string
        maxLength: 50
        minLength: 2
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The subscription id
      required: true
      x-ms-skip-url-encoding: true
      schema:
        type: string
    deviceNameParameter:
      name: deviceName
      in: path
      description: The device name
      required: true
      x-ms-parameter-location: method
      x-ms-skip-url-encoding: true
      schema:
        type: string
    apiVersionParameter:
      name: api-version
      in: query
      description: The api version
      required: true
      x-ms-skip-url-encoding: true
      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
x-refined-from:
- dataprotectionbackupclient-openapi-original.yml
- recoveryservicesbackupclient-openapi-original.yml
- storsimple8000seriesmanagementclient-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'