Azure Mgmt Apimanagement Py

1---
2name: azure-mgmt-apimanagement-py
3description: |
4  Azure API Management SDK for Python. Use for managing APIM services, APIs, products, subscriptions, and policies.
5  Triggers: "azure-mgmt-apimanagement", "ApiManagementClient", "APIM", "API gateway", "API Management".
6package: azure-mgmt-apimanagement
7---
8 
9# Azure API Management SDK for Python
10 
11Manage Azure API Management services, APIs, products, and policies.
12 
13## Installation
14 
15```bash
16pip install azure-mgmt-apimanagement
17pip install azure-identity
18```
19 
20## Environment Variables
21 
22```bash
23AZURE_SUBSCRIPTION_ID=your-subscription-id
24```
25 
26## Authentication
27 
28```python
29from azure.identity import DefaultAzureCredential
30from azure.mgmt.apimanagement import ApiManagementClient
31import os
32 
33client = ApiManagementClient(
34    credential=DefaultAzureCredential(),
35    subscription_id=os.environ["AZURE_SUBSCRIPTION_ID"]
36)
37```
38 
39## Create APIM Service
40 
41```python
42from azure.mgmt.apimanagement.models import (
43    ApiManagementServiceResource,
44    ApiManagementServiceSkuProperties,
45    SkuType
46)
47 
48service = client.api_management_service.begin_create_or_update(
49    resource_group_name="my-resource-group",
50    service_name="my-apim",
51    parameters=ApiManagementServiceResource(
52        location="eastus",
53        publisher_email="admin@example.com",
54        publisher_name="My Organization",
55        sku=ApiManagementServiceSkuProperties(
56            name=SkuType.DEVELOPER,
57            capacity=1
58        )
59    )
60).result()
61 
62print(f"Created APIM: {service.name}")
63```
64 
65## Import API from OpenAPI
66 
67```python
68from azure.mgmt.apimanagement.models import (
69    ApiCreateOrUpdateParameter,
70    ContentFormat,
71    Protocol
72)
73 
74api = client.api.begin_create_or_update(
75    resource_group_name="my-resource-group",
76    service_name="my-apim",
77    api_id="my-api",
78    parameters=ApiCreateOrUpdateParameter(
79        display_name="My API",
80        path="myapi",
81        protocols=[Protocol.HTTPS],
82        format=ContentFormat.OPENAPI_JSON,
83        value='{"openapi": "3.0.0", "info": {"title": "My API", "version": "1.0"}, "paths": {"/health": {"get": {"responses": {"200": {"description": "OK"}}}}}}'
84    )
85).result()
86 
87print(f"Imported API: {api.display_name}")
88```
89 
90## Import API from URL
91 
92```python
93api = client.api.begin_create_or_update(
94    resource_group_name="my-resource-group",
95    service_name="my-apim",
96    api_id="petstore",
97    parameters=ApiCreateOrUpdateParameter(
98        display_name="Petstore API",
99        path="petstore",
100        protocols=[Protocol.HTTPS],
101        format=ContentFormat.OPENAPI_LINK,
102        value="https://petstore.swagger.io/v2/swagger.json"
103    )
104).result()
105```
106 
107## List APIs
108 
109```python
110apis = client.api.list_by_service(
111    resource_group_name="my-resource-group",
112    service_name="my-apim"
113)
114 
115for api in apis:
116    print(f"{api.name}: {api.display_name} - {api.path}")
117```
118 
119## Create Product
120 
121```python
122from azure.mgmt.apimanagement.models import ProductContract
123 
124product = client.product.create_or_update(
125    resource_group_name="my-resource-group",
126    service_name="my-apim",
127    product_id="premium",
128    parameters=ProductContract(
129        display_name="Premium",
130        description="Premium tier with unlimited access",
131        subscription_required=True,
132        approval_required=False,
133        state="published"
134    )
135)
136 
137print(f"Created product: {product.display_name}")
138```
139 
140## Add API to Product
141 
142```python
143client.product_api.create_or_update(
144    resource_group_name="my-resource-group",
145    service_name="my-apim",
146    product_id="premium",
147    api_id="my-api"
148)
149```
150 
151## Create Subscription
152 
153```python
154from azure.mgmt.apimanagement.models import SubscriptionCreateParameters
155 
156subscription = client.subscription.create_or_update(
157    resource_group_name="my-resource-group",
158    service_name="my-apim",
159    sid="my-subscription",
160    parameters=SubscriptionCreateParameters(
161        display_name="My Subscription",
162        scope=f"/products/premium",
163        state="active"
164    )
165)
166 
167print(f"Subscription key: {subscription.primary_key}")
168```
169 
170## Set API Policy
171 
172```python
173from azure.mgmt.apimanagement.models import PolicyContract
174 
175policy_xml = """
176<policies>
177    <inbound>
178        <rate-limit calls="100" renewal-period="60" />
179        <set-header name="X-Custom-Header" exists-action="override">
180            <value>CustomValue</value>
181        </set-header>
182    </inbound>
183    <backend>
184        <forward-request />
185    </backend>
186    <outbound />
187    <on-error />
188</policies>
189"""
190 
191client.api_policy.create_or_update(
192    resource_group_name="my-resource-group",
193    service_name="my-apim",
194    api_id="my-api",
195    policy_id="policy",
196    parameters=PolicyContract(
197        value=policy_xml,
198        format="xml"
199    )
200)
201```
202 
203## Create Named Value (Secret)
204 
205```python
206from azure.mgmt.apimanagement.models import NamedValueCreateContract
207 
208named_value = client.named_value.begin_create_or_update(
209    resource_group_name="my-resource-group",
210    service_name="my-apim",
211    named_value_id="backend-api-key",
212    parameters=NamedValueCreateContract(
213        display_name="Backend API Key",
214        value="secret-key-value",
215        secret=True
216    )
217).result()
218```
219 
220## Create Backend
221 
222```python
223from azure.mgmt.apimanagement.models import BackendContract
224 
225backend = client.backend.create_or_update(
226    resource_group_name="my-resource-group",
227    service_name="my-apim",
228    backend_id="my-backend",
229    parameters=BackendContract(
230        url="https://api.backend.example.com",
231        protocol="http",
232        description="My backend service"
233    )
234)
235```
236 
237## Create User
238 
239```python
240from azure.mgmt.apimanagement.models import UserCreateParameters
241 
242user = client.user.create_or_update(
243    resource_group_name="my-resource-group",
244    service_name="my-apim",
245    user_id="newuser",
246    parameters=UserCreateParameters(
247        email="user@example.com",
248        first_name="John",
249        last_name="Doe"
250    )
251)
252```
253 
254## Operation Groups
255 
256| Group | Purpose |
257|-------|---------|
258| `api_management_service` | APIM instance management |
259| `api` | API operations |
260| `api_operation` | API operation details |
261| `api_policy` | API-level policies |
262| `product` | Product management |
263| `product_api` | Product-API associations |
264| `subscription` | Subscription management |
265| `user` | User management |
266| `named_value` | Named values/secrets |
267| `backend` | Backend services |
268| `certificate` | Certificates |
269| `gateway` | Self-hosted gateways |
270 
271## Best Practices
272 
2731. **Use named values** for secrets and configuration
2742. **Apply policies** at appropriate scopes (global, product, API, operation)
2753. **Use products** to bundle APIs and manage access
2764. **Enable Application Insights** for monitoring
2775. **Use backends** to abstract backend services
2786. **Version your APIs** using APIM's versioning features
279