Tag interface

Balíček:

@azure/arm-apimanagement

Rozhraní představující značku.

Metody

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)	Přiřaďte značku k rozhraní API.
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)	Přiřaďte značku operaci.
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)	Přiřaďte značku produktu.
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)	Vytvoří značku.
delete(string, string, string, string, TagDeleteOptionalParams)	Odstraní konkrétní značku instance služby Gestione API.
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)	Odpojte značku od rozhraní API.
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)	Odpojte značku od operace.
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)	Odpojte značku od produktu.
get(string, string, string, TagGetOptionalParams)	Získá podrobnosti značky určené jeho identifikátor.
getByApi(string, string, string, string, TagGetByApiOptionalParams)	Získejte značku přidruženou k rozhraní API.
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)	Získejte značku přidruženou k operaci.
getByProduct(string, string, string, string, TagGetByProductOptionalParams)	Získejte značku přidruženou k produktu.
getEntityState(string, string, string, TagGetEntityStateOptionalParams)	Získá verzi entity stav značky určené jeho identifikátorem.
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)	Získá verzi entity stav značky určené jeho identifikátorem.
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)	Získá verzi entity stav značky určené jeho identifikátorem.
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)	Získá verzi entity stav značky určené jeho identifikátorem.
listByApi(string, string, string, TagListByApiOptionalParams)	Zobrazí seznam všech značek přidružených k rozhraní API.
listByOperation(string, string, string, string, TagListByOperationOptionalParams)	Zobrazí seznam všech značek přidružených k operaci.
listByProduct(string, string, string, TagListByProductOptionalParams)	Zobrazí seznam všech značek přidružených k produktu.
listByService(string, string, TagListByServiceOptionalParams)	Zobrazí seznam kolekce značek definovaných v instanci služby.
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)	Aktualizace podrobnosti o značce určené jejím identifikátorem.

Podrobnosti metody

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

Přiřaďte značku k rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná. Non-current revize má příponu ;rev=n, kde n je číslo revize.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagAssignToApiOptionalParams

Parametry možností

Návraty

Promise<TagAssignToApiResponse>

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

Přiřaďte značku operaci.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná. Non-current revize má příponu ;rev=n, kde n je číslo revize.

operationId

string

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagAssignToOperationOptionalParams

Parametry možností

Návraty

Promise<TagContract>

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

Přiřaďte značku produktu.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

productId

string

Identifikátor produktu. V aktuální instanci služby Gestione API musí být jedinečná.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagAssignToProductOptionalParams

Parametry možností

Návraty

Promise<TagContract>

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

Vytvoří značku.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

parameters

TagCreateUpdateParameters

Vytvořte parametry.

options

TagCreateOrUpdateOptionalParams

Parametry možností

Návraty

Promise<TagCreateOrUpdateResponse>

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

Odstraní konkrétní značku instance služby Gestione API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

ifMatch

string

Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro bezpodmínečnou aktualizaci.

options

TagDeleteOptionalParams

Parametry možností

Návraty

Promise<void>

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

Odpojte značku od rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná. Non-current revize má příponu ;rev=n, kde n je číslo revize.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagDetachFromApiOptionalParams

Parametry možností

Návraty

Promise<void>

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

Odpojte značku od operace.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná. Non-current revize má příponu ;rev=n, kde n je číslo revize.

operationId

string

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagDetachFromOperationOptionalParams

Parametry možností

Návraty

Promise<void>

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

Odpojte značku od produktu.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

productId

string

Identifikátor produktu. V aktuální instanci služby Gestione API musí být jedinečná.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagDetachFromProductOptionalParams

Parametry možností

Návraty

Promise<void>

get(string, string, string, TagGetOptionalParams)

Získá podrobnosti značky určené jeho identifikátor.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagGetOptionalParams

Parametry možností

Návraty

Promise<TagGetResponse>

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

Získejte značku přidruženou k rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná. Non-current revize má příponu ;rev=n, kde n je číslo revize.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagGetByApiOptionalParams

Parametry možností

Návraty

Promise<TagGetByApiResponse>

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

Získejte značku přidruženou k operaci.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná. Non-current revize má příponu ;rev=n, kde n je číslo revize.

operationId

string

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagGetByOperationOptionalParams

Parametry možností

Návraty

Promise<TagGetByOperationResponse>

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

Získejte značku přidruženou k produktu.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

productId

string

Identifikátor produktu. V aktuální instanci služby Gestione API musí být jedinečná.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagGetByProductOptionalParams

Parametry možností

Návraty

Promise<TagGetByProductResponse>

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

Získá verzi entity stav značky určené jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagGetEntityStateOptionalParams

Parametry možností

Návraty

Promise<TagGetEntityStateHeaders>

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

Získá verzi entity stav značky určené jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná. Non-current revize má příponu ;rev=n, kde n je číslo revize.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagGetEntityStateByApiOptionalParams

Parametry možností

Návraty

Promise<TagGetEntityStateByApiHeaders>

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

Získá verzi entity stav značky určené jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná. Non-current revize má příponu ;rev=n, kde n je číslo revize.

operationId

string

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagGetEntityStateByOperationOptionalParams

Parametry možností

Návraty

Promise<TagGetEntityStateByOperationHeaders>

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

Získá verzi entity stav značky určené jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

productId

string

Identifikátor produktu. V aktuální instanci služby Gestione API musí být jedinečná.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagGetEntityStateByProductOptionalParams

Parametry možností

Návraty

Promise<TagGetEntityStateByProductHeaders>

listByApi(string, string, string, TagListByApiOptionalParams)

Zobrazí seznam všech značek přidružených k rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná. Non-current revize má příponu ;rev=n, kde n je číslo revize.

options

TagListByApiOptionalParams

Parametry možností

Návraty

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

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

Zobrazí seznam všech značek přidružených k operaci.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná. Non-current revize má příponu ;rev=n, kde n je číslo revize.

operationId

string

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagListByOperationOptionalParams

Parametry možností

Návraty

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByProduct(string, string, string, TagListByProductOptionalParams)

Zobrazí seznam všech značek přidružených k produktu.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

productId

string

Identifikátor produktu. V aktuální instanci služby Gestione API musí být jedinečná.

options

TagListByProductOptionalParams

Parametry možností

Návraty

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByService(string, string, TagListByServiceOptionalParams)

Zobrazí seznam kolekce značek definovaných v instanci služby.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

options

TagListByServiceOptionalParams

Parametry možností

Návraty

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

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

Aktualizace podrobnosti o značce určené jejím identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

tagId

string

Identifikátor značky. V aktuální instanci služby Gestione API musí být jedinečná.

ifMatch

string

Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro bezpodmínečnou aktualizaci.

parameters

TagCreateUpdateParameters

Aktualizujte parametry.

options

TagUpdateOptionalParams

Parametry možností

Návraty

Promise<TagUpdateResponse>