swagger: '2.0' info: title: Microsoft Azure Azure Red Hat OpenShift Client description: Rest API for Azure Red Hat OpenShift 4 version: 2021-09-01-preview host: management.azure.com schemes: - https consumes: - application/json produces: - application/json paths: /providers/Microsoft.RedHatOpenShift/operations: get: tags: - Operations summary: 'Microsoft Azure Lists All Of The Available Rp Operations' description: The operation returns the RP operations. operationId: microsoftAzureOperationsList parameters: - $ref: >- ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/OperationList' 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. schema: $ref: '#/definitions/CloudError' x-ms-examples: Lists all of the available RP operations.: $ref: ./examples/Operations_List.json x-ms-pageable: nextLinkName: nextLink /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/v2/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/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. schema: $ref: '#/definitions/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/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 responses: '200': description: OK schema: $ref: '#/definitions/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. schema: $ref: '#/definitions/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/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 type: string responses: '200': description: OK schema: $ref: '#/definitions/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. schema: $ref: '#/definitions/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/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 type: string - name: parameters in: body description: The OpenShift cluster resource. required: true schema: $ref: '#/definitions/OpenShiftCluster' responses: '200': description: OK schema: $ref: '#/definitions/OpenShiftCluster' '201': description: Created schema: $ref: '#/definitions/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. schema: $ref: '#/definitions/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 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/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 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. schema: $ref: '#/definitions/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/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 type: string - name: parameters in: body description: The OpenShift cluster resource. required: true schema: $ref: '#/definitions/OpenShiftClusterUpdate' responses: '200': description: OK schema: $ref: '#/definitions/OpenShiftCluster' '201': description: Created schema: $ref: '#/definitions/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. schema: $ref: '#/definitions/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 ? /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 type: string responses: '200': description: OK schema: $ref: '#/definitions/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. schema: $ref: '#/definitions/CloudError' x-ms-examples: Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource name.: $ref: ./examples/OpenShiftClusters_ListAdminCredentials.json ? /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/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 type: string responses: '200': description: OK schema: $ref: '#/definitions/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. schema: $ref: '#/definitions/CloudError' x-ms-examples: Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name.: $ref: ./examples/OpenShiftClusters_ListCredentials.json definitions: APIServerProfile: description: APIServerProfile represents an API server profile. type: object properties: visibility: $ref: '#/definitions/Visibility' description: API server visibility. url: description: The URL to access the cluster API server. type: string ip: description: The IP of the cluster API server. type: string CloudError: description: CloudError represents a cloud error. type: object properties: error: $ref: '#/definitions/CloudErrorBody' description: An error response from the service. CloudErrorBody: 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: '#/definitions/CloudErrorBody' ClusterProfile: description: ClusterProfile represents a cluster profile. type: object properties: pullSecret: description: The pull secret for the cluster. type: string domain: description: The domain for the cluster. type: string version: description: The version of the cluster. type: string resourceGroupId: description: The ID of the cluster resource group. type: string ConsoleProfile: description: ConsoleProfile represents a console profile. type: object properties: url: description: The URL to access the cluster console. type: string Display: description: Display represents the display details of an operation. type: object properties: provider: description: Friendly name of the resource provider. type: string resource: description: Resource type on which the operation is performed. type: string operation: description: 'Operation type: read, write, delete, listKeys/action, etc.' type: string description: description: Friendly name of the operation. type: string EncryptionAtHost: description: EncryptionAtHost represents encryption at host state enum: - Disabled - Enabled type: string x-ms-enum: name: EncryptionAtHost modelAsString: true IngressProfile: description: IngressProfile represents an ingress profile. type: object properties: name: description: The ingress profile name. type: string visibility: $ref: '#/definitions/Visibility' description: Ingress visibility. ip: description: The IP of the ingress. type: string MasterProfile: description: MasterProfile represents a master profile. type: object properties: vmSize: $ref: '#/definitions/VMSize' description: The size of the master VMs. subnetId: description: The Azure resource ID of the master subnet. type: string encryptionAtHost: $ref: '#/definitions/EncryptionAtHost' description: Whether master virtual machines are encrypted at host. diskEncryptionSetId: description: The resource ID of an associated DiskEncryptionSet, if applicable. type: string NetworkProfile: description: NetworkProfile represents a network profile. type: object properties: softwareDefinedNetwork: $ref: '#/definitions/SoftwareDefinedNetwork' description: The software defined network (SDN) to use when installing the cluster. podCidr: description: The CIDR used for OpenShift/Kubernetes Pods. type: string serviceCidr: description: The CIDR used for OpenShift/Kubernetes Services. type: string OpenShiftCluster: description: OpenShiftCluster represents an Azure Red Hat OpenShift cluster. type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource properties: properties: $ref: '#/definitions/OpenShiftClusterProperties' description: The cluster properties. x-ms-client-flatten: true systemData: $ref: >- ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: The system meta data relating to this resource. readOnly: true 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 OpenShiftClusterCredentials: description: OpenShiftClusterCredentials represents an OpenShift cluster's credentials. type: object properties: kubeadminUsername: description: The username for the kubeadmin user. type: string kubeadminPassword: description: The password for the kubeadmin user. type: string x-ms-secret: true OpenShiftClusterList: description: OpenShiftClusterList represents a list of OpenShift clusters. type: object properties: value: description: The list of OpenShift clusters. type: array items: $ref: '#/definitions/OpenShiftCluster' nextLink: description: The link used to get the next page of operations. type: string OpenShiftClusterProperties: description: OpenShiftClusterProperties represents an OpenShift cluster's properties. type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState' description: The cluster provisioning state. clusterProfile: $ref: '#/definitions/ClusterProfile' description: The cluster profile. consoleProfile: $ref: '#/definitions/ConsoleProfile' description: The console profile. servicePrincipalProfile: $ref: '#/definitions/ServicePrincipalProfile' description: The cluster service principal profile. networkProfile: $ref: '#/definitions/NetworkProfile' description: The cluster network profile. masterProfile: $ref: '#/definitions/MasterProfile' description: The cluster master profile. workerProfiles: description: The cluster worker profiles. type: array items: $ref: '#/definitions/WorkerProfile' apiserverProfile: $ref: '#/definitions/APIServerProfile' description: The cluster API server profile. ingressProfiles: description: The cluster ingress profiles. type: array items: $ref: '#/definitions/IngressProfile' OpenShiftClusterUpdate: description: OpenShiftCluster represents an Azure Red Hat OpenShift cluster. type: object properties: tags: $ref: '#/definitions/Tags' description: The resource tags. properties: $ref: '#/definitions/OpenShiftClusterProperties' description: The cluster properties. x-ms-client-flatten: true systemData: $ref: >- ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: The system meta data relating to this resource. readOnly: true Operation: description: Operation represents an RP operation. type: object properties: name: description: 'Operation name: {provider}/{resource}/{operation}.' type: string display: $ref: '#/definitions/Display' description: The object that describes the operation. origin: description: >- Sources of requests to this operation. Comma separated list with valid values user or system, e.g. "user,system". type: string OperationList: description: OperationList represents an RP operation list. type: object properties: value: description: List of operations supported by the resource provider. type: array items: $ref: '#/definitions/Operation' nextLink: description: The link used to get the next page of operations. type: string ProvisioningState: description: ProvisioningState represents a provisioning state. enum: - AdminUpdating - Creating - Deleting - Failed - Succeeded - Updating type: string ServicePrincipalProfile: description: ServicePrincipalProfile represents a service principal profile. type: object properties: clientId: description: The client ID used for the cluster. type: string clientSecret: description: The client secret used for the cluster. type: string SoftwareDefinedNetwork: description: SoftwareDefinedNetwork constants. enum: - OVNKubernetes - OpenShiftSDN type: string x-ms-enum: name: SoftwareDefinedNetwork modelAsString: true Tags: description: Tags represents an OpenShift cluster's tags. type: object additionalProperties: type: string VMSize: description: VMSize represents a VM size. enum: - Standard_D16as_v4 - Standard_D16s_v3 - Standard_D2s_v3 - Standard_D32as_v4 - Standard_D32s_v3 - Standard_D4as_v4 - Standard_D4s_v3 - Standard_D8as_v4 - Standard_D8s_v3 - Standard_E16s_v3 - Standard_E32s_v3 - Standard_E4s_v3 - Standard_E64i_v3 - Standard_E64is_v3 - Standard_E8s_v3 - Standard_F16s_v2 - Standard_F32s_v2 - Standard_F4s_v2 - Standard_F72s_v2 - Standard_F8s_v2 - Standard_G5 - Standard_GS5 - Standard_M128ms type: string x-ms-enum: name: VMSize modelAsString: true Visibility: description: Visibility represents visibility. enum: - Private - Public type: string x-ms-enum: name: Visibility modelAsString: true WorkerProfile: description: WorkerProfile represents a worker profile. type: object properties: name: description: The worker profile name. type: string vmSize: $ref: '#/definitions/VMSize' description: The size of the worker VMs. diskSizeGB: description: The disk size of the worker VMs. type: integer subnetId: description: The Azure resource ID of the worker subnet. type: string count: description: The number of worker VMs. type: integer encryptionAtHost: $ref: '#/definitions/EncryptionAtHost' description: Whether master virtual machines are encrypted at host. diskEncryptionSetId: description: The resource ID of an associated DiskEncryptionSet, if applicable. type: string securityDefinitions: azure_auth: type: oauth2 description: Azure Active Directory OAuth2 Flow flow: implicit authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize scopes: user_impersonation: impersonate your user account security: - azure_auth: - user_impersonation tags: - name: OpenShiftClusters - name: Operations