Generated by API Evangelist
Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Microsoft Azure Metrics Advisor Hook API
version: 1.0.0
extends: openapi/microsoft-azure-hook-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 5
- target: $.paths['/hooks'].get
update:
x-apievangelist-phrasing:
intent: List notification hooks
effect: read
questions:
- Which alert hooks have I set up for anomaly notifications?
- Can I find a hook by name and page through the results?
instructions:
- text: List all my notification hooks.
- text: Find hooks named {hook_name}, {page_size} per page.
slots:
hook_name: query.hookName
page_size: query.$maxpagesize
method: generated
generated: '2026-09-26'
- target: $.paths['/hooks'].post
update:
x-apievangelist-phrasing:
intent: Create a notification hook
effect: write
questions:
- How do I set up an email or webhook hook to receive alerts?
- Can I add admins and an external link when creating a hook?
instructions:
- text: Create a {hook_type} hook named {hook_name}.
slots:
hook_type: requestBody.hookType
hook_name: requestBody.hookName
- text: Create hook {hook_name} of type {hook_type} with admins {admins} and description {description}.
slots:
hook_name: requestBody.hookName
hook_type: requestBody.hookType
admins: requestBody.admins
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/hooks/{hookId}'].get
update:
x-apievangelist-phrasing:
intent: Get a notification hook
effect: read
questions:
- What settings does one of my alert hooks have?
- Can I look up a hook's type and admins by its id?
instructions:
- text: Get hook {hook_id}.
slots:
hook_id: path.hookId
- text: Show the configuration of alert hook {hook_id}.
slots:
hook_id: path.hookId
method: generated
generated: '2026-09-26'
- target: $.paths['/hooks/{hookId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a notification hook
effect: destructive
questions:
- How do I stop alerts going to a hook by deleting it?
- Can I remove a hook I no longer use?
instructions:
- text: Delete hook {hook_id}.
slots:
hook_id: path.hookId
- text: Remove alert hook {hook_id} permanently.
slots:
hook_id: path.hookId
method: generated
generated: '2026-09-26'
- target: $.paths['/hooks/{hookId}'].patch
update:
x-apievangelist-phrasing:
intent: Update a notification hook
effect: write
questions:
- Can I rename a hook or change who administers it?
- What's the way to update the external link on an existing hook?
instructions:
- text: Rename {hook_type} hook {hook_id} to {hook_name}.
slots:
hook_type: requestBody.hookType
hook_id: path.hookId
hook_name: requestBody.hookName
- text: Set the external link on {hook_type} hook {hook_id} to {link}.
slots:
hook_type: requestBody.hookType
hook_id: path.hookId
link: requestBody.externalLink
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.