Sdílet prostřednictvím

ApiOperation interface

  • Reference
Balíček:
@azure/arm-apimanagement

Rozhraní představující ApiOperation

Metody

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

Vytvoří novou operaci v rozhraní API nebo aktualizuje existující operaci.
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

Odstraní zadanou operaci v rozhraní API.
get(string, string, string, string, ApiOperationGetOptionalParams)

Získá podrobnosti operace rozhraní API určené jeho identifikátorem.
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

Získá verzi stavu entity (Etag) operace rozhraní API určenou jeho identifikátorem.
listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Zobrazí kolekci operací pro zadané rozhraní API.
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

Aktualizuje podrobnosti o operaci v rozhraní API určeném jeho identifikátorem.

Podrobnosti metody

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

Vytvoří novou operaci v rozhraní API nebo aktualizuje existující operaci.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

operationId

string

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

parameters
OperationContract

Vytvořte parametry.

options
ApiOperationCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiOperationCreateOrUpdateResponse>

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

Odstraní zadanou operaci v rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

operationId

string

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

ifMatch

string

ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.

options
ApiOperationDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

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

Získá podrobnosti operace rozhraní API určené jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

operationId

string

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

options
ApiOperationGetOptionalParams

Parametry možností.

Návraty

Promise<ApiOperationGetResponse>

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

Získá verzi stavu entity (Etag) operace rozhraní API určenou jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

operationId

string

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

options
ApiOperationGetEntityTagOptionalParams

Parametry možností.

Návraty

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Zobrazí kolekci operací pro zadané rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

options
ApiOperationListByApiOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

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

Aktualizuje podrobnosti o operaci v rozhraní API určeném jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

operationId

string

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

ifMatch

string

ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.

parameters
OperationUpdateContract

Parametry aktualizace operace rozhraní API

options
ApiOperationUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiOperationUpdateResponse>