Tag interface

Paket:

@azure/arm-apimanagement

Schnittstelle, die ein Tag darstellt.

Methoden

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)	Weist der API ein Tag zu
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)	Weist dem Vorgang ein Tag zu
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)	Weist dem Produkt ein Tag zu
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)	Erstellt ein Tag
delete(string, string, string, string, TagDeleteOptionalParams)	Löscht das angegebene Tag aus der API Management-Dienstinstanz
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)	Trennt das Tag von der API
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)	Trennt das Tag vom Vorgang
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)	Trennt das Tag vom Produkt
get(string, string, string, TagGetOptionalParams)	Ruft die Details des Tags ab, das durch den Bezeichner angegeben wird.
getByApi(string, string, string, string, TagGetByApiOptionalParams)	Ruft tag ab, das der API zugeordnet ist.
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)	Ruft das Tag ab, das dem Vorgang zugeordnet ist.
getByProduct(string, string, string, string, TagGetByProductOptionalParams)	Ruft das Tag ab, das dem Produkt zugeordnet ist.
getEntityState(string, string, string, TagGetEntityStateOptionalParams)	Ruft die Entitätsstatusversion des Tags ab, die durch den Bezeichner angegeben wird.
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)	Ruft die Entitätsstatusversion des Tags ab, die durch den Bezeichner angegeben wird.
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)	Ruft die Entitätsstatusversion des Tags ab, die durch den Bezeichner angegeben wird.
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)	Ruft die Entitätsstatusversion des Tags ab, die durch den Bezeichner angegeben wird.
listByApi(string, string, string, TagListByApiOptionalParams)	Listet alle der API zugeordneten Tags auf
listByOperation(string, string, string, string, TagListByOperationOptionalParams)	Listet alle dem Vorgang zugeordneten Tags auf
listByProduct(string, string, string, TagListByProductOptionalParams)	Listet alle dem Produkt zugeordneten Tags auf
listByService(string, string, TagListByServiceOptionalParams)	Listet eine Auflistung der in einer Dienstinstanz definierten Tags auf
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)	Updates die Details des Tags, das durch seinen Bezeichner angegeben wird.

Details zur Methode

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)

Weist der API ein Tag zu

function assignToApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagAssignToApiOptionalParams): Promise<TagAssignToApiResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

tagId

string

Tagbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

options

TagAssignToApiOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagAssignToApiResponse>

assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)

Weist dem Vorgang ein Tag zu

function assignToOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagAssignToOperationOptionalParams): Promise<TagContract>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss im aktuellen API Management Dienst instance eindeutig sein.

tagId

string

Tagbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

options

TagAssignToOperationOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagContract>

assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)

Weist dem Produkt ein Tag zu

function assignToProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagAssignToProductOptionalParams): Promise<TagContract>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

productId

string

Produktbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

tagId

string

Tagbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

options

TagAssignToProductOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagContract>

createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)

Erstellt ein Tag

function createOrUpdate(resourceGroupName: string, serviceName: string, tagId: string, parameters: TagCreateUpdateParameters, options?: TagCreateOrUpdateOptionalParams): Promise<TagCreateOrUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

tagId

string

Tagbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

parameters

TagCreateUpdateParameters

Erstellen sie Parameter.

options

TagCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagCreateOrUpdateResponse>

delete(string, string, string, string, TagDeleteOptionalParams)

Löscht das angegebene Tag aus der API Management-Dienstinstanz

function delete(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, options?: TagDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

tagId

string

Tagbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

options

TagDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)

Trennt das Tag von der API

function detachFromApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagDetachFromApiOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagDetachFromApiOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)

Trennt das Tag vom Vorgang

function detachFromOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagDetachFromOperationOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss im aktuellen API Management-Dienst instance eindeutig sein.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagDetachFromOperationOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)

Trennt das Tag vom Produkt

function detachFromProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagDetachFromProductOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

productId

string

Produktbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagDetachFromProductOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, TagGetOptionalParams)

Ruft die Details des Tags ab, das durch den Bezeichner angegeben wird.

function get(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetOptionalParams): Promise<TagGetResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagGetResponse>

getByApi(string, string, string, string, TagGetByApiOptionalParams)

Ruft tag ab, das der API zugeordnet ist.

function getByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetByApiOptionalParams): Promise<TagGetByApiResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagGetByApiOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagGetByApiResponse>

getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)

Ruft das Tag ab, das dem Vorgang zugeordnet ist.

function getByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetByOperationOptionalParams): Promise<TagGetByOperationResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss im aktuellen API Management-Dienst instance eindeutig sein.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagGetByOperationOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagGetByOperationResponse>

getByProduct(string, string, string, string, TagGetByProductOptionalParams)

Ruft das Tag ab, das dem Produkt zugeordnet ist.

function getByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetByProductOptionalParams): Promise<TagGetByProductResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

productId

string

Produktbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagGetByProductOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagGetByProductResponse>

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

Ruft die Entitätsstatusversion des Tags ab, die durch den Bezeichner angegeben wird.

function getEntityState(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetEntityStateOptionalParams): Promise<TagGetEntityStateHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagGetEntityStateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagGetEntityStateHeaders>

getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)

Ruft die Entitätsstatusversion des Tags ab, die durch den Bezeichner angegeben wird.

function getEntityStateByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetEntityStateByApiOptionalParams): Promise<TagGetEntityStateByApiHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagGetEntityStateByApiOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagGetEntityStateByApiHeaders>

getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)

Ruft die Entitätsstatusversion des Tags ab, die durch den Bezeichner angegeben wird.

function getEntityStateByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetEntityStateByOperationOptionalParams): Promise<TagGetEntityStateByOperationHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss im aktuellen API Management-Dienst instance eindeutig sein.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagGetEntityStateByOperationOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagGetEntityStateByOperationHeaders>

getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)

Ruft die Entitätsstatusversion des Tags ab, die durch den Bezeichner angegeben wird.

function getEntityStateByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetEntityStateByProductOptionalParams): Promise<TagGetEntityStateByProductHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

productId

string

Produktbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

tagId

string

Tagbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

TagGetEntityStateByProductOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagGetEntityStateByProductHeaders>

listByApi(string, string, string, TagListByApiOptionalParams)

Listet alle der API zugeordneten Tags auf

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: TagListByApiOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

options

TagListByApiOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByOperation(string, string, string, string, TagListByOperationOptionalParams)

Listet alle dem Vorgang zugeordneten Tags auf

function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: TagListByOperationOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss im aktuellen API Management Dienst instance eindeutig sein.

options

TagListByOperationOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByProduct(string, string, string, TagListByProductOptionalParams)

Listet alle dem Produkt zugeordneten Tags auf

function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: TagListByProductOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

productId

string

Produktbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

options

TagListByProductOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByService(string, string, TagListByServiceOptionalParams)

Listet eine Auflistung der in einer Dienstinstanz definierten Tags auf

function listByService(resourceGroupName: string, serviceName: string, options?: TagListByServiceOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

options

TagListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)

Updates die Details des Tags, das durch seinen Bezeichner angegeben wird.

function update(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, parameters: TagCreateUpdateParameters, options?: TagUpdateOptionalParams): Promise<TagUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

tagId

string

Tagbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

parameters

TagCreateUpdateParameters

Parameter aktualisieren.

options

TagUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TagUpdateResponse>