Udostępnij za pośrednictwem

ApiWiki interface

  • Odwołanie
Pakiet:
@azure/arm-apimanagement

Interfejs reprezentujący interfejs ApiWiki.

Metody

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)

Tworzy nową witrynę typu wiki dla interfejsu API lub aktualizuje istniejącą.
delete(string, string, string, string, ApiWikiDeleteOptionalParams)

Usuwa określoną witrynę typu wiki z interfejsu API.
get(string, string, string, ApiWikiGetOptionalParams)

Pobiera szczegółowe informacje o witrynie typu wiki dla interfejsu API określonego przez jego identyfikator.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Pobiera wersję typu wiki stanu jednostki (Etag) dla interfejsu API określonego przez jego identyfikator.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)

Aktualizuje szczegóły witryny typu wiki dla interfejsu API określonego przez jego identyfikator.

Szczegóły metody

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)

Tworzy nową witrynę typu wiki dla interfejsu API lub aktualizuje istniejącą.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: WikiContract, options?: ApiWikiCreateOrUpdateOptionalParams): Promise<ApiWikiCreateOrUpdateResponse>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

apiId

string

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

parameters
WikiContract

Utwórz parametry.

options
ApiWikiCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiWikiCreateOrUpdateResponse>

delete(string, string, string, string, ApiWikiDeleteOptionalParams)

Usuwa określoną witrynę typu wiki z interfejsu API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiWikiDeleteOptionalParams): 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 interfejsu API. 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
ApiWikiDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

Pobiera szczegółowe informacje o witrynie typu wiki dla interfejsu API określonego przez jego identyfikator.

function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetOptionalParams): Promise<ApiWikiGetResponse>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

apiId

string

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

options
ApiWikiGetOptionalParams

Parametry opcji.

Zwraca

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Pobiera wersję typu wiki stanu jednostki (Etag) dla interfejsu API określonego przez jego identyfikator.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetEntityTagOptionalParams): Promise<ApiWikiGetEntityTagHeaders>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

apiId

string

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

options
ApiWikiGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<ApiWikiGetEntityTagHeaders>

update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)

Aktualizuje szczegóły witryny typu wiki dla interfejsu API określonego przez jego identyfikator.

function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ApiWikiUpdateOptionalParams): Promise<ApiWikiUpdateResponse>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator interfejsu API. 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
WikiUpdateContract

Parametry aktualizacji witryny typu wiki.

options
ApiWikiUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiWikiUpdateResponse>