swagger: '2.0'
info:
  title: Microsoft Azure ScopeConnections
  description: >-
    The Microsoft Azure Virtual Network Manager API provides a RESTful set of
    web services that interact with Microsoft Azure Network Manager service to
    manage your network resources.
  version: 2022-02-01-preview
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
security:
  - azure_auth:
      - user_impersonation
securityDefinitions:
  azure_auth:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    description: Azure Active Directory OAuth2 Flow.
    scopes:
      user_impersonation: impersonate your user account
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections/{scopeConnectionName}
  : parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./networkManager.json#/parameters/ResourceGroupNameParameter
      - $ref: ./networkManager.json#/parameters/NetworkManagerNameParameter
      - $ref: '#/parameters/ScopeConnectionName'
      - $ref: ./network.json#/parameters/ApiVersionParameter
    put:
      tags:
        - ScopeConnections
      operationId: microsoftAzureScopeconnectionsCreateorupdate
      description: Creates or updates scope connection from Network Manager
      parameters:
        - name: parameters
          in: body
          required: true
          schema:
            $ref: '#/definitions/ScopeConnection'
          description: Scope connection to be created/updated.
      responses:
        '200':
          description: Updated - Returns information about the updates scope connection.
          schema:
            $ref: '#/definitions/ScopeConnection'
        '201':
          description: Created - Returns information about the new scope connection.
          schema:
            $ref: '#/definitions/ScopeConnection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Create or Update Network Manager Scope Connection:
          $ref: ./examples/NetworkManagerScopeConnectionPut.json
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Scopeconnections Scopeconnectionname
    get:
      tags:
        - ScopeConnections
      operationId: microsoftAzureScopeconnectionsGet
      description: Get specified scope connection created by this Network Manager.
      responses:
        '200':
          description: OK - Returns the invitation
          schema:
            $ref: '#/definitions/ScopeConnection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Get Network Manager Scope Connection:
          $ref: ./examples/NetworkManagerScopeConnectionGet.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Scopeconnections Scopeconnectionname
    delete:
      tags:
        - ScopeConnections
      operationId: microsoftAzureScopeconnectionsDelete
      description: Delete the pending scope connection created by this network manager.
      responses:
        '200':
          description: Delete Succeed.
        '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-examples:
        Delete Network Manager Scope Connection:
          $ref: ./examples/NetworkManagerScopeConnectionDelete.json
      summary: >-
        Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Scopeconnections Scopeconnectionname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections
  : get:
      tags:
        - ScopeConnections
      operationId: microsoftAzureScopeconnectionsList
      description: List all scope connections created by this network manager.
      parameters:
        - $ref: ./network.json#/parameters/SubscriptionIdParameter
        - $ref: ./networkManager.json#/parameters/ResourceGroupNameParameter
        - $ref: ./networkManager.json#/parameters/NetworkManagerNameParameter
        - $ref: ./network.json#/parameters/ApiVersionParameter
        - $ref: ./networkManager.json#/parameters/ListTopParameter
        - $ref: ./networkManager.json#/parameters/ListSkipTokenParameter
      responses:
        '200':
          description: OK - Returns information about the scope connection(s).
          schema:
            $ref: '#/definitions/ScopeConnectionListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List Network Manager Scope Connection:
          $ref: ./examples/NetworkManagerScopeConnectionList.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Scopeconnections
definitions:
  ScopeConnection:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ScopeConnectionProperties'
        description: The scope connection properties
      etag:
        readOnly: true
        type: string
        description: >-
          A unique read-only string that changes whenever the resource is
          updated.
      systemData:
        readOnly: true
        description: The system metadata related to this resource.
        $ref: ./network.json#/definitions/SystemData
    allOf:
      - $ref: ./network.json#/definitions/ProxyResource
    description: The Scope Connections resource
  ScopeConnectionProperties:
    type: object
    properties:
      tenantId:
        type: string
        description: Tenant ID.
      resourceId:
        type: string
        description: Resource ID.
      connectionState:
        x-ms-client-flatten: true
        $ref: '#/definitions/ConnectionState'
        description: Connection State
      description:
        type: string
        description: A description of the scope connection.
    description: Scope connection.
  ScopeConnectionListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ScopeConnection'
        description: List of scope connections.
      nextLink:
        type: string
        description: Gets the URL to get the next page of results.
    description: List of scope connections.
  ConnectionState:
    type: string
    readOnly: true
    description: The current scope connection state.
    enum:
      - Connected
      - Pending
      - Conflict
      - Revoked
      - Rejected
    x-ms-enum:
      name: ScopeConnectionState
      modelAsString: true
parameters:
  ScopeConnectionName:
    name: scopeConnectionName
    in: path
    required: true
    type: string
    description: Name for the cross-tenant connection.
    x-ms-parameter-location: method
tags:
  - name: ScopeConnections