Sdílet prostřednictvím

ApiPolicy interface

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

Rozhraní představující ApiPolicy.

Metody

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)

Vytvoří nebo aktualizuje konfiguraci zásad pro rozhraní API.
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)

Odstraní konfiguraci zásad v rozhraní API.
get(string, string, string, string, ApiPolicyGetOptionalParams)

Získejte konfiguraci zásad na úrovni rozhraní API.
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)

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

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

Podrobnosti metody

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)

Vytvoří nebo aktualizuje konfiguraci zásad pro rozhraní API.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>

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.

policyId

string

Identifikátor zásady.

parameters
PolicyContract

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

options
ApiPolicyCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)

Odstraní konfiguraci zásad v rozhraní API.

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

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
ApiPolicyDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

get(string, string, string, string, ApiPolicyGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>

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.

policyId

string

Identifikátor zásady.

options
ApiPolicyGetOptionalParams

Parametry možností.

Návraty

Promise<ApiPolicyGetResponse>

getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagHeaders>

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.

policyId

string

Identifikátor zásady.

options
ApiPolicyGetEntityTagOptionalParams

Parametry možností.

Návraty

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

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

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

options
ApiPolicyListByApiOptionalParams

Parametry možností.

Návraty

Promise<PolicyCollection>