Azure Site Recovery Replication Network Mappings API

openapi: 3.2.0
info:
  title: Microsoft Azure Site Recovery Replication Network Mappings…
  version: '2026-11-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged ReplicationNetworkMappings across 2 of this provider''s published API definitions: microsoft-azure-site-recovery-service-2026-11-01.json, microsoft-azure-site-recovery-openapi.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: ReplicationNetworkMappings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings
  : get:
      operationId: ReplicationNetworkMappings_ListByReplicationNetworks
      tags:
      - ReplicationNetworkMappings
      summary: Gets all the network mappings under a network
      description: Lists all ASR network mappings for the specified network.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMappingCollection'
      x-ms-examples:
        Gets all the network mappings under a network.:
          $ref: ./examples/ReplicationNetworkMappings_ListByReplicationNetworks.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}
  : get:
      operationId: ReplicationNetworkMappings_Get
      tags:
      - ReplicationNetworkMappings
      summary: Gets network mapping by name
      description: Gets the details of an ASR network mapping.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        schema:
          type: string
      - name: networkMappingName
        in: path
        description: Network mapping name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapping'
      x-ms-examples:
        Gets network mapping by name.:
          $ref: ./examples/ReplicationNetworkMappings_Get.json
    put:
      operationId: ReplicationNetworkMappings_Create
      tags:
      - ReplicationNetworkMappings
      summary: Creates network mapping
      description: The operation to create an ASR network mapping.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        schema:
          type: string
      - name: networkMappingName
        in: path
        description: Network mapping name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'NetworkMapping' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapping'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
      x-ms-examples:
        Creates network mapping.:
          $ref: ./examples/ReplicationNetworkMappings_Create.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/NetworkMapping'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNetworkMappingInput'
        description: Create network mapping input.
        required: true
    patch:
      operationId: ReplicationNetworkMappings_Update
      tags:
      - ReplicationNetworkMappings
      summary: Updates network mapping
      description: The operation to update an ASR network mapping.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        schema:
          type: string
      - name: networkMappingName
        in: path
        description: Network mapping name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapping'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
      x-ms-examples:
        Updates network mapping.:
          $ref: ./examples/ReplicationNetworkMappings_Update.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/NetworkMapping'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNetworkMappingInput'
        description: Update network mapping input.
        required: true
    delete:
      operationId: ReplicationNetworkMappings_Delete
      tags:
      - ReplicationNetworkMappings
      summary: Delete network mapping
      description: The operation to delete a network mapping.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: fabricName
        in: path
        description: Fabric name.
        required: true
        schema:
          type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        schema:
          type: string
      - name: networkMappingName
        in: path
        description: Network mapping name.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
      x-ms-examples:
        Delete network mapping.:
          $ref: ./examples/ReplicationNetworkMappings_Delete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworkMappings
  : get:
      operationId: ReplicationNetworkMappings_List
      tags:
      - ReplicationNetworkMappings
      summary: Gets all the network mappings under a vault
      description: Lists all ASR network mappings in the vault.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the recovery services vault.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMappingCollection'
      x-ms-examples:
        Gets all the network mappings under a vault.:
          $ref: ./examples/ReplicationNetworkMappings_List.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
components:
  schemas:
    NetworkMappingFabricSpecificSettings:
      type: object
      description: Network Mapping fabric specific settings.
      properties:
        instanceType:
          type: string
          description: Gets the Instance type.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    UpdateNetworkMappingInput:
      type: object
      description: Update network mapping input.
      properties:
        properties:
          $ref: '#/components/schemas/UpdateNetworkMappingInputProperties'
          description: The input properties needed to update network mapping.
    NetworkMappingProperties:
      type: object
      description: Network Mapping Properties.
      properties:
        state:
          type: string
          description: The pairing state for network mapping.
        primaryNetworkFriendlyName:
          type: string
          description: The primary network friendly name.
        primaryNetworkId:
          type: string
          description: The primary network id for network mapping.
        primaryFabricFriendlyName:
          type: string
          description: The primary fabric friendly name.
        recoveryNetworkFriendlyName:
          type: string
          description: The recovery network friendly name.
        recoveryNetworkId:
          type: string
          description: The recovery network id for network mapping.
        recoveryFabricArmId:
          type: string
          description: The recovery fabric ARM id.
        recoveryFabricFriendlyName:
          type: string
          description: The recovery fabric friendly name.
        fabricSpecificSettings:
          $ref: '#/components/schemas/NetworkMappingFabricSpecificSettings'
          description: The fabric specific settings.
    NetworkMapping:
      type: object
      description: Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate extensions in subsequent versions.
      properties:
        properties:
          $ref: '#/components/schemas/NetworkMappingProperties'
          description: The Network Mapping Properties.
        location:
          type: string
          description: Resource Location
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    UpdateNetworkMappingInputProperties:
      type: object
      description: Common input details for network mapping operation.
      properties:
        recoveryFabricName:
          type: string
          description: Recovery fabric name.
        recoveryNetworkId:
          type: string
          description: Recovery network Id.
        fabricSpecificDetails:
          $ref: '#/components/schemas/FabricSpecificUpdateNetworkMappingInput'
          description: Fabrics specific input network Id.
    FabricSpecificCreateNetworkMappingInput:
      type: object
      description: Input details specific to fabrics during Network Mapping.
      properties:
        instanceType:
          type: string
          description: The instance type.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    CreateNetworkMappingInputProperties:
      type: object
      description: Common input details for network mapping operation.
      properties:
        recoveryFabricName:
          type: string
          description: Recovery fabric Name.
        recoveryNetworkId:
          type: string
          description: Recovery network Id.
        fabricSpecificDetails:
          $ref: '#/components/schemas/FabricSpecificCreateNetworkMappingInput'
          description: Fabric specific input properties.
      required:
      - recoveryNetworkId
    CreateNetworkMappingInput:
      type: object
      description: Create network mappings input.
      properties:
        properties:
          $ref: '#/components/schemas/CreateNetworkMappingInputProperties'
          description: Input properties for creating network mapping.
      required:
      - properties
    FabricSpecificUpdateNetworkMappingInput:
      type: object
      description: Input details specific to fabrics during Network Mapping.
      properties:
        instanceType:
          type: string
          description: The instance type.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    NetworkMappingCollection:
      type: object
      description: List of network mappings. As with NetworkMapping, it should be possible to reuse a prev version of this class. It doesn't seem likely this class could be anything more than a slightly bespoke collection of NetworkMapping. Hence it makes sense to override Load with Base.NetworkMapping instead of existing CurrentVersion.NetworkMapping.
      properties:
        value:
          type: array
          description: The NetworkMapping items on this page
          items:
            $ref: '#/components/schemas/NetworkMapping'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
  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:
- microsoft-azure-site-recovery-service-2026-11-01.json
- microsoft-azure-site-recovery-openapi.yml