TagsOperations interface
Schnittstelle, die ein TagsOperations-Objekt darstellt.
Methoden
| create |
Dieser Vorgang ermöglicht das Hinzufügen eines Namens zur Liste der vordefinierten Tagnamen für das angegebene Abonnement. Ein Tagname kann maximal 512 Zeichen lang sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Tagnamen dürfen nicht die folgenden Präfixe aufweisen, die für die Azure-Verwendung reserviert sind: "microsoft", "azure", "windows". |
| create |
Dieser Vorgang ermöglicht das Hinzufügen oder Ersetzen des gesamten Tagssatzes für die angegebene Ressource oder das angegebene Abonnement. Die angegebene Entität kann maximal 50 Tags aufweisen. |
| create |
Dieser Vorgang ermöglicht das Hinzufügen eines Werts zur Liste der vordefinierten Werte für einen vorhandenen vordefinierten Tagnamen. Ein Tagwert kann maximal 256 Zeichen umfassen. |
| delete(string, Tags |
Dieser Vorgang ermöglicht das Löschen eines Namens aus der Liste der vordefinierten Tagnamen für das angegebene Abonnement. Der zu löschende Name darf nicht als Tagname für eine Ressource verwendet werden. Alle vordefinierten Werte für den angegebenen Namen müssen bereits gelöscht worden sein. |
| delete |
Löscht den gesamten Satz von Tags für eine Ressource oder ein Abonnement. |
| delete |
Dieser Vorgang ermöglicht das Löschen eines Werts aus der Liste der vordefinierten Werte für einen vorhandenen vordefinierten Tagnamen. Der zu löschende Wert darf nicht als Tagwert für den angegebenen Tagnamen für eine Ressource verwendet werden. |
| get |
Ruft den gesamten Satz von Tags für eine Ressource oder ein Abonnement ab. |
| list(Tags |
Dieser Vorgang führt eine Vereinigung von vordefinierten Tags, Ressourcentags, Ressourcengruppentags und Abonnementtags aus und gibt eine Zusammenfassung der Verwendung für jeden Tagnamen und -wert unter dem angegebenen Abonnement zurück. Bei einer großen Anzahl von Tags kann dieser Vorgang ein zuvor zwischengespeichertes Ergebnis zurückgeben. |
| update |
Dieser Vorgang ermöglicht das Ersetzen, Zusammenführen oder selektive Löschen von Tags für die angegebene Ressource oder das angegebene Abonnement. Die angegebene Entität kann am Ende des Vorgangs maximal 50 Tags aufweisen. Die Option "replace" ersetzt den gesamten Satz vorhandener Tags durch einen neuen Satz. Die Option "Merge" ermöglicht das Hinzufügen von Tags mit neuen Namen und das Aktualisieren der Werte von Tags mit vorhandenen Namen. Die Option "Löschen" ermöglicht das selektive Löschen von Tags basierend auf angegebenen Namen oder Namen/Wert-Paaren. |
Details zur Methode
createOrUpdate(string, TagsCreateOrUpdateOptionalParams)
Dieser Vorgang ermöglicht das Hinzufügen eines Namens zur Liste der vordefinierten Tagnamen für das angegebene Abonnement. Ein Tagname kann maximal 512 Zeichen lang sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Tagnamen dürfen nicht die folgenden Präfixe aufweisen, die für die Azure-Verwendung reserviert sind: "microsoft", "azure", "windows".
function createOrUpdate(tagName: string, options?: TagsCreateOrUpdateOptionalParams): Promise<TagDetails>Parameter
- tagName
-
string
Der Name des zu erstellenden Tags.
- options
- TagsCreateOrUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<TagDetails>
createOrUpdateAtScope(string, TagsResource, TagsCreateOrUpdateAtScopeOptionalParams)
Dieser Vorgang ermöglicht das Hinzufügen oder Ersetzen des gesamten Tagssatzes für die angegebene Ressource oder das angegebene Abonnement. Die angegebene Entität kann maximal 50 Tags aufweisen.
function createOrUpdateAtScope(scope: string, parameters: TagsResource, options?: TagsCreateOrUpdateAtScopeOptionalParams): Promise<TagsResource>Parameter
- scope
-
string
Der Ressourcenbereich.
- parameters
- TagsResource
Wrapperressource für TAGS-API-Anforderungen und -Antworten.
Die Optionsparameter.
Gibt zurück
Promise<TagsResource>
createOrUpdateValue(string, string, TagsCreateOrUpdateValueOptionalParams)
Dieser Vorgang ermöglicht das Hinzufügen eines Werts zur Liste der vordefinierten Werte für einen vorhandenen vordefinierten Tagnamen. Ein Tagwert kann maximal 256 Zeichen umfassen.
function createOrUpdateValue(tagName: string, tagValue: string, options?: TagsCreateOrUpdateValueOptionalParams): Promise<TagValue>Parameter
- tagName
-
string
Der Name des Tags.
- tagValue
-
string
Der Wert des zu erstellenden Tags.
Die Optionsparameter.
Gibt zurück
Promise<TagValue>
delete(string, TagsDeleteOptionalParams)
Dieser Vorgang ermöglicht das Löschen eines Namens aus der Liste der vordefinierten Tagnamen für das angegebene Abonnement. Der zu löschende Name darf nicht als Tagname für eine Ressource verwendet werden. Alle vordefinierten Werte für den angegebenen Namen müssen bereits gelöscht worden sein.
function delete(tagName: string, options?: TagsDeleteOptionalParams): Promise<void>Parameter
- tagName
-
string
Der Name des Tags.
- options
- TagsDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
deleteAtScope(string, TagsDeleteAtScopeOptionalParams)
Löscht den gesamten Satz von Tags für eine Ressource oder ein Abonnement.
function deleteAtScope(scope: string, options?: TagsDeleteAtScopeOptionalParams): Promise<void>Parameter
- scope
-
string
Der Ressourcenbereich.
- options
- TagsDeleteAtScopeOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
deleteValue(string, string, TagsDeleteValueOptionalParams)
Dieser Vorgang ermöglicht das Löschen eines Werts aus der Liste der vordefinierten Werte für einen vorhandenen vordefinierten Tagnamen. Der zu löschende Wert darf nicht als Tagwert für den angegebenen Tagnamen für eine Ressource verwendet werden.
function deleteValue(tagName: string, tagValue: string, options?: TagsDeleteValueOptionalParams): Promise<void>Parameter
- tagName
-
string
Der Name des Tags.
- tagValue
-
string
Der Wert des zu löschenden Tags.
- options
- TagsDeleteValueOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
getAtScope(string, TagsGetAtScopeOptionalParams)
Ruft den gesamten Satz von Tags für eine Ressource oder ein Abonnement ab.
function getAtScope(scope: string, options?: TagsGetAtScopeOptionalParams): Promise<TagsResource>Parameter
- scope
-
string
Der Ressourcenbereich.
- options
- TagsGetAtScopeOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<TagsResource>
list(TagsListOptionalParams)
Dieser Vorgang führt eine Vereinigung von vordefinierten Tags, Ressourcentags, Ressourcengruppentags und Abonnementtags aus und gibt eine Zusammenfassung der Verwendung für jeden Tagnamen und -wert unter dem angegebenen Abonnement zurück. Bei einer großen Anzahl von Tags kann dieser Vorgang ein zuvor zwischengespeichertes Ergebnis zurückgeben.
function list(options?: TagsListOptionalParams): PagedAsyncIterableIterator<TagDetails, TagDetails[], PageSettings>Parameter
- options
- TagsListOptionalParams
Die Optionsparameter.
Gibt zurück
updateAtScope(string, TagsPatchResource, TagsUpdateAtScopeOptionalParams)
Dieser Vorgang ermöglicht das Ersetzen, Zusammenführen oder selektive Löschen von Tags für die angegebene Ressource oder das angegebene Abonnement. Die angegebene Entität kann am Ende des Vorgangs maximal 50 Tags aufweisen. Die Option "replace" ersetzt den gesamten Satz vorhandener Tags durch einen neuen Satz. Die Option "Merge" ermöglicht das Hinzufügen von Tags mit neuen Namen und das Aktualisieren der Werte von Tags mit vorhandenen Namen. Die Option "Löschen" ermöglicht das selektive Löschen von Tags basierend auf angegebenen Namen oder Namen/Wert-Paaren.
function updateAtScope(scope: string, parameters: TagsPatchResource, options?: TagsUpdateAtScopeOptionalParams): Promise<TagsResource>Parameter
- scope
-
string
Der Ressourcenbereich.
- parameters
- TagsPatchResource
Wrapperressource nur für Die Patch-API-Anforderung für Tags.
- options
- TagsUpdateAtScopeOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<TagsResource>