ApiPolicy interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa una apiPolicy.

Métodos

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)	Crea o actualiza la configuración de directivas de la API.
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)	Elimina la configuración de directivas en la API.
get(string, string, string, string, ApiPolicyGetOptionalParams)	Obtiene la configuración de directivas en el nivel de API
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)	Obtiene la versión del estado de entidad (Etag) de la directiva de API especificada por su identificador.
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)	Obtiene la configuración de directivas en el nivel de API

Detalles del método

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

Crea o actualiza la configuración de directivas de la API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.

policyId

string

Identificador de la directiva.

parameters

PolicyContract

Contenido de la directiva que se va a aplicar.

options

ApiPolicyCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiPolicyCreateOrUpdateResponse>

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

Elimina la configuración de directivas en la API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.

policyId

string

Identificador de la directiva.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

options

ApiPolicyDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

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

Obtiene la configuración de directivas en el nivel de API

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.

policyId

string

Identificador de la directiva.

options

ApiPolicyGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiPolicyGetResponse>

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

Obtiene la versión del estado de entidad (Etag) de la directiva de API especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.

policyId

string

Identificador de la directiva.

options

ApiPolicyGetEntityTagOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

Obtiene la configuración de directivas en el nivel de API

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.

options

ApiPolicyListByApiOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PolicyCollection>