Microsoft Azure InboundEndpoints API

openapi: 3.2.0
info:
  title: Microsoft Azure DnsResolverManagementClient Inbound…
  description: The DNS Resolver Management Client.
  version: 2020-04-01-preview
servers:
- url: https://management.azure.com
tags:
- name: InboundEndpoints
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}
  : put:
      tags:
      - InboundEndpoints
      operationId: microsoftAzureInboundendpointsCreateorupdate
      description: Creates or updates an inbound 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: '#/components/parameters/DnsResolverNameParameter'
      - $ref: '#/components/parameters/InboundEndpointNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/IfMatchParameter'
      - $ref: '#/components/parameters/IfNoneMatchParameter'
      responses:
        '200':
          description: The inbound endpoint for the DNS resolver has been updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundEndpoint'
        '201':
          description: The inbound endpoint for the DNS resolver has been created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundEndpoint'
        '202':
          description: The operation to upsert inbound 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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Upsert inbound endpoint for DNS resolver:
          $ref: ./examples/InboundEndpoint_Put.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundEndpoint'
        description: Parameters supplied to the CreateOrUpdate operation.
        required: true
    patch:
      tags:
      - InboundEndpoints
      operationId: microsoftAzureInboundendpointsUpdate
      description: Updates an inbound 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: '#/components/parameters/DnsResolverNameParameter'
      - $ref: '#/components/parameters/InboundEndpointNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/IfMatchParameter'
      responses:
        '200':
          description: The inbound endpoint for the DNS resolver has been updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundEndpoint'
        '202':
          description: The operation to update inbound 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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Update inbound endpoint for DNS resolver:
          $ref: ./examples/InboundEndpoint_Patch.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundEndpointPatch'
        description: Parameters supplied to the Update operation.
        required: true
    delete:
      tags:
      - InboundEndpoints
      operationId: microsoftAzureInboundendpointsDelete
      description: 'Deletes an inbound 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: '#/components/parameters/DnsResolverNameParameter'
      - $ref: '#/components/parameters/InboundEndpointNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/IfMatchParameter'
      responses:
        '200':
          description: The inbound endpoint for the DNS resolver has been deleted.
        '202':
          description: The operation to delete inbound endpoint for the DNS resolver has been accepted and will complete asynchronously.
        '204':
          description: The inbound endpoint for the DNS resolver was not found.
        default:
          description: Default response. It will be deserialized as per the Error definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete inbound endpoint for DNS resolver:
          $ref: ./examples/InboundEndpoint_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    get:
      tags:
      - InboundEndpoints
      operationId: microsoftAzureInboundendpointsGet
      description: Gets properties of an inbound 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: '#/components/parameters/DnsResolverNameParameter'
      - $ref: '#/components/parameters/InboundEndpointNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The inbound endpoint for the DNS resolver was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundEndpoint'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Retrieve inbound endpoint for DNS resolver:
          $ref: ./examples/InboundEndpoint_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints
  : get:
      tags:
      - InboundEndpoints
      operationId: microsoftAzureInboundendpointsList
      description: Lists inbound 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: '#/components/parameters/DnsResolverNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/TopParameter'
      responses:
        '200':
          description: List of inbound endpoints for the DNS resolver.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundEndpointListResult'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List inbound endpoints by DNS resolver:
          $ref: ./examples/InboundEndpoint_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  parameters:
    IfMatchParameter:
      name: If-Match
      in: header
      required: false
      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
      schema:
        type: string
    InboundEndpointNameParameter:
      name: inboundEndpointName
      in: path
      required: true
      description: The name of the inbound endpoint for the DNS resolver.
      x-ms-parameter-location: method
      schema:
        type: string
    DnsResolverNameParameter:
      name: dnsResolverName
      in: path
      required: true
      description: The name of the DNS resolver.
      x-ms-parameter-location: method
      schema:
        type: string
    TopParameter:
      name: $top
      in: query
      required: false
      description: The maximum number of results to return. If not specified, returns up to 100 results.
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
    IfNoneMatchParameter:
      name: If-None-Match
      in: header
      required: false
      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
      schema:
        type: string
  schemas:
    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
    SubResource:
      description: Reference to another ARM resource.
      type: object
      properties:
        id:
          type: string
          description: Resource ID.
      x-ms-azure-resource: true
    InboundEndpointProperties:
      description: Represents the properties of an inbound endpoint for a DNS resolver.
      type: object
      properties:
        ipConfigurations:
          description: IP configurations for the inbound endpoint.
          type: array
          items:
            $ref: '#/components/schemas/IpConfiguration'
          x-ms-identifiers: []
        provisioningState:
          description: The current provisioning state of the inbound endpoint. This is a read-only property and any attempt to set this value will be ignored.
          readOnly: true
          $ref: '#/components/schemas/ProvisioningState'
        resourceGuid:
          description: The resourceGuid property of the inbound endpoint resource.
          readOnly: true
          $ref: '#/components/schemas/ResourceGuid'
    CloudError:
      description: An error message
      type: object
      properties:
        error:
          description: The error message body
          $ref: '#/components/schemas/CloudErrorBody'
      x-ms-external: true
    IpConfiguration:
      description: IP configuration.
      type: object
      properties:
        subnet:
          description: The reference to the subnet bound to the IP configuration.
          $ref: '#/components/schemas/SubResource'
        privateIpAddress:
          description: Private IP address of the IP configuration.
          type: string
        privateIpAllocationMethod:
          description: Private IP address allocation method.
          type: string
          enum:
          - Static
          - Dynamic
          default: Dynamic
          x-ms-enum:
            name: IpAllocationMethod
            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: '#/components/schemas/CloudErrorBody'
          x-ms-identifiers: []
      x-ms-external: true
    InboundEndpointListResult:
      description: The response to an enumeration operation on inbound endpoints for a DNS resolver.
      type: object
      properties:
        value:
          description: Enumeration of the inbound endpoints for a DNS resolver.
          type: array
          items:
            $ref: '#/components/schemas/InboundEndpoint'
        nextLink:
          description: The continuation token for the next page of results.
          type: string
          readOnly: true
    InboundEndpoint:
      description: Describes an inbound endpoint for a DNS resolver.
      type: object
      properties:
        etag:
          description: ETag of the inbound endpoint.
          type: string
          readOnly: true
        properties:
          description: Properties of the inbound endpoint.
          $ref: '#/components/schemas/InboundEndpointProperties'
          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
    ResourceGuid:
      type: string
      description: The Guid property of the resource.
    InboundEndpointPatch:
      description: Describes an inbound 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 inbound endpoint.
  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