Microsoft Azure ReplicationProtectableItems API

openapi: 3.2.0
info:
  version: '2023-06-01'
  title: Microsoft Azure SiteRecoveryManagementClient Replication…
  x-ms-code-generation-settings:
    header: MICROSOFT_MIT_NO_VERSION
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ReplicationProtectableItems
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems
  : get:
      tags:
      - ReplicationProtectableItems
      summary: Microsoft Azure Gets The List Of Protectable Items
      description: Lists the protectable items in a protection container.
      operationId: microsoftAzureReplicationprotectableitemsListbyreplicationprotectioncontainers
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        schema:
          type: string
      - name: $filter
        in: query
        description: OData filter options.
        required: false
        schema:
          type: string
      - name: $take
        in: query
        description: take OData query parameter.
        required: false
        schema:
          type: string
      - name: $skipToken
        in: query
        description: skipToken OData query parameter.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectableItemCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/ProtectableItemQueryParameter'
      x-ms-examples:
        Gets the list of protectable items.:
          $ref: ./examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems/{protectableItemName}
  : get:
      tags:
      - ReplicationProtectableItems
      summary: Microsoft Azure Gets The Details Of A Protectable Item
      description: The operation to get the details of a protectable item.
      operationId: microsoftAzureReplicationprotectableitemsGet
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: protectionContainerName
        in: path
        description: Protection container name.
        required: true
        schema:
          type: string
      - name: protectableItemName
        in: path
        description: Protectable item name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtectableItem'
      x-ms-examples:
        Gets the details of a protectable item.:
          $ref: ./examples/ReplicationProtectableItems_Get.json
components:
  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: client
      schema:
        type: string
    ResourceName:
      name: resourceName
      in: path
      description: The name of the recovery services vault.
      required: true
      x-ms-parameter-location: client
      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
  schemas:
    ConfigurationSettings:
      description: Replication provider specific settings.
      required:
      - instanceType
      type: object
      properties:
        instanceType:
          description: Gets the class type. Overridden in derived classes.
          type: string
      discriminator:
        propertyName: instanceType
    ProtectableItemProperties:
      description: Replication protected item custom data details.
      type: object
      properties:
        friendlyName:
          description: The name.
          type: string
        protectionStatus:
          description: The protection status.
          type: string
        replicationProtectedItemId:
          description: The ARM resource of protected items.
          type: string
        recoveryServicesProviderId:
          description: The recovery provider ARM Id.
          type: string
        protectionReadinessErrors:
          description: The Current protection readiness errors.
          type: array
          items:
            type: string
        supportedReplicationProviders:
          description: The list of replication providers supported for the protectable item.
          type: array
          items:
            type: string
        customDetails:
          $ref: '#/components/schemas/ConfigurationSettings'
          description: The Replication provider custom settings.
    ProtectableItem:
      description: Replication protected item.
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          $ref: '#/components/schemas/ProtectableItemProperties'
          description: The custom data.
    ProtectableItemCollection:
      description: Protectable item collection.
      type: object
      properties:
        value:
          description: The Protectable item details.
          type: array
          items:
            $ref: '#/components/schemas/ProtectableItem'
        nextLink:
          description: The value of next link.
          type: string
    Resource:
      description: Azure resource.
      type: object
      properties:
        id:
          description: Resource Id
          type: string
          readOnly: true
        name:
          description: Resource Name
          type: string
          readOnly: true
        type:
          description: Resource Type
          type: string
          readOnly: true
        location:
          description: Resource Location
          type: string
      x-ms-azure-resource: true
  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