ProductPolicy interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en ProductPolicy.

Metoder

createOrUpdate(string, string, string, string, PolicyContract, ProductPolicyCreateOrUpdateOptionalParams)	Skapar eller uppdaterar principkonfigurationen för produkten.
delete(string, string, string, string, string, ProductPolicyDeleteOptionalParams)	Tar bort principkonfigurationen i Produkten.
get(string, string, string, string, ProductPolicyGetOptionalParams)	Hämta principkonfigurationen på produktnivå.
getEntityTag(string, string, string, string, ProductPolicyGetEntityTagOptionalParams)	Hämta ETag för principkonfigurationen på produktnivå.
listByProduct(string, string, string, ProductPolicyListByProductOptionalParams)	Hämta principkonfigurationen på produktnivå.

Metodinformation

createOrUpdate(string, string, string, string, PolicyContract, ProductPolicyCreateOrUpdateOptionalParams)

Skapar eller uppdaterar principkonfigurationen för produkten.

function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, policyId: string, parameters: PolicyContract, options?: ProductPolicyCreateOrUpdateOptionalParams): Promise<ProductPolicyCreateOrUpdateResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

policyId

string

Principens identifierare.

parameters

PolicyContract

Det principinnehåll som ska tillämpas.

options

ProductPolicyCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ProductPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, ProductPolicyDeleteOptionalParams)

Tar bort principkonfigurationen i Produkten.

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

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

policyId

string

Principens identifierare.

ifMatch

string

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

options

ProductPolicyDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, string, string, ProductPolicyGetOptionalParams)

Hämta principkonfigurationen på produktnivå.

function get(resourceGroupName: string, serviceName: string, productId: string, policyId: string, options?: ProductPolicyGetOptionalParams): Promise<ProductPolicyGetResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

policyId

string

Principens identifierare.

options

ProductPolicyGetOptionalParams

Alternativparametrarna.

Returer

Promise<ProductPolicyGetResponse>

getEntityTag(string, string, string, string, ProductPolicyGetEntityTagOptionalParams)

Hämta ETag för principkonfigurationen på produktnivå.

function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, policyId: string, options?: ProductPolicyGetEntityTagOptionalParams): Promise<ProductPolicyGetEntityTagHeaders>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

policyId

string

Principens identifierare.

options

ProductPolicyGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<ProductPolicyGetEntityTagHeaders>

listByProduct(string, string, string, ProductPolicyListByProductOptionalParams)

Hämta principkonfigurationen på produktnivå.

function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductPolicyListByProductOptionalParams): Promise<PolicyCollection>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

ProductPolicyListByProductOptionalParams

Alternativparametrarna.

Returer

Promise<PolicyCollection>