swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Device Network API
schemes:
- https
tags:
- name: Device Network
paths:
  /device-network/network:retrieve:
    post:
      operationId: microsoftAzureDevicenetworkRetrieve
      description: Retrieves the network a given device is on. Returns network in a networkCode format that can be used for other APIs.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      - $ref: '#/parameters/ApcGatewayIdHeader'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NetworkIdentifier'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/NetworkRetrievalResult'
          headers:
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
            x-ms-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, server-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        DeviceNetwork_Retrieve:
          $ref: ./examples/DeviceNetwork_Retrieve_MaximumSet_Gen.json
      summary: Microsoft Azure Post Device Network Network:retrieve
      tags:
      - Device Network
definitions:
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  NetworkRetrievalResult:
    type: object
    description: The network that the device is on.
    properties:
      networkCode:
        type: string
        description: The identifier for the network. This can be used as the networkIdentifier for the service APIs.
        pattern: '[a-z0-9-]+$'
    required:
    - networkCode
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  NetworkIdentifier:
    type: object
    description: Identifier for the network to be queried
    properties:
      identifierType:
        type: string
        description: 'The type of identifier for the network. one of: ''IPv4'', ''IPv6'', ''NetworkCode'''
      identifier:
        type: string
        description: 'The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a Network Code.

          A Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint.'
    required:
    - identifierType
    - identifier
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
parameters:
  ApcGatewayIdHeader:
    name: apc-gateway-id
    in: header
    description: The identifier of the APC Gateway resource which should handle this request.
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-client-name: apcGatewayId
  Azure.Core.ClientRequestIdHeader:
    name: x-ms-client-request-id
    in: header
    description: An opaque, globally-unique, client-generated string identifier for the request.
    required: false
    type: string
    format: uuid
    x-ms-parameter-location: method
    x-ms-client-name: clientRequestId
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'