Microsoft Azure ReplicationNetworkMappings API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ReplicationNetworkMappings API
schemes:
- https
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
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Primary fabric name.
        required: true
        type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/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
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Primary fabric name.
        required: true
        type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        type: string
      - name: networkMappingName
        in: path
        description: Network mapping name.
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/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
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Primary fabric name.
        required: true
        type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        type: string
      - name: networkMappingName
        in: path
        description: Network mapping name.
        required: true
        type: string
      - name: input
        in: body
        description: Create network mapping input.
        required: true
        schema:
          $ref: '#/definitions/CreateNetworkMappingInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/NetworkMapping'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Creates network mapping.:
          $ref: ./examples/ReplicationNetworkMappings_Create.json
    delete:
      tags:
      - ReplicationNetworkMappings
      summary: Microsoft Azure Delete Network Mapping
      description: The operation to delete a network mapping.
      operationId: microsoftAzureReplicationnetworkmappingsDelete
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Primary fabric name.
        required: true
        type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        type: string
      - name: networkMappingName
        in: path
        description: ARM Resource Name for network mapping.
        required: true
        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
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: fabricName
        in: path
        description: Primary fabric name.
        required: true
        type: string
      - name: networkName
        in: path
        description: Primary network name.
        required: true
        type: string
      - name: networkMappingName
        in: path
        description: Network mapping name.
        required: true
        type: string
      - name: input
        in: body
        description: Update network mapping input.
        required: true
        schema:
          $ref: '#/definitions/UpdateNetworkMappingInput'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/NetworkMapping'
        '202':
          description: Accepted
      x-ms-long-running-operation: true
      x-ms-examples:
        Updates network mapping.:
          $ref: ./examples/ReplicationNetworkMappings_Update.json
  ? /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
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/ResourceName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/NetworkMappingCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets all the network mappings under a vault.:
          $ref: ./examples/ReplicationNetworkMappings_List.json
definitions:
  FabricSpecificUpdateNetworkMappingInput:
    description: Input details specific to fabrics during Network Mapping.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The instance type.
        type: string
    discriminator: 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: '#/definitions/NetworkMappingFabricSpecificSettings'
        description: The fabric specific settings.
  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
  UpdateNetworkMappingInput:
    description: Update network mapping input.
    type: object
    properties:
      properties:
        $ref: '#/definitions/UpdateNetworkMappingInputProperties'
        description: The input properties needed to update network mapping.
  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: '#/definitions/FabricSpecificCreateNetworkMappingInput'
        description: Fabric specific input properties.
  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: '#/definitions/NetworkMapping'
      nextLink:
        description: The value of next link.
        type: string
  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: '#/definitions/FabricSpecificUpdateNetworkMappingInput'
        description: Fabrics specific input network Id.
  CreateNetworkMappingInput:
    description: Create network mappings input.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/CreateNetworkMappingInputProperties'
        description: Input properties for creating network mapping.
  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: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/NetworkMappingProperties'
        description: The Network Mapping Properties.
  FabricSpecificCreateNetworkMappingInput:
    description: Input details specific to fabrics during Network Mapping.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: The instance type.
        type: string
    discriminator: instanceType
  NetworkMappingFabricSpecificSettings:
    description: Network Mapping fabric specific settings.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: Gets the Instance type.
        type: string
    discriminator: instanceType
parameters:
  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: client
  ResourceName:
    name: resourceName
    in: path
    description: The name of the recovery services vault.
    required: true
    type: string
    x-ms-parameter-location: client
  ApiVersion:
    name: api-version
    in: query
    description: Client Api Version.
    required: true
    type: string
  SubscriptionId:
    name: subscriptionId
    in: path
    description: The subscription Id.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'