WorkspaceApiOperation interface

Csomag:

@azure/arm-apimanagement

A WorkspaceApiOperation-t képviselő felület.

Metódusok

createOrUpdate(string, string, string, string, string, OperationContract, WorkspaceApiOperationCreateOrUpdateOptionalParams)	Új műveletet hoz létre az API-ban, vagy frissít egy meglévőt.
delete(string, string, string, string, string, string, WorkspaceApiOperationDeleteOptionalParams)	Törli a megadott műveletet az API-ban.
get(string, string, string, string, string, WorkspaceApiOperationGetOptionalParams)	Lekéri az azonosító által megadott API-művelet részleteit.
getEntityTag(string, string, string, string, string, WorkspaceApiOperationGetEntityTagOptionalParams)	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, string, WorkspaceApiOperationListByApiOptionalParams)	A megadott API műveleteinek gyűjteményét sorolja fel.
update(string, string, string, string, string, string, OperationUpdateContract, WorkspaceApiOperationUpdateOptionalParams)	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, string, OperationContract, WorkspaceApiOperationCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, parameters: OperationContract, options?: WorkspaceApiOperationCreateOrUpdateOptionalParams): Promise<WorkspaceApiOperationCreateOrUpdateResponse>

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.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

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

WorkspaceApiOperationCreateOrUpdateOptionalParams

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

Válaszok

Promise<WorkspaceApiOperationCreateOrUpdateResponse>

delete(string, string, string, string, string, string, WorkspaceApiOperationDeleteOptionalParams)

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

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

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

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

WorkspaceApiOperationDeleteOptionalParams

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

Válaszok

Promise<void>

get(string, string, string, string, string, WorkspaceApiOperationGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetOptionalParams): Promise<WorkspaceApiOperationGetResponse>

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.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

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

WorkspaceApiOperationGetOptionalParams

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

Válaszok

Promise<WorkspaceApiOperationGetResponse>

getEntityTag(string, string, string, string, string, WorkspaceApiOperationGetEntityTagOptionalParams)

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, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetEntityTagOptionalParams): Promise<WorkspaceApiOperationGetEntityTagHeaders>

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.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

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

WorkspaceApiOperationGetEntityTagOptionalParams

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

Válaszok

Promise<WorkspaceApiOperationGetEntityTagHeaders>

listByApi(string, string, string, string, WorkspaceApiOperationListByApiOptionalParams)

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

function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiOperationListByApiOptionalParams): 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.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

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

WorkspaceApiOperationListByApiOptionalParams

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

Válaszok

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

update(string, string, string, string, string, string, OperationUpdateContract, WorkspaceApiOperationUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: WorkspaceApiOperationUpdateOptionalParams): Promise<WorkspaceApiOperationUpdateResponse>

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.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

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

WorkspaceApiOperationUpdateOptionalParams

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

Válaszok

Promise<WorkspaceApiOperationUpdateResponse>