swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ForwardingRules API
schemes:
- https
tags:
- name: ForwardingRules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}
  : put:
      tags:
      - ForwardingRules
      operationId: microsoftAzureForwardingrulesCreateorupdate
      description: Creates or updates a forwarding rule in a DNS forwarding ruleset.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DnsForwardingRulesetNameParameter'
      - $ref: '#/parameters/ForwardingRuleNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ForwardingRule'
        description: Parameters supplied to the CreateOrUpdate operation.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/IfMatchParameter'
      - $ref: '#/parameters/IfNoneMatchParameter'
      responses:
        '200':
          description: The forwarding rule has been updated.
          schema:
            $ref: '#/definitions/ForwardingRule'
        '201':
          description: The forwarding rule has been created.
          schema:
            $ref: '#/definitions/ForwardingRule'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Upsert forwarding rule in a DNS forwarding ruleset:
          $ref: ./examples/ForwardingRule_Put.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsforwardingrulesets Dnsforwardingrulesetname Forwardingrules Forwardingrulename
    patch:
      tags:
      - ForwardingRules
      operationId: microsoftAzureForwardingrulesUpdate
      description: Updates a forwarding rule in a DNS forwarding ruleset.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DnsForwardingRulesetNameParameter'
      - $ref: '#/parameters/ForwardingRuleNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ForwardingRulePatch'
        description: Parameters supplied to the Update operation.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/IfMatchParameter'
      responses:
        '200':
          description: The forwarding rule has been updated.
          schema:
            $ref: '#/definitions/ForwardingRule'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Update forwarding rule in a DNS forwarding ruleset:
          $ref: ./examples/ForwardingRule_Patch.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsforwardingrulesets Dnsforwardingrulesetname Forwardingrules Forwardingrulename
    delete:
      tags:
      - ForwardingRules
      operationId: microsoftAzureForwardingrulesDelete
      description: 'Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.'
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DnsForwardingRulesetNameParameter'
      - $ref: '#/parameters/ForwardingRuleNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/IfMatchParameter'
      responses:
        '200':
          description: The forwarding rule has been deleted.
        '204':
          description: The forwarding rule was not found.
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Delete forwarding rule in a DNS forwarding ruleset:
          $ref: ./examples/ForwardingRule_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsforwardingrulesets Dnsforwardingrulesetname Forwardingrules Forwardingrulename
    get:
      tags:
      - ForwardingRules
      operationId: microsoftAzureForwardingrulesGet
      description: Gets properties of a forwarding rule in a DNS forwarding ruleset.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DnsForwardingRulesetNameParameter'
      - $ref: '#/parameters/ForwardingRuleNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The forwarding rule was found.
          schema:
            $ref: '#/definitions/ForwardingRule'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Retrieve forwarding rule in a DNS forwarding ruleset:
          $ref: ./examples/ForwardingRule_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsforwardingrulesets Dnsforwardingrulesetname Forwardingrules Forwardingrulename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules
  : get:
      tags:
      - ForwardingRules
      operationId: microsoftAzureForwardingrulesList
      description: Lists forwarding rules in a DNS forwarding ruleset.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DnsForwardingRulesetNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: List of forwarding rules in the DNS forwarding ruleset.
          schema:
            $ref: '#/definitions/ForwardingRuleListResult'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List forwarding rules in a DNS forwarding ruleset:
          $ref: ./examples/ForwardingRule_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsforwardingrulesets Dnsforwardingrulesetname Forwardingrules
definitions:
  ForwardingRulePatch:
    description: Describes a forwarding rule for PATCH operation.
    type: object
    properties:
      properties:
        description: Updatable properties of the forwarding rule.
        $ref: '#/definitions/ForwardingRulePatchProperties'
        x-ms-client-flatten: true
  ForwardingRulePatchProperties:
    description: Represents the updatable properties of a forwarding rule within a DNS forwarding ruleset.
    type: object
    properties:
      targetDnsServers:
        description: DNS servers to forward the DNS query to.
        type: array
        items:
          $ref: '#/definitions/TargetDnsServer'
        x-ms-identifiers: []
      metadata:
        description: Metadata attached to the forwarding rule.
        type: object
        additionalProperties:
          type: string
      forwardingRuleState:
        type: string
        description: The state of forwarding rule.
        enum:
        - Enabled
        - Disabled
        default: Enabled
        x-ms-enum:
          name: ForwardingRuleState
          modelAsString: true
  CloudError:
    description: An error message
    type: object
    properties:
      error:
        description: The error message body
        $ref: '#/definitions/CloudErrorBody'
    x-ms-external: true
  ProvisioningState:
    description: The current provisioning state of the resource.
    type: string
    enum:
    - Creating
    - Updating
    - Deleting
    - Succeeded
    - Failed
    - Canceled
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  CloudErrorBody:
    description: The body of an error message
    type: object
    properties:
      code:
        description: The error code
        type: string
      message:
        description: A description of what caused the error
        type: string
      target:
        description: The target resource of the error message
        type: string
      details:
        description: Extra error information
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers: []
    x-ms-external: true
  TargetDnsServer:
    description: Describes a server to forward the DNS queries to.
    type: object
    properties:
      ipAddress:
        description: DNS server IP address.
        type: string
      port:
        description: DNS server port.
        type: integer
        format: int32
        default: 53
  ForwardingRuleListResult:
    description: The response to an enumeration operation on forwarding rules within a DNS forwarding ruleset.
    type: object
    properties:
      value:
        description: Enumeration of the forwarding rules.
        type: array
        items:
          $ref: '#/definitions/ForwardingRule'
      nextLink:
        description: The continuation token for the next page of results.
        type: string
        readOnly: true
  ForwardingRule:
    description: Describes a forwarding rule within a DNS forwarding ruleset.
    type: object
    properties:
      etag:
        description: ETag of the forwarding rule.
        type: string
        readOnly: true
      properties:
        description: Properties of the forwarding rule.
        $ref: '#/definitions/ForwardingRuleProperties'
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of the resource.
        readOnly: true
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
  ForwardingRuleProperties:
    description: Represents the properties of a forwarding rule within a DNS forwarding ruleset.
    type: object
    required:
    - domainName
    - targetDnsServers
    properties:
      domainName:
        description: The domain name for the forwarding rule.
        type: string
      targetDnsServers:
        description: DNS servers to forward the DNS query to.
        type: array
        items:
          $ref: '#/definitions/TargetDnsServer'
        x-ms-identifiers: []
      metadata:
        description: Metadata attached to the forwarding rule.
        type: object
        additionalProperties:
          type: string
      forwardingRuleState:
        type: string
        description: The state of forwarding rule.
        enum:
        - Enabled
        - Disabled
        x-ms-enum:
          name: ForwardingRuleState
          modelAsString: true
      provisioningState:
        description: The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.
        $ref: '#/definitions/ProvisioningState'
        readOnly: true
parameters:
  IfNoneMatchParameter:
    name: If-None-Match
    in: header
    required: false
    type: string
    x-ms-client-name: IfNoneMatch
    description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.
    x-ms-parameter-location: method
  IfMatchParameter:
    name: If-Match
    in: header
    required: false
    type: string
    x-ms-client-name: IfMatch
    description: ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.
    x-ms-parameter-location: method
  TopParameter:
    name: $top
    in: query
    required: false
    type: integer
    format: int32
    description: The maximum number of results to return. If not specified, returns up to 100 results.
    x-ms-parameter-location: method
  DnsForwardingRulesetNameParameter:
    name: dnsForwardingRulesetName
    in: path
    required: true
    type: string
    description: The name of the DNS forwarding ruleset.
    x-ms-parameter-location: method
  ForwardingRuleNameParameter:
    name: forwardingRuleName
    in: path
    required: true
    type: string
    description: The name of the forwarding rule.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'