swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector RoleInstances API
schemes:
- https
tags:
- name: RoleInstances
paths:
  ? /subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}/roleInstances/{roleInstanceName}/start
  : post:
      tags:
      - RoleInstances
      operationId: microsoftAzureRoleinstancesStart
      description: Starts a role instance of a vendor network function.
      parameters:
      - name: locationName
        in: path
        required: true
        type: string
        description: The Azure region where the network function resource was created by customer.
      - name: vendorName
        in: path
        required: true
        type: string
        description: The name of the vendor.
      - name: serviceKey
        in: path
        required: true
        type: string
        description: The GUID for the vendor network function.
      - name: roleInstanceName
        in: path
        required: true
        type: string
        description: The name of the role instance of the vendor network function.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: OK.
        '202':
          description: Accepted. The header contains 'Azure-AsyncOperation' header which can be used to monitor the progress of the operation.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Start a role instance of a vendor network function:
          $ref: ./examples/RoleInstanceStart.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Hybridnetwork Locations Locationname Vendors Vendorname Networkfunctions Servicekey Roleinstances Roleinstancename Start
  ? /subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}/roleInstances/{roleInstanceName}/stop
  : post:
      tags:
      - RoleInstances
      operationId: microsoftAzureRoleinstancesStop
      description: Powers off (stop) a role instance of a vendor network function.
      parameters:
      - name: locationName
        in: path
        required: true
        type: string
        description: The Azure region where the network function resource was created by customer.
      - name: vendorName
        in: path
        required: true
        type: string
        description: The name of the vendor.
      - name: serviceKey
        in: path
        required: true
        type: string
        description: The GUID for the vendor network function.
      - name: roleInstanceName
        in: path
        required: true
        type: string
        description: The name of the role instance of the vendor network function.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: OK.
        '202':
          description: Accepted. The header contains 'Azure-AsyncOperation' header which can be used to monitor the progress of the operation.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Stop a role instance of a vendor network function:
          $ref: ./examples/RoleInstanceStop.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Hybridnetwork Locations Locationname Vendors Vendorname Networkfunctions Servicekey Roleinstances Roleinstancename Stop
  ? /subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}/roleInstances/{roleInstanceName}/restart
  : post:
      tags:
      - RoleInstances
      operationId: microsoftAzureRoleinstancesRestart
      description: Restarts a role instance of a vendor network function.
      parameters:
      - name: locationName
        in: path
        required: true
        type: string
        description: The Azure region where the network function resource was created by customer.
      - name: vendorName
        in: path
        required: true
        type: string
        description: The name of the vendor.
      - name: serviceKey
        in: path
        required: true
        type: string
        description: The GUID for the vendor network function.
      - name: roleInstanceName
        in: path
        required: true
        type: string
        description: The name of the role instance of the vendor network function.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: OK.
        '202':
          description: Accepted. The header contains 'Azure-AsyncOperation' header which can be used to monitor the progress of the operation.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Restart a role instance of a vendor network function:
          $ref: ./examples/RoleInstanceRestart.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Hybridnetwork Locations Locationname Vendors Vendorname Networkfunctions Servicekey Roleinstances Roleinstancename Restart
  ? /subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}/roleInstances/{roleInstanceName}
  : get:
      tags:
      - RoleInstances
      operationId: microsoftAzureRoleinstancesGet
      description: Gets the information of role instance of vendor network function.
      parameters:
      - name: locationName
        in: path
        required: true
        type: string
        description: The Azure region where the network function resource was created by customer.
      - name: vendorName
        in: path
        required: true
        type: string
        description: The name of the vendor.
      - name: serviceKey
        in: path
        required: true
        type: string
        description: The GUID for the vendor network function.
      - name: roleInstanceName
        in: path
        required: true
        type: string
        description: The name of the role instance of the vendor network function.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/RoleInstance'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get the operational state of role instance of vendor network function:
          $ref: ./examples/RoleInstanceGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Hybridnetwork Locations Locationname Vendors Vendorname Networkfunctions Servicekey Roleinstances Roleinstancename
  ? /subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}/roleInstances
  : get:
      tags:
      - RoleInstances
      operationId: microsoftAzureRoleinstancesList
      description: Lists the information of role instances of vendor network function.
      parameters:
      - name: locationName
        in: path
        required: true
        type: string
        description: The Azure region where the network function resource was created by customer.
      - name: vendorName
        in: path
        required: true
        type: string
        description: The name of the vendor.
      - name: serviceKey
        in: path
        required: true
        type: string
        description: The GUID for the vendor network function.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/NetworkFunctionRoleInstanceListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List all role instances of vendor network function:
          $ref: ./examples/RoleInstanceListByVendorNetworkFunction.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Hybridnetwork Locations Locationname Vendors Vendorname Networkfunctions Servicekey Roleinstances
definitions:
  RoleInstance:
    x-ms-azure-resource: true
    properties:
      name:
        type: string
        description: The role instance name.
      id:
        type: string
        description: The ARM ID of the resource.
      type:
        type: string
        description: The type of the resource.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/RoleInstanceProperties'
        description: The role instance properties.
    description: The role instance sub resource.
  NetworkFunctionRoleInstanceListResult:
    description: List of role instances of vendor network function.
    properties:
      value:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/RoleInstance'
        description: A list of role instances.
      nextLink:
        readOnly: true
        type: string
        description: The URL to get the next set of results.
  RoleInstanceProperties:
    properties:
      operationalState:
        type: string
        description: The operational state of the role instance.
        enum:
        - Unknown
        - Stopped
        - Running
        - Stopping
        - Starting
        x-ms-enum:
          name: OperationalState
          modelAsString: true
    description: The role instance properties of the network function.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'