swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector CloudConnections API
schemes:
- https
tags:
- name: CloudConnections
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCloud/cloudConnections:
    get:
      tags:
      - CloudConnections
      description: Return list of cloud connections in a subscription.
      operationId: microsoftAzureCloudconnectionsListbysubscription
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of cloud connection resources.
          schema:
            $ref: '#/definitions/CloudConnectionListResult'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List of Cloud Connections by Subscription:
          $ref: ./examples/CloudConnectionsBySubscriptionList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Hybridcloud Cloudconnections
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCloud/cloudConnections:
    get:
      tags:
      - CloudConnections
      description: Return list of cloud connections in a resource group.
      operationId: microsoftAzureCloudconnectionsListbyresourcegroup
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of cloud connections resources.
          schema:
            $ref: '#/definitions/CloudConnectionListResult'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List of Cloud Connections by ResourceGroup:
          $ref: ./examples/CloudConnectionsByResourceGroupList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcloud Cloudconnections
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCloud/cloudConnections/{cloudConnectionName}
  : get:
      tags:
      - CloudConnections
      operationId: microsoftAzureCloudconnectionsGet
      description: Gets the specified cloud connection in a specified resource group.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/cloudConnectionNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Request successful. The operation returns the resulting cloud connection resource.
          schema:
            $ref: '#/definitions/CloudConnection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Cloud Connection:
          $ref: ./examples/CloudConnectionGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcloud Cloudconnections Cloudconnectionname
    put:
      tags:
      - CloudConnections
      description: Creates or updates a cloud connection resource
      operationId: microsoftAzureCloudconnectionsCreateorupdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/cloudConnectionNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: parameters
        in: body
        required: true
        x-ms-client-flatten: true
        schema:
          $ref: '#/definitions/CloudConnection'
        description: The parameters to provide for the created cloud connection.
      responses:
        '200':
          description: Update successful. The operation returns the resulting cloud connection resource.
          schema:
            $ref: '#/definitions/CloudConnection'
        '201':
          description: Create successful. The operation returns the resulting cloud connection resource.
          schema:
            $ref: '#/definitions/CloudConnection'
          headers:
            Azure-AsyncOperation:
              description: URI to poll for the operation status
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create a Cloud Connection:
          $ref: ./examples/CloudConnectionCreate.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcloud Cloudconnections Cloudconnectionname
    delete:
      tags:
      - CloudConnections
      operationId: microsoftAzureCloudconnectionsDelete
      description: Deletes a specified cloud connection resource.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/cloudConnectionNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Delete successful.
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            Location:
              type: string
        '204':
          description: Request successful. Resource does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete Cloud Connection:
          $ref: ./examples/CloudConnectionDelete.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcloud Cloudconnections Cloudconnectionname
    patch:
      tags:
      - CloudConnections
      operationId: microsoftAzureCloudconnectionsUpdatetags
      description: Updates the specified cloud connection tags.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/cloudConnectionNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/TagsObject'
        description: Parameters supplied to update cloud connection tags.
      responses:
        '200':
          description: Update successful. The operation returns the resulting cloud connection resource.
          schema:
            $ref: '#/definitions/CloudConnection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Update Cloud Connections tags:
          $ref: ./examples/CloudConnectionUpdateTags.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcloud Cloudconnections Cloudconnectionname
definitions:
  TagsObject:
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags.
    description: Tags object for patch operations.
  CloudConnectionListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/CloudConnection'
        description: A list of cloud connection resources.
      nextLink:
        type: string
        description: Link to hold the next page of results
    description: Response for the ListCloudConnections API service call
  ProvisioningState:
    type: string
    readOnly: true
    description: The current provisioning state.
    enum:
    - Succeeded
    - Updating
    - Deleting
    - Failed
    - Canceled
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  CloudConnectionProperties:
    type: object
    properties:
      cloudConnector:
        $ref: '#/definitions/ResourceReference'
        description: The cloud connector which discovered the remote resource.
        x-ms-mutability:
        - create
        - read
      remoteResourceId:
        type: string
        description: Identifier for the remote cloud resource
        x-ms-mutability:
        - create
        - read
      virtualHub:
        $ref: '#/definitions/ResourceReference'
        description: The virtualHub to which the cloud connection belongs.
        x-ms-mutability:
        - create
        - read
      sharedKey:
        type: string
        description: Shared key of the cloud connection.
        x-ms-secret: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The provisioning state of the cloud collection resource.
        readOnly: true
    description: Cloud connection resource properties.
  CloudConnection:
    type: object
    x-ms-azure-resource: true
    description: Resource which represents the managed network connection between Azure Gateways and remote cloud gateways.
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/CloudConnectionProperties'
        description: Properties of the cloud connection.
      etag:
        type: string
        readOnly: true
        description: A unique read-only string that changes whenever the resource is updated.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
  ResourceReference:
    type: object
    properties:
      id:
        type: string
        description: Resource ID.
    description: Resource reference properties.
parameters:
  cloudConnectionNameParameter:
    name: cloudConnectionName
    in: path
    required: true
    type: string
    description: The name of the cloud connection resource
    pattern: ^[a-z][A-Za-z0-9]*$
  apiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to use for this operation.
    minLength: 1
    enum:
    - 2023-01-01-preview
    default: 2023-01-01-preview
    x-ms-enum:
      name: apiVersionParameter
      modelAsString: true
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'