Tag interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący tag.

Metody

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)	Przypisz tag do interfejsu API.
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)	Przypisz tag do operacji.
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)	Przypisz tag do produktu.
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)	Tworzy tag.
delete(string, string, string, string, TagDeleteOptionalParams)	Usuwa określony tag wystąpienia usługi API Management.
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)	Odłącz tag od interfejsu API.
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)	Odłącz tag od operacji.
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)	Odłącz tag od produktu.
get(string, string, string, TagGetOptionalParams)	Pobiera szczegóły tagu określonego przez jego identyfikator.
getByApi(string, string, string, string, TagGetByApiOptionalParams)	Pobierz tag skojarzony z interfejsem API.
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)	Pobierz tag skojarzony z operacją.
getByProduct(string, string, string, string, TagGetByProductOptionalParams)	Pobierz tag skojarzony z produktem.
getEntityState(string, string, string, TagGetEntityStateOptionalParams)	Pobiera wersję stanu jednostki tagu określonego przez jego identyfikator.
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)	Pobiera wersję stanu jednostki tagu określonego przez jego identyfikator.
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)	Pobiera wersję stanu jednostki tagu określonego przez jego identyfikator.
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)	Pobiera wersję stanu jednostki tagu określonego przez jego identyfikator.
listByApi(string, string, string, TagListByApiOptionalParams)	Wyświetla listę wszystkich tagów skojarzonych z interfejsem API.
listByOperation(string, string, string, string, TagListByOperationOptionalParams)	Wyświetla listę wszystkich tagów skojarzonych z operacją.
listByProduct(string, string, string, TagListByProductOptionalParams)	Wyświetla listę wszystkich tagów skojarzonych z produktem.
listByService(string, string, TagListByServiceOptionalParams)	Wyświetla kolekcję tagów zdefiniowanych w wystąpieniu usługi.
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)	Aktualizuje szczegóły tagu określonego przez jego identyfikator.

Szczegóły metody

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

Przypisz tag do interfejsu API.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagAssignToApiOptionalParams

Parametry opcji.

Zwraca

Promise<TagAssignToApiResponse>

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

Przypisz tag do operacji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

operationId

string

Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagAssignToOperationOptionalParams

Parametry opcji.

Zwraca

Promise<TagContract>

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

Przypisz tag do produktu.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

productId

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagAssignToProductOptionalParams

Parametry opcji.

Zwraca

Promise<TagContract>

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

Tworzy tag.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

parameters

TagCreateUpdateParameters

Utwórz parametry.

options

TagCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<TagCreateOrUpdateResponse>

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

Usuwa określony tag wystąpienia usługi API Management.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

ifMatch

string

Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

options

TagDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

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

Odłącz tag od interfejsu API.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagDetachFromApiOptionalParams

Parametry opcji.

Zwraca

Promise<void>

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

Odłącz tag od operacji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

operationId

string

Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagDetachFromOperationOptionalParams

Parametry opcji.

Zwraca

Promise<void>

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

Odłącz tag od produktu.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

productId

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagDetachFromProductOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, TagGetOptionalParams)

Pobiera szczegóły tagu określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagGetOptionalParams

Parametry opcji.

Zwraca

Promise<TagGetResponse>

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

Pobierz tag skojarzony z interfejsem API.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagGetByApiOptionalParams

Parametry opcji.

Zwraca

Promise<TagGetByApiResponse>

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

Pobierz tag skojarzony z operacją.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

operationId

string

Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagGetByOperationOptionalParams

Parametry opcji.

Zwraca

Promise<TagGetByOperationResponse>

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

Pobierz tag skojarzony z produktem.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

productId

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagGetByProductOptionalParams

Parametry opcji.

Zwraca

Promise<TagGetByProductResponse>

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

Pobiera wersję stanu jednostki tagu określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagGetEntityStateOptionalParams

Parametry opcji.

Zwraca

Promise<TagGetEntityStateHeaders>

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

Pobiera wersję stanu jednostki tagu określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagGetEntityStateByApiOptionalParams

Parametry opcji.

Zwraca

Promise<TagGetEntityStateByApiHeaders>

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

Pobiera wersję stanu jednostki tagu określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

operationId

string

Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagGetEntityStateByOperationOptionalParams

Parametry opcji.

Zwraca

Promise<TagGetEntityStateByOperationHeaders>

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

Pobiera wersję stanu jednostki tagu określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

productId

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagGetEntityStateByProductOptionalParams

Parametry opcji.

Zwraca

Promise<TagGetEntityStateByProductHeaders>

listByApi(string, string, string, TagListByApiOptionalParams)

Wyświetla listę wszystkich tagów skojarzonych z interfejsem API.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

options

TagListByApiOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

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

Wyświetla listę wszystkich tagów skojarzonych z operacją.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

operationId

string

Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagListByOperationOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByProduct(string, string, string, TagListByProductOptionalParams)

Wyświetla listę wszystkich tagów skojarzonych z produktem.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

productId

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

TagListByProductOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByService(string, string, TagListByServiceOptionalParams)

Wyświetla kolekcję tagów zdefiniowanych w wystąpieniu usługi.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

TagListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

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

Aktualizuje szczegóły tagu określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

tagId

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

ifMatch

string

Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

parameters

TagCreateUpdateParameters

Aktualizuj parametry.

options

TagUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<TagUpdateResponse>