Azure Site Recovery Replication Vault Setting API

openapi: 3.2.0
info:
  title: Microsoft Azure Site Recovery Replication Vault Setting API
  version: '2026-11-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged ReplicationVaultSetting 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: ReplicationVaultSetting
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings
  : get:
      operationId: ReplicationVaultSetting_List
      tags:
      - ReplicationVaultSetting
      summary: Gets the list of vault setting
      description: Gets the list of vault setting. This includes the Migration Hub connection settings.
      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: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultSettingCollection'
      x-ms-examples:
        Gets the list of vault setting.:
          $ref: ./examples/ReplicationVaultSetting_List.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings/{vaultSettingName}
  : get:
      operationId: ReplicationVaultSetting_Get
      tags:
      - ReplicationVaultSetting
      summary: Gets the vault setting
      description: Gets the vault setting. This includes the Migration Hub connection settings.
      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: vaultSettingName
        in: path
        description: Vault setting name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultSetting'
      x-ms-examples:
        Gets the vault setting.:
          $ref: ./examples/ReplicationVaultSetting_Get.json
    put:
      operationId: ReplicationVaultSetting_Create
      tags:
      - ReplicationVaultSetting
      summary: Updates vault setting.
      description: The operation to configure vault setting.
      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: vaultSettingName
        in: path
        description: Vault setting name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultSetting'
      x-ms-examples:
        Updates vault setting with the A2A recovery network configuration auto-sync policy disabled.:
          $ref: ./examples/ReplicationVaultSetting_Create_Disabled.json
        Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.:
          $ref: ./examples/ReplicationVaultSetting_Create.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/VaultSetting'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VaultSettingCreationInput'
        description: Vault setting creation input.
        required: true
    servers:
    - url: https://management.azure.com
components:
  schemas:
    VaultSettingCreationInput:
      type: object
      description: Input to create vault setting.
      properties:
        properties:
          $ref: '#/components/schemas/VaultSettingCreationInputProperties'
          description: Vault setting creation input properties.
      required:
      - properties
    VaultSetting:
      type: object
      description: Vault setting.
      properties:
        properties:
          $ref: '#/components/schemas/VaultSettingProperties'
          description: The vault setting properties.
        location:
          type: string
          description: Resource Location
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    VaultSettingCollection:
      type: object
      description: Vault setting collection.
      properties:
        value:
          type: array
          description: The VaultSetting items on this page
          items:
            $ref: '#/components/schemas/VaultSetting'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    RecoveryNetworkConfigAutoSyncPolicy:
      type: string
      description: The vault level policy controlling whether the A2A recovery network configuration is automatically kept in sync with the source virtual machine.
      enum:
      - Disabled
      - Enabled
      x-ms-enum:
        name: RecoveryNetworkConfigAutoSyncPolicy
        modelAsString: true
        values:
        - name: Disabled
          value: Disabled
          description: Automatic synchronization of the recovery network configuration is turned off. Recovery NIC settings are changed only through an explicit update operation.
        - name: Enabled
          value: Enabled
          description: Automatic synchronization of the recovery network configuration is turned on. Recovery NIC settings are refreshed from the source virtual machine as its network configuration changes.
    VaultSettingCreationInputProperties:
      type: object
      description: Input to create vault setting.
      properties:
        migrationSolutionId:
          type: string
          description: The migration solution Id.
        vmwareToAzureProviderType:
          type: string
          description: VMware to Azure provider type.
        recoveryNetworkConfigAutoSync:
          $ref: '#/components/schemas/RecoveryNetworkConfigAutoSyncPolicy'
          description: The vault level policy controlling whether the A2A recovery network configuration is automatically kept in sync with the source virtual machine. If the property is omitted from the request body, the policy is set to `Disabled`.
    VaultSettingProperties:
      type: object
      description: Vault setting properties.
      properties:
        migrationSolutionId:
          type: string
          description: The migration solution ARM Id.
        vmwareToAzureProviderType:
          type: string
          description: VMware to Azure provider type.
        recoveryNetworkConfigAutoSync:
          $ref: '#/components/schemas/RecoveryNetworkConfigAutoSyncPolicy'
          description: The vault level policy controlling whether the A2A recovery network configuration is automatically kept in sync with the source virtual machine.
  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