更改日志
概览
APIM的成分可以方便地站立 Windows API 管理 API 包括产品的创建/修改、订阅等等.
使用量
APIM的典型用例是拥有单一的主资源并使用与主数据同步的二级区域. 如果您正在使用此用例, 您应该配置配方实例, 条件是 "[coreutils.primary region ()]" 以便它只应用到你的主烤区域配置。 否则,如果您有多个区域,同样的数据将会被应用到每一个pim 实例中.
成份名称
@azbake/ ingredient- apim
如何纳入食谱
name: My package
shortName: mypkg
version: 0.0.1
ingredients:
- "@azbake/ingredient-apim@~0" #include the latest version of the ingredient at build time
parallelRegions: false #typically we only want to deploy to the primary region, so can turn off parallel deploy
resourceGroup: true #Create a resource group for the APIM resource
如何用作成份实例
recipe:
apim-deploy:
properties:
type: "@azbake/ingredient-apim" #ingredient type
condition: "[coreutils.primary_region()]" #make sure we only execute this against the primary region for multi-region configs
parameters:
... #see documentation below on parameter documentation for how to use.
参数
以下是该成分所有支持的平分仪的文档.
服务
apimService: #follows this azure spec for *ApiManagementServiceResource* : https://github.com/Azure/azure-sdk-for-js/blob/01898c51c663be4c53e02034a0468cf550ce5279/sdk/apimanagement/arm-apimanagement/src/models/index.ts#L4025
- name: <apim name> #required name of APIM service
诊断
diagnostics: #follows this azure spec for *DiagnosticSettingsResource* : https://github.com/Azure/azure-sdk-for-js/blob/20fe312b1122b21811f9364e3d95fe77202e6466/sdk/monitor/arm-monitor/src/models/index.ts#L991
- name: <diagnostics name> #required name of diagnostics settings
名称为 Values
namedValues: #follows this azure spec for *NamedValueCreateContract* : https://github.com/Azure/azure-sdk-for-js/blob/01898c51c663be4c53e02034a0468cf550ce5279/sdk/apimanagement/arm-apimanagement/src/models/index.ts#LL3568C1-L3568C1
- name: <named value id> #required name of property (named value)
组
groups: #follows this azure spec for *GroupCreateParameters* : https://github.com/Azure/azure-sdk-for-js/blob/01898c51c663be4c53e02034a0468cf550ce5279/sdk/apimanagement/arm-apimanagement/src/models/index.ts#L1882
- name: <group id> #required name of the group
用户
users: #follows this azure spec for *UserCreateParameters* : https://github.com/Azure/azure-sdk-for-js/blob/01898c51c663be4c53e02034a0468cf550ce5279/sdk/apimanagement/arm-apimanagement/src/models/index.ts#L2874
- name: <user id> #required name of the user
订阅
subscriptions: #follows this azure spec for *SubscriptionCreateParameters* : https://github.com/Azure/azure-sdk-for-js/blob/01898c51c663be4c53e02034a0468cf550ce5279/sdk/apimanagement/arm-apimanagement/src/models/index.ts#L2746
- name: <subscription id> #required name of the subscription
user: <user> #optional user lookup, can also use ownerId on SubscriptionCreateParameters if the path is known
类人鱼
#Does not allow for full API buildout (see apim-api ingredient). But allows to delete any api in an APIM instance.
apis:
- name: <api id> #required name of the api
delete: boolean # determines whether to delete the API.
产品
products: #follows this azure spec for *ProductContract* : https://github.com/Azure/azure-sdk-for-js/blob/01898c51c663be4c53e02034a0468cf550ce5279/sdk/apimanagement/arm-apimanagement/src/models/index.ts#L3111
- name: <product id> #required name of the product
apis: #optional array of api names to add to product
- api1
groups: #optional array of groups to assign to product
- group1
policy: #optional policy for prduct. follows asure spec for *PolicyContract*: https://github.com/Azure/azure-sdk-for-js/blob/20fe312b1122b21811f9364e3d95fe77202e6466/sdk/apimanagement/arm-apimanagement/src/models/index.ts#L797
日志
loggers: #follows this azure spec for *LoggerContract* : https://github.com/Azure/azure-sdk-for-js/blob/01898c51c663be4c53e02034a0468cf550ce5279/sdk/apimanagement/arm-apimanagement/src/models/index.ts#L3537
- name: <logger name> #required name of the logger
cleanKeys: true # clean the old subscription keys
认证服务员
authServers: #follows this azure spec for *AuthorizationServerContract* : https://github.com/Azure/azure-sdk-for-js/blob/01898c51c663be4c53e02034a0468cf550ce5279/sdk/apimanagement/arm-apimanagement/src/models/index.ts#L3229
- name: <auth servier id> #required name of the auth server
身份 供应商
identityProviders: #follows this azure spec for *IdentityProviderContract* : https://github.com/Azure/azure-sdk-for-js/blob/01898c51c663be4c53e02034a0468cf550ce5279/sdk/apimanagement/arm-apimanagement/src/models/index.ts#L3489
- identityProviderContractType: microsoft #this is part of the IdentityProviderContract contract and is required
自动缩放
autoScaleSettings: #follows this azure spec for *AutoscaleSettingResource* : https://github.com/Azure/azure-sdk-for-js/blob/20fe312b1122b21811f9364e3d95fe77202e6466/sdk/monitor/arm-monitor/src/models/index.ts#L347
- name: <auto scale setting name>
后端
backends: #follows this azure spec for *BackendContract* : https://github.com/Azure/azure-sdk-for-js/blob/01898c51c663be4c53e02034a0468cf550ce5279/sdk/apimanagement/arm-apimanagement/src/models/index.ts#L3301
- name: <back end name>
工具函数
工具课可以在烘焙内部使用. 参数和源值的 Yaml 文件 .
apim 类
| 函数 | 回返 | 说明 |
|---|---|---|
get_resource_name(name: string) | string | 获取 APIM 实例的标准资源名称 |
get_resource_group(name: string = "apim") | string | 获取 APIM 实例的标准资源组 |
get_subnet(resourceGroup: string, vnetName: string, subnetName: string) | Promise<SubnetsGetResponse> | 返回一组参数的子网. |
get_logger(resourceGroup: string, apimName: string, loggerId: string) | Promise<LoggerGetResponse> | 返回一组参数的日志. |
get_storageaccount(resourceGroup: string, name: string) | Promise<StorageAccountGetPropertiesResponse> | 返回一组参数的存储账户. |
get_namedValue(resourceGroup: string, apimName: string, namedValueId: string) | Promise<PropertyGetResponse> | 返回给定的一组参数的命名值(财产). |
get_subscription(resourceGroup: string, resource: string, subscriptionId: string) | Promise<SubscriptionGetResponse> | 返回对一组参数的订阅. |
get_subscription_key(resourceGroup: string, resource: string, subscriptionId: string) | Promise<string> | 返回一组参数的订阅密钥. |
get_subscription_keySecondary(resourceGroup: string, resource: string, subscriptionId: string) | Promise<string> | 返回一组参数的订阅次要密钥. |
| `get source(名称:字符串) | 无效 = 无效” | Promise<string> |
工具函数示例
rgOverride: "[apim.get_resource_group()]"
variables:
apimName: "[apim.get_resource_name(<name>)]"
subnetResource: "[await apim.get_subnet(<vnet resource Group>, <vnet name>, <subnet name>)]"
logger: "[await apim.get_logger(<apim resource group>, <apim name>, <logger name>)]"
storageAccount: "[await apim.get_storageaccount(<storage account resource group>, <storage account name>)]"
namedValue: "[await apim.get_namedValue(<apim resource group>, <apim name>, <named value id>)]"
subscription: "[await apim.get_subscription(<apim resource group>, <apim name>, <subscription id>)]"
subscriptionKey: "[await apim.get_subscription_key(<apim resource group>, <apim name>, <subscription id>)]"
subscriptionKeySecondary: "[await apim.get_subscription_keySecondary(<apim resource group>, <apim name>, <subscription id>)]"
样本
name: apim
shortName: apim
owner: arch
version: 1.0.0
ingredients:
- "@azbake/ingredient-apim@~0"
- "@azbake/ingredient-app-insights@~0" #use app insights ingredient to create ai resource for diagnostics
resourceGroup: true
parallelRegions: false
rgOverride: "[apim.get_resource_group()]"
variables:
aiName: "[appinsights.get_resource_name('apim-api')]"
aiKey: "[await appinsights.get_instrumentation_key('apim-api','appinsights', true)]"
aiResourceGroup: "[coreutils.resource_group('appinsights', false, null, true)]"
apimName: "[apim.get_resource_name('api')]"
recipe:
# deploy app insights first for logger configuration (optional)
apim-app-insights-deploy:
properties:
type: "@azbake/ingredient-app-insights"
source: ""
condition: "[coreutils.current_region_primary()]"
parameters:
appInsightsName: "[coreutils.variable('aiName')]"
rgOverride: "[coreutils.variable('aiResourceGroup')]"
apim-deploy:
dependsOn: apim-app-insights-deploy
properties:
type: "@azbake/ingredient-apim"
condition: "[coreutils.primary_region()]"
parameters:
apimService:
name: "[coreutils.variable('apimName')]"
location: "[coreutils.current_region().name]"
publisherEmail: [email protected]
publisherName: Joe Smith
sku:
name: Developer
capacity: 1
enableClientCertificate: true
customProperties:
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "false"
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11: "false"
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168: "false"
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30: "false"
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10: "false"
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11: "false"
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30: "false"
virtualNetworkType: External
virtualNetworkConfiguration:
subnetResourceId: "[(await apim.get_subnet('RG_VNET_TEST', 'vnettest', 'default')).id]"
diagnostics:
name: diag1
storageAccountId: "[(await apim.get_storageaccount('RG_STORAGE_TEST', 'storagetest')).id]"
metrics:
- timeGrain: PT1M
enabled: true
retentionPolicy:
days: 0
enabled: true
logs:
- category: GatewayLogs
enabled: true
retentionPolicy:
days: 0
enabled: true
namedValues:
- name: expression1
displayName: expression1Display
value: "@(DateTime.Now.ToString())"
secret: false
tags:
- test
- test2
groups:
- name: "testGroup"
displayName: "test group"
description: "test group description"
type: "custom"
users:
- name: john
email: [email protected]
firstName: john
lastName: smith
groups:
- testGroup
apis:
- name: echo-api #delete the default echo api
delete: true
products:
- name: petstore-product
displayName: My Petstore
description: My Petstore Description
terms: My terms
subscriptionRequired: false
state: published
groups:
- Administrators
- Developers
- testGroup
policy:
format: xml #we use a non-link format here to embed the policy, but this could have been xml-link and a http address
value: <policies>
<inbound />
<backend>
<forward-request />
</backend>
<outbound>
<set-header name="X-Powered-By" exists-action="delete" />
<set-header name="X-AspNet-Version" exists-action="delete" />
<set-header name="CustomHeader" exists-action="override">
<value>{{expression1Display}}</value>
</set-header>
</outbound>
</policies>
subscriptions:
- name: petstore-subscription
user: Administrator
product: petstore-product
displayName: petstore-subscription
state: active
allowTracing: true
loggers:
- name: apimLogger
cleanKeys: true
description: apimlogger
loggerType: applicationInsights
credentials:
instrumentationKey: "[coreutils.variable('aiKey')]"
authServers:
- name: auth
displayName: authDisplay
description: auth description
clientRegistrationEndpoint: "<endpoint>"
authorizationEndpoint: "<endpoint>"
tokenEndpoint: "<endpoint>"
clientId: clientid
clientSecret: clientSecret
clientAuthenticationMethod:
- Body
authorizationMethods:
- GET
grantTypes:
- implicit
identityProviders:
- identityProviderContractType: microsoft
clientId : clientid
clientSecret: clientSecret
autoScaleSettings:
- name: apim-autoscale
enabled: true
profiles:
- name: default
capacity:
minimum: "1"
maximum: "2"
default: "1"
rules:
- metricTrigger:
metricName: Capacity
timeGrain: PT1M
statistic: Average
timeWindow: PT10M
timeAggregation: Average
operator: GreaterThan
threshold: 80
scaleAction:
direction: Increase
type: ChangeCount
value: "1"
cooldown: PT60M
- metricTrigger:
metricName: Capacity
timeGrain: PT1M
statistic: Average
timeWindow: PT10M
timeAggregation: Average
operator: LessThan
threshold: 35
scaleAction:
direction: Decrease
type: ChangeCount
value: "1"
cooldown: PT90M
notifications:
- email:
sendToSubscriptionAdministrator: true
sendToSubscriptionCoAdministrators: true