Share via

Usage Class

  • Reference

AzureML resource usage.

Inheritance
azure.ai.ml.entities._mixins.RestTranslatableMixin
Usage

Constructor

Usage(id: str | None = None, aml_workspace_location: str | None = None, type: str | None = None, unit: str | UsageUnit | None = None, current_value: int | None = None, limit: int | None = None, name: UsageName | None = None)

Parameters

Name Description
id
Optional[str]

The resource ID.

Default value: None
aml_workspace_location
Optional[str]

The region of the AzureML workspace specified by the ID.

Default value: None
type
Optional[str]

The resource type.

Default value: None
unit
Optional[Union[str, UsageUnit]]

The unit of measurement for usage. Accepted value is "Count".

Default value: None
current_value
Optional[int]

The current usage of the resource.

Default value: None
limit
Optional[int]

The maximum permitted usage for the resource.

Default value: None
name
Optional[UsageName]

The name of the usage type.

Default value: None

Methods

dump

Dumps the job content into a file in YAML format.

dump

Dumps the job content into a file in YAML format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name Description
dest
Required
Union[<xref:PathLike>, str, IO[AnyStr]]

The local path or file stream to write the YAML content to. If dest is a file path, a new file will be created. If dest is an open file, the file will be written to directly.

Exceptions

Type Description
FileExistsError if dest is a file path and the file already exists.
IOError if dest is an open file and the file is not writable.