swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector BackupPolicies API schemes: - https tags: - name: BackupPolicies paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies : get: tags: - BackupPolicies description: Returns list of backup policies belonging to a backup vault operationId: microsoftAzureBackuppoliciesList produces: - application/json 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: '#/parameters/VaultName' responses: '200': description: OK schema: $ref: '#/definitions/BaseBackupPolicyResourceList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List BackupPolicy: $ref: ./examples/PolicyCRUD/ListBackupPolicy.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backuppolicies ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName} : get: tags: - BackupPolicies operationId: microsoftAzureBackuppoliciesGet description: Gets a backup policy belonging to a backup vault produces: - application/json 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: '#/parameters/VaultName' - name: backupPolicyName in: path required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/BaseBackupPolicyResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/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: - BackupPolicies operationId: microsoftAzureBackuppoliciesCreateorupdate summary: Microsoft Azure Creates Or Updates A Backup Policy Belonging To A Backup Vault produces: - application/json 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: '#/parameters/VaultName' - name: backupPolicyName description: Name of the policy in: path required: true type: string - name: parameters in: body description: Request body for operation required: true schema: $ref: '#/definitions/BaseBackupPolicyResource' responses: '200': description: OK schema: $ref: '#/definitions/BaseBackupPolicyResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: CreateOrUpdate BackupPolicy: $ref: ./examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json description: Needs a more full description created. delete: tags: - BackupPolicies operationId: microsoftAzureBackuppoliciesDelete summary: Microsoft Azure Deletes A Backup Policy Belonging To A Backup Vault produces: - application/json 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: '#/parameters/VaultName' - name: backupPolicyName in: path required: true type: string responses: '200': description: OK '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Delete BackupPolicy: $ref: ./examples/PolicyCRUD/DeleteBackupPolicy.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies : get: tags: - BackupPolicies description: Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch
scoped results. operationId: microsoftAzureBackuppoliciesList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/VaultName_2' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: $filter in: query description: OData filter options. required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/ProtectionPolicyResourceList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/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 Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backuppolicies ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies : get: tags: - BackupPolicies description: Gets all the backup policies in a device. operationId: microsoftAzureBackuppoliciesListbydevice consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/deviceNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/managerNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The collection of backup policies. schema: $ref: '#/definitions/BackupPolicyList' deprecated: false x-ms-pageable: nextLinkName: null x-ms-examples: BackupPoliciesListByDevice: $ref: ./examples/BackupPoliciesListByDevice.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Backuppolicies ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName} : get: tags: - BackupPolicies description: Gets the properties of the specified backup policy name. operationId: microsoftAzureBackuppoliciesGet consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/deviceNameParameter' - name: backupPolicyName in: path description: The name of backup policy to be fetched. required: true type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/managerNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The backup policy. schema: $ref: '#/definitions/BackupPolicy' deprecated: false x-ms-examples: BackupPoliciesGet: $ref: ./examples/BackupPoliciesGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Backuppolicies Backuppolicyname put: tags: - BackupPolicies description: Creates or updates the backup policy. operationId: microsoftAzureBackuppoliciesCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/deviceNameParameter' - name: backupPolicyName in: path description: The name of the backup policy to be created/updated. required: true type: string x-ms-skip-url-encoding: true - name: parameters in: body description: The backup policy. required: true schema: $ref: '#/definitions/BackupPolicy' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/managerNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully created or updated the backup policy. schema: $ref: '#/definitions/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 Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Backuppolicies Backuppolicyname delete: tags: - BackupPolicies description: Deletes the backup policy. operationId: microsoftAzureBackuppoliciesDelete consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/deviceNameParameter' - name: backupPolicyName in: path description: The name of the backup policy. required: true type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/managerNameParameter' - $ref: '#/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 Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Backuppolicies Backuppolicyname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}/backup : post: tags: - BackupPolicies description: Backup the backup policy now. operationId: microsoftAzureBackuppoliciesBackupnow consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/deviceNameParameter' - name: backupPolicyName in: path description: The backup policy name. required: true type: string x-ms-skip-url-encoding: true - name: backupType in: query description: The backup Type. This can be cloudSnapshot or localSnapshot. required: true type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/managerNameParameter' - $ref: '#/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 Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Backuppolicies Backuppolicyname Backup definitions: 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. 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 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 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 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 BaseBackupPolicy: description: BackupPolicy base discriminator: 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 BaseBackupPolicyResource: allOf: - $ref: '#/definitions/DppResource' description: BaseBackupPolicy resource properties: properties: $ref: '#/definitions/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 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 BackupPolicyList: description: The collection of backup policies. required: - value type: object properties: value: description: The value. type: array items: $ref: '#/definitions/BackupPolicy' 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 BaseBackupPolicyResourceList: allOf: - $ref: '#/definitions/DppResourceList' description: List of BaseBackupPolicy resources properties: value: description: List of resources. items: $ref: '#/definitions/BaseBackupPolicyResource' type: array title: BaseBackupPolicyResourceList type: object ProtectionPolicyResource: description: Base class for backup policy. Workload-specific backup policies are derived from this class. allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/ProtectionPolicy' description: ProtectionPolicyResource properties Error: description: The resource management error response. properties: additionalInfo: description: The error additional info. items: $ref: '#/definitions/ErrorAdditionalInfo' x-ms-identifiers: [] readOnly: true type: array code: description: The error code. readOnly: true type: string details: description: The error details. items: $ref: '#/definitions/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 ProtectionPolicyResourceList: description: List of ProtectionPolicy resources type: object allOf: - $ref: '#/definitions/ResourceList' properties: value: description: List of resources. type: array items: $ref: '#/definitions/ProtectionPolicyResource' BackupPolicy: description: The backup policy. required: - properties type: object allOf: - $ref: '#/definitions/BaseModel' properties: properties: $ref: '#/definitions/BackupPolicyProperties' description: The properties of the backup policy. x-ms-client-flatten: true 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: backupManagementType CloudError: description: An error response from Azure Backup. properties: error: $ref: '#/definitions/Error' title: CloudError x-ms-external: true CloudError_2: x-ms-external: true properties: error: type: object $ref: '#/definitions/CloudErrorBody' description: The error object. description: An error response from the Container Instance service. parameters: VaultName: name: vaultName in: path description: The name of the backup vault. required: true type: string x-ms-parameter-location: method resourceGroupNameParameter: name: resourceGroupName in: path description: The resource group name required: true type: string x-ms-parameter-location: method x-ms-skip-url-encoding: true SubscriptionId: name: subscriptionId in: path description: The subscription Id. required: true type: string 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 managerNameParameter: name: managerName in: path description: The manager name required: true type: string maxLength: 50 minLength: 2 x-ms-parameter-location: method x-ms-skip-url-encoding: true ApiVersion: name: api-version in: query description: Client Api Version. required: true type: string apiVersionParameter: name: api-version in: query description: The api version required: true type: string x-ms-skip-url-encoding: true deviceNameParameter: name: deviceName in: path description: The device name required: true type: string x-ms-parameter-location: method x-ms-skip-url-encoding: true subscriptionIdParameter: name: subscriptionId in: path description: The subscription id required: true type: string x-ms-skip-url-encoding: true VaultName_2: name: vaultName in: path description: The name of the recovery services vault. required: true type: string x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'