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.

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

New Partner APIs for ordering service #13576

Merged
merged 13 commits into from
Apr 1, 2021

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"parameters": {
"api-version": "2020-12-01-preview",
"User-Agent": [
"vscode-restclient"
],
"Referer": [
"https://localhost/providers/Microsoft.EdgeOrderPartner/operations?api-version=2020-12-01-preview"
]
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "Microsoft.EdgeOrderPartner/operations/read",
"display": {
"provider": "Edge Ordering",
"resource": "Operations",
"operation": "List or Get Operations",
"description": "List or get the Operations"
},
"origin": "user",
"isDataAction": false
},
{
"name": "Microsoft.EdgeOrderPartner/searchInventories/action",
"display": {
"provider": "Edge Ordering",
"resource": "ArmApiRes_Microsoft.EdgeOrderPartner"
},
"origin": "user",
"isDataAction": true
},
{
"name": "Microsoft.EdgeOrderPartner/locations/inventories/manageLink/action",
"display": {
"provider": "Edge Ordering",
"resource": "ArmApiRes_inventories"
},
"origin": "user",
"isDataAction": true
},
{
"name": "Microsoft.EdgeOrderPartner/locations/inventories/manageInventoryMetadata/action",
"display": {
"provider": "Edge Ordering",
"resource": "ArmApiRes_inventories"
},
"origin": "user",
"isDataAction": true
}
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"parameters": {
"subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
"location": "westus",
"serialNumber": "SerialNumber1",
"api-version": "2020-12-01-preview",
"User-Agent": [
"vscode-restclient"
],
"Referer": [
"https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.EdgeOrderPartner/locations/westus/inventories/SerialNumber1/manageInventoryMetadata?api-version=2020-12-01-preview"
],
"Content-Type": [
"application/json; charset=utf-8"
],
"Content-Length": [
"181"
],
"manageInventoryMetadataRequest": {
"familyIdentifier": "FamilyIdentifier",
pilor marked this conversation as resolved.
Show resolved Hide resolved
"inventoryMetadata": "InventoryMetadata",
"configurationOnDevice": {
"configurationIdentifier": "ConfigurationIdentifierOnDevice"
}
}
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"parameters": {
"subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
"location": "westus",
"serialNumber": "SerialNumber1",
"api-version": "2020-12-01-preview",
"User-Agent": [
"vscode-restclient"
],
"Referer": [
"https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.EdgeOrderPartner/locations/westus/inventories/SerialNumber1/manageLink?api-version=2020-12-01-preview"
],
"Content-Type": [
"application/json; charset=utf-8"
],
"Content-Length": [
"144"
],
"manageLinkRequest": {
"familyIdentifier": "FamilyIdentifier",
"managementResourceArmId": "ManagementResourceArmId",
"operation": "Link",
"tenantId": "TenantId"
}
},
"responses": {
"200": {},
"204": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
{
"parameters": {
"subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
"api-version": "2020-12-01-preview",
"User-Agent": [
"vscode-restclient"
],
"Referer": [
"https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.EdgeOrderPartner/searchInventories?api-version=2020-12-01-preview"
],
"Content-Type": [
"application/json; charset=utf-8"
],
"Content-Length": [
"75"
],
"searchInventoriesRequest": {
"serialNumber": "SerialNumber1",
"familyIdentifier": "FamilyIdentifier"
}
},
"responses": {
"200": {
"body": {
"value": [
{
"properties": {
"serialNumber": "SerialNumber1",
"orderItem": {
"armId": "ArmId",
"orderItemType": "Purchase"
},
"configuration": {
"familyIdentifier": "FamilyIdentifier",
"productLineIdentifier": "ProductLineIdentifier",
"productIdentifier": "ProductIdentifier",
"configurationIdentifier": "ConfigurationIdentifier",
"configurationIdentifierOnDevice": "ConfigurationIdentifierOnDevice"
},
"managementResource": {
"armId": "ArmId",
"tenantId": "guid"
},
"inventory": {
"status": "Healthy",
"location": "Rack",
"registrationAllowed": false
},
"location": "It can be used in update API."
}
}
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
{
"parameters": {
"subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
"api-version": "2020-12-01-preview",
"$expand": "details",
"User-Agent": [
"vscode-restclient"
],
"Referer": [
"https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.EdgeOrderPartner/searchInventories?api-version=2020-12-01-preview&$expand=details"
],
"Content-Type": [
"application/json; charset=utf-8"
],
"Content-Length": [
"75"
],
"searchInventoriesRequest": {
"serialNumber": "SerialNumber1",
"familyIdentifier": "FamilyIdentifier"
}
},
"responses": {
"200": {
"body": {
"value": [
{
"properties": {
"serialNumber": "SerialNumber1",
"orderItem": {
"armId": "ArmId",
"orderItemType": "Purchase"
},
"configuration": {
"familyIdentifier": "FamilyIdentifier",
"productLineIdentifier": "ProductLineIdentifier",
"productIdentifier": "ProductIdentifier",
"configurationIdentifier": "ConfigurationIdentifier",
"configurationIdentifierOnDevice": "ConfigurationIdentifierOnDevice"
},
"managementResource": {
"armId": "ArmId",
"tenantId": "guid"
},
"inventory": {
"status": "Healthy",
"location": "Rack",
"registrationAllowed": false
},
"location": "It can be used in update API.",
"details": {
"orderItem": {
"status": {
"stageStatus": "InProgress",
"stageName": "DevicePrepared",
"displayName": "DevicePrepared - InProgress",
"startTime": "2021-12-03T10:38:38+05:30"
},
"subscription": {
"id": "guid",
"state": "Registered",
"quotaId": "Internal_2014-09-01"
}
},
"inventoryMetadata": "partner specific any serialzed string. Blackbox for service. Service will store and just return it.",
"configuration": {
"specifications": [
{
"name": "Cores",
"value": "24"
},
{
"name": "Memory",
"value": "128 GB"
},
{
"name": "Storage",
"value": "~8 TB"
}
]
},
"inventory": {
"additionalData": {
"key1": "Value1",
"key2": "Value2"
}
},
"billing": {
"billingType": "Example",
"status": "statusExample"
},
"secrets": {
"key1": "Value1",
"key2": "Value2"
}
}
}
}
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## AzureResourceSchema

These settings apply only when `--azureresourceschema` is specified on the command line.

### AzureResourceSchema multi-api

``` yaml $(azureresourceschema) && $(multiapi)
batch:
- tag: schema-edgeorderpartner-2020-12-01-preview

```

Please also specify `--azureresourceschema-folder=<path to the root directory of your azure-resource-manager-schemas clone>`.

### Tag: schema-edgeorderpartner-2020-12-01-preview and azureresourceschema

``` yaml $(tag) == 'schema-edgeorderpartner-2020-12-01-preview' && $(azureresourceschema)
output-folder: $(azureresourceschema-folder)/schemas

# all the input files in this apiVersion
input-file:
- Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json

```
41 changes: 41 additions & 0 deletions specification/edgeorderpartner/resource-manager/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# EdgeOrderPartner

> see https://aka.ms/autorest

This is the AutoRest configuration file for EdgeOrderPartner.



---
## Getting Started
To build the SDK for EdgeOrderPartner, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:

> `autorest`

To see additional help and options, run:

> `autorest --help`
---

## Configuration



### Basic Information
These are the global settings for the EdgeOrderPartner API.

``` yaml
title: Edge Order Partner API's
Copy link
Member

@weidongxu-microsoft weidongxu-microsoft Apr 1, 2021

Choose a reason for hiding this comment

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

It is recommended to take a SDK friendly title. It is usually used as entry point of the SDK. Generally SDK class cannot display space or quote.

E.g. compute https://github.com/Azure/azure-rest-api-specs/blob/master/specification/compute/resource-manager/readme.md#basic-information
results in SDK class https://docs.microsoft.com/en-us/python/api/azure-mgmt-compute/azure.mgmt.compute.computemanagementclient?view=azure-python

You can put the detail in description.

openapi-type: arm
tag: package-2020-12-preview
```

### Tag: package-2020-12-preview

These settings apply only when `--tag=package-2020-12-preview` is specified on the command line.

``` yaml $(tag) == 'package-2020-12-preview'
input-file:
- Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json
```
---