TagsOperations interface

パッケージ:

@azure/arm-resources

TagsOperations を表すインターフェイス。

メソッド

beginCreateOrUpdateAtScope(string, TagsResource, TagsCreateOrUpdateAtScopeOptionalParams)	この操作により、指定したリソースまたはサブスクリプションのタグのセット全体を追加または置換できます。 指定したエンティティは、最大 50 個のタグを持つことができます。
beginCreateOrUpdateAtScopeAndWait(string, TagsResource, TagsCreateOrUpdateAtScopeOptionalParams)	この操作により、指定したリソースまたはサブスクリプションのタグのセット全体を追加または置換できます。 指定したエンティティは、最大 50 個のタグを持つことができます。
beginDeleteAtScope(string, TagsDeleteAtScopeOptionalParams)	リソースまたはサブスクリプションのタグのセット全体を削除します。
beginDeleteAtScopeAndWait(string, TagsDeleteAtScopeOptionalParams)	リソースまたはサブスクリプションのタグのセット全体を削除します。
beginUpdateAtScope(string, TagsPatchResource, TagsUpdateAtScopeOptionalParams)	この操作により、指定したリソースまたはサブスクリプションのタグを置換、マージ、または選択的に削除できます。 指定したエンティティは、操作の最後に最大 50 個のタグを持つことができます。 'replace' オプションは、既存のタグのセット全体を新しいセットに置き換えます。 'merge' オプションを使用すると、新しい名前を持つタグを追加したり、タグの値を既存の名前で更新したりできます。 'delete' オプションを使用すると、指定された名前または名前と値のペアに基づいてタグを選択的に削除できます。
beginUpdateAtScopeAndWait(string, TagsPatchResource, TagsUpdateAtScopeOptionalParams)	この操作により、指定したリソースまたはサブスクリプションのタグを置換、マージ、または選択的に削除できます。 指定したエンティティは、操作の最後に最大 50 個のタグを持つことができます。 'replace' オプションは、既存のタグのセット全体を新しいセットに置き換えます。 'merge' オプションを使用すると、新しい名前を持つタグを追加したり、タグの値を既存の名前で更新したりできます。 'delete' オプションを使用すると、指定された名前または名前と値のペアに基づいてタグを選択的に削除できます。
createOrUpdate(string, TagsCreateOrUpdateOptionalParams)	この操作により、指定されたサブスクリプションの定義済みのタグ名の一覧に名前を追加できます。 タグ名は最大 512 文字で、大文字と小文字は区別されません。 タグ名には、Azure 用に予約されているプレフィックス 'microsoft'、'azure'、'windows' を含めることはできません。
createOrUpdateValue(string, string, TagsCreateOrUpdateValueOptionalParams)	この操作により、既存の定義済みタグ名の定義済み値の一覧に値を追加できます。 タグ値には、最大 256 文字を指定できます。
delete(string, TagsDeleteOptionalParams)	この操作により、指定されたサブスクリプションの定義済みのタグ名の一覧から名前を削除できます。 削除される名前は、リソースのタグ名として使用しないでください。 指定された名前の定義済みの値はすべて既に削除されている必要があります。
deleteValue(string, string, TagsDeleteValueOptionalParams)	この操作により、既存の定義済みタグ名の定義済み値の一覧から値を削除できます。 削除される値は、リソースの特定のタグ名のタグ値として使用することはできません。
getAtScope(string, TagsGetAtScopeOptionalParams)	リソースまたはサブスクリプションのタグのセット全体を取得します。
list(TagsListOptionalParams)	この操作は、定義済みのタグ、リソース タグ、リソース グループ タグ、サブスクリプション タグの和集合を実行し、指定されたサブスクリプションの各タグ名と値の使用状況の概要を返します。 タグの数が多い場合、この操作は以前にキャッシュされた結果を返す可能性があります。

メソッドの詳細

beginCreateOrUpdateAtScope(string, TagsResource, TagsCreateOrUpdateAtScopeOptionalParams)

この操作により、指定したリソースまたはサブスクリプションのタグのセット全体を追加または置換できます。 指定したエンティティは、最大 50 個のタグを持つことができます。

function beginCreateOrUpdateAtScope(scope: string, parameters: TagsResource, options?: TagsCreateOrUpdateAtScopeOptionalParams): Promise<SimplePollerLike<OperationState<TagsResource>, TagsResource>>

パラメーター

scope

string

リソース スコープ。

parameters

TagsResource

タグ API の要求と応答のラッパー リソース。

options

TagsCreateOrUpdateAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<@azure/core-lro.SimplePollerLike<OperationState<TagsResource>, TagsResource>>

beginCreateOrUpdateAtScopeAndWait(string, TagsResource, TagsCreateOrUpdateAtScopeOptionalParams)

この操作により、指定したリソースまたはサブスクリプションのタグのセット全体を追加または置換できます。 指定したエンティティは、最大 50 個のタグを持つことができます。

function beginCreateOrUpdateAtScopeAndWait(scope: string, parameters: TagsResource, options?: TagsCreateOrUpdateAtScopeOptionalParams): Promise<TagsResource>

パラメーター

scope

string

リソース スコープ。

parameters

TagsResource

タグ API の要求と応答のラッパー リソース。

options

TagsCreateOrUpdateAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<TagsResource>

beginDeleteAtScope(string, TagsDeleteAtScopeOptionalParams)

リソースまたはサブスクリプションのタグのセット全体を削除します。

function beginDeleteAtScope(scope: string, options?: TagsDeleteAtScopeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

パラメーター

scope

string

リソース スコープ。

options

TagsDeleteAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAtScopeAndWait(string, TagsDeleteAtScopeOptionalParams)

リソースまたはサブスクリプションのタグのセット全体を削除します。

function beginDeleteAtScopeAndWait(scope: string, options?: TagsDeleteAtScopeOptionalParams): Promise<void>

パラメーター

scope

string

リソース スコープ。

options

TagsDeleteAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<void>

beginUpdateAtScope(string, TagsPatchResource, TagsUpdateAtScopeOptionalParams)

この操作により、指定したリソースまたはサブスクリプションのタグを置換、マージ、または選択的に削除できます。 指定したエンティティは、操作の最後に最大 50 個のタグを持つことができます。 'replace' オプションは、既存のタグのセット全体を新しいセットに置き換えます。 'merge' オプションを使用すると、新しい名前を持つタグを追加したり、タグの値を既存の名前で更新したりできます。 'delete' オプションを使用すると、指定された名前または名前と値のペアに基づいてタグを選択的に削除できます。

function beginUpdateAtScope(scope: string, parameters: TagsPatchResource, options?: TagsUpdateAtScopeOptionalParams): Promise<SimplePollerLike<OperationState<TagsResource>, TagsResource>>

パラメーター

scope

string

リソース スコープ。

parameters

TagsPatchResource

タグのパッチ API 要求のみのラッパー リソース。

options

TagsUpdateAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<@azure/core-lro.SimplePollerLike<OperationState<TagsResource>, TagsResource>>

beginUpdateAtScopeAndWait(string, TagsPatchResource, TagsUpdateAtScopeOptionalParams)

この操作により、指定したリソースまたはサブスクリプションのタグを置換、マージ、または選択的に削除できます。 指定したエンティティは、操作の最後に最大 50 個のタグを持つことができます。 'replace' オプションは、既存のタグのセット全体を新しいセットに置き換えます。 'merge' オプションを使用すると、新しい名前を持つタグを追加したり、タグの値を既存の名前で更新したりできます。 'delete' オプションを使用すると、指定された名前または名前と値のペアに基づいてタグを選択的に削除できます。

function beginUpdateAtScopeAndWait(scope: string, parameters: TagsPatchResource, options?: TagsUpdateAtScopeOptionalParams): Promise<TagsResource>

パラメーター

scope

string

リソース スコープ。

parameters

TagsPatchResource

タグのパッチ API 要求のみのラッパー リソース。

options

TagsUpdateAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<TagsResource>

createOrUpdate(string, TagsCreateOrUpdateOptionalParams)

この操作により、指定されたサブスクリプションの定義済みのタグ名の一覧に名前を追加できます。 タグ名は最大 512 文字で、大文字と小文字は区別されません。 タグ名には、Azure 用に予約されているプレフィックス 'microsoft'、'azure'、'windows' を含めることはできません。

function createOrUpdate(tagName: string, options?: TagsCreateOrUpdateOptionalParams): Promise<TagDetails>

パラメーター

tagName

string

作成するタグの名前。

options

TagsCreateOrUpdateOptionalParams

オプション パラメーター。

戻り値

Promise<TagDetails>

createOrUpdateValue(string, string, TagsCreateOrUpdateValueOptionalParams)

この操作により、既存の定義済みタグ名の定義済み値の一覧に値を追加できます。 タグ値には、最大 256 文字を指定できます。

function createOrUpdateValue(tagName: string, tagValue: string, options?: TagsCreateOrUpdateValueOptionalParams): Promise<TagValue>

パラメーター

tagName

string

タグの名前。

tagValue

string

作成するタグの値。

options

TagsCreateOrUpdateValueOptionalParams

オプション パラメーター。

戻り値

Promise<TagValue>

delete(string, TagsDeleteOptionalParams)

この操作により、指定されたサブスクリプションの定義済みのタグ名の一覧から名前を削除できます。 削除される名前は、リソースのタグ名として使用しないでください。 指定された名前の定義済みの値はすべて既に削除されている必要があります。

function delete(tagName: string, options?: TagsDeleteOptionalParams): Promise<void>

パラメーター

tagName

string

タグの名前。

options

TagsDeleteOptionalParams

オプション パラメーター。

戻り値

Promise<void>

deleteValue(string, string, TagsDeleteValueOptionalParams)

この操作により、既存の定義済みタグ名の定義済み値の一覧から値を削除できます。 削除される値は、リソースの特定のタグ名のタグ値として使用することはできません。

function deleteValue(tagName: string, tagValue: string, options?: TagsDeleteValueOptionalParams): Promise<void>

パラメーター

tagName

string

タグの名前。

tagValue

string

削除するタグの値。

options

TagsDeleteValueOptionalParams

オプション パラメーター。

戻り値

Promise<void>

getAtScope(string, TagsGetAtScopeOptionalParams)

リソースまたはサブスクリプションのタグのセット全体を取得します。

function getAtScope(scope: string, options?: TagsGetAtScopeOptionalParams): Promise<TagsResource>

パラメーター

scope

string

リソース スコープ。

options

TagsGetAtScopeOptionalParams

オプション パラメーター。

戻り値

Promise<TagsResource>

list(TagsListOptionalParams)

この操作は、定義済みのタグ、リソース タグ、リソース グループ タグ、サブスクリプション タグの和集合を実行し、指定されたサブスクリプションの各タグ名と値の使用状況の概要を返します。 タグの数が多い場合、この操作は以前にキャッシュされた結果を返す可能性があります。

function list(options?: TagsListOptionalParams): PagedAsyncIterableIterator<TagDetails, TagDetails[], PageSettings>

パラメーター

options

TagsListOptionalParams

オプション パラメーター。

戻り値

PagedAsyncIterableIterator<TagDetails, TagDetails[], PageSettings>