swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector OutboundEndpoints API
schemes:
- https
tags:
- name: OutboundEndpoints
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}
  : put:
      tags:
      - OutboundEndpoints
      operationId: microsoftAzureOutboundendpointsCreateorupdate
      description: Creates or updates an outbound endpoint for a DNS resolver.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DnsResolverNameParameter'
      - $ref: '#/parameters/OutboundEndpointNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/OutboundEndpoint'
        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 outbound endpoint for the DNS resolver has been updated.
          schema:
            $ref: '#/definitions/OutboundEndpoint'
        '201':
          description: The outbound endpoint for the DNS resolver has been created.
          schema:
            $ref: '#/definitions/OutboundEndpoint'
        '202':
          description: The operation to upsert outbound endpoint for the DNS resolver has been accepted and will complete asynchronously.
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Upsert outbound endpoint for DNS resolver:
          $ref: ./examples/OutboundEndpoint_Put.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsresolvers Dnsresolvername Outboundendpoints Outboundendpointname
    patch:
      tags:
      - OutboundEndpoints
      operationId: microsoftAzureOutboundendpointsUpdate
      description: Updates an outbound endpoint for a DNS resolver.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DnsResolverNameParameter'
      - $ref: '#/parameters/OutboundEndpointNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/OutboundEndpointPatch'
        description: Parameters supplied to the Update operation.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/IfMatchParameter'
      responses:
        '200':
          description: The outbound endpoint for the DNS resolver has been updated.
          schema:
            $ref: '#/definitions/OutboundEndpoint'
        '202':
          description: The operation to update outbound endpoint for the DNS resolver has been accepted and will complete asynchronously.
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Update outbound endpoint for DNS resolver:
          $ref: ./examples/OutboundEndpoint_Patch.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsresolvers Dnsresolvername Outboundendpoints Outboundendpointname
    delete:
      tags:
      - OutboundEndpoints
      operationId: microsoftAzureOutboundendpointsDelete
      description: 'Deletes an outbound endpoint for a DNS resolver. 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/DnsResolverNameParameter'
      - $ref: '#/parameters/OutboundEndpointNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/IfMatchParameter'
      responses:
        '200':
          description: The outbound endpoint for the DNS resolver has been deleted.
        '202':
          description: The operation to delete outbound endpoint for the DNS resolver has been accepted and will complete asynchronously.
        '204':
          description: The outbound endpoint for the DNS resolver was not found.
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete outbound endpoint for DNS resolver:
          $ref: ./examples/OutboundEndpoint_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsresolvers Dnsresolvername Outboundendpoints Outboundendpointname
    get:
      tags:
      - OutboundEndpoints
      operationId: microsoftAzureOutboundendpointsGet
      description: Gets properties of an outbound endpoint for a DNS resolver.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DnsResolverNameParameter'
      - $ref: '#/parameters/OutboundEndpointNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The outbound endpoint for the DNS resolver was found.
          schema:
            $ref: '#/definitions/OutboundEndpoint'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Retrieve outbound endpoint for DNS resolver:
          $ref: ./examples/OutboundEndpoint_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsresolvers Dnsresolvername Outboundendpoints Outboundendpointname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints
  : get:
      tags:
      - OutboundEndpoints
      operationId: microsoftAzureOutboundendpointsList
      description: Lists outbound endpoints for a DNS resolver.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/DnsResolverNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: List of outbound endpoints for the DNS resolver.
          schema:
            $ref: '#/definitions/OutboundEndpointListResult'
        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 outbound endpoints by DNS resolver:
          $ref: ./examples/OutboundEndpoint_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsresolvers Dnsresolvername Outboundendpoints
definitions:
  ResourceGuid:
    type: string
    description: The Guid property of the resource.
  OutboundEndpointPatch:
    description: Describes an outbound endpoint for a DNS resolver for PATCH operation.
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
        description: Tags for outbound endpoint.
  CloudError:
    description: An error message
    type: object
    properties:
      error:
        description: The error message body
        $ref: '#/definitions/CloudErrorBody'
    x-ms-external: true
  SubResource:
    description: Reference to another ARM resource.
    type: object
    properties:
      id:
        type: string
        description: Resource ID.
    x-ms-azure-resource: 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
  OutboundEndpointListResult:
    description: The response to an enumeration operation on outbound endpoints for a DNS resolver.
    type: object
    properties:
      value:
        description: Enumeration of the outbound endpoints for a DNS resolver.
        type: array
        items:
          $ref: '#/definitions/OutboundEndpoint'
      nextLink:
        description: The continuation token for the next page of results.
        type: string
        readOnly: true
  OutboundEndpointProperties:
    description: Represents the properties of an outbound endpoint for a DNS resolver.
    type: object
    properties:
      subnet:
        description: The reference to the subnet used for the outbound endpoint.
        $ref: '#/definitions/SubResource'
      provisioningState:
        description: The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.
        $ref: '#/definitions/ProvisioningState'
        readOnly: true
      resourceGuid:
        description: The resourceGuid property of the outbound endpoint resource.
        readOnly: true
        $ref: '#/definitions/ResourceGuid'
  OutboundEndpoint:
    description: Describes an outbound endpoint for a DNS resolver.
    type: object
    properties:
      etag:
        description: ETag of the outbound endpoint.
        type: string
        readOnly: true
      properties:
        description: Properties of the outbound endpoint.
        $ref: '#/definitions/OutboundEndpointProperties'
        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/TrackedResource
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
  DnsResolverNameParameter:
    name: dnsResolverName
    in: path
    required: true
    type: string
    description: The name of the DNS resolver.
    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
  OutboundEndpointNameParameter:
    name: outboundEndpointName
    in: path
    required: true
    type: string
    description: The name of the outbound endpoint for the DNS resolver.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'