Documentation interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący dokumentację.

Metody

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)	Tworzy nową dokumentację lub aktualizuje istniejącą.
delete(string, string, string, string, DocumentationDeleteOptionalParams)	Usuwa określoną dokumentację z interfejsu API.
get(string, string, string, DocumentationGetOptionalParams)	Pobiera szczegóły dokumentacji określonej przez jej identyfikator.
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) dokumentacji według jego identyfikatora.
listByService(string, string, DocumentationListByServiceOptionalParams)	Wyświetla listę wszystkich dokumentacji wystąpienia usługi API Management.
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)	Aktualizuje szczegóły dokumentacji interfejsu API określonego przez jego identyfikator.

Szczegóły metody

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)

Tworzy nową dokumentację lub aktualizuje istniejącą.

function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

documentationId

string

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

parameters

DocumentationContract

Utwórz parametry.

options

DocumentationCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<DocumentationCreateOrUpdateResponse>

delete(string, string, string, string, DocumentationDeleteOptionalParams)

Usuwa określoną dokumentację z interfejsu API.

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

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

documentationId

string

Identyfikator dokumentacji. 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

DocumentationDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, DocumentationGetOptionalParams)

Pobiera szczegóły dokumentacji określonej przez jej identyfikator.

function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

documentationId

string

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

options

DocumentationGetOptionalParams

Parametry opcji.

Zwraca

Promise<DocumentationGetResponse>

getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

Pobiera wersję stanu jednostki (Etag) dokumentacji według jego identyfikatora.

function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

documentationId

string

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

options

DocumentationGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<DocumentationGetEntityTagHeaders>

listByService(string, string, DocumentationListByServiceOptionalParams)

Wyświetla listę wszystkich dokumentacji wystąpienia usługi API Management.

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

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

options

DocumentationListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)

Aktualizuje szczegóły dokumentacji interfejsu API określonego przez jego identyfikator.

function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

documentationId

string

Identyfikator dokumentacji. 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

DocumentationUpdateContract

Parametry aktualizacji dokumentacji.

options

DocumentationUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<DocumentationUpdateResponse>