Skip to content

Commit ffd9f69

Browse files
author
Danny Tundwe (from Dev Box)
committed
Update documentation to clarify Azure Front Door (AFD) Edge Actions
- Updated README.md with comprehensive usage examples - Clarified service is Azure Front Door Edge Actions (not generic CDN) - Added installation instructions and command examples - Updated setup.py description to mention Azure Front Door
1 parent e11b633 commit ffd9f69

File tree

2 files changed

+71
-5
lines changed

2 files changed

+71
-5
lines changed

src/edge-action/README.md

Lines changed: 70 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,71 @@
1-
# Azure CLI EdgeAction Extension #
2-
This is an extension to Azure CLI to manage EdgeAction resources.
1+
# Azure CLI Edge Action Extension
32

4-
## How to use ##
5-
Please add commands usage here.
3+
Azure CLI extension for managing Azure Front Door (AFD) Edge Actions.
4+
5+
## Overview
6+
7+
Edge Actions allow you to customize how Azure Front Door handles requests and responses at the edge. This extension provides commands to create, manage, and deploy Edge Actions for Azure Front Door.
8+
9+
## Installation
10+
11+
```bash
12+
az extension add --name edge-action
13+
```
14+
15+
## Commands
16+
17+
### Edge Action Management
18+
19+
```bash
20+
# Create an edge action
21+
az edge-action create --resource-group myResourceGroup --name myEdgeAction --location global --sku name=Standard tier=Standard
22+
23+
# List edge actions
24+
az edge-action list --resource-group myResourceGroup
25+
26+
# Show edge action details
27+
az edge-action show --resource-group myResourceGroup --name myEdgeAction
28+
29+
# Update edge action
30+
az edge-action update --resource-group myResourceGroup --name myEdgeAction --tags env=prod
31+
32+
# Delete edge action
33+
az edge-action delete --resource-group myResourceGroup --name myEdgeAction
34+
```
35+
36+
### Version Management
37+
38+
```bash
39+
# Create a version
40+
az edge-action version create --resource-group myResourceGroup --edge-action-name myEdgeAction --name v1 --location global --deployment-type file
41+
42+
# Deploy code to a version
43+
az edge-action version deploy-from-file --resource-group myResourceGroup --edge-action-name myEdgeAction --version v1 --file-path ./mycode.js
44+
45+
# List versions
46+
az edge-action version list --resource-group myResourceGroup --edge-action-name myEdgeAction
47+
48+
# Delete a version
49+
az edge-action version delete --resource-group myResourceGroup --edge-action-name myEdgeAction --name v1
50+
```
51+
52+
### Execution Filters
53+
54+
```bash
55+
# Create an execution filter
56+
az edge-action execution-filter create --resource-group myResourceGroup --edge-action-name myEdgeAction --name myFilter --location global --action-version-id /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Cdn/edgeActions/{name}/versions/{version}
57+
58+
# List execution filters
59+
az edge-action execution-filter list --resource-group myResourceGroup --edge-action-name myEdgeAction
60+
61+
# Delete an execution filter
62+
az edge-action execution-filter delete --resource-group myResourceGroup --edge-action-name myEdgeAction --name myFilter
63+
```
64+
65+
## Features
66+
67+
- Full lifecycle management of Azure Front Door Edge Actions
68+
- Version control for Edge Action code
69+
- JavaScript and zip file deployment support
70+
- Execution filter management for selective Edge Action execution
71+
- Azure Front Door route attachment support

src/edge-action/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
setup(
3939
name='edge-action',
4040
version=VERSION,
41-
description='Microsoft Azure Command-Line Tools EdgeAction Extension.',
41+
description='Microsoft Azure Command-Line Tools Extension for Azure Front Door Edge Actions',
4242
long_description=README + '\n\n' + HISTORY,
4343
license='MIT',
4444
author='Microsoft Corporation',

0 commit comments

Comments
 (0)