Resource Class

Base class for entity classes.

Resource is an abstract object that serves as a base for creating resources. It contains common properties and methods for all resources.

This class should not be instantiated directly. Instead, use one of its subclasses.

Constructor

Resource(name: str | None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, **kwargs: Any)

Name	Description
name Required	str The name of the resource.
description	Optional[str] The description of the resource. Default value: None
tags	Optional[dict] Tags can be added, removed, and updated. Default value: None
properties	Optional[dict] The resource's property dictionary. Default value: None

Name	Description
print_as_yaml	bool Specifies if the the resource should print out as a YAML-formatted object. If False, the resource will print out in a more-compact style. By default, the YAML output is only used in Jupyter notebooks. Be aware that some bookkeeping values are shown only in the non-YAML output.

dump	Dump the object content into a file.

Dump the object content into a file.

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

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.

The base path of the resource.

Type	Description
str	The base path of the resource.

The creation context of the resource.

Type	Description
Optional[SystemData]	The creation metadata for the resource.

The resource ID.

Type	Description
Optional[str]	The global ID of the resource, an Azure Resource Manager (ARM) ID.