WorkspaceApi interface

Csomag:

@azure/arm-apimanagement

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

Metódusok

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	Új vagy frissített api-t hoz létre a munkaterületen egy API Management szolgáltatáspéldányban.
beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	Új vagy frissített api-t hoz létre a munkaterületen egy API Management szolgáltatáspéldányban.
delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)	Törli a munkaterület megadott API-ját egy API Management szolgáltatáspéldányban.
get(string, string, string, string, WorkspaceApiGetOptionalParams)	Lekéri az azonosító által megadott API részleteit.
getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)	Lekéri az API azonosító által megadott entitásállapot-(Etag-) verzióját.
listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)	Megjeleníti a munkaterület összes API-ját egy API Management szolgáltatáspéldányban.
update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)	Frissíti a munkaterület megadott API-ját egy API Management szolgáltatáspéldányban.

Metódus adatai

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)

Új vagy frissített api-t hoz létre a munkaterületen egy API Management szolgáltatáspéldányban.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>

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.

parameters

ApiCreateOrUpdateParameter

Paraméterek létrehozása vagy frissítése.

options

WorkspaceApiCreateOrUpdateOptionalParams

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

Válaszok

Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)

Új vagy frissített api-t hoz létre a munkaterületen egy API Management szolgáltatáspéldányban.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<WorkspaceApiCreateOrUpdateResponse>

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.

parameters

ApiCreateOrUpdateParameter

Paraméterek létrehozása vagy frissítése.

options

WorkspaceApiCreateOrUpdateOptionalParams

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

Válaszok

Promise<WorkspaceApiCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)

Törli a munkaterület megadott API-ját egy API Management szolgáltatáspéldányban.

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

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

WorkspaceApiDeleteOptionalParams

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

Válaszok

Promise<void>

get(string, string, string, string, WorkspaceApiGetOptionalParams)

Lekéri az azonosító által megadott API részleteit.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetOptionalParams): Promise<WorkspaceApiGetResponse>

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

WorkspaceApiGetOptionalParams

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

Válaszok

Promise<WorkspaceApiGetResponse>

getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)

Lekéri az API azonosító által megadott entitásállapot-(Etag-) verzióját.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetEntityTagOptionalParams): Promise<WorkspaceApiGetEntityTagHeaders>

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

WorkspaceApiGetEntityTagOptionalParams

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

Válaszok

Promise<WorkspaceApiGetEntityTagHeaders>

listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)

Megjeleníti a munkaterület összes API-ját egy API Management szolgáltatáspéldányban.

function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], 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.

options

WorkspaceApiListByServiceOptionalParams

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

Válaszok

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)

Frissíti a munkaterület megadott API-ját egy API Management szolgáltatáspéldányban.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: WorkspaceApiUpdateOptionalParams): Promise<WorkspaceApiUpdateResponse>

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.

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

ApiUpdateContract

API Update Contract paraméterek.

options

WorkspaceApiUpdateOptionalParams

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

Válaszok

Promise<WorkspaceApiUpdateResponse>