Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Management service SKU API documentation #4466

Merged
merged 8 commits into from
Dec 4, 2018
Merged

API Management service SKU API documentation #4466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4a4ab88
added API management SKUS API documentation
KedarJoshi Nov 14, 2018
cb44322
added API management SKUS API documentation
KedarJoshi Nov 14, 2018
02392dd
added consumption sku definition as well in preview api version
KedarJoshi Nov 14, 2018
9070dcf
added consumption sku definition as well in preview api version
KedarJoshi Nov 14, 2018
e8183a0
added example
KedarJoshi Nov 14, 2018
6f7dd12
PR comments addressed
KedarJoshi Nov 14, 2018
4fb410f
more PR comment fixes
KedarJoshi Nov 15, 2018
b2942f3
correct casing
KedarJoshi Nov 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 184 additions & 1 deletion ...t/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,49 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SKU API works at provider scope. It does not have the resource type segment. Please see the contract here - https://microsoft.sharepoint.com/:w:/r/teams/azureresourcemanagerteam/Shared%20Documents/ARM%20Wiki%20Documents/arm-sku-api.docx?d=wd68fd8469ec24d20925d133626dd6d1b&csf=1&e=xWTTk8

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The API we have implemented here is
https://github.com/Azure/azure-resource-manager-rpc/blob/abfecf634ca8d369f71ede73516bde8a5bca282a/v1.0/Addendum.md#enumerating-skus-for-an-existing-resource
which is required by Azure monitor for Auto-Scale.

"get": {
"tags": [
"ApiManagementServiceSkus"
],
"summary": "Gets available SKUs for API Management service",
"description": "Gets all available SKU for a given API Management service",
"operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus",
"x-ms-examples": {
"ApiManagementListSKUs-Dedicated": {
"$ref": "./examples/ApiManagementListSKUs-Dedicated.json"
},
"ApiManagementListSKUs-Consumption": {
"$ref": "./examples/ApiManagementListSKUs-Consumption.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Success. The response describes the list of SKUs.",
"schema": {
"$ref": "#/definitions/ResourceSkuResults"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore": {
"post": {
"tags": [
Expand Down Expand Up @@ -646,6 +689,141 @@
}
},
"definitions": {
"ResourceSkuResults": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceSkuResult"
},
"description": "The list of skus available for the service."
},
"nextLink": {
"type": "string",
"description": "The uri to fetch the next page of API Management service Skus."
}
},
"required": [
"value"
],
"description": "The API Management service SKUs operation response."
},
"ResourceSkuResult": {
"properties": {
"resourceType": {
"readOnly": true,
"type": "string",
"description": "The type of resource the SKU applies to."
},
"sku": {
"$ref": "#/definitions/ResourceSku",
"readOnly": true,
"description": "Specifies API Management SKU."
},
"capacity": {
"$ref": "#/definitions/ResourceSkuCapacity",
"readOnly": true,
"description": "Specifies the number of API Management units."
}
},
"description": "Describes an available API Management service SKU."
KedarJoshi marked this conversation as resolved.
Show resolved Hide resolved
},
"ResourceSkuCapacity": {
"properties": {
"minimum": {
"type": "integer",
"readOnly": true,
"format": "int32",
"description": "The minimum capacity."
},
"maximum": {
"type": "integer",
"readOnly": true,
"format": "int32",
"description": "The maximum capacity that can be set."
},
"default": {
"type": "integer",
"readOnly": true,
"format": "int32",
"description": "The default capacity."
},
"scaleType": {
"type": "string",
"readOnly": true,
"description": "The scale type applicable to the sku.",
"enum": [
"automatic",
"manual",
"none"
],
"x-ms-enum": {
"name": "ResourceSkuCapacityScaleType",
"modelAsString": true,
"values": [
{
"value": "automatic",
"description": "Supported scale type automatic."
},
{
"value": "manual",
"description": "Supported scale type manual."
},
{
"value": "none",
"description": "Scaling not supported."
}
]
}
KedarJoshi marked this conversation as resolved.
Show resolved Hide resolved
}
},
"description": "Describes scaling information of a SKU."
},
"ResourceSku": {
"properties": {
"name": {
"type": "string",
"description": "Name of the Sku.",
"externalDocs": {
"url": "https://azure.microsoft.com/en-us/pricing/details/api-management/"
},
"enum": [
"Developer",
"Standard",
"Premium",
"Basic",
"Consumption"
],
KedarJoshi marked this conversation as resolved.
Show resolved Hide resolved
"x-ms-enum": {
"name": "SkuType",
"modelAsString": true,
"values": [
{
"value": "Developer",
"description": "Developer SKU of Api Management."
},
{
"value": "Standard",
"description": "Standard SKU of Api Management."
},
{
"value": "Premium",
"description": "Premium SKU of Api Management."
},
{
"value": "Basic",
"description": "Basic SKU of Api Management."
},
{
"value": "Consumption",
"description": "Consumption SKU of Api Management."
}
]
}
}
},
"description": "Describes an available API Management SKU."
},
"CertificateInformation": {
"properties": {
"expiry": {
Expand Down Expand Up @@ -1022,7 +1200,8 @@
"Developer",
"Standard",
"Premium",
"Basic"
"Basic",
"Consumption"
],
"x-ms-enum": {
"name": "SkuType",
Expand All @@ -1043,6 +1222,10 @@
{
"value": "Basic",
"description": "Basic SKU of Api Management."
},
{
"value": "Consumption",
"description": "Consumption SKU of Api Management."
}
]
}
Expand Down
24 changes: 24 additions & 0 deletions ....ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSKUs-Consumption.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"parameters": {
"api-version": "2018-06-01-preview",
"serviceName": "apimService1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"resourceType": "Microsoft.ApiManagement/service",
"sku": {
"name": "Consumption"
},
"capacity": null
}
],
"nextLink": null
}
}
}
}
65 changes: 65 additions & 0 deletions ...ft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSKUs-Dedicated.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"parameters": {
"api-version": "2018-06-01-preview",
"serviceName": "apimService1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
KedarJoshi marked this conversation as resolved.
Show resolved Hide resolved
"responses": {
"200": {
"body": {
"value": [
{
"resourceType": "Microsoft.ApiManagement/service",
"sku": {
"name": "Developer"
},
"capacity": {
"minimum": 1,
"maximum": 1,
"default": 1,
"scaleType": "none"
}
},
{
"resourceType": "Microsoft.ApiManagement/service",
"sku": {
"name": "Basic"
},
"capacity": {
"minimum": 1,
"maximum": 2,
"default": 1,
"scaleType": "manual"
}
},
{
"resourceType": "Microsoft.ApiManagement/service",
"sku": {
"name": "Standard"
},
"capacity": {
"minimum": 1,
"maximum": 4,
"default": 1,
"scaleType": "automatic"
}
},
{
"resourceType": "Microsoft.ApiManagement/service",
"sku": {
"name": "Premium"
},
"capacity": {
"minimum": 1,
"maximum": 10,
"default": 1,
"scaleType": "automatic"
}
}
],
"nextLink": null
}
}
}
}
Loading