ApiOperation interface

Csomag:

@azure/arm-apimanagement

ApiOperationt képviselő felület.

Metódusok

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)	Új műveletet hoz létre az API-ban, vagy frissít egy meglévőt.
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)	Törli a megadott műveletet az API-ban.
get(string, string, string, string, ApiOperationGetOptionalParams)	Lekéri az azonosító által megadott API-művelet részleteit.
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)	Lekéri az api-művelet entitásállapotának (Etag) verzióját, amelyet az azonosítója határoz meg.
listByApi(string, string, string, ApiOperationListByApiOptionalParams)	A megadott API műveleteinek gyűjteményét sorolja fel.
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)	Frissíti a művelet részleteit az api-ban, amelyet az azonosítója határoz meg.

Metódus adatai

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

Új műveletet hoz létre az API-ban, vagy frissít egy meglévőt.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

apiId

string

API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

operationId

string

Műveletazonosító egy API-on belül. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

parameters

OperationContract

Paraméterek létrehozása.

options

ApiOperationCreateOrUpdateOptionalParams

A beállítások paraméterei.

Válaszok

Promise<ApiOperationCreateOrUpdateResponse>

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

Törli a megadott műveletet az API-ban.

function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, options?: ApiOperationDeleteOptionalParams): Promise<void>

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

apiId

string

API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

operationId

string

Műveletazonosító egy API-on belül. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

ifMatch

string

Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.

options

ApiOperationDeleteOptionalParams

A beállítások paraméterei.

Válaszok

Promise<void>

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

Lekéri az azonosító által megadott API-művelet részleteit.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

apiId

string

API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

operationId

string

Műveletazonosító egy API-on belül. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

options

ApiOperationGetOptionalParams

A beállítások paraméterei.

Válaszok

Promise<ApiOperationGetResponse>

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

Lekéri az api-művelet entitásállapotának (Etag) verzióját, amelyet az azonosítója határoz meg.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

apiId

string

API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

operationId

string

Műveletazonosító egy API-on belül. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

options

ApiOperationGetEntityTagOptionalParams

A beállítások paraméterei.

Válaszok

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

A megadott API műveleteinek gyűjteményét sorolja fel.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

apiId

string

API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

options

ApiOperationListByApiOptionalParams

A beállítások paraméterei.

Válaszok

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

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

Frissíti a művelet részleteit az api-ban, amelyet az azonosítója határoz meg.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

apiId

string

API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

operationId

string

Műveletazonosító egy API-on belül. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

ifMatch

string

Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.

parameters

OperationUpdateContract

API-műveletfrissítési paraméterek.

options

ApiOperationUpdateOptionalParams

A beállítások paraméterei.

Válaszok

Promise<ApiOperationUpdateResponse>