TagsOperations interface

Pakiet:

@azure/arm-resources-profile-2020-09-01-hybrid

Interfejs reprezentujący element TagsOperations.

Metody

createOrUpdate(string, TagsCreateOrUpdateOptionalParams)	Ta operacja umożliwia dodanie nazwy do listy wstępnie zdefiniowanych nazw tagów dla danej subskrypcji. Nazwa tagu może zawierać maksymalnie 512 znaków i jest niewrażliwa na wielkość liter. Nazwy tagów nie mogą mieć następujących prefiksów zarezerwowanych do użycia na platformie Azure: "microsoft", "azure", "windows".
createOrUpdateAtScope(string, TagsResource, TagsCreateOrUpdateAtScopeOptionalParams)	Ta operacja umożliwia dodawanie lub zastępowanie całego zestawu tagów w określonym zasobie lub subskrypcji. Określona jednostka może mieć maksymalnie 50 tagów.
createOrUpdateValue(string, string, TagsCreateOrUpdateValueOptionalParams)	Ta operacja umożliwia dodanie wartości do listy wstępnie zdefiniowanych wartości dla istniejącej wstępnie zdefiniowanej nazwy tagu. Wartość tagu może mieć maksymalnie 256 znaków.
delete(string, TagsDeleteOptionalParams)	Ta operacja umożliwia usunięcie nazwy z listy wstępnie zdefiniowanych nazw tagów dla danej subskrypcji. Usunięta nazwa nie może być używana jako nazwa tagu dla dowolnego zasobu. Wszystkie wstępnie zdefiniowane wartości dla danej nazwy muszą już zostać usunięte.
deleteAtScope(string, TagsDeleteAtScopeOptionalParams)	Usuwa cały zestaw tagów w zasobie lub subskrypcji.
deleteValue(string, string, TagsDeleteValueOptionalParams)	Ta operacja umożliwia usunięcie wartości z listy wstępnie zdefiniowanych wartości dla istniejącej wstępnie zdefiniowanej nazwy tagu. Usunięta wartość nie może być używana jako wartość tagu dla danej nazwy tagu dla dowolnego zasobu.
getAtScope(string, TagsGetAtScopeOptionalParams)	Pobiera cały zestaw tagów w zasobie lub subskrypcji.
list(TagsListOptionalParams)	Ta operacja wykonuje związek wstępnie zdefiniowanych tagów, tagów zasobów, tagów grupy zasobów i tagów subskrypcji oraz zwraca podsumowanie użycia dla każdej nazwy i wartości tagu w ramach danej subskrypcji. W przypadku dużej liczby tagów ta operacja może zwrócić wcześniej buforowany wynik.
updateAtScope(string, TagsPatchResource, TagsUpdateAtScopeOptionalParams)	Ta operacja umożliwia zastępowanie, scalanie lub selektywne usuwanie tagów w określonym zasobie lub subskrypcji. Określona jednostka może mieć maksymalnie 50 tagów na końcu operacji. Opcja "replace" zastępuje cały zestaw istniejących tagów nowym zestawem. Opcja "scalanie" umożliwia dodawanie tagów z nowymi nazwami i aktualizowanie wartości tagów z istniejącymi nazwami. Opcja "usuń" umożliwia selektywne usuwanie tagów na podstawie podanych nazw lub par nazw/wartości.

Szczegóły metody

createOrUpdate(string, TagsCreateOrUpdateOptionalParams)

Ta operacja umożliwia dodanie nazwy do listy wstępnie zdefiniowanych nazw tagów dla danej subskrypcji. Nazwa tagu może zawierać maksymalnie 512 znaków i jest niewrażliwa na wielkość liter. Nazwy tagów nie mogą mieć następujących prefiksów zarezerwowanych do użycia na platformie Azure: "microsoft", "azure", "windows".

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

Parametry

tagName

string

Nazwa tagu do utworzenia.

options

TagsCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<TagDetails>

createOrUpdateAtScope(string, TagsResource, TagsCreateOrUpdateAtScopeOptionalParams)

Ta operacja umożliwia dodawanie lub zastępowanie całego zestawu tagów w określonym zasobie lub subskrypcji. Określona jednostka może mieć maksymalnie 50 tagów.

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

Parametry

scope

string

Zakres zasobów.

parameters

TagsResource

Zasób otoki dla żądań i odpowiedzi interfejsu API tagów.

options

TagsCreateOrUpdateAtScopeOptionalParams

Parametry opcji.

Zwraca

Promise<TagsResource>

createOrUpdateValue(string, string, TagsCreateOrUpdateValueOptionalParams)

Ta operacja umożliwia dodanie wartości do listy wstępnie zdefiniowanych wartości dla istniejącej wstępnie zdefiniowanej nazwy tagu. Wartość tagu może mieć maksymalnie 256 znaków.

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

Parametry

tagName

string

Nazwa tagu.

tagValue

string

Wartość tagu do utworzenia.

options

TagsCreateOrUpdateValueOptionalParams

Parametry opcji.

Zwraca

Promise<TagValue>

delete(string, TagsDeleteOptionalParams)

Ta operacja umożliwia usunięcie nazwy z listy wstępnie zdefiniowanych nazw tagów dla danej subskrypcji. Usunięta nazwa nie może być używana jako nazwa tagu dla dowolnego zasobu. Wszystkie wstępnie zdefiniowane wartości dla danej nazwy muszą już zostać usunięte.

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

Parametry

tagName

string

Nazwa tagu.

options

TagsDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

deleteAtScope(string, TagsDeleteAtScopeOptionalParams)

Usuwa cały zestaw tagów w zasobie lub subskrypcji.

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

Parametry

scope

string

Zakres zasobów.

options

TagsDeleteAtScopeOptionalParams

Parametry opcji.

Zwraca

Promise<void>

deleteValue(string, string, TagsDeleteValueOptionalParams)

Ta operacja umożliwia usunięcie wartości z listy wstępnie zdefiniowanych wartości dla istniejącej wstępnie zdefiniowanej nazwy tagu. Usunięta wartość nie może być używana jako wartość tagu dla danej nazwy tagu dla dowolnego zasobu.

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

Parametry

tagName

string

Nazwa tagu.

tagValue

string

Wartość tagu do usunięcia.

options

TagsDeleteValueOptionalParams

Parametry opcji.

Zwraca

Promise<void>

getAtScope(string, TagsGetAtScopeOptionalParams)

Pobiera cały zestaw tagów w zasobie lub subskrypcji.

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

Parametry

scope

string

Zakres zasobów.

options

TagsGetAtScopeOptionalParams

Parametry opcji.

Zwraca

Promise<TagsResource>

list(TagsListOptionalParams)

Ta operacja wykonuje związek wstępnie zdefiniowanych tagów, tagów zasobów, tagów grupy zasobów i tagów subskrypcji oraz zwraca podsumowanie użycia dla każdej nazwy i wartości tagu w ramach danej subskrypcji. W przypadku dużej liczby tagów ta operacja może zwrócić wcześniej buforowany wynik.

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

Parametry

options

TagsListOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<TagDetails, TagDetails[], PageSettings>

updateAtScope(string, TagsPatchResource, TagsUpdateAtScopeOptionalParams)

Ta operacja umożliwia zastępowanie, scalanie lub selektywne usuwanie tagów w określonym zasobie lub subskrypcji. Określona jednostka może mieć maksymalnie 50 tagów na końcu operacji. Opcja "replace" zastępuje cały zestaw istniejących tagów nowym zestawem. Opcja "scalanie" umożliwia dodawanie tagów z nowymi nazwami i aktualizowanie wartości tagów z istniejącymi nazwami. Opcja "usuń" umożliwia selektywne usuwanie tagów na podstawie podanych nazw lub par nazw/wartości.

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

Parametry

scope

string

Zakres zasobów.

parameters

TagsPatchResource

Zasób otoki tylko dla żądania interfejsu API poprawek tagów.

options

TagsUpdateAtScopeOptionalParams

Parametry opcji.

Zwraca

Promise<TagsResource>