Microsoft Azure ValidateOperationStatuses API

openapi: 3.2.0
info:
  version: 2022-09-30-preview
  title: Microsoft Azure RecoveryServicesBackupClient Validate…
  x-ms-code-generation-settings:
    internalConstructors: false
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ValidateOperationStatuses
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperationsStatuses/{operationId}
  : get:
      tags:
      - ValidateOperationStatuses
      description: 'Fetches the status of a triggered validate operation. The status can be in progress, completed

        or failed. You can refer to the OperationStatus enum for all the possible states of the operation.

        If operation has completed, this method returns the list of errors obtained while validating the operation.'
      operationId: microsoftAzureValidateoperationstatusesGet
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/VaultName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: operationId
        in: path
        description: OperationID represents the operation whose status needs to be fetched.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationStatus'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Get Operation Status of Validate Operation:
          $ref: ./examples/AzureIaasVm/ValidateOperationStatus.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  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.
    OperationStatus:
      description: Operation status.
      type: object
      properties:
        id:
          description: ID of the operation.
          type: string
        name:
          description: Name of the operation.
          type: string
        status:
          description: Operation status.
          enum:
          - Invalid
          - InProgress
          - Succeeded
          - Failed
          - Canceled
          type: string
          x-ms-enum:
            name: OperationStatusValues
            modelAsString: true
        startTime:
          format: date-time
          description: 'Operation start time. Format: ISO-8601.'
          type: string
        endTime:
          format: date-time
          description: 'Operation end time. Format: ISO-8601.'
          type: string
        error:
          $ref: '#/components/schemas/OperationStatusError'
          description: Error information related to this operation.
        properties:
          $ref: '#/components/schemas/OperationStatusExtendedInfo'
          description: Additional information associated with this operation.
    OperationStatusExtendedInfo:
      description: Base class for additional information of operation status.
      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:
        propertyName: 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: '#/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.
    OperationStatusError:
      description: Error information associated with operation status call.
      type: object
      properties:
        code:
          description: Error code of the operation failure.
          type: string
        message:
          description: Error message displayed if the operation failure.
          type: string
  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