Microsoft Azure Cloud Connectors API

openapi: 3.2.0
info:
  version: 2023-01-01-preview
  title: Microsoft Azure HybridCloud Cloud Connectors API
  description: Hybrid cloud connectivity Management API.
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Cloud Connectors
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCloud/cloudConnectors:
    get:
      tags:
      - Cloud Connectors
      description: Return list of cloud connectors in a subscription.
      operationId: microsoftAzureCloudconnectorsListbysubscription
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of cloud connector resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudConnectorListResult'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List of Cloud Connectors by Subscription:
          $ref: ./examples/CloudConnectorsBySubscriptionList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft…
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCloud/cloudConnectors:
    get:
      tags:
      - Cloud Connectors
      description: Return list of cloud connectors in a resource group.
      operationId: microsoftAzureCloudconnectorsListbyresourcegroup
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Request successful. The operation returns a list of cloud connectors resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudConnectorListResult'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List of Cloud Connectors by ResourceGroup:
          $ref: ./examples/CloudConnectorsByResourceGroupList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCloud/cloudConnectors/{cloudConnectorName}
  : get:
      tags:
      - Cloud Connectors
      operationId: microsoftAzureCloudconnectorsGet
      description: Gets the specified cloud connector 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: '#/components/parameters/cloudConnectorNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Request successful. The operation returns the resulting cloud connector resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudConnector'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Cloud Connector:
          $ref: ./examples/CloudConnectorGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - Cloud Connectors
      description: Creates or updates a cloud connector resource.
      operationId: microsoftAzureCloudconnectorsCreateorupdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/cloudConnectorNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Update successful. The operation returns the resulting cloud connector resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudConnector'
        '201':
          description: Create successful. The operation returns the resulting cloud connector resource.
          headers:
            Azure-AsyncOperation:
              description: URI to poll for the operation status.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudConnector'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create a Cloud Connector:
          $ref: ./examples/CloudConnectorCreate.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…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudConnector'
        description: The parameters to provide for the created cloud connector resource.
        required: true
    delete:
      tags:
      - Cloud Connectors
      operationId: microsoftAzureCloudconnectorsDelete
      description: Deletes a specified cloud connector resource.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/cloudConnectorNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Delete successful.
        '202':
          description: Accepted and the operation will complete asynchronously.
          headers:
            Location:
              schema:
                type: string
        '204':
          description: Request successful. Resource does not exist.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete Cloud Connector:
          $ref: ./examples/CloudConnectorDelete.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    patch:
      tags:
      - Cloud Connectors
      operationId: microsoftAzureCloudconnectorsUpdatetags
      description: Updates the specified cloud connector tags.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/cloudConnectorNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Update successful. The operation returns the resulting cloud connector resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudConnector'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Update Cloud Connector tags:
          $ref: ./examples/CloudConnectorUpdateTags.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsObject'
        description: Parameters supplied to update cloud connector tags.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCloud/cloudConnectors/{cloudConnectorName}/discoverResources
  : post:
      tags:
      - Cloud Connectors
      operationId: microsoftAzureCloudconnectorsDiscoverresources
      description: Returns a list of discovered remote cloud resources via this cloud connector resource.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/cloudConnectorNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Get successful. The operation returns a list of discovered remote cloud resources via this cloud connector resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscoveredResources'
        '202':
          description: Accepted and the operation discover will complete asynchronously.
          headers:
            Location:
              schema:
                type: string
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get remote cloud resources by Cloud Connector:
          $ref: ./examples/CloudConnectorDiscoverResources.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    ProvisioningState:
      type: string
      readOnly: true
      description: The current provisioning state.
      enum:
      - Succeeded
      - Updating
      - Deleting
      - Failed
      - Canceled
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
    TagsObject:
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags.
      description: Tags object for patch operations.
    CloudConnector:
      type: object
      x-ms-azure-resource: true
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/CloudConnectorProperties'
          description: Properties of the cloud connector.
        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
      description: Cloud Connector resource.
    CloudConnectorListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/CloudConnector'
          x-ms-identifiers:
          - id
          description: A list of cloud connector resources.
        nextLink:
          type: string
          description: Link to hold the next page of results
      description: Response for the ListCloudConnectors API service call
    DiscoveredResources:
      type: object
      description: API to discover resources in remote cloud referred by the connector.
      properties:
        resourceFilter:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/ResourceFilter'
          description: Remote cloud resource filter.
        discoveredResources:
          type: array
          items:
            $ref: '#/components/schemas/DiscoveredResource'
          x-ms-identifiers:
          - id
          description: List of discovered remote cloud resources.
    CloudConnectorProperties:
      type: object
      properties:
        accountId:
          type: string
          description: Account identifier of the remote cloud.
        cloudType:
          type: string
          description: The cloud connector type.
          enum:
          - AWS
          x-ms-enum:
            name: cloudType
            modelAsString: true
        provisioningState:
          readOnly: true
          $ref: '#/components/schemas/ProvisioningState'
          description: The provisioning state of the cloud connector resource.
      description: Cloud connector resource properties.
    ResourceFilter:
      type: object
      description: Remote Cloud Resource filter.
      properties:
        name:
          type: string
          description: Remote Resource name to filter on.
        type:
          type: string
          description: Remote Resource type to filter on.
        region:
          type: string
          description: Remote Resource location/region to filter on.
        tag:
          type: string
          description: Remote Resource tags to filter on in key:value format.
    DiscoveredResource:
      type: object
      properties:
        id:
          type: string
          description: Remote cloud resource identifier
          readOnly: true
        bodyContentType:
          type: string
          description: Content type of the cloud resource body.
          readOnly: true
          enum:
          - Xml
          - Json
          x-ms-enum:
            name: bodyContentType
            modelAsString: true
        body:
          type: string
          description: Properties of the remote cloud resource.
          readOnly: true
      description: Discovered Resource properties.
  parameters:
    cloudConnectorNameParameter:
      name: cloudConnectorName
      in: path
      required: true
      description: The name of the cloud connector resource
      schema:
        type: string
        pattern: ^[A-Za-z0-9]*$
    apiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      x-ms-enum:
        name: apiVersionParameter
        modelAsString: true
      x-ms-parameter-location: client
      schema:
        type: string
        enum:
        - 2023-01-01-preview
        default: 2023-01-01-preview
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.