openapi: 3.2.0
info:
  version: 2022-09-30-preview
  title: Microsoft Azure RecoveryServicesBackupClient Protection…
  x-ms-code-generation-settings:
    internalConstructors: false
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Protection Policies
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
  : get:
      tags:
      - Protection Policies
      description: 'Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous

        operation. Status of the operation can be fetched using GetPolicyOperationResult API.'
      operationId: microsoftAzureProtectionpoliciesGet
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/VaultName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: policyName
        in: path
        description: Backup policy information to be fetched.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectionPolicyResource'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Get Azure IaasVm Protection Policy Details:
          $ref: ./examples/AzureIaasVm/ProtectionPolicies_Get.json
        Get Azure IaasVm Enhanced Protection Policy Details:
          $ref: ./examples/AzureIaasVm/V2Policy/v2-Get-Policy.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - Protection Policies
      description: 'Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched

        using GetPolicyOperationResult API.'
      operationId: microsoftAzureProtectionpoliciesCreateorupdate
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/VaultName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: policyName
        in: path
        description: Backup policy to be created.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectionPolicyResource'
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Create or Update Simple Azure Vm Protection Policy:
          $ref: ./examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json
        Create or Update Full Azure Vm Protection Policy:
          $ref: ./examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json
        Create or Update Enhanced Azure Vm Protection Policy with Hourly backup:
          $ref: ./examples/AzureIaasVm/V2Policy/IaaS_v2_hourly.json
        Create or Update Enhanced Azure Vm Protection Policy with daily backup:
          $ref: ./examples/AzureIaasVm/V2Policy/IaaS_v2_daily.json
        Create or Update Full Azure Workload Protection Policy:
          $ref: ./examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json
        Create or Update Daily Azure Storage Protection Policy:
          $ref: ./examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Daily.json
        Create or Update Hourly Azure Storage Protection Policy:
          $ref: ./examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hourly.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtectionPolicyResource'
        description: resource backup policy
        required: true
    delete:
      tags:
      - Protection Policies
      description: 'Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the

        operation can be fetched using GetProtectionPolicyOperationResult API.'
      operationId: microsoftAzureProtectionpoliciesDelete
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/VaultName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: policyName
        in: path
        description: Backup policy to be deleted.
        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-long-running-operation: true
      x-ms-examples:
        Delete Azure Vm Protection Policy:
          $ref: ./examples/AzureIaasVm/ProtectionPolicies_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
components:
  parameters:
    SubscriptionId:
      name: subscriptionId
      in: path
      description: The subscription Id.
      required: true
      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
    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
  schemas:
    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.
    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
    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
    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
  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