Microsoft Azure OpenShiftClusters API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Open Shift Clusters API
tags:
- name: OpenShiftClusters
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/openShiftClusters:
    get:
      tags:
      - OpenShiftClusters
      summary: Microsoft Azure Lists Openshift Clusters In The Specified Subscription
      description: The operation returns properties of each OpenShift cluster.
      operationId: microsoftAzureOpenshiftclustersList
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenShiftClusterList'
        default:
          description: Error response describing why the operation failed.  If the resource doesn't exist, 404 (Not Found) is returned.  If any of the input parameters is wrong, 400 (Bad Request) is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Lists OpenShift clusters in the specified subscription.:
          $ref: ./examples/OpenShiftClusters_List.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters:
    get:
      tags:
      - OpenShiftClusters
      summary: Microsoft Azure Lists Openshift Clusters In The Specified Subscription And Resource Group
      description: The operation returns properties of each OpenShift cluster.
      operationId: microsoftAzureOpenshiftclustersListbyresourcegroup
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenShiftClusterList'
        default:
          description: Error response describing why the operation failed.  If the resource doesn't exist, 404 (Not Found) is returned.  If any of the input parameters is wrong, 400 (Bad Request) is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Lists OpenShift clusters in the specified subscription and resource group.:
          $ref: ./examples/OpenShiftClusters_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}
  : get:
      tags:
      - OpenShiftClusters
      summary: Microsoft Azure Gets A Openshift Cluster With The Specified Subscription, Resource Group And Resource Name
      description: The operation returns properties of a OpenShift cluster.
      operationId: microsoftAzureOpenshiftclustersGet
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the OpenShift cluster resource.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenShiftCluster'
        default:
          description: Error response describing why the operation failed.  If the resource doesn't exist, 404 (Not Found) is returned.  If any of the input parameters is wrong, 400 (Bad Request) is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Gets a OpenShift cluster with the specified subscription, resource group and resource name.:
          $ref: ./examples/OpenShiftClusters_Get.json
    put:
      tags:
      - OpenShiftClusters
      summary: Microsoft Azure Creates Or Updates A Openshift Cluster With The Specified Subscription, Resource Group And Resource Name
      description: The operation returns properties of a OpenShift cluster.
      operationId: microsoftAzureOpenshiftclustersCreateorupdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the OpenShift cluster resource.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenShiftCluster'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenShiftCluster'
        default:
          description: Error response describing why the operation failed.  If the resource doesn't exist, 404 (Not Found) is returned.  If any of the input parameters is wrong, 400 (Bad Request) is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.:
          $ref: ./examples/OpenShiftClusters_CreateOrUpdate.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenShiftCluster'
        description: The OpenShift cluster resource.
        required: true
    delete:
      tags:
      - OpenShiftClusters
      summary: Microsoft Azure Deletes A Openshift Cluster With The Specified Subscription, Resource Group And Resource Name
      description: The operation returns nothing.
      operationId: microsoftAzureOpenshiftclustersDelete
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the OpenShift cluster resource.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.  If the resource doesn't exist, 404 (Not Found) is returned.  If any of the input parameters is wrong, 400 (Bad Request) is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Deletes a OpenShift cluster with the specified subscription, resource group and resource name.:
          $ref: ./examples/OpenShiftClusters_Delete.json
    patch:
      tags:
      - OpenShiftClusters
      summary: Microsoft Azure Creates Or Updates A Openshift Cluster With The Specified Subscription, Resource Group And Resource Name
      description: The operation returns properties of a OpenShift cluster.
      operationId: microsoftAzureOpenshiftclustersUpdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the OpenShift cluster resource.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenShiftCluster'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenShiftCluster'
        default:
          description: Error response describing why the operation failed.  If the resource doesn't exist, 404 (Not Found) is returned.  If any of the input parameters is wrong, 400 (Bad Request) is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.:
          $ref: ./examples/OpenShiftClusters_Update.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenShiftClusterUpdate'
        description: The OpenShift cluster resource.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}/listCredentials
  : post:
      tags:
      - OpenShiftClusters
      summary: Microsoft Azure Lists Credentials Of An Openshift Cluster With The Specified Subscription, Resource Group And Resource Name
      description: The operation returns the credentials.
      operationId: microsoftAzureOpenshiftclustersListcredentials
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the OpenShift cluster resource.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenShiftClusterCredentials'
        default:
          description: Error response describing why the operation failed.  If the resource doesn't exist, 404 (Not Found) is returned.  If any of the input parameters is wrong, 400 (Bad Request) is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name.:
          $ref: ./examples/OpenShiftClusters_ListCredentials.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}/listAdminCredentials
  : post:
      tags:
      - OpenShiftClusters
      summary: Microsoft Azure Lists Admin Kubeconfig Of An Openshift Cluster With The Specified Subscription, Resource Group And Resource Name
      description: The operation returns the admin kubeconfig.
      operationId: microsoftAzureOpenshiftclustersListadmincredentials
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the OpenShift cluster resource.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenShiftClusterAdminKubeconfig'
        default:
          description: Error response describing why the operation failed.  If the resource doesn't exist, 404 (Not Found) is returned.  If any of the input parameters is wrong, 400 (Bad Request) is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError_2'
      x-ms-examples:
        Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource name.:
          $ref: ./examples/OpenShiftClusters_ListAdminCredentials.json
components:
  schemas:
    APIServerProfile:
      description: APIServerProfile represents an API server profile.
      properties:
        visibility:
          $ref: '#/components/schemas/Visibility'
          description: API server visibility (immutable).
        url:
          description: The URL to access the cluster API server (immutable).
          type: string
        ip:
          description: The IP of the cluster API server (immutable).
          type: string
    NetworkProfile:
      description: NetworkProfile represents a network profile.
      properties:
        podCidr:
          description: The CIDR used for OpenShift/Kubernetes Pods (immutable).
          type: string
        serviceCidr:
          description: The CIDR used for OpenShift/Kubernetes Services (immutable).
          type: string
    CloudError_2:
      description: CloudError represents a cloud error.
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody_2'
          description: An error response from the service.
    Visibility:
      description: Visibility represents visibility.
      enum:
      - Private
      - Public
      type: string
    OpenShiftClusterProperties:
      description: OpenShiftClusterProperties represents an OpenShift cluster's properties.
      properties:
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The cluster provisioning state (immutable).
        clusterProfile:
          $ref: '#/components/schemas/ClusterProfile'
          description: The cluster profile.
        consoleProfile:
          $ref: '#/components/schemas/ConsoleProfile'
          description: The console profile.
        servicePrincipalProfile:
          $ref: '#/components/schemas/ServicePrincipalProfile'
          description: The cluster service principal profile.
        networkProfile:
          $ref: '#/components/schemas/NetworkProfile'
          description: The cluster network profile.
        masterProfile:
          $ref: '#/components/schemas/MasterProfile'
          description: The cluster master profile.
        workerProfiles:
          description: The cluster worker profiles.
          type: array
          items:
            $ref: '#/components/schemas/WorkerProfile'
          x-ms-identifiers:
          - name
        apiserverProfile:
          $ref: '#/components/schemas/APIServerProfile'
          description: The cluster API server profile.
        ingressProfiles:
          description: The cluster ingress profiles.
          type: array
          items:
            $ref: '#/components/schemas/IngressProfile'
          x-ms-identifiers:
          - name
    OpenShiftClusterCredentials:
      description: OpenShiftClusterCredentials represents an OpenShift cluster's credentials
      properties:
        kubeadminUsername:
          description: The username for the kubeadmin user
          type: string
        kubeadminPassword:
          description: The password for the kubeadmin user
          type: string
    CloudErrorBody_2:
      description: CloudErrorBody represents the body of a cloud error.
      type: object
      properties:
        code:
          description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
          type: string
        message:
          description: A message describing the error, intended to be suitable for display in a user interface.
          type: string
        target:
          description: The target of the particular error. For example, the name of the property in error.
          type: string
        details:
          description: A list of additional details about the error.
          type: array
          items:
            $ref: '#/components/schemas/CloudErrorBody_2'
    OpenShiftClusterAdminKubeconfig:
      description: OpenShiftClusterAdminKubeconfig represents an OpenShift cluster's admin kubeconfig.
      type: object
      properties:
        kubeconfig:
          description: The base64-encoded kubeconfig file.
          type: string
          x-ms-secret: true
    WorkerProfile:
      description: WorkerProfile represents a worker profile.
      properties:
        name:
          description: The worker profile name.  Must be "worker" (immutable).
          type: string
        vmSize:
          $ref: '#/components/schemas/VMSize'
          description: The size of the worker VMs (immutable).
        diskSizeGB:
          description: The disk size of the worker VMs.  Must be 128 or greater (immutable).
          type: integer
        subnetId:
          description: The Azure resource ID of the worker subnet (immutable).
          type: string
        count:
          description: The number of worker VMs.  Must be between 3 and 20 (immutable).
          type: integer
    MasterProfile:
      description: MasterProfile represents a master profile.
      properties:
        vmSize:
          $ref: '#/components/schemas/VMSize'
          description: The size of the master VMs (immutable).
        subnetId:
          description: The Azure resource ID of the master subnet (immutable).
          type: string
    OpenShiftClusterList:
      description: OpenShiftClusterList represents a list of OpenShift clusters.
      properties:
        value:
          description: The list of OpenShift clusters.
          type: array
          items:
            $ref: '#/components/schemas/OpenShiftCluster'
        nextLink:
          description: The link used to get the next page of operations.
          type: string
    VMSize:
      description: VMSize represents a VM size.
      enum:
      - Standard_D2s_v3
      - Standard_D4s_v3
      - Standard_D8s_v3
      type: string
    ConsoleProfile:
      description: ConsoleProfile represents a console profile.
      properties:
        url:
          description: The URL to access the cluster console (immutable).
          type: string
    ServicePrincipalProfile:
      description: ServicePrincipalProfile represents a service principal profile.
      properties:
        clientId:
          description: The client ID used for the cluster (immutable).
          type: string
        clientSecret:
          description: The client secret used for the cluster (immutable).
          type: string
    ProvisioningState:
      description: ProvisioningState represents a provisioning state.
      enum:
      - AdminUpdating
      - Creating
      - Deleting
      - Failed
      - Succeeded
      - Updating
      type: string
    Tags:
      description: Tags represents an OpenShift cluster's tags.
      type: object
      additionalProperties:
        type: string
    ClusterProfile:
      description: ClusterProfile represents a cluster profile.
      properties:
        pullSecret:
          description: The pull secret for the cluster (immutable).
          type: string
        domain:
          description: The domain for the cluster (immutable).
          type: string
        version:
          description: The version of the cluster (immutable).
          type: string
        resourceGroupId:
          description: The ID of the cluster resource group (immutable).
          type: string
    CloudErrorBody:
      description: CloudErrorBody represents the body of a cloud error.
      properties:
        code:
          description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
          type: string
        message:
          description: A message describing the error, intended to be suitable for display in a user interface.
          type: string
        target:
          description: The target of the particular error. For example, the name of the property in error.
          type: string
        details:
          description: A list of additional details about the error.
          type: array
          items:
            $ref: '#/components/schemas/CloudErrorBody'
          x-ms-identifiers:
          - code
    CloudError:
      description: CloudError represents a cloud error.
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: An error response from the service.
    OpenShiftClusterUpdate:
      description: OpenShiftCluster represents an Azure Red Hat OpenShift cluster.
      properties:
        tags:
          $ref: '#/components/schemas/Tags'
          description: The resource tags.
        properties:
          $ref: '#/components/schemas/OpenShiftClusterProperties'
          description: The cluster properties.
          x-ms-client-flatten: true
    OpenShiftCluster:
      description: OpenShiftCluster represents an Azure Red Hat OpenShift cluster.
      allOf:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource
      properties:
        properties:
          $ref: '#/components/schemas/OpenShiftClusterProperties'
          description: The cluster properties.
          x-ms-client-flatten: true
    IngressProfile:
      description: IngressProfile represents an ingress profile.
      properties:
        name:
          description: The ingress profile name.  Must be "default" (immutable).
          type: string
        visibility:
          $ref: '#/components/schemas/Visibility'
          description: Ingress visibility (immutable).
        ip:
          description: The IP of the ingress (immutable).
          type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'