Microsoft Azure ReplicationNetworkMappings 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: ReplicationNetworkMappings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings
  : get:
      tags:
      - ReplicationNetworkMappings
      summary: Microsoft Azure Gets All The Network Mappings Under A Network
      description: Lists all ASR network mappings for the specified network.
      operationId: microsoftAzureReplicationnetworkmappingsListbyreplicationnetworks
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Primary fabric name.
        required: true
        schema:
          type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMappingCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets all the network mappings under a network.:
          $ref: ./examples/ReplicationNetworkMappings_ListByReplicationNetworks.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}
  : get:
      tags:
      - ReplicationNetworkMappings
      summary: Microsoft Azure Gets Network Mapping By Name
      description: Gets the details of an ASR network mapping.
      operationId: microsoftAzureReplicationnetworkmappingsGet
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Primary 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: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapping'
      x-ms-examples:
        Gets network mapping by name.:
          $ref: ./examples/ReplicationNetworkMappings_Get.json
    put:
      tags:
      - ReplicationNetworkMappings
      summary: Microsoft Azure Creates Network Mapping
      description: The operation to create an ASR network mapping.
      operationId: microsoftAzureReplicationnetworkmappingsCreate
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Primary 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: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapping'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Creates network mapping.:
          $ref: ./examples/ReplicationNetworkMappings_Create.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNetworkMappingInput'
        description: Create network mapping input.
        required: true
    delete:
      tags:
      - ReplicationNetworkMappings
      summary: Microsoft Azure Delete Network Mapping
      description: The operation to delete a network mapping.
      operationId: microsoftAzureReplicationnetworkmappingsDelete
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Primary 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: ARM Resource Name for network mapping.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted
        '204':
          description: NoContent
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete network mapping.:
          $ref: ./examples/ReplicationNetworkMappings_Delete.json
    patch:
      tags:
      - ReplicationNetworkMappings
      summary: Microsoft Azure Updates Network Mapping
      description: The operation to update an ASR network mapping.
      operationId: microsoftAzureReplicationnetworkmappingsUpdate
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Primary 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: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapping'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Updates network mapping.:
          $ref: ./examples/ReplicationNetworkMappings_Update.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNetworkMappingInput'
        description: Update network mapping input.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworkMappings
  : get:
      tags:
      - ReplicationNetworkMappings
      summary: Microsoft Azure Gets All The Network Mappings Under A Vault
      description: Lists all ASR network mappings in the vault.
      operationId: microsoftAzureReplicationnetworkmappingsList
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/ResourceName'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/SubscriptionId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMappingCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets all the network mappings under a vault.:
          $ref: ./examples/ReplicationNetworkMappings_List.json
components:
  schemas:
    CreateNetworkMappingInputProperties:
      description: Common input details for network mapping operation.
      required:
      - recoveryNetworkId
      type: object
      properties:
        recoveryFabricName:
          description: Recovery fabric Name.
          type: string
        recoveryNetworkId:
          description: Recovery network Id.
          type: string
        fabricSpecificDetails:
          $ref: '#/components/schemas/FabricSpecificCreateNetworkMappingInput'
          description: Fabric specific input properties.
    FabricSpecificCreateNetworkMappingInput:
      description: Input details specific to fabrics during Network Mapping.
      required:
      - instanceType
      type: object
      properties:
        instanceType:
          description: The instance type.
          type: string
      discriminator:
        propertyName: instanceType
    UpdateNetworkMappingInput:
      description: Update network mapping input.
      type: object
      properties:
        properties:
          $ref: '#/components/schemas/UpdateNetworkMappingInputProperties'
          description: The input properties needed to update network mapping.
    NetworkMappingFabricSpecificSettings:
      description: Network Mapping fabric specific settings.
      required:
      - instanceType
      type: object
      properties:
        instanceType:
          description: Gets the Instance type.
          type: string
      discriminator:
        propertyName: instanceType
    NetworkMappingProperties:
      description: Network Mapping Properties.
      type: object
      properties:
        state:
          description: The pairing state for network mapping.
          type: string
        primaryNetworkFriendlyName:
          description: The primary network friendly name.
          type: string
        primaryNetworkId:
          description: The primary network id for network mapping.
          type: string
        primaryFabricFriendlyName:
          description: The primary fabric friendly name.
          type: string
        recoveryNetworkFriendlyName:
          description: The recovery network friendly name.
          type: string
        recoveryNetworkId:
          description: The recovery network id for network mapping.
          type: string
        recoveryFabricArmId:
          description: The recovery fabric ARM id.
          type: string
        recoveryFabricFriendlyName:
          description: The recovery fabric friendly name.
          type: string
        fabricSpecificSettings:
          $ref: '#/components/schemas/NetworkMappingFabricSpecificSettings'
          description: The fabric specific settings.
    NetworkMapping:
      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.
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          $ref: '#/components/schemas/NetworkMappingProperties'
          description: The Network Mapping Properties.
    CreateNetworkMappingInput:
      description: Create network mappings input.
      required:
      - properties
      type: object
      properties:
        properties:
          $ref: '#/components/schemas/CreateNetworkMappingInputProperties'
          description: Input properties for creating network mapping.
    NetworkMappingCollection:
      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.
      type: object
      properties:
        value:
          description: The Network Mappings list.
          type: array
          items:
            $ref: '#/components/schemas/NetworkMapping'
        nextLink:
          description: The value of next link.
          type: string
    FabricSpecificUpdateNetworkMappingInput:
      description: Input details specific to fabrics during Network Mapping.
      required:
      - instanceType
      type: object
      properties:
        instanceType:
          description: The instance type.
          type: string
      discriminator:
        propertyName: instanceType
    UpdateNetworkMappingInputProperties:
      description: Common input details for network mapping operation.
      type: object
      properties:
        recoveryFabricName:
          description: Recovery fabric name.
          type: string
        recoveryNetworkId:
          description: Recovery network Id.
          type: string
        fabricSpecificDetails:
          $ref: '#/components/schemas/FabricSpecificUpdateNetworkMappingInput'
          description: Fabrics specific input network Id.
    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
  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
  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