swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NspLinkReferences API
schemes:
- https
tags:
- name: NspLinkReferences
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/linkReferences/{linkReferenceName}
  : parameters:
    - $ref: ./network.json#/parameters/SubscriptionIdParameter
    - $ref: '#/parameters/ResourceGroupNameParameter'
    - $ref: '#/parameters/NetworkSecurityPerimeterNameParameter'
    - $ref: '#/parameters/LinkReferenceNameParameter'
    - $ref: ./network.json#/parameters/ApiVersionParameter
    get:
      tags:
      - NspLinkReferences
      operationId: microsoftAzureNsplinkreferencesGet
      description: Gets the specified NSP linkReference resource.
      responses:
        '200':
          description: OK - Returns the NSP linkReference resource.
          schema:
            $ref: '#/definitions/NspLinkReference'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NspLinkReferencesGet:
          $ref: ./examples/NspLinkReferenceGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Linkreferences Linkreferencename
    delete:
      tags:
      - NspLinkReferences
      operationId: microsoftAzureNsplinkreferencesDelete
      description: Deletes an NSP LinkReference resource.
      responses:
        '200':
          description: Delete Succeed.
        '202':
          description: Delete in progress.
          headers:
            location:
              description: location header
              type: string
        '204':
          description: Request successful. The resource does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        NspLinkReferenceDelete:
          $ref: ./examples/NspLinkReferenceDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Linkreferences Linkreferencename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/linkReferences
  : get:
      tags:
      - NspLinkReferences
      operationId: microsoftAzureNsplinkreferencesList
      description: Lists the NSP LinkReference resources in the specified network security perimeter.
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/NetworkSecurityPerimeterNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/ListTopParameter'
      - $ref: '#/parameters/ListSkipTokenParameter'
      responses:
        '200':
          description: OK - Returns the list of NSP linkReference resources.
          schema:
            $ref: '#/definitions/NspLinkReferenceListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NspLinkReferenceList:
          $ref: ./examples/NspLinkReferenceList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Linkreferences
definitions:
  NspLinkReference:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/NspLinkReferenceProperties'
        description: Properties of the network security perimeter linkReference resource.
    allOf:
    - $ref: ./network.json#/definitions/ProxyResource
    description: The network security perimeter linkReference resource
  NSPLinkProvisioningState:
    type: string
    readOnly: true
    description: The current provisioning state of NSP Link/LinkReference.
    enum:
    - Succeeded
    - Creating
    - Updating
    - Deleting
    - Accepted
    - Failed
    - WaitForRemoteCompletion
    x-ms-enum:
      name: nspLinkProvisioningState
      modelAsString: true
  NspLinkReferenceProperties:
    type: object
    properties:
      provisioningState:
        readOnly: true
        $ref: '#/definitions/NSPLinkProvisioningState'
        description: The provisioning state of the NSP LinkReference resource.
      remotePerimeterResourceId:
        readOnly: true
        type: string
        description: Perimeter ARM Id for the remote NSP with which the link is created.
      remotePerimeterGuid:
        readOnly: true
        type: string
        description: Remote NSP Guid with which the link is created.
      remotePerimeterLocation:
        readOnly: true
        type: string
        description: Remote NSP location with which the link gets created.
      localInboundProfiles:
        type: array
        items:
          type: string
        description: Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles.
        uniqueItems: true
      localOutboundProfiles:
        type: array
        items:
          type: string
        readOnly: true
        description: Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
        uniqueItems: true
      remoteInboundProfiles:
        type: array
        items:
          type: string
        readOnly: true
        description: Remote Inbound profile names to which Inbound is allowed. ['*'] value implies inbound is allowed to all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter.
      remoteOutboundProfiles:
        type: array
        items:
          type: string
        readOnly: true
        description: Remote Outbound profile names from which Outbound is allowed. ['*'] value implies outbound is allowed from all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter.
      description:
        type: string
        readOnly: true
        description: A message sent by the remote NSP link admin for connection request. In case of Auto-approved flow, it is default to 'Auto Approved'.
      status:
        type: string
        description: The NSP linkReference state. It cannot be changed if link is created in auto-approval mode.
        enum:
        - Approved
        - Pending
        - Rejected
        - Disconnected
        x-ms-enum:
          name: nspLinkStatus
          modelAsString: true
    description: Properties of NSP LinkReference resource.
  NspLinkReferenceListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/NspLinkReference'
        description: Gets a page of NSP LinkReference resources.
      nextLink:
        type: string
        description: Gets the URL to get the next page of results.
    description: Result of the request to list NSP linkReference resources. Contains a list of NSP linkReference resources and a URL link to get the next set of results.
parameters:
  LinkReferenceNameParameter:
    name: linkReferenceName
    in: path
    required: true
    type: string
    description: The name of the NSP linkReference.
    x-ms-parameter-location: method
  ListTopParameter:
    name: $top
    description: An optional query parameter which specifies the maximum number of records to be returned by the server.
    in: query
    required: false
    type: integer
    format: int32
    minimum: 1
    maximum: 20
    x-ms-parameter-location: method
  NetworkSecurityPerimeterNameParameter:
    name: networkSecurityPerimeterName
    in: path
    required: true
    type: string
    description: The name of the network security perimeter.
    x-ms-parameter-location: method
  ListSkipTokenParameter:
    name: $skipToken
    description: SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
    in: query
    required: false
    type: string
    x-ms-parameter-location: method
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'