OpenShiftClustersOperations Class

OpenShiftClustersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

OpenShiftClustersOperations

Constructor

OpenShiftClustersOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update	Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.
begin_delete	Deletes a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns nothing.
begin_update	Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.
get	Gets a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.
list	Lists OpenShift clusters in the specified subscription. The operation returns properties of each OpenShift cluster.
list_by_resource_group	Lists OpenShift clusters in the specified subscription and resource group. The operation returns properties of each OpenShift cluster.
list_credentials	Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the credentials.

begin_create_or_update

Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.

The operation returns properties of a OpenShift cluster.

begin_create_or_update(resource_group_name: str, resource_name: str, parameters: azure.mgmt.redhatopenshift.v2020_04_30.models._models_py3.OpenShiftCluster, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.redhatopenshift.v2020_04_30.models._models_py3.OpenShiftCluster]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

The name of the OpenShift cluster resource.

parameters

OpenShiftCluster

Required

The OpenShift cluster resource.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either OpenShiftCluster or the result of cls(response)

Return type

LROPoller[OpenShiftCluster]

Exceptions

HttpResponseError

begin_delete

Deletes a OpenShift cluster with the specified subscription, resource group and resource name.

The operation returns nothing.

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

The name of the OpenShift cluster resource.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_update

Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.

The operation returns properties of a OpenShift cluster.

begin_update(resource_group_name: str, resource_name: str, parameters: azure.mgmt.redhatopenshift.v2020_04_30.models._models_py3.OpenShiftClusterUpdate, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.redhatopenshift.v2020_04_30.models._models_py3.OpenShiftCluster]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

The name of the OpenShift cluster resource.

parameters

OpenShiftClusterUpdate

Required

The OpenShift cluster resource.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either OpenShiftCluster or the result of cls(response)

Return type

LROPoller[OpenShiftCluster]

Exceptions

HttpResponseError

get

Gets a OpenShift cluster with the specified subscription, resource group and resource name.

The operation returns properties of a OpenShift cluster.

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.redhatopenshift.v2020_04_30.models._models_py3.OpenShiftCluster

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

The name of the OpenShift cluster resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

OpenShiftCluster, or the result of cls(response)

Return type

OpenShiftCluster

Exceptions

HttpResponseError

list

Lists OpenShift clusters in the specified subscription.

The operation returns properties of each OpenShift cluster.

list(**kwargs: Any) -> Iterable[azure.mgmt.redhatopenshift.v2020_04_30.models._models_py3.OpenShiftClusterList]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either OpenShiftClusterList or the result of cls(response)

Return type

ItemPaged[OpenShiftClusterList]

Exceptions

HttpResponseError

list_by_resource_group

Lists OpenShift clusters in the specified subscription and resource group.

The operation returns properties of each OpenShift cluster.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.redhatopenshift.v2020_04_30.models._models_py3.OpenShiftClusterList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either OpenShiftClusterList or the result of cls(response)

Return type

ItemPaged[OpenShiftClusterList]

Exceptions

HttpResponseError

list_credentials

Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name.

The operation returns the credentials.

list_credentials(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.redhatopenshift.v2020_04_30.models._models_py3.OpenShiftClusterCredentials

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

The name of the OpenShift cluster resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

OpenShiftClusterCredentials, or the result of cls(response)

Return type

OpenShiftClusterCredentials

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.redhatopenshift.v2020_04_30.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\redhatopenshift\\v2020_04_30\\models\\__init__.py'>