ApiOperationPolicy interface
Interfaz que representa una ApiOperationPolicy.
Métodos
| create |
Crea o actualiza la configuración de directivas para el nivel de operación de API. |
| delete(string, string, string, string, string, string, Api |
Elimina la configuración de directivas en la operación de API. |
| get(string, string, string, string, string, Api |
Obtenga la configuración de directiva en el nivel de operación de API. |
| get |
Obtiene la versión del estado de entidad (Etag) de la directiva de operación de API especificada por su identificador. |
| list |
Obtiene la lista de configuración de directivas en el nivel de operación de API |
Detalles del método
createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)
Crea o actualiza la configuración de directivas para el nivel de operación de API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>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.
- operationId
-
string
Identificador de operación dentro de una API. Debe ser único en la instancia de servicio API Management actual.
- policyId
-
string
Identificador de la directiva.
- parameters
- PolicyContract
Contenido de la directiva que se va a aplicar.
Parámetros de opciones.
Devoluciones
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)
Elimina la configuración de directivas en la operación de API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, ifMatch: string, options?: ApiOperationPolicyDeleteOptionalParams): 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.
- operationId
-
string
Identificador de operación dentro de una API. Debe ser único en la instancia de servicio API Management actual.
- 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.
Parámetros de opciones.
Devoluciones
Promise<void>
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)
Obtenga la configuración de directiva en el nivel de operación de API.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>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.
- operationId
-
string
Identificador de operación dentro de una API. Debe ser único en la instancia de servicio API Management actual.
- policyId
-
string
Identificador de la directiva.
Parámetros de opciones.
Devoluciones
Promise<ApiOperationPolicyGetResponse>
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)
Obtiene la versión del estado de entidad (Etag) de la directiva de operación de API especificada por su identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>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.
- operationId
-
string
Identificador de operación dentro de una API. Debe ser único en la instancia de servicio API Management actual.
- policyId
-
string
Identificador de la directiva.
Parámetros de opciones.
Devoluciones
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)
Obtiene la lista de configuración de directivas en el nivel de operación de API
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): 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.
- operationId
-
string
Identificador de operación dentro de una API. Debe ser único en la instancia de servicio API Management actual.
Parámetros de opciones.
Devoluciones
Promise<PolicyCollection>