ApiPolicy interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en ApiPolicy.

Metoder

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)	Skapar eller uppdaterar principkonfigurationen för API:et.
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)	Tar bort principkonfigurationen i API:et.
get(string, string, string, string, ApiPolicyGetOptionalParams)	Hämta principkonfigurationen på API-nivå.
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)	Hämtar entitetstillståndsversionen (Etag) av API-principen som anges av dess identifierare.
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)	Hämta principkonfigurationen på API-nivå.

Metodinformation

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

Skapar eller uppdaterar principkonfigurationen för API:et.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

policyId

string

Identifieraren för principen.

parameters

PolicyContract

Principinnehållet som ska tillämpas.

options

ApiPolicyCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ApiPolicyCreateOrUpdateResponse>

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

Tar bort principkonfigurationen i API:et.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

policyId

string

Identifieraren för principen.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran eller * för ovillkorlig uppdatering.

options

ApiPolicyDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

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

Hämta principkonfigurationen på API-nivå.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

policyId

string

Identifieraren för principen.

options

ApiPolicyGetOptionalParams

Alternativparametrarna.

Returer

Promise<ApiPolicyGetResponse>

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

Hämtar entitetstillståndsversionen (Etag) av API-principen som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

policyId

string

Identifieraren för principen.

options

ApiPolicyGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

Hämta principkonfigurationen på API-nivå.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): Promise<PolicyCollection>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

options

ApiPolicyListByApiOptionalParams

Alternativparametrarna.

Returer

Promise<PolicyCollection>