Resource クラス

エンティティ クラスの基底クラス。

Resource は、リソースを作成するためのベースとして機能する抽象オブジェクトです。 これには、すべてのリソースに共通のプロパティとメソッドが含まれています。

このクラスは直接インスタンス化しないでください。 代わりに、サブクラスの 1 つを使用します。

継承

ABC

Resource

コンストラクター

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

パラメーター

name

str

必須

リソースの名前。

description

Optional[str]

既定値: None

リソースの説明。

tags

Optional[dict]

既定値: None

タグは追加、削除、更新できます。

properties

Optional[dict]

既定値: None

リソースのプロパティ ディクショナリ。

print_as_yaml

bool

リソースを YAML 形式のオブジェクトとして出力するかどうかを指定します。 False の場合、リソースはよりコンパクトなスタイルで出力されます。 既定では、YAML 出力は Jupyter ノートブックでのみ使用されます。 一部の簿記値は、YAML 以外の出力にのみ表示されることに注意してください。

メソッド

dump	オブジェクトの内容をファイルにダンプします。

dump

オブジェクトの内容をファイルにダンプします。

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

パラメーター

dest

Union[<xref:PathLike>, str, IO[AnyStr]]

必須

YAML コンテンツを書き込むローカル パスまたはファイル ストリーム。 dest がファイル パスの場合は、新しいファイルが作成されます。 dest が開いているファイルの場合、ファイルは に直接書き込まれます。

属性

base_path

リソースのベース パス。

戻り値

リソースのベース パス。

の戻り値の型 :

str

creation_context

リソースの作成コンテキスト。

戻り値

リソースの作成メタデータ。

の戻り値の型 :

Optional[SystemData]

id

リソース ID。

戻り値

リソースのグローバル ID、Azure Resource Manager (ARM) ID。

の戻り値の型 :

Optional[str]