igz_mgmt.operations

igz_mgmt.operations#

Below are classes which do not have a corresponding resource in the API but represent operations.

Some endpoints within the management API are considered “operations”, which means that the response may not represent a resource. Some operations are long-living, which means a background job is created whereas the response will hold its id.

class igz_mgmt.operations.AppServices#

Bases: object

Syntactic sugar to AppServicesManifest class.

classmethod create_or_update(http_client: APIClient, app_service: Union[AppServiceSpec, AppServiceBase], wait_for_completion=True) → Optional[Job]#

Creates or updates an app service.

Parameters:

  • http_client (APIClient) – The client to use.

  • app_service (AppServiceSpec or AppServiceBase) – app service to create or update.

  • wait_for_completion (bool) – Whether to wait for the job to complete.

Returns:

The job that was created or None if wait_for_completion is False

Return type:

Job, optional

classmethod disable(http_client: APIClient, app_service_spec_name: str, wait_for_completion=True) → Optional[Job]#

Disables an app service.

Parameters:

  • http_client (APIClient) – The client to use.

  • app_service_spec_name (str) – Name of the app service to disable.

  • wait_for_completion (bool) – Whether to wait for the job to complete.

Returns:

The job that was created or None if wait_for_completion is False

Return type:

Job, optional

classmethod enable(http_client: APIClient, app_service_spec_name: str, wait_for_completion=True) → Optional[Job]#

Enables an app service.

Parameters:

  • http_client (APIClient) – The client to use.

  • app_service_spec_name (str) – Name of the app service to enable.

  • wait_for_completion (bool) – Whether to wait for the job to complete.

Returns:

The job that was created or None if wait_for_completion is False

Return type:

Job, optional

classmethod get(http_client: APIClient, app_service_spec_name: str) → Optional[AppServiceBase]#

Gets the app service that matches the given spec name.

Parameters:

  • http_client (APIClient) – The client to use.

  • app_service_spec_name (str) – The name of the app service spec.

Returns:

The app service instance that matches the given spec name.

Return type:

AppServiceBase, optional

classmethod remove(http_client: APIClient, app_service_spec_name: str, wait_for_completion=True) → Optional[Job]#

Removes an app service.

Parameters:

  • http_client (APIClient) – The client to use.

  • app_service_spec_name (str) – Name of the app service to remove.

  • wait_for_completion (bool) – Whether to wait for the job to complete.

Returns:

The job that was created or None if wait_for_completion is False

Return type:

Job, optional

classmethod restart(http_client: APIClient, app_service_spec_name: str, wait_for_completion=True) → Optional[Job]#

Restarts an app service.

Parameters:

  • http_client (APIClient) – The client to use.

  • app_service_spec_name (str) – Name of the app service to restart.

  • wait_for_completion (bool) – Whether to wait for the job to complete.

Returns:

The job that was created or None if wait_for_completion is False

Return type:

Job, optional

classmethod scale_from_zero(http_client: APIClient, app_service_spec_name: str, wait_for_completion=True) → Optional[Job]#

Scales an app service from zero.

Parameters:

  • http_client (APIClient) – The client to use.

  • app_service_spec_name (str) – Name of the app service to scale from zero.

  • wait_for_completion (bool) – Whether to wait for the job to complete.

Returns:

The job that was created or None if wait_for_completion is False

Return type:

Job, optional

class igz_mgmt.operations.ClusterConfigurations#

Bases: object

Cluster configuration operations.

classmethod reload(http_client: APIClient, config_type: ConfigTypes)#

Cluster configuration reload.

Parameters:

  • http_client (APIClient) – The client to use.

  • config_type (ConfigTypes) – The configuration type.

class igz_mgmt.operations.ManualEvents#

Bases: object

Manual event operations.

classmethod emit(http_client: APIClient, event: Event, audit_tenant_id: Optional[str] = None, **kwargs)#

Emits a manual event.

This operation requires system-admin role permissions.

Parameters:

  • http_client (APIClient) – The client to use.

  • event (ManualEventSchema) – The event to emit.

  • audit_tenant_id – The assigned tenant id for auditing events (required for audit events).

  • kwargs – Additional arguments to pass to the request.

Contents