ApiOperation interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący interfejs ApiOperation.

Metody

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)	Tworzy nową operację w interfejsie API lub aktualizuje istniejącą operację.
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)	Usuwa określoną operację w interfejsie API.
get(string, string, string, string, ApiOperationGetOptionalParams)	Pobiera szczegóły operacji interfejsu API określonej przez jego identyfikator.
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) operacji interfejsu API określonej przez jej identyfikator.
listByApi(string, string, string, ApiOperationListByApiOptionalParams)	Wyświetla kolekcję operacji dla określonego interfejsu API.
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)	Aktualizuje szczegóły operacji w interfejsie API określonym przez jego identyfikator.

Szczegóły metody

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)

Tworzy nową operację w interfejsie API lub aktualizuje istniejącą operację.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>

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.

parameters

OperationContract

Utwórz parametry.

options

ApiOperationCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiOperationCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

Usuwa określoną operację w interfejsie API.

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

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

ApiOperationDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, string, ApiOperationGetOptionalParams)

Pobiera szczegóły operacji interfejsu API określonej przez jego identyfikator.

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>

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

ApiOperationGetOptionalParams

Parametry opcji.

Zwraca

Promise<ApiOperationGetResponse>

getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

Pobiera wersję stanu jednostki (Etag) operacji interfejsu API określonej przez jej identyfikator.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>

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

ApiOperationGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Wyświetla kolekcję operacji dla określonego interfejsu API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], 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

ApiOperationListByApiOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

Aktualizuje szczegóły operacji w interfejsie API określonym przez jego identyfikator.

function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>

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.

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

OperationUpdateContract

Parametry aktualizacji operacji interfejsu API.

options

ApiOperationUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiOperationUpdateResponse>