ApiOperationPolicy interface

Balíček:

@azure/arm-apimanagement

Rozhraní představující ApiOperationPolicy.

Metody

createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)	Vytvoří nebo aktualizuje konfiguraci zásad pro úroveň operace rozhraní API.
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)	Odstraní konfiguraci zásad v operaci rozhraní API.
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)	Získejte konfiguraci zásad na úrovni operace rozhraní API.
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)	Získá verzi stavu entity (Etag) zásady operace rozhraní API určené jeho identifikátorem.
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)	Získejte seznam konfigurace zásad na úrovni operace rozhraní API.

Podrobnosti metody

createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)

Vytvoří nebo aktualizuje konfiguraci zásad pro úroveň operace rozhraní API.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>

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é.

policyId

string

Identifikátor zásady.

parameters

PolicyContract

Obsah zásad, který se má použít.

options

ApiOperationPolicyCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiOperationPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)

Odstraní konfiguraci zásad v operaci rozhraní API.

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

policyId

string

Identifikátor zásady.

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

ApiOperationPolicyDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)

Získejte konfiguraci zásad na úrovni operace rozhraní API.

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>

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é.

policyId

string

Identifikátor zásady.

options

ApiOperationPolicyGetOptionalParams

Parametry možností.

Návraty

Promise<ApiOperationPolicyGetResponse>

getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)

Získá verzi stavu entity (Etag) zásady operace rozhraní API určené jeho identifikátorem.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>

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é.

policyId

string

Identifikátor zásady.

options

ApiOperationPolicyGetEntityTagOptionalParams

Parametry možností.

Návraty

Promise<ApiOperationPolicyGetEntityTagHeaders>

listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)

Získejte seznam konfigurace zásad na úrovni operace rozhraní API.

function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): Promise<PolicyCollection>

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

ApiOperationPolicyListByOperationOptionalParams

Parametry možností.

Návraty

Promise<PolicyCollection>