From 0e01ea2003a2304e543e91716a61036fb0bfdfc8 Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Tue, 9 Mar 2021 18:01:38 +0530 Subject: [PATCH 01/13] Adding initial files for edge order parther APIs --- .../2020-12-01-preview/EdgeOrderPartner.json | 1290 +++++++++++++++++ .../examples/ManageInventoryMetadata.json | 36 + .../examples/ManageLink.json | 31 + .../examples/SearchInventories.json | 98 ++ .../readme.azureresourceschema.md | 24 + .../resource-manager/readme.md | 41 + 6 files changed, 1520 insertions(+) create mode 100644 specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json create mode 100644 specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json create mode 100644 specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json create mode 100644 specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json create mode 100644 specification/edgeorderpartner/resource-manager/readme.azureresourceschema.md create mode 100644 specification/edgeorderpartner/resource-manager/readme.md diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json new file mode 100644 index 000000000000..3d17a4ad3da3 --- /dev/null +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json @@ -0,0 +1,1290 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01-preview", + "title": "Edge Ordering Service-Partner" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.EdgeOrderPartner/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "This method gets all the operations that are exposed for customer.", + "operationId": "ListOperationsPartner", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "required": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOperationsPartner": { + "$ref": "./examples/ListOperationsPartner.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{SerialNumber}/manageInventoryMetadata": { + "post": { + "tags": [ + "PartnerInventory" + ], + "summary": "API for updating inventory metadata and inventory configuration", + "operationId": "ManageInventoryMetadata", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "required": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/subscriptionIdParameter" + }, + { + "required": true, + "$ref": "#/parameters/locationParameter" + }, + { + "name": "SerialNumber", + "in": "path", + "required": true, + "type": "string" + }, + { + "required": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/apiVersionParameter" + }, + { + "name": "manageInventoryMetadataRequest", + "in": "body", + "description": "Updates inventory metadata and inventory configuration", + "required": true, + "schema": { + "$ref": "#/definitions/ManageInventoryMetadataRequest" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ManageInventoryMetadata": { + "$ref": "./examples/ManageInventoryMetadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{SerialNumber}/manageLink": { + "post": { + "tags": [ + "PartnerInventory" + ], + "summary": "API for linking management resource with inventory", + "operationId": "ManageLink", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "required": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/subscriptionIdParameter" + }, + { + "required": true, + "$ref": "#/parameters/locationParameter" + }, + { + "name": "SerialNumber", + "in": "path", + "required": true, + "type": "string" + }, + { + "required": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/apiVersionParameter" + }, + { + "name": "manageLinkRequest", + "in": "body", + "description": "Links the management resource to the inventory", + "required": true, + "schema": { + "$ref": "#/definitions/ManageLinkRequest" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ManageLink": { + "$ref": "./examples/ManageLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/searchInventories": { + "post": { + "tags": [ + "PartnerInventory" + ], + "summary": "API for Search inventories", + "operationId": "SearchInventories", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "required": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/subscriptionIdParameter" + }, + { + "required": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/apiVersionParameter" + }, + { + "name": "searchInventoriesRequest", + "in": "body", + "description": "Searches inventories with the given filters and returns in the form of a list", + "required": true, + "schema": { + "$ref": "#/definitions/SearchInventoriesRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PartnerInventoryList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SearchInventories": { + "$ref": "./examples/SearchInventories.json" + } + } + } + } + }, + "definitions": { + "AdditionalErrorInfo": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "info": { + "type": "object" + } + } + }, + "AdditionalInventoryDetails": { + "description": "Contains additional data about inventory in dictionary format", + "type": "object", + "properties": { + "additionalData": { + "description": "Additional Data", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "AdditionalOrderDetails": { + "description": "Contains additional order details", + "type": "object", + "properties": { + "status": { + "description": "Order status", + "enum": [ + "InProgress", + "Completed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OrderStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "InProgress", + "description": "Order is in progress" + }, + { + "value": "Completed", + "description": "Order has been completed" + } + ] + } + }, + "subscription": { + "$ref": "#/definitions/SubscriptionDetails", + "description": "Subscription details", + "readOnly": true + } + } + }, + "AvailabilityInformation": { + "description": "Availability information of a product system.", + "type": "object", + "properties": { + "availabilityStage": { + "description": "Current availability stage of the product. Availability stage", + "enum": [ + "Available", + "ComingSoon", + "Preview", + "Deprecated" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AvailabilityStage", + "modelAsExtensible": true, + "values": [ + { + "value": "Available", + "description": "Product is available." + }, + { + "value": "ComingSoon", + "description": "Product is coming soon." + }, + { + "value": "Preview", + "description": "Product is in preview." + }, + { + "value": "Deprecated", + "description": "Product is deprecated." + } + ] + } + }, + "disabledReason": { + "description": "Reason why the product is disabled.", + "enum": [ + "None", + "Country", + "Region", + "Feature", + "OfferType", + "NoSubscriptionInfo", + "NotAvailable", + "OutOfStock" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DisabledReason", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "Not disabled." + }, + { + "value": "Country", + "description": "Not available in the requested country." + }, + { + "value": "Region", + "description": "Not available to push data to the requested Azure region." + }, + { + "value": "Feature", + "description": "Required features are not enabled." + }, + { + "value": "OfferType", + "description": "Subscription does not have required offer types." + }, + { + "value": "NoSubscriptionInfo", + "description": "Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification." + }, + { + "value": "NotAvailable", + "description": "The product is not yet available." + }, + { + "value": "OutOfStock", + "description": "The product is out of stock." + } + ] + } + }, + "disabledReasonMessage": { + "description": "Message for why the product is disabled.", + "type": "string", + "readOnly": true + } + } + }, + "BasicInformation": { + "description": "Basic information for any product system", + "type": "object", + "properties": { + "displayName": { + "description": "Display Name for the product system.", + "type": "string", + "readOnly": true + }, + "description": { + "$ref": "#/definitions/Description", + "description": "Description related to the product system.", + "readOnly": true + }, + "imageInformation": { + "description": "Image information for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ImageInformation" + }, + "readOnly": true + }, + "costInformation": { + "$ref": "#/definitions/CostInformation", + "description": "Cost information for the product system.", + "readOnly": true + }, + "availabilityInformation": { + "$ref": "#/definitions/AvailabilityInformation", + "description": "Availability information of the product system.", + "readOnly": true + }, + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Hierarchy information of a product", + "readOnly": true + } + } + }, + "BillingDetails": { + "description": "Contains billing details for the inventory", + "type": "object", + "properties": { + "billingType": { + "description": "Billing type for the inventory", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Billing status for the inventory", + "type": "string", + "readOnly": true + } + } + }, + "BillingModel": { + "description": "Model to represent the billing cycle", + "type": "object", + "properties": { + "model": { + "description": "String to represent the billing model", + "type": "string", + "readOnly": true + } + } + }, + "CloudError": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "target": { + "type": "string" + }, + "details": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CloudError" + }, + "readOnly": true + }, + "additionalInfo": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalErrorInfo" + }, + "readOnly": true + } + }, + "x-ms-external": true + }, + "CommonProperties": { + "description": "Represents common properties accross product hierarchy", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BasicInformation" + } + ], + "properties": { + "filterableProperties": { + "description": "list of filters supported for a product", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/FilterableProperty" + }, + "readOnly": true + } + } + }, + "ConfigurationData": { + "description": "Contains information about inventory configuration", + "type": "object", + "properties": { + "familyIdentifier": { + "description": "Family identifier of inventory", + "type": "string", + "readOnly": true + }, + "productLineIdentifier": { + "description": "Product Line identifier of inventory", + "type": "string", + "readOnly": true + }, + "productIdentifier": { + "description": "Product identifier of inventory", + "type": "string", + "readOnly": true + }, + "configurationIdentifier": { + "description": "Configuration identifier of inventory", + "type": "string", + "readOnly": true + }, + "configurationIdentifierOnDevice": { + "description": "Configuration identifier on device - this is used in case of any mismatch\r\nbetween actual configuration on inventory and configuration stored in service", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationDetails": { + "description": "Contains additional configuration details about inventory", + "type": "object", + "properties": { + "specifications": { + "description": "Collection of specification details about the inventory", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SpecificationDetails" + }, + "readOnly": true + } + } + }, + "CostInformation": { + "description": "Cost information for the product system", + "type": "object", + "properties": { + "primaryMeterType": { + "description": "Primary meter i.e. basic billing type for the product system.", + "enum": [ + "ServiceFee", + "ShippingFee", + "LostOrDamagedFee", + "LateDayFee" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MeterType", + "modelAsExtensible": true, + "values": [ + { + "value": "ServiceFee", + "description": "Service usage fee." + }, + { + "value": "ShippingFee", + "description": "Shipping fee." + }, + { + "value": "LostOrDamagedFee", + "description": "Fee charged if the device is lost or damaged." + }, + { + "value": "LateDayFee", + "description": "Fee charged if the device is kept longer that the allotted days." + } + ] + } + }, + "meterDetails": { + "description": "Details on the various billing aspects for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MeterDetails" + }, + "readOnly": true + } + } + }, + "Description": { + "description": "Description related properties of a product system.", + "type": "object", + "properties": { + "descriptionType": { + "description": "Type of description.", + "enum": [ + "Base" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DescriptionType", + "modelAsExtensible": true, + "values": [ + { + "value": "Base", + "description": "Base description." + } + ] + } + }, + "shortDescription": { + "description": "Short description of the product system.", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the product system.", + "type": "string", + "readOnly": true + }, + "keywords": { + "description": "Keywords for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "attributes": { + "description": "Attributes for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "links": { + "description": "Links for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Link" + }, + "readOnly": true + } + } + }, + "FilterableProperty": { + "description": "Different types of filters supported and its values.", + "type": "object", + "properties": { + "type": { + "description": "Type of product filter.", + "enum": [ + "ShipToCountries" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportedFilterTypes", + "modelAsExtensible": true, + "values": [ + { + "value": "ShipToCountries", + "description": "Ship to country" + } + ] + } + }, + "supportedValues": { + "description": "Values to be filtered.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "HierarchyInformation": { + "description": "Holds details about product hierarchy information", + "type": "object", + "properties": { + "productFamilyName": { + "description": "Represents product family name that uniquely identifies product family", + "type": "string" + }, + "productLineName": { + "description": "Represents product line name that uniquely identifies product line", + "type": "string" + }, + "productName": { + "description": "Represents product name that uniquely identifies product", + "type": "string" + }, + "configurationName": { + "description": "Represents configuration name that uniquely identifies configuration", + "type": "string" + } + } + }, + "ImageInformation": { + "description": "Image for the product", + "type": "object", + "properties": { + "imageType": { + "description": "Type of the image", + "enum": [ + "MainImage", + "BulletImage", + "GenericImage" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ImageType", + "modelAsExtensible": true, + "values": [ + { + "value": "MainImage", + "description": "Main image." + }, + { + "value": "BulletImage", + "description": "Bullet image." + }, + { + "value": "GenericImage", + "description": "Generic image." + } + ] + } + }, + "imageUrl": { + "description": "Url of the image", + "type": "string", + "readOnly": true + } + } + }, + "InventoryAdditionalDetails": { + "description": "Represents additional details abpout the partner inventory", + "type": "object", + "properties": { + "order": { + "$ref": "#/definitions/AdditionalOrderDetails", + "description": "Represents additional details about the order" + }, + "inventoryMetadata": { + "description": "Contains inventory metadata", + "type": "string", + "readOnly": true + }, + "configuration": { + "$ref": "#/definitions/ConfigurationDetails", + "description": "Represents additional details about the configuration", + "readOnly": true + }, + "inventory": { + "$ref": "#/definitions/AdditionalInventoryDetails", + "description": "Represents additional data about the inventory", + "readOnly": true + }, + "billing": { + "$ref": "#/definitions/BillingDetails", + "description": "Represents additional details about billing for the inventory", + "readOnly": true + }, + "secrets": { + "description": "Represents secrets on the inventory", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true, + "x-ms-secret": true + } + } + }, + "InventoryData": { + "description": "Contains basic information about inventory", + "type": "object", + "properties": { + "status": { + "description": "Inventory status", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Inventory location", + "type": "string", + "readOnly": true + }, + "registrationAllowed": { + "description": "Boolean flag to indicate if registration is allowed", + "type": "boolean", + "readOnly": true + } + } + }, + "InventoryProperties": { + "description": "Represents inventory properties", + "type": "object", + "properties": { + "serialNumber": { + "description": "Serial number of the device.", + "type": "string", + "readOnly": true + }, + "order": { + "$ref": "#/definitions/OrderData", + "description": "Represents basic order data.", + "readOnly": true + }, + "configuration": { + "$ref": "#/definitions/ConfigurationData", + "description": "Represents basic configuration data.", + "readOnly": true + }, + "managementResource": { + "$ref": "#/definitions/ManagementResourceData", + "description": "Represents management resource data associated with inventory.", + "readOnly": true + }, + "inventory": { + "$ref": "#/definitions/InventoryData", + "description": "Represents basic inventory data.", + "readOnly": true + }, + "location": { + "description": "Location of inventory", + "type": "string", + "readOnly": true + }, + "details": { + "$ref": "#/definitions/InventoryAdditionalDetails", + "description": "Represents additional details of inventory", + "readOnly": true + } + } + }, + "Link": { + "description": "Returns link related to the product", + "type": "object", + "properties": { + "linkType": { + "description": "Type of link", + "enum": [ + "Generic", + "TermsAndConditions", + "Specification", + "Documentation", + "KnowMore", + "SignUp" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "LinkType", + "modelAsExtensible": true, + "values": [ + { + "value": "Generic", + "description": "Generic link." + }, + { + "value": "TermsAndConditions", + "description": "Terms and conditions link." + }, + { + "value": "Specification", + "description": "Link to product specification." + }, + { + "value": "Documentation", + "description": "Link to product documentation" + }, + { + "value": "KnowMore", + "description": "Link to know more" + }, + { + "value": "SignUp", + "description": "Link to sign up for products" + } + ] + } + }, + "linkUrl": { + "description": "Url of the link", + "type": "string", + "readOnly": true + } + } + }, + "ManageInventoryMetadataRequest": { + "description": "Request body for ManageInventoryMetadata call", + "required": [ + "familyIdentifier", + "inventoryMetadata" + ], + "type": "object", + "properties": { + "familyIdentifier": { + "description": "Family identifier for inventory", + "type": "string" + }, + "inventoryMetadata": { + "description": "Inventory metadata to be updated", + "type": "string" + }, + "configuration": { + "$ref": "#/definitions/ConfigurationData", + "description": "Inventory configuration to be updated" + } + } + }, + "ManageLinkRequest": { + "description": "Request body for ManageLink call", + "required": [ + "familyIdentifier", + "managementResourceArmId", + "operation", + "tenantId" + ], + "type": "object", + "properties": { + "familyIdentifier": { + "description": "Family identifier for inventory", + "type": "string" + }, + "managementResourceArmId": { + "description": "Arm Id of the management resource to which inventory is to be linked\r\nFor unlink operation, enter empty string", + "type": "string" + }, + "operation": { + "description": "Operation to be performed - Link, Unlink, Relink", + "enum": [ + "Link", + "Unlink", + "Relink" + ], + "type": "string", + "x-ms-enum": { + "name": "ManageLinkOperation", + "modelAsExtensible": true, + "values": [ + { + "value": "Link", + "description": "Link." + }, + { + "value": "Unlink", + "description": "Unlink." + }, + { + "value": "Relink", + "description": "Relink." + } + ] + } + }, + "tenantId": { + "description": "Tenant ID of management resource associated with inventory", + "type": "string" + } + } + }, + "ManagementResourceData": { + "description": "Contains information about management resource", + "type": "object", + "properties": { + "armId": { + "description": "Arm ID of management resource associated with inventory", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant ID of management resource associated with inventory", + "type": "string", + "readOnly": true + } + } + }, + "MeterDetails": { + "description": "Billing details for each meter.", + "type": "object", + "properties": { + "meterId": { + "description": "MeterId/ Billing Guid against which the product system will be charged", + "type": "string", + "readOnly": true + }, + "meterType": { + "description": "Category of the billing meter.", + "enum": [ + "ServiceFee", + "ShippingFee", + "LostOrDamagedFee", + "LateDayFee" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MeterType", + "modelAsExtensible": true, + "values": [ + { + "value": "ServiceFee", + "description": "Service usage fee." + }, + { + "value": "ShippingFee", + "description": "Shipping fee." + }, + { + "value": "LostOrDamagedFee", + "description": "Fee charged if the device is lost or damaged." + }, + { + "value": "LateDayFee", + "description": "Fee charged if the device is kept longer that the allotted days." + } + ] + } + }, + "billingModel": { + "$ref": "#/definitions/BillingModel", + "description": "Billing model to represent billing cycle, i.e. Monthly, biweekly, daily, hourly etc.", + "readOnly": true + } + } + }, + "OrderData": { + "description": "Contains information about the order to which inventory belongs", + "type": "object", + "properties": { + "armId": { + "description": "Arm ID of order", + "type": "string", + "readOnly": true + }, + "orderType": { + "description": "Order type - purchase or rental", + "enum": [ + "Purchase", + "Rental" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OrderType", + "modelAsExtensible": true, + "values": [ + { + "value": "Purchase", + "description": "Purchase Order." + }, + { + "value": "Rental", + "description": "Rental Order." + } + ] + } + } + } + }, + "PartnerInventory": { + "description": "Represents partner inventory contract", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/InventoryProperties", + "description": "Inventory properties", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "PartnerInventoryList": { + "description": "Represents the list of partner inventories", + "type": "object", + "properties": { + "value": { + "description": "List of partner inventories", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/PartnerInventory" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of order collection resources.", + "type": "string" + } + } + }, + "ResourceIdentity": { + "description": "Msi identity details of the resource", + "type": "object", + "properties": { + "type": { + "description": "Identity type", + "type": "string" + }, + "principalId": { + "description": "Service Principal Id backing the Msi", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Home Tenant Id", + "type": "string", + "readOnly": true + } + } + }, + "SearchInventoriesRequest": { + "description": "Request body for SearchInventories call", + "required": [ + "serialNumber", + "familyIdentifier" + ], + "type": "object", + "properties": { + "serialNumber": { + "description": "Serial number of the inventory", + "type": "string" + }, + "familyIdentifier": { + "description": "Family identifier for inventory", + "type": "string" + } + } + }, + "Sku": { + "description": "The Sku.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The sku name.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + } + ] + } + }, + "displayName": { + "description": "The display name of the sku.", + "type": "string" + }, + "family": { + "description": "The sku family.", + "type": "string" + } + } + }, + "SpecificationDetails": { + "description": "Specification details for the inventory", + "type": "object", + "properties": { + "name": { + "description": "Name", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Value", + "type": "string", + "readOnly": true + } + } + }, + "SubscriptionDetails": { + "description": "Contains subscription details", + "type": "object", + "properties": { + "id": { + "description": "Subscription Id", + "type": "string", + "readOnly": true + }, + "state": { + "description": "Subscription State", + "type": "string", + "readOnly": true + }, + "quotaId": { + "description": "Subscription QuotaId", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "addressNameParameter": { + "name": "addressName", + "in": "path", + "description": "The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only", + "required": true, + "type": "string", + "maxLength": 24, + "minLength": 3, + "pattern": "^[-\\w\\.]+$", + "x-ms-parameter-location": "method" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "orderCollectionNameParameter": { + "name": "orderCollectionName", + "in": "path", + "description": "The name of the order collection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "orderNameParameter": { + "name": "orderName", + "in": "path", + "description": "The name of the order", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} \ No newline at end of file diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json new file mode 100644 index 000000000000..d87bbd63ceb9 --- /dev/null +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "location": "westus", + "SerialNumber": "SerialNumber", + "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/SerialNumber/manageInventoryMetadata?api-version=2020-12-01-preview" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "388" + ], + "manageInventoryMetadataRequest": { + "familyIdentifier": "FamilyIdentifier", + "inventoryMetadata": "InventoryMetadata", + "inventoryConfiguration": { + "familyIdentifier": "FamilyIdentifier", + "productLineIdentifier": "ProductLineIdentifier", + "productIdentifier": "ProductIdentifier", + "configurationIdentifier": "ConfigurationIdentifier", + "configurationIdentifierOnDevice": "ConfigurationIdentifierOnDevice" + } + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json new file mode 100644 index 000000000000..9f91e8f7829f --- /dev/null +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "location": "westus", + "SerialNumber": "SerialNumber", + "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/SerialNumber/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": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json new file mode 100644 index 000000000000..fe64776672ed --- /dev/null +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json @@ -0,0 +1,98 @@ +{ + "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" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "75" + ], + "searchInventoriesRequest": { + "serialNumber": "SerialNumber", + "familyIdentifier": "FamilyIdentifier" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serialNumber": "SerialNumber", + "order": { + "armId": "ArmId", + "orderType": "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": { + "order": { + "status": "InProgress", + "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" + } + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgeorderpartner/resource-manager/readme.azureresourceschema.md b/specification/edgeorderpartner/resource-manager/readme.azureresourceschema.md new file mode 100644 index 000000000000..994182741ccd --- /dev/null +++ b/specification/edgeorderpartner/resource-manager/readme.azureresourceschema.md @@ -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-edgeorder-2020-12-01-preview + +``` + +Please also specify `--azureresourceschema-folder=`. + +### Tag: schema-edgeorderpartner-2020-12-01-preview and azureresourceschema + +``` yaml $(tag) == 'schema-edgeorder-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 + +``` diff --git a/specification/edgeorderpartner/resource-manager/readme.md b/specification/edgeorderpartner/resource-manager/readme.md new file mode 100644 index 000000000000..e6f66db1535b --- /dev/null +++ b/specification/edgeorderpartner/resource-manager/readme.md @@ -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 +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 +``` +--- \ No newline at end of file From f17e58759dea68d45343f16db072ad90dfea424c Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Fri, 12 Mar 2021 13:33:17 +0530 Subject: [PATCH 02/13] Fixes for spec and example validations. --- .../2020-12-01-preview/EdgeOrderPartner.json | 44 +++++++------------ .../examples/ManageInventoryMetadata.json | 11 ++--- .../examples/ManageLink.json | 3 +- .../examples/SearchInventories.json | 2 +- 4 files changed, 20 insertions(+), 40 deletions(-) diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json index 3d17a4ad3da3..87c6a9fcdea3 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json @@ -30,31 +30,25 @@ ], "parameters": [ { - "required": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OperationListResult" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListOperationsPartner": { - "$ref": "./examples/ListOperationsPartner.json" - } } } }, @@ -73,8 +67,7 @@ ], "parameters": [ { - "required": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "required": true, @@ -87,8 +80,7 @@ "type": "string" }, { - "required": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "name": "manageInventoryMetadataRequest", @@ -107,7 +99,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -133,8 +125,7 @@ ], "parameters": [ { - "required": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "required": true, @@ -147,8 +138,7 @@ "type": "string" }, { - "required": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "name": "manageLinkRequest", @@ -167,7 +157,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -193,12 +183,10 @@ ], "parameters": [ { - "required": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "required": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "name": "searchInventoriesRequest", @@ -220,7 +208,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -533,8 +521,7 @@ }, "configurationIdentifierOnDevice": { "description": "Configuration identifier on device - this is used in case of any mismatch\r\nbetween actual configuration on inventory and configuration stored in service", - "type": "string", - "readOnly": true + "type": "string" } } }, @@ -788,8 +775,7 @@ "additionalProperties": { "type": "string" }, - "readOnly": true, - "x-ms-secret": true + "readOnly": true } } }, @@ -1287,4 +1273,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json index d87bbd63ceb9..572f3ab8da7c 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json @@ -19,18 +19,13 @@ "manageInventoryMetadataRequest": { "familyIdentifier": "FamilyIdentifier", "inventoryMetadata": "InventoryMetadata", - "inventoryConfiguration": { - "familyIdentifier": "FamilyIdentifier", - "productLineIdentifier": "ProductLineIdentifier", - "productIdentifier": "ProductIdentifier", - "configurationIdentifier": "ConfigurationIdentifier", + "configuration": { "configurationIdentifierOnDevice": "ConfigurationIdentifierOnDevice" } } }, "responses": { "200": { - "body": "" - } + } } -} \ No newline at end of file +} diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json index 9f91e8f7829f..4661a4deb075 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json @@ -25,7 +25,6 @@ }, "responses": { "200": { - "body": "" } } -} \ No newline at end of file +} diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json index fe64776672ed..b1bd4cc05a2e 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json @@ -95,4 +95,4 @@ } } } -} \ No newline at end of file +} From dcb19b7bf372011de67f96cd2f9dda65de479e3a Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Tue, 16 Mar 2021 18:11:35 +0530 Subject: [PATCH 03/13] Fixes for example and spec validations. --- .../2020-12-01-preview/EdgeOrderPartner.json | 257 ++++++++++++++---- .../examples/ListOperationsPartner.json | 61 +++++ .../examples/ManageInventoryMetadata.json | 14 +- .../examples/ManageLink.json | 4 +- .../examples/SearchInventories.json | 44 +-- .../examples/SearchInventoriesDetails.json | 103 +++++++ 6 files changed, 385 insertions(+), 98 deletions(-) create mode 100644 specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json create mode 100644 specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json index 87c6a9fcdea3..bbc70dde212e 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json @@ -49,6 +49,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOperationsPartner": { + "$ref": "./examples/ListOperationsPartner.json" + } } } }, @@ -94,7 +99,13 @@ ], "responses": { "200": { - "description": "Success" + "description": "\"No content\"" + }, + "202": { + "description": "\"No content\"" + }, + "204": { + "description": "\"No content\"" }, "default": { "description": "Error response describing reason for operation failure.", @@ -103,6 +114,7 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { "ManageInventoryMetadata": { "$ref": "./examples/ManageInventoryMetadata.json" @@ -152,7 +164,10 @@ ], "responses": { "200": { - "description": "Success" + "description": "\"No content\"" + }, + "204": { + "description": "\"No content\"" }, "default": { "description": "Error response describing reason for operation failure.", @@ -251,27 +266,9 @@ "type": "object", "properties": { "status": { + "$ref": "#/definitions/OrderStatusDetails", "description": "Order status", - "enum": [ - "InProgress", - "Completed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "OrderStatus", - "modelAsExtensible": true, - "values": [ - { - "value": "InProgress", - "description": "Order is in progress" - }, - { - "value": "Completed", - "description": "Order has been completed" - } - ] - } + "readOnly": true }, "subscription": { "$ref": "#/definitions/SubscriptionDetails", @@ -521,7 +518,8 @@ }, "configurationIdentifierOnDevice": { "description": "Configuration identifier on device - this is used in case of any mismatch\r\nbetween actual configuration on inventory and configuration stored in service", - "type": "string" + "type": "string", + "readOnly": true } } }, @@ -540,6 +538,19 @@ } } }, + "ConfigurationOnDevice": { + "description": "Configuration parameters for ManageInventoryMetadata call", + "required": [ + "configurationIdentifier" + ], + "type": "object", + "properties": { + "configurationIdentifier": { + "description": "Configuration identifier on device", + "type": "string" + } + } + }, "CostInformation": { "description": "Cost information for the product system", "type": "object", @@ -911,8 +922,8 @@ "description": "Inventory metadata to be updated", "type": "string" }, - "configuration": { - "$ref": "#/definitions/ConfigurationData", + "configurationOnDevice": { + "$ref": "#/definitions/ConfigurationOnDevice", "description": "Inventory configuration to be updated" } } @@ -1067,6 +1078,177 @@ } } }, + "OrderStatusDetails": { + "description": "Order status CurrentStatus", + "type": "object", + "properties": { + "stageStatus": { + "description": "Order status", + "enum": [ + "None", + "InProgress", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No status available yet." + }, + { + "value": "InProgress", + "description": "Stage is in progress." + }, + { + "value": "Succeeded", + "description": "Stage has succeeded." + }, + { + "value": "Failed", + "description": "Stage has failed." + }, + { + "value": "Cancelled", + "description": "Stage has been cancelled." + }, + { + "value": "Cancelling", + "description": "Stage is cancelling." + } + ] + } + }, + "stageName": { + "description": "Order stage name", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Aborted", + "CompletedWithWarnings", + "ReadyToDispatchFromAzureDC", + "ReadyToReceiveAtAzureDC", + "Placed", + "InReview", + "Confirmed", + "ReadyForDispatch", + "Dispatched", + "Delivered", + "InUse" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageName", + "modelAsExtensible": true, + "values": [ + { + "value": "DeviceOrdered", + "description": "An order has been created." + }, + { + "value": "DevicePrepared", + "description": "A device has been prepared for the order." + }, + { + "value": "PickedUp", + "description": "Device has been picked up from user and in transit to Azure datacenter." + }, + { + "value": "AtAzureDC", + "description": "Device has been received at Azure datacenter from the user." + }, + { + "value": "DataCopy", + "description": "Data copy from the device at Azure datacenter." + }, + { + "value": "Completed", + "description": "Order has completed." + }, + { + "value": "CompletedWithErrors", + "description": "Order has completed with errors." + }, + { + "value": "Cancelled", + "description": "Order has been cancelled." + }, + { + "value": "Aborted", + "description": "Order has been aborted." + }, + { + "value": "Current" + }, + { + "value": "CompletedWithWarnings", + "description": "Order has completed with warnings." + }, + { + "value": "ReadyToDispatchFromAzureDC", + "description": "Device is ready to be handed to customer from Azure DC." + }, + { + "value": "ReadyToReceiveAtAzureDC", + "description": "Device can be dropped off at Azure DC." + }, + { + "value": "Placed", + "description": "Currently in draft mode and can still be cancelled" + }, + { + "value": "InReview", + "description": "Order is currently in draft mode and can still be cancelled" + }, + { + "value": "Confirmed", + "description": "Order is confirmed" + }, + { + "value": "ReadyForDispatch", + "description": "Order is ready for dispatch" + }, + { + "value": "Dispatched", + "description": "Order is in transit to customer" + }, + { + "value": "Delivered", + "description": "Order is delivered to customer" + }, + { + "value": "InUse", + "description": "Order is in use at customer site" + } + ] + } + }, + "displayName": { + "description": "Display name of the order stage.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Stage start time", + "type": "string", + "readOnly": true + } + } + }, "PartnerInventory": { "description": "Represents partner inventory contract", "type": "object", @@ -1145,30 +1327,7 @@ "properties": { "name": { "description": "The sku name.", - "enum": [ - "DataBox", - "DataBoxDisk", - "DataBoxHeavy" - ], - "type": "string", - "x-ms-enum": { - "name": "SkuName", - "modelAsExtensible": true, - "values": [ - { - "value": "DataBox", - "description": "Data Box." - }, - { - "value": "DataBoxDisk", - "description": "Data Box Disk." - }, - { - "value": "DataBoxHeavy", - "description": "Data Box Heavy." - } - ] - } + "type": "string" }, "displayName": { "description": "The display name of the sku.", diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json new file mode 100644 index 000000000000..078d79f20cc2 --- /dev/null +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json @@ -0,0 +1,61 @@ +{ + "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, + "actionType": "" + }, + { + "name": "Microsoft.EdgeOrderPartner/searchInventories/action", + "display": { + "provider": "Edge Ordering", + "resource": "ArmApiRes_Microsoft.EdgeOrderPartner" + }, + "origin": "user", + "isDataAction": true, + "actionType": "" + }, + { + "name": "Microsoft.EdgeOrderPartner/locations/inventories/manageLink/action", + "display": { + "provider": "Edge Ordering", + "resource": "ArmApiRes_inventories" + }, + "origin": "user", + "isDataAction": true, + "actionType": "" + }, + { + "name": "Microsoft.EdgeOrderPartner/locations/inventories/manageInventoryMetadata/action", + "display": { + "provider": "Edge Ordering", + "resource": "ArmApiRes_inventories" + }, + "origin": "user", + "isDataAction": true, + "actionType": "" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json index 572f3ab8da7c..f3b4ee608ce4 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json @@ -14,18 +14,22 @@ "application/json; charset=utf-8" ], "Content-Length": [ - "388" + "181" ], "manageInventoryMetadataRequest": { "familyIdentifier": "FamilyIdentifier", "inventoryMetadata": "InventoryMetadata", - "configuration": { - "configurationIdentifierOnDevice": "ConfigurationIdentifierOnDevice" + "configurationOnDevice": { + "configurationIdentifier": "ConfigurationIdentifierOnDevice" } } }, "responses": { "200": { - } + }, + "202": { + }, + "204": { + } } -} +} \ No newline at end of file diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json index 4661a4deb075..8abe7cb805f6 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json @@ -25,6 +25,8 @@ }, "responses": { "200": { + }, + "204": { } } -} +} \ No newline at end of file diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json index b1bd4cc05a2e..4e15ca00cde8 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json @@ -2,7 +2,6 @@ "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "api-version": "2020-12-01-preview", - "$expand": "details", "User-Agent": [ "vscode-restclient" ], @@ -47,48 +46,7 @@ "location": "Rack", "registrationAllowed": false }, - "location": "It can be used in update API.", - "details": { - "order": { - "status": "InProgress", - "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" - } - } + "location": "It can be used in update API." } } ] diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json new file mode 100644 index 000000000000..502e37ba8b2c --- /dev/null +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json @@ -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": "SerialNumber", + "familyIdentifier": "FamilyIdentifier" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serialNumber": "SerialNumber", + "order": { + "armId": "ArmId", + "orderType": "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": { + "order": { + "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" + } + } + } + } + ] + } + } + } +} \ No newline at end of file From 0cea42880f5ed4d2efdf10f598390be7263ffc38 Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Thu, 18 Mar 2021 16:13:36 +0530 Subject: [PATCH 04/13] Fixed autorest validation issues. --- .../2020-12-01-preview/EdgeOrderPartner.json | 53 ++++++------------- 1 file changed, 16 insertions(+), 37 deletions(-) diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json index bbc70dde212e..1fe287bad2e8 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json @@ -57,7 +57,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{SerialNumber}/manageInventoryMetadata": { + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{serialNumber}/manageInventoryMetadata": { "post": { "tags": [ "PartnerInventory" @@ -75,14 +75,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "required": true, "$ref": "#/parameters/locationParameter" }, - { - "name": "SerialNumber", - "in": "path", - "required": true, - "type": "string" + { + "$ref": "#/parameters/serialNumberParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" @@ -122,7 +118,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{SerialNumber}/manageLink": { + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{serialNumber}/manageLink": { "post": { "tags": [ "PartnerInventory" @@ -140,14 +136,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "required": true, "$ref": "#/parameters/locationParameter" }, { - "name": "SerialNumber", - "in": "path", - "required": true, - "type": "string" + "$ref": "#/parameters/serialNumberParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" @@ -1318,38 +1310,17 @@ } } }, - "Sku": { - "description": "The Sku.", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The sku name.", - "type": "string" - }, - "displayName": { - "description": "The display name of the sku.", - "type": "string" - }, - "family": { - "description": "The sku family.", - "type": "string" - } - } - }, "SpecificationDetails": { "description": "Specification details for the inventory", "type": "object", "properties": { "name": { - "description": "Name", + "description": "Name of the specification property", "type": "string", "readOnly": true }, "value": { - "description": "Value", + "description": "Value of the specification property", "type": "string", "readOnly": true } @@ -1412,7 +1383,15 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" - } + }, + "serialNumberParameter": { + "name": "serialNumber", + "in": "path", + "description": "The serial number of the device", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } }, "securityDefinitions": { "azure_auth": { From 6aca29a91563e67fbddc721834c6a8d9ce050b94 Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Fri, 19 Mar 2021 17:14:57 +0530 Subject: [PATCH 05/13] Changes for order to order otem and actiontype removal for operationsList API. --- .../2020-12-01-preview/EdgeOrderPartner.json | 560 +----------------- .../examples/ListOperationsPartner.json | 12 +- .../examples/ManageInventoryMetadata.json | 4 +- .../examples/ManageLink.json | 4 +- .../examples/SearchInventories.json | 8 +- .../examples/SearchInventoriesDetails.json | 10 +- 6 files changed, 38 insertions(+), 560 deletions(-) diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json index 1fe287bad2e8..a46a95eb4b5b 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json @@ -77,7 +77,7 @@ { "$ref": "#/parameters/locationParameter" }, - { + { "$ref": "#/parameters/serialNumberParameter" }, { @@ -253,12 +253,12 @@ } } }, - "AdditionalOrderDetails": { + "AdditionalOrderItemDetails": { "description": "Contains additional order details", "type": "object", "properties": { "status": { - "$ref": "#/definitions/OrderStatusDetails", + "$ref": "#/definitions/StageDetails", "description": "Order status", "readOnly": true }, @@ -269,143 +269,6 @@ } } }, - "AvailabilityInformation": { - "description": "Availability information of a product system.", - "type": "object", - "properties": { - "availabilityStage": { - "description": "Current availability stage of the product. Availability stage", - "enum": [ - "Available", - "ComingSoon", - "Preview", - "Deprecated" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AvailabilityStage", - "modelAsExtensible": true, - "values": [ - { - "value": "Available", - "description": "Product is available." - }, - { - "value": "ComingSoon", - "description": "Product is coming soon." - }, - { - "value": "Preview", - "description": "Product is in preview." - }, - { - "value": "Deprecated", - "description": "Product is deprecated." - } - ] - } - }, - "disabledReason": { - "description": "Reason why the product is disabled.", - "enum": [ - "None", - "Country", - "Region", - "Feature", - "OfferType", - "NoSubscriptionInfo", - "NotAvailable", - "OutOfStock" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "DisabledReason", - "modelAsExtensible": true, - "values": [ - { - "value": "None", - "description": "Not disabled." - }, - { - "value": "Country", - "description": "Not available in the requested country." - }, - { - "value": "Region", - "description": "Not available to push data to the requested Azure region." - }, - { - "value": "Feature", - "description": "Required features are not enabled." - }, - { - "value": "OfferType", - "description": "Subscription does not have required offer types." - }, - { - "value": "NoSubscriptionInfo", - "description": "Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification." - }, - { - "value": "NotAvailable", - "description": "The product is not yet available." - }, - { - "value": "OutOfStock", - "description": "The product is out of stock." - } - ] - } - }, - "disabledReasonMessage": { - "description": "Message for why the product is disabled.", - "type": "string", - "readOnly": true - } - } - }, - "BasicInformation": { - "description": "Basic information for any product system", - "type": "object", - "properties": { - "displayName": { - "description": "Display Name for the product system.", - "type": "string", - "readOnly": true - }, - "description": { - "$ref": "#/definitions/Description", - "description": "Description related to the product system.", - "readOnly": true - }, - "imageInformation": { - "description": "Image information for the product system.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ImageInformation" - }, - "readOnly": true - }, - "costInformation": { - "$ref": "#/definitions/CostInformation", - "description": "Cost information for the product system.", - "readOnly": true - }, - "availabilityInformation": { - "$ref": "#/definitions/AvailabilityInformation", - "description": "Availability information of the product system.", - "readOnly": true - }, - "hierarchyInformation": { - "$ref": "#/definitions/HierarchyInformation", - "description": "Hierarchy information of a product", - "readOnly": true - } - } - }, "BillingDetails": { "description": "Contains billing details for the inventory", "type": "object", @@ -422,17 +285,6 @@ } } }, - "BillingModel": { - "description": "Model to represent the billing cycle", - "type": "object", - "properties": { - "model": { - "description": "String to represent the billing model", - "type": "string", - "readOnly": true - } - } - }, "CloudError": { "type": "object", "properties": { @@ -464,26 +316,6 @@ }, "x-ms-external": true }, - "CommonProperties": { - "description": "Represents common properties accross product hierarchy", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/BasicInformation" - } - ], - "properties": { - "filterableProperties": { - "description": "list of filters supported for a product", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/FilterableProperty" - }, - "readOnly": true - } - } - }, "ConfigurationData": { "description": "Contains information about inventory configuration", "type": "object", @@ -543,213 +375,12 @@ } } }, - "CostInformation": { - "description": "Cost information for the product system", - "type": "object", - "properties": { - "primaryMeterType": { - "description": "Primary meter i.e. basic billing type for the product system.", - "enum": [ - "ServiceFee", - "ShippingFee", - "LostOrDamagedFee", - "LateDayFee" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "MeterType", - "modelAsExtensible": true, - "values": [ - { - "value": "ServiceFee", - "description": "Service usage fee." - }, - { - "value": "ShippingFee", - "description": "Shipping fee." - }, - { - "value": "LostOrDamagedFee", - "description": "Fee charged if the device is lost or damaged." - }, - { - "value": "LateDayFee", - "description": "Fee charged if the device is kept longer that the allotted days." - } - ] - } - }, - "meterDetails": { - "description": "Details on the various billing aspects for the product system.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/MeterDetails" - }, - "readOnly": true - } - } - }, - "Description": { - "description": "Description related properties of a product system.", - "type": "object", - "properties": { - "descriptionType": { - "description": "Type of description.", - "enum": [ - "Base" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "DescriptionType", - "modelAsExtensible": true, - "values": [ - { - "value": "Base", - "description": "Base description." - } - ] - } - }, - "shortDescription": { - "description": "Short description of the product system.", - "type": "string", - "readOnly": true - }, - "longDescription": { - "description": "Long description of the product system.", - "type": "string", - "readOnly": true - }, - "keywords": { - "description": "Keywords for the product system.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "attributes": { - "description": "Attributes for the product system.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "links": { - "description": "Links for the product system.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Link" - }, - "readOnly": true - } - } - }, - "FilterableProperty": { - "description": "Different types of filters supported and its values.", - "type": "object", - "properties": { - "type": { - "description": "Type of product filter.", - "enum": [ - "ShipToCountries" - ], - "type": "string", - "x-ms-enum": { - "name": "SupportedFilterTypes", - "modelAsExtensible": true, - "values": [ - { - "value": "ShipToCountries", - "description": "Ship to country" - } - ] - } - }, - "supportedValues": { - "description": "Values to be filtered.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "HierarchyInformation": { - "description": "Holds details about product hierarchy information", - "type": "object", - "properties": { - "productFamilyName": { - "description": "Represents product family name that uniquely identifies product family", - "type": "string" - }, - "productLineName": { - "description": "Represents product line name that uniquely identifies product line", - "type": "string" - }, - "productName": { - "description": "Represents product name that uniquely identifies product", - "type": "string" - }, - "configurationName": { - "description": "Represents configuration name that uniquely identifies configuration", - "type": "string" - } - } - }, - "ImageInformation": { - "description": "Image for the product", - "type": "object", - "properties": { - "imageType": { - "description": "Type of the image", - "enum": [ - "MainImage", - "BulletImage", - "GenericImage" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ImageType", - "modelAsExtensible": true, - "values": [ - { - "value": "MainImage", - "description": "Main image." - }, - { - "value": "BulletImage", - "description": "Bullet image." - }, - { - "value": "GenericImage", - "description": "Generic image." - } - ] - } - }, - "imageUrl": { - "description": "Url of the image", - "type": "string", - "readOnly": true - } - } - }, "InventoryAdditionalDetails": { - "description": "Represents additional details abpout the partner inventory", + "description": "Represents additional details about the partner inventory", "type": "object", "properties": { - "order": { - "$ref": "#/definitions/AdditionalOrderDetails", + "orderItem": { + "$ref": "#/definitions/AdditionalOrderItemDetails", "description": "Represents additional details about the order" }, "inventoryMetadata": { @@ -812,8 +443,8 @@ "type": "string", "readOnly": true }, - "order": { - "$ref": "#/definitions/OrderData", + "orderItem": { + "$ref": "#/definitions/OrderItemData", "description": "Represents basic order data.", "readOnly": true }, @@ -844,60 +475,6 @@ } } }, - "Link": { - "description": "Returns link related to the product", - "type": "object", - "properties": { - "linkType": { - "description": "Type of link", - "enum": [ - "Generic", - "TermsAndConditions", - "Specification", - "Documentation", - "KnowMore", - "SignUp" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "LinkType", - "modelAsExtensible": true, - "values": [ - { - "value": "Generic", - "description": "Generic link." - }, - { - "value": "TermsAndConditions", - "description": "Terms and conditions link." - }, - { - "value": "Specification", - "description": "Link to product specification." - }, - { - "value": "Documentation", - "description": "Link to product documentation" - }, - { - "value": "KnowMore", - "description": "Link to know more" - }, - { - "value": "SignUp", - "description": "Link to sign up for products" - } - ] - } - }, - "linkUrl": { - "description": "Url of the link", - "type": "string", - "readOnly": true - } - } - }, "ManageInventoryMetadataRequest": { "description": "Request body for ManageInventoryMetadata call", "required": [ @@ -987,56 +564,7 @@ } } }, - "MeterDetails": { - "description": "Billing details for each meter.", - "type": "object", - "properties": { - "meterId": { - "description": "MeterId/ Billing Guid against which the product system will be charged", - "type": "string", - "readOnly": true - }, - "meterType": { - "description": "Category of the billing meter.", - "enum": [ - "ServiceFee", - "ShippingFee", - "LostOrDamagedFee", - "LateDayFee" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "MeterType", - "modelAsExtensible": true, - "values": [ - { - "value": "ServiceFee", - "description": "Service usage fee." - }, - { - "value": "ShippingFee", - "description": "Shipping fee." - }, - { - "value": "LostOrDamagedFee", - "description": "Fee charged if the device is lost or damaged." - }, - { - "value": "LateDayFee", - "description": "Fee charged if the device is kept longer that the allotted days." - } - ] - } - }, - "billingModel": { - "$ref": "#/definitions/BillingModel", - "description": "Billing model to represent billing cycle, i.e. Monthly, biweekly, daily, hourly etc.", - "readOnly": true - } - } - }, - "OrderData": { + "OrderItemData": { "description": "Contains information about the order to which inventory belongs", "type": "object", "properties": { @@ -1045,7 +573,7 @@ "type": "string", "readOnly": true }, - "orderType": { + "orderItemType": { "description": "Order type - purchase or rental", "enum": [ "Purchase", @@ -1054,28 +582,28 @@ "type": "string", "readOnly": true, "x-ms-enum": { - "name": "OrderType", + "name": "OrderItemType", "modelAsExtensible": true, "values": [ { "value": "Purchase", - "description": "Purchase Order." + "description": "Purchase OrderItem." }, { "value": "Rental", - "description": "Rental Order." + "description": "Rental OrderItem." } ] } } } }, - "OrderStatusDetails": { - "description": "Order status CurrentStatus", + "StageDetails": { + "description": "Resource stage details.", "type": "object", "properties": { "stageStatus": { - "description": "Order status", + "description": "Stage status.", "enum": [ "None", "InProgress", @@ -1118,7 +646,7 @@ } }, "stageName": { - "description": "Order stage name", + "description": "Stage name", "enum": [ "DeviceOrdered", "DevicePrepared", @@ -1229,7 +757,7 @@ } }, "displayName": { - "description": "Display name of the order stage.", + "description": "Display name of the resource stage.", "type": "string", "readOnly": true }, @@ -1272,26 +800,6 @@ } } }, - "ResourceIdentity": { - "description": "Msi identity details of the resource", - "type": "object", - "properties": { - "type": { - "description": "Identity type", - "type": "string" - }, - "principalId": { - "description": "Service Principal Id backing the Msi", - "type": "string", - "readOnly": true - }, - "tenantId": { - "description": "Home Tenant Id", - "type": "string", - "readOnly": true - } - } - }, "SearchInventoriesRequest": { "description": "Request body for SearchInventories call", "required": [ @@ -1349,17 +857,6 @@ } }, "parameters": { - "addressNameParameter": { - "name": "addressName", - "in": "path", - "description": "The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only", - "required": true, - "type": "string", - "maxLength": 24, - "minLength": 3, - "pattern": "^[-\\w\\.]+$", - "x-ms-parameter-location": "method" - }, "locationParameter": { "name": "location", "in": "path", @@ -1368,30 +865,14 @@ "type": "string", "x-ms-parameter-location": "method" }, - "orderCollectionNameParameter": { - "name": "orderCollectionName", - "in": "path", - "description": "The name of the order collection", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "orderNameParameter": { - "name": "orderName", - "in": "path", - "description": "The name of the order", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "serialNumberParameter": { + "serialNumberParameter": { "name": "serialNumber", "in": "path", "description": "The serial number of the device", "required": true, "type": "string", "x-ms-parameter-location": "method" - } + } }, "securityDefinitions": { "azure_auth": { @@ -1412,3 +893,4 @@ } ] } + \ No newline at end of file diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json index 078d79f20cc2..c8dfd9a28f50 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json @@ -21,8 +21,7 @@ "description": "List or get the Operations" }, "origin": "user", - "isDataAction": false, - "actionType": "" + "isDataAction": false }, { "name": "Microsoft.EdgeOrderPartner/searchInventories/action", @@ -31,8 +30,7 @@ "resource": "ArmApiRes_Microsoft.EdgeOrderPartner" }, "origin": "user", - "isDataAction": true, - "actionType": "" + "isDataAction": true }, { "name": "Microsoft.EdgeOrderPartner/locations/inventories/manageLink/action", @@ -41,8 +39,7 @@ "resource": "ArmApiRes_inventories" }, "origin": "user", - "isDataAction": true, - "actionType": "" + "isDataAction": true }, { "name": "Microsoft.EdgeOrderPartner/locations/inventories/manageInventoryMetadata/action", @@ -51,8 +48,7 @@ "resource": "ArmApiRes_inventories" }, "origin": "user", - "isDataAction": true, - "actionType": "" + "isDataAction": true } ] } diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json index f3b4ee608ce4..8426bfc97459 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json @@ -2,13 +2,13 @@ "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "location": "westus", - "SerialNumber": "SerialNumber", + "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/SerialNumber/manageInventoryMetadata?api-version=2020-12-01-preview" + "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" diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json index 8abe7cb805f6..cb97e0b4effa 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json @@ -2,13 +2,13 @@ "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "location": "westus", - "SerialNumber": "SerialNumber", + "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/SerialNumber/manageLink?api-version=2020-12-01-preview" + "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" diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json index 4e15ca00cde8..00e706c86b5f 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json @@ -15,7 +15,7 @@ "75" ], "searchInventoriesRequest": { - "serialNumber": "SerialNumber", + "serialNumber": "SerialNumber1", "familyIdentifier": "FamilyIdentifier" } }, @@ -25,10 +25,10 @@ "value": [ { "properties": { - "serialNumber": "SerialNumber", - "order": { + "serialNumber": "SerialNumber1", + "orderItem": { "armId": "ArmId", - "orderType": "Purchase" + "orderItemType": "Purchase" }, "configuration": { "familyIdentifier": "FamilyIdentifier", diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json index 502e37ba8b2c..e683611f8365 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json @@ -16,7 +16,7 @@ "75" ], "searchInventoriesRequest": { - "serialNumber": "SerialNumber", + "serialNumber": "SerialNumber1", "familyIdentifier": "FamilyIdentifier" } }, @@ -26,10 +26,10 @@ "value": [ { "properties": { - "serialNumber": "SerialNumber", - "order": { + "serialNumber": "SerialNumber1", + "orderItem": { "armId": "ArmId", - "orderType": "Purchase" + "orderItemType": "Purchase" }, "configuration": { "familyIdentifier": "FamilyIdentifier", @@ -49,7 +49,7 @@ }, "location": "It can be used in update API.", "details": { - "order": { + "orderItem": { "status": { "stageStatus": "InProgress", "stageName": "DevicePrepared", From 9035a60287a1b134174c8447bfd173d28ebf3c88 Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Tue, 23 Mar 2021 14:14:10 +0530 Subject: [PATCH 06/13] Some fixes from pull request errors --- .../preview/2020-12-01-preview/EdgeOrderPartner.json | 1 - .../examples/ListOperationsPartner.json | 2 +- .../examples/ManageInventoryMetadata.json | 11 ++++------- .../2020-12-01-preview/examples/ManageLink.json | 8 +++----- .../examples/SearchInventoriesDetails.json | 2 +- 5 files changed, 9 insertions(+), 15 deletions(-) diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json index a46a95eb4b5b..71e9d6e19307 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json @@ -893,4 +893,3 @@ } ] } - \ No newline at end of file diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json index c8dfd9a28f50..82db6b82d175 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json @@ -54,4 +54,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json index 8426bfc97459..e51738f06d4b 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json @@ -25,11 +25,8 @@ } }, "responses": { - "200": { - }, - "202": { - }, - "204": { - } + "200": {}, + "202": {}, + "204": {} } -} \ No newline at end of file +} diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json index cb97e0b4effa..ebe84ec17c76 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json @@ -24,9 +24,7 @@ } }, "responses": { - "200": { - }, - "204": { - } + "200": {}, + "204": {} } -} \ No newline at end of file +} diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json index e683611f8365..2089af3dc8b0 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json @@ -100,4 +100,4 @@ } } } -} \ No newline at end of file +} From 973ade056906ee8dc7613edbc21f1b8ad263c1bb Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Tue, 23 Mar 2021 14:25:40 +0530 Subject: [PATCH 07/13] Fixed tag issue --- .../resource-manager/readme.azureresourceschema.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/edgeorderpartner/resource-manager/readme.azureresourceschema.md b/specification/edgeorderpartner/resource-manager/readme.azureresourceschema.md index 994182741ccd..54cb3c585254 100644 --- a/specification/edgeorderpartner/resource-manager/readme.azureresourceschema.md +++ b/specification/edgeorderpartner/resource-manager/readme.azureresourceschema.md @@ -6,7 +6,7 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: - - tag: schema-edgeorder-2020-12-01-preview + - tag: schema-edgeorderpartner-2020-12-01-preview ``` @@ -14,7 +14,7 @@ Please also specify `--azureresourceschema-folder= Date: Tue, 23 Mar 2021 14:38:03 +0530 Subject: [PATCH 08/13] Removing swagger file temporarily to fix filename issue --- .../2020-12-01-preview/EdgeOrderPartner.json | 895 ------------------ 1 file changed, 895 deletions(-) delete mode 100644 specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json deleted file mode 100644 index 71e9d6e19307..000000000000 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/EdgeOrderPartner.json +++ /dev/null @@ -1,895 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2020-12-01-preview", - "title": "Edge Ordering Service-Partner" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/providers/Microsoft.EdgeOrderPartner/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "This method gets all the operations that are exposed for customer.", - "operationId": "ListOperationsPartner", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing reason for operation failure.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListOperationsPartner": { - "$ref": "./examples/ListOperationsPartner.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{serialNumber}/manageInventoryMetadata": { - "post": { - "tags": [ - "PartnerInventory" - ], - "summary": "API for updating inventory metadata and inventory configuration", - "operationId": "ManageInventoryMetadata", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/locationParameter" - }, - { - "$ref": "#/parameters/serialNumberParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "manageInventoryMetadataRequest", - "in": "body", - "description": "Updates inventory metadata and inventory configuration", - "required": true, - "schema": { - "$ref": "#/definitions/ManageInventoryMetadataRequest" - } - } - ], - "responses": { - "200": { - "description": "\"No content\"" - }, - "202": { - "description": "\"No content\"" - }, - "204": { - "description": "\"No content\"" - }, - "default": { - "description": "Error response describing reason for operation failure.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "ManageInventoryMetadata": { - "$ref": "./examples/ManageInventoryMetadata.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{serialNumber}/manageLink": { - "post": { - "tags": [ - "PartnerInventory" - ], - "summary": "API for linking management resource with inventory", - "operationId": "ManageLink", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/locationParameter" - }, - { - "$ref": "#/parameters/serialNumberParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "manageLinkRequest", - "in": "body", - "description": "Links the management resource to the inventory", - "required": true, - "schema": { - "$ref": "#/definitions/ManageLinkRequest" - } - } - ], - "responses": { - "200": { - "description": "\"No content\"" - }, - "204": { - "description": "\"No content\"" - }, - "default": { - "description": "Error response describing reason for operation failure.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ManageLink": { - "$ref": "./examples/ManageLink.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/searchInventories": { - "post": { - "tags": [ - "PartnerInventory" - ], - "summary": "API for Search inventories", - "operationId": "SearchInventories", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "searchInventoriesRequest", - "in": "body", - "description": "Searches inventories with the given filters and returns in the form of a list", - "required": true, - "schema": { - "$ref": "#/definitions/SearchInventoriesRequest" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PartnerInventoryList" - } - }, - "default": { - "description": "Error response describing reason for operation failure.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SearchInventories": { - "$ref": "./examples/SearchInventories.json" - } - } - } - } - }, - "definitions": { - "AdditionalErrorInfo": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "info": { - "type": "object" - } - } - }, - "AdditionalInventoryDetails": { - "description": "Contains additional data about inventory in dictionary format", - "type": "object", - "properties": { - "additionalData": { - "description": "Additional Data", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "readOnly": true - } - } - }, - "AdditionalOrderItemDetails": { - "description": "Contains additional order details", - "type": "object", - "properties": { - "status": { - "$ref": "#/definitions/StageDetails", - "description": "Order status", - "readOnly": true - }, - "subscription": { - "$ref": "#/definitions/SubscriptionDetails", - "description": "Subscription details", - "readOnly": true - } - } - }, - "BillingDetails": { - "description": "Contains billing details for the inventory", - "type": "object", - "properties": { - "billingType": { - "description": "Billing type for the inventory", - "type": "string", - "readOnly": true - }, - "status": { - "description": "Billing status for the inventory", - "type": "string", - "readOnly": true - } - } - }, - "CloudError": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "target": { - "type": "string" - }, - "details": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/CloudError" - }, - "readOnly": true - }, - "additionalInfo": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalErrorInfo" - }, - "readOnly": true - } - }, - "x-ms-external": true - }, - "ConfigurationData": { - "description": "Contains information about inventory configuration", - "type": "object", - "properties": { - "familyIdentifier": { - "description": "Family identifier of inventory", - "type": "string", - "readOnly": true - }, - "productLineIdentifier": { - "description": "Product Line identifier of inventory", - "type": "string", - "readOnly": true - }, - "productIdentifier": { - "description": "Product identifier of inventory", - "type": "string", - "readOnly": true - }, - "configurationIdentifier": { - "description": "Configuration identifier of inventory", - "type": "string", - "readOnly": true - }, - "configurationIdentifierOnDevice": { - "description": "Configuration identifier on device - this is used in case of any mismatch\r\nbetween actual configuration on inventory and configuration stored in service", - "type": "string", - "readOnly": true - } - } - }, - "ConfigurationDetails": { - "description": "Contains additional configuration details about inventory", - "type": "object", - "properties": { - "specifications": { - "description": "Collection of specification details about the inventory", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/SpecificationDetails" - }, - "readOnly": true - } - } - }, - "ConfigurationOnDevice": { - "description": "Configuration parameters for ManageInventoryMetadata call", - "required": [ - "configurationIdentifier" - ], - "type": "object", - "properties": { - "configurationIdentifier": { - "description": "Configuration identifier on device", - "type": "string" - } - } - }, - "InventoryAdditionalDetails": { - "description": "Represents additional details about the partner inventory", - "type": "object", - "properties": { - "orderItem": { - "$ref": "#/definitions/AdditionalOrderItemDetails", - "description": "Represents additional details about the order" - }, - "inventoryMetadata": { - "description": "Contains inventory metadata", - "type": "string", - "readOnly": true - }, - "configuration": { - "$ref": "#/definitions/ConfigurationDetails", - "description": "Represents additional details about the configuration", - "readOnly": true - }, - "inventory": { - "$ref": "#/definitions/AdditionalInventoryDetails", - "description": "Represents additional data about the inventory", - "readOnly": true - }, - "billing": { - "$ref": "#/definitions/BillingDetails", - "description": "Represents additional details about billing for the inventory", - "readOnly": true - }, - "secrets": { - "description": "Represents secrets on the inventory", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "readOnly": true - } - } - }, - "InventoryData": { - "description": "Contains basic information about inventory", - "type": "object", - "properties": { - "status": { - "description": "Inventory status", - "type": "string", - "readOnly": true - }, - "location": { - "description": "Inventory location", - "type": "string", - "readOnly": true - }, - "registrationAllowed": { - "description": "Boolean flag to indicate if registration is allowed", - "type": "boolean", - "readOnly": true - } - } - }, - "InventoryProperties": { - "description": "Represents inventory properties", - "type": "object", - "properties": { - "serialNumber": { - "description": "Serial number of the device.", - "type": "string", - "readOnly": true - }, - "orderItem": { - "$ref": "#/definitions/OrderItemData", - "description": "Represents basic order data.", - "readOnly": true - }, - "configuration": { - "$ref": "#/definitions/ConfigurationData", - "description": "Represents basic configuration data.", - "readOnly": true - }, - "managementResource": { - "$ref": "#/definitions/ManagementResourceData", - "description": "Represents management resource data associated with inventory.", - "readOnly": true - }, - "inventory": { - "$ref": "#/definitions/InventoryData", - "description": "Represents basic inventory data.", - "readOnly": true - }, - "location": { - "description": "Location of inventory", - "type": "string", - "readOnly": true - }, - "details": { - "$ref": "#/definitions/InventoryAdditionalDetails", - "description": "Represents additional details of inventory", - "readOnly": true - } - } - }, - "ManageInventoryMetadataRequest": { - "description": "Request body for ManageInventoryMetadata call", - "required": [ - "familyIdentifier", - "inventoryMetadata" - ], - "type": "object", - "properties": { - "familyIdentifier": { - "description": "Family identifier for inventory", - "type": "string" - }, - "inventoryMetadata": { - "description": "Inventory metadata to be updated", - "type": "string" - }, - "configurationOnDevice": { - "$ref": "#/definitions/ConfigurationOnDevice", - "description": "Inventory configuration to be updated" - } - } - }, - "ManageLinkRequest": { - "description": "Request body for ManageLink call", - "required": [ - "familyIdentifier", - "managementResourceArmId", - "operation", - "tenantId" - ], - "type": "object", - "properties": { - "familyIdentifier": { - "description": "Family identifier for inventory", - "type": "string" - }, - "managementResourceArmId": { - "description": "Arm Id of the management resource to which inventory is to be linked\r\nFor unlink operation, enter empty string", - "type": "string" - }, - "operation": { - "description": "Operation to be performed - Link, Unlink, Relink", - "enum": [ - "Link", - "Unlink", - "Relink" - ], - "type": "string", - "x-ms-enum": { - "name": "ManageLinkOperation", - "modelAsExtensible": true, - "values": [ - { - "value": "Link", - "description": "Link." - }, - { - "value": "Unlink", - "description": "Unlink." - }, - { - "value": "Relink", - "description": "Relink." - } - ] - } - }, - "tenantId": { - "description": "Tenant ID of management resource associated with inventory", - "type": "string" - } - } - }, - "ManagementResourceData": { - "description": "Contains information about management resource", - "type": "object", - "properties": { - "armId": { - "description": "Arm ID of management resource associated with inventory", - "type": "string", - "readOnly": true - }, - "tenantId": { - "description": "Tenant ID of management resource associated with inventory", - "type": "string", - "readOnly": true - } - } - }, - "OrderItemData": { - "description": "Contains information about the order to which inventory belongs", - "type": "object", - "properties": { - "armId": { - "description": "Arm ID of order", - "type": "string", - "readOnly": true - }, - "orderItemType": { - "description": "Order type - purchase or rental", - "enum": [ - "Purchase", - "Rental" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "OrderItemType", - "modelAsExtensible": true, - "values": [ - { - "value": "Purchase", - "description": "Purchase OrderItem." - }, - { - "value": "Rental", - "description": "Rental OrderItem." - } - ] - } - } - } - }, - "StageDetails": { - "description": "Resource stage details.", - "type": "object", - "properties": { - "stageStatus": { - "description": "Stage status.", - "enum": [ - "None", - "InProgress", - "Succeeded", - "Failed", - "Cancelled", - "Cancelling" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "StageStatus", - "modelAsExtensible": true, - "values": [ - { - "value": "None", - "description": "No status available yet." - }, - { - "value": "InProgress", - "description": "Stage is in progress." - }, - { - "value": "Succeeded", - "description": "Stage has succeeded." - }, - { - "value": "Failed", - "description": "Stage has failed." - }, - { - "value": "Cancelled", - "description": "Stage has been cancelled." - }, - { - "value": "Cancelling", - "description": "Stage is cancelling." - } - ] - } - }, - "stageName": { - "description": "Stage name", - "enum": [ - "DeviceOrdered", - "DevicePrepared", - "PickedUp", - "AtAzureDC", - "DataCopy", - "Completed", - "CompletedWithErrors", - "Cancelled", - "Aborted", - "CompletedWithWarnings", - "ReadyToDispatchFromAzureDC", - "ReadyToReceiveAtAzureDC", - "Placed", - "InReview", - "Confirmed", - "ReadyForDispatch", - "Dispatched", - "Delivered", - "InUse" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "StageName", - "modelAsExtensible": true, - "values": [ - { - "value": "DeviceOrdered", - "description": "An order has been created." - }, - { - "value": "DevicePrepared", - "description": "A device has been prepared for the order." - }, - { - "value": "PickedUp", - "description": "Device has been picked up from user and in transit to Azure datacenter." - }, - { - "value": "AtAzureDC", - "description": "Device has been received at Azure datacenter from the user." - }, - { - "value": "DataCopy", - "description": "Data copy from the device at Azure datacenter." - }, - { - "value": "Completed", - "description": "Order has completed." - }, - { - "value": "CompletedWithErrors", - "description": "Order has completed with errors." - }, - { - "value": "Cancelled", - "description": "Order has been cancelled." - }, - { - "value": "Aborted", - "description": "Order has been aborted." - }, - { - "value": "Current" - }, - { - "value": "CompletedWithWarnings", - "description": "Order has completed with warnings." - }, - { - "value": "ReadyToDispatchFromAzureDC", - "description": "Device is ready to be handed to customer from Azure DC." - }, - { - "value": "ReadyToReceiveAtAzureDC", - "description": "Device can be dropped off at Azure DC." - }, - { - "value": "Placed", - "description": "Currently in draft mode and can still be cancelled" - }, - { - "value": "InReview", - "description": "Order is currently in draft mode and can still be cancelled" - }, - { - "value": "Confirmed", - "description": "Order is confirmed" - }, - { - "value": "ReadyForDispatch", - "description": "Order is ready for dispatch" - }, - { - "value": "Dispatched", - "description": "Order is in transit to customer" - }, - { - "value": "Delivered", - "description": "Order is delivered to customer" - }, - { - "value": "InUse", - "description": "Order is in use at customer site" - } - ] - } - }, - "displayName": { - "description": "Display name of the resource stage.", - "type": "string", - "readOnly": true - }, - "startTime": { - "format": "date-time", - "description": "Stage start time", - "type": "string", - "readOnly": true - } - } - }, - "PartnerInventory": { - "description": "Represents partner inventory contract", - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/InventoryProperties", - "description": "Inventory properties", - "readOnly": true, - "x-ms-client-flatten": true - } - } - }, - "PartnerInventoryList": { - "description": "Represents the list of partner inventories", - "type": "object", - "properties": { - "value": { - "description": "List of partner inventories", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/PartnerInventory" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link for the next set of order collection resources.", - "type": "string" - } - } - }, - "SearchInventoriesRequest": { - "description": "Request body for SearchInventories call", - "required": [ - "serialNumber", - "familyIdentifier" - ], - "type": "object", - "properties": { - "serialNumber": { - "description": "Serial number of the inventory", - "type": "string" - }, - "familyIdentifier": { - "description": "Family identifier for inventory", - "type": "string" - } - } - }, - "SpecificationDetails": { - "description": "Specification details for the inventory", - "type": "object", - "properties": { - "name": { - "description": "Name of the specification property", - "type": "string", - "readOnly": true - }, - "value": { - "description": "Value of the specification property", - "type": "string", - "readOnly": true - } - } - }, - "SubscriptionDetails": { - "description": "Contains subscription details", - "type": "object", - "properties": { - "id": { - "description": "Subscription Id", - "type": "string", - "readOnly": true - }, - "state": { - "description": "Subscription State", - "type": "string", - "readOnly": true - }, - "quotaId": { - "description": "Subscription QuotaId", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "locationParameter": { - "name": "location", - "in": "path", - "description": "The location of the resource", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "serialNumberParameter": { - "name": "serialNumber", - "in": "path", - "description": "The serial number of the device", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} From 7ab058487b194e5cf1ce19a6cf4e53221a3d82b5 Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Tue, 23 Mar 2021 14:41:03 +0530 Subject: [PATCH 09/13] Adding swagger file with changed name --- .../2020-12-01-preview/edgeorderpartner.json | 895 ++++++++++++++++++ 1 file changed, 895 insertions(+) create mode 100644 specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json new file mode 100644 index 000000000000..71e9d6e19307 --- /dev/null +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json @@ -0,0 +1,895 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01-preview", + "title": "Edge Ordering Service-Partner" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.EdgeOrderPartner/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "This method gets all the operations that are exposed for customer.", + "operationId": "ListOperationsPartner", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOperationsPartner": { + "$ref": "./examples/ListOperationsPartner.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{serialNumber}/manageInventoryMetadata": { + "post": { + "tags": [ + "PartnerInventory" + ], + "summary": "API for updating inventory metadata and inventory configuration", + "operationId": "ManageInventoryMetadata", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/serialNumberParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "manageInventoryMetadataRequest", + "in": "body", + "description": "Updates inventory metadata and inventory configuration", + "required": true, + "schema": { + "$ref": "#/definitions/ManageInventoryMetadataRequest" + } + } + ], + "responses": { + "200": { + "description": "\"No content\"" + }, + "202": { + "description": "\"No content\"" + }, + "204": { + "description": "\"No content\"" + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ManageInventoryMetadata": { + "$ref": "./examples/ManageInventoryMetadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{serialNumber}/manageLink": { + "post": { + "tags": [ + "PartnerInventory" + ], + "summary": "API for linking management resource with inventory", + "operationId": "ManageLink", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/serialNumberParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "manageLinkRequest", + "in": "body", + "description": "Links the management resource to the inventory", + "required": true, + "schema": { + "$ref": "#/definitions/ManageLinkRequest" + } + } + ], + "responses": { + "200": { + "description": "\"No content\"" + }, + "204": { + "description": "\"No content\"" + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ManageLink": { + "$ref": "./examples/ManageLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/searchInventories": { + "post": { + "tags": [ + "PartnerInventory" + ], + "summary": "API for Search inventories", + "operationId": "SearchInventories", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "searchInventoriesRequest", + "in": "body", + "description": "Searches inventories with the given filters and returns in the form of a list", + "required": true, + "schema": { + "$ref": "#/definitions/SearchInventoriesRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PartnerInventoryList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SearchInventories": { + "$ref": "./examples/SearchInventories.json" + } + } + } + } + }, + "definitions": { + "AdditionalErrorInfo": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "info": { + "type": "object" + } + } + }, + "AdditionalInventoryDetails": { + "description": "Contains additional data about inventory in dictionary format", + "type": "object", + "properties": { + "additionalData": { + "description": "Additional Data", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "AdditionalOrderItemDetails": { + "description": "Contains additional order details", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/StageDetails", + "description": "Order status", + "readOnly": true + }, + "subscription": { + "$ref": "#/definitions/SubscriptionDetails", + "description": "Subscription details", + "readOnly": true + } + } + }, + "BillingDetails": { + "description": "Contains billing details for the inventory", + "type": "object", + "properties": { + "billingType": { + "description": "Billing type for the inventory", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Billing status for the inventory", + "type": "string", + "readOnly": true + } + } + }, + "CloudError": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "target": { + "type": "string" + }, + "details": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CloudError" + }, + "readOnly": true + }, + "additionalInfo": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalErrorInfo" + }, + "readOnly": true + } + }, + "x-ms-external": true + }, + "ConfigurationData": { + "description": "Contains information about inventory configuration", + "type": "object", + "properties": { + "familyIdentifier": { + "description": "Family identifier of inventory", + "type": "string", + "readOnly": true + }, + "productLineIdentifier": { + "description": "Product Line identifier of inventory", + "type": "string", + "readOnly": true + }, + "productIdentifier": { + "description": "Product identifier of inventory", + "type": "string", + "readOnly": true + }, + "configurationIdentifier": { + "description": "Configuration identifier of inventory", + "type": "string", + "readOnly": true + }, + "configurationIdentifierOnDevice": { + "description": "Configuration identifier on device - this is used in case of any mismatch\r\nbetween actual configuration on inventory and configuration stored in service", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationDetails": { + "description": "Contains additional configuration details about inventory", + "type": "object", + "properties": { + "specifications": { + "description": "Collection of specification details about the inventory", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SpecificationDetails" + }, + "readOnly": true + } + } + }, + "ConfigurationOnDevice": { + "description": "Configuration parameters for ManageInventoryMetadata call", + "required": [ + "configurationIdentifier" + ], + "type": "object", + "properties": { + "configurationIdentifier": { + "description": "Configuration identifier on device", + "type": "string" + } + } + }, + "InventoryAdditionalDetails": { + "description": "Represents additional details about the partner inventory", + "type": "object", + "properties": { + "orderItem": { + "$ref": "#/definitions/AdditionalOrderItemDetails", + "description": "Represents additional details about the order" + }, + "inventoryMetadata": { + "description": "Contains inventory metadata", + "type": "string", + "readOnly": true + }, + "configuration": { + "$ref": "#/definitions/ConfigurationDetails", + "description": "Represents additional details about the configuration", + "readOnly": true + }, + "inventory": { + "$ref": "#/definitions/AdditionalInventoryDetails", + "description": "Represents additional data about the inventory", + "readOnly": true + }, + "billing": { + "$ref": "#/definitions/BillingDetails", + "description": "Represents additional details about billing for the inventory", + "readOnly": true + }, + "secrets": { + "description": "Represents secrets on the inventory", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InventoryData": { + "description": "Contains basic information about inventory", + "type": "object", + "properties": { + "status": { + "description": "Inventory status", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Inventory location", + "type": "string", + "readOnly": true + }, + "registrationAllowed": { + "description": "Boolean flag to indicate if registration is allowed", + "type": "boolean", + "readOnly": true + } + } + }, + "InventoryProperties": { + "description": "Represents inventory properties", + "type": "object", + "properties": { + "serialNumber": { + "description": "Serial number of the device.", + "type": "string", + "readOnly": true + }, + "orderItem": { + "$ref": "#/definitions/OrderItemData", + "description": "Represents basic order data.", + "readOnly": true + }, + "configuration": { + "$ref": "#/definitions/ConfigurationData", + "description": "Represents basic configuration data.", + "readOnly": true + }, + "managementResource": { + "$ref": "#/definitions/ManagementResourceData", + "description": "Represents management resource data associated with inventory.", + "readOnly": true + }, + "inventory": { + "$ref": "#/definitions/InventoryData", + "description": "Represents basic inventory data.", + "readOnly": true + }, + "location": { + "description": "Location of inventory", + "type": "string", + "readOnly": true + }, + "details": { + "$ref": "#/definitions/InventoryAdditionalDetails", + "description": "Represents additional details of inventory", + "readOnly": true + } + } + }, + "ManageInventoryMetadataRequest": { + "description": "Request body for ManageInventoryMetadata call", + "required": [ + "familyIdentifier", + "inventoryMetadata" + ], + "type": "object", + "properties": { + "familyIdentifier": { + "description": "Family identifier for inventory", + "type": "string" + }, + "inventoryMetadata": { + "description": "Inventory metadata to be updated", + "type": "string" + }, + "configurationOnDevice": { + "$ref": "#/definitions/ConfigurationOnDevice", + "description": "Inventory configuration to be updated" + } + } + }, + "ManageLinkRequest": { + "description": "Request body for ManageLink call", + "required": [ + "familyIdentifier", + "managementResourceArmId", + "operation", + "tenantId" + ], + "type": "object", + "properties": { + "familyIdentifier": { + "description": "Family identifier for inventory", + "type": "string" + }, + "managementResourceArmId": { + "description": "Arm Id of the management resource to which inventory is to be linked\r\nFor unlink operation, enter empty string", + "type": "string" + }, + "operation": { + "description": "Operation to be performed - Link, Unlink, Relink", + "enum": [ + "Link", + "Unlink", + "Relink" + ], + "type": "string", + "x-ms-enum": { + "name": "ManageLinkOperation", + "modelAsExtensible": true, + "values": [ + { + "value": "Link", + "description": "Link." + }, + { + "value": "Unlink", + "description": "Unlink." + }, + { + "value": "Relink", + "description": "Relink." + } + ] + } + }, + "tenantId": { + "description": "Tenant ID of management resource associated with inventory", + "type": "string" + } + } + }, + "ManagementResourceData": { + "description": "Contains information about management resource", + "type": "object", + "properties": { + "armId": { + "description": "Arm ID of management resource associated with inventory", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant ID of management resource associated with inventory", + "type": "string", + "readOnly": true + } + } + }, + "OrderItemData": { + "description": "Contains information about the order to which inventory belongs", + "type": "object", + "properties": { + "armId": { + "description": "Arm ID of order", + "type": "string", + "readOnly": true + }, + "orderItemType": { + "description": "Order type - purchase or rental", + "enum": [ + "Purchase", + "Rental" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OrderItemType", + "modelAsExtensible": true, + "values": [ + { + "value": "Purchase", + "description": "Purchase OrderItem." + }, + { + "value": "Rental", + "description": "Rental OrderItem." + } + ] + } + } + } + }, + "StageDetails": { + "description": "Resource stage details.", + "type": "object", + "properties": { + "stageStatus": { + "description": "Stage status.", + "enum": [ + "None", + "InProgress", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No status available yet." + }, + { + "value": "InProgress", + "description": "Stage is in progress." + }, + { + "value": "Succeeded", + "description": "Stage has succeeded." + }, + { + "value": "Failed", + "description": "Stage has failed." + }, + { + "value": "Cancelled", + "description": "Stage has been cancelled." + }, + { + "value": "Cancelling", + "description": "Stage is cancelling." + } + ] + } + }, + "stageName": { + "description": "Stage name", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Aborted", + "CompletedWithWarnings", + "ReadyToDispatchFromAzureDC", + "ReadyToReceiveAtAzureDC", + "Placed", + "InReview", + "Confirmed", + "ReadyForDispatch", + "Dispatched", + "Delivered", + "InUse" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageName", + "modelAsExtensible": true, + "values": [ + { + "value": "DeviceOrdered", + "description": "An order has been created." + }, + { + "value": "DevicePrepared", + "description": "A device has been prepared for the order." + }, + { + "value": "PickedUp", + "description": "Device has been picked up from user and in transit to Azure datacenter." + }, + { + "value": "AtAzureDC", + "description": "Device has been received at Azure datacenter from the user." + }, + { + "value": "DataCopy", + "description": "Data copy from the device at Azure datacenter." + }, + { + "value": "Completed", + "description": "Order has completed." + }, + { + "value": "CompletedWithErrors", + "description": "Order has completed with errors." + }, + { + "value": "Cancelled", + "description": "Order has been cancelled." + }, + { + "value": "Aborted", + "description": "Order has been aborted." + }, + { + "value": "Current" + }, + { + "value": "CompletedWithWarnings", + "description": "Order has completed with warnings." + }, + { + "value": "ReadyToDispatchFromAzureDC", + "description": "Device is ready to be handed to customer from Azure DC." + }, + { + "value": "ReadyToReceiveAtAzureDC", + "description": "Device can be dropped off at Azure DC." + }, + { + "value": "Placed", + "description": "Currently in draft mode and can still be cancelled" + }, + { + "value": "InReview", + "description": "Order is currently in draft mode and can still be cancelled" + }, + { + "value": "Confirmed", + "description": "Order is confirmed" + }, + { + "value": "ReadyForDispatch", + "description": "Order is ready for dispatch" + }, + { + "value": "Dispatched", + "description": "Order is in transit to customer" + }, + { + "value": "Delivered", + "description": "Order is delivered to customer" + }, + { + "value": "InUse", + "description": "Order is in use at customer site" + } + ] + } + }, + "displayName": { + "description": "Display name of the resource stage.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Stage start time", + "type": "string", + "readOnly": true + } + } + }, + "PartnerInventory": { + "description": "Represents partner inventory contract", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/InventoryProperties", + "description": "Inventory properties", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "PartnerInventoryList": { + "description": "Represents the list of partner inventories", + "type": "object", + "properties": { + "value": { + "description": "List of partner inventories", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/PartnerInventory" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of order collection resources.", + "type": "string" + } + } + }, + "SearchInventoriesRequest": { + "description": "Request body for SearchInventories call", + "required": [ + "serialNumber", + "familyIdentifier" + ], + "type": "object", + "properties": { + "serialNumber": { + "description": "Serial number of the inventory", + "type": "string" + }, + "familyIdentifier": { + "description": "Family identifier for inventory", + "type": "string" + } + } + }, + "SpecificationDetails": { + "description": "Specification details for the inventory", + "type": "object", + "properties": { + "name": { + "description": "Name of the specification property", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Value of the specification property", + "type": "string", + "readOnly": true + } + } + }, + "SubscriptionDetails": { + "description": "Contains subscription details", + "type": "object", + "properties": { + "id": { + "description": "Subscription Id", + "type": "string", + "readOnly": true + }, + "state": { + "description": "Subscription State", + "type": "string", + "readOnly": true + }, + "quotaId": { + "description": "Subscription QuotaId", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "serialNumberParameter": { + "name": "serialNumber", + "in": "path", + "description": "The serial number of the device", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} From 509df5f72fe69ba287a93da933d7ffe2966bbc3a Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Tue, 23 Mar 2021 15:03:10 +0530 Subject: [PATCH 10/13] Added multiple examples in swagger json for search inventories. --- .../preview/2020-12-01-preview/edgeorderpartner.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json index 71e9d6e19307..b899153a9ec1 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json @@ -222,6 +222,9 @@ "x-ms-examples": { "SearchInventories": { "$ref": "./examples/SearchInventories.json" + }, + "SearchInventoriesDetails": { + "$ref": "./examples/SearchInventoriesDetails.json" } } } From 49d2616f7ecc2a596467b9b0d2de23b7ba235ebb Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Wed, 24 Mar 2021 17:15:32 +0530 Subject: [PATCH 11/13] Fixed some descriptions. --- .../2020-12-01-preview/edgeorderpartner.json | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json index b899153a9ec1..aa61f392c654 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json @@ -257,12 +257,12 @@ } }, "AdditionalOrderItemDetails": { - "description": "Contains additional order details", + "description": "Contains additional order item details", "type": "object", "properties": { "status": { "$ref": "#/definitions/StageDetails", - "description": "Order status", + "description": "Order item status", "readOnly": true }, "subscription": { @@ -384,7 +384,7 @@ "properties": { "orderItem": { "$ref": "#/definitions/AdditionalOrderItemDetails", - "description": "Represents additional details about the order" + "description": "Represents additional details about the order item" }, "inventoryMetadata": { "description": "Contains inventory metadata", @@ -448,7 +448,7 @@ }, "orderItem": { "$ref": "#/definitions/OrderItemData", - "description": "Represents basic order data.", + "description": "Represents basic order item data.", "readOnly": true }, "configuration": { @@ -568,16 +568,16 @@ } }, "OrderItemData": { - "description": "Contains information about the order to which inventory belongs", + "description": "Contains information about the order item to which inventory belongs", "type": "object", "properties": { "armId": { - "description": "Arm ID of order", + "description": "Arm ID of order item ", "type": "string", "readOnly": true }, "orderItemType": { - "description": "Order type - purchase or rental", + "description": "Order item type - purchase or rental", "enum": [ "Purchase", "Rental" @@ -798,7 +798,7 @@ "readOnly": true }, "nextLink": { - "description": "Link for the next set of order collection resources.", + "description": "Link for the next set of partner inventories.", "type": "string" } } @@ -896,3 +896,4 @@ } ] } + \ No newline at end of file From b1ac478e7e745e54f0649ba1134f47e868ae31f5 Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Mon, 29 Mar 2021 20:18:53 +0530 Subject: [PATCH 12/13] Changes in the specs and examples as per discussion with Chris. --- .../2020-12-01-preview/edgeorderpartner.json | 49 +++++++++-------- .../examples/ListOperationsPartner.json | 4 +- .../examples/ManageInventoryMetadata.json | 8 +-- .../examples/ManageLink.json | 10 ++-- .../examples/SearchInventories.json | 30 +++++------ .../examples/SearchInventoriesDetails.json | 53 +++++++++---------- 6 files changed, 80 insertions(+), 74 deletions(-) diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json index aa61f392c654..b165d976ac91 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json @@ -57,7 +57,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{serialNumber}/manageInventoryMetadata": { + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/productFamilies/{familyIdentifier}/inventories/{serialNumber}/manageInventoryMetadata": { "post": { "tags": [ "PartnerInventory" @@ -71,6 +71,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/familyIdentifierParameter" + }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, @@ -95,10 +98,10 @@ ], "responses": { "200": { - "description": "\"No content\"" + "description": "\"Success\"" }, "202": { - "description": "\"No content\"" + "description": "\"Request is accepted to manage inventory metadata\"" }, "204": { "description": "\"No content\"" @@ -118,7 +121,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/inventories/{serialNumber}/manageLink": { + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/productFamilies/{familyIdentifier}/inventories/{serialNumber}/manageLink": { "post": { "tags": [ "PartnerInventory" @@ -132,6 +135,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/familyIdentifierParameter" + }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, @@ -156,7 +162,7 @@ ], "responses": { "200": { - "description": "\"No content\"" + "description": "\"Success\"" }, "204": { "description": "\"No content\"" @@ -219,6 +225,9 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { "SearchInventories": { "$ref": "./examples/SearchInventories.json" @@ -406,13 +415,14 @@ "description": "Represents additional details about billing for the inventory", "readOnly": true }, - "secrets": { + "inventorySecrets": { "description": "Represents secrets on the inventory", "type": "object", "additionalProperties": { "type": "string" }, - "readOnly": true + "readOnly": true, + "x-ms-secret": true } } }, @@ -481,15 +491,10 @@ "ManageInventoryMetadataRequest": { "description": "Request body for ManageInventoryMetadata call", "required": [ - "familyIdentifier", "inventoryMetadata" ], "type": "object", "properties": { - "familyIdentifier": { - "description": "Family identifier for inventory", - "type": "string" - }, "inventoryMetadata": { "description": "Inventory metadata to be updated", "type": "string" @@ -503,17 +508,12 @@ "ManageLinkRequest": { "description": "Request body for ManageLink call", "required": [ - "familyIdentifier", "managementResourceArmId", "operation", "tenantId" ], "type": "object", "properties": { - "familyIdentifier": { - "description": "Family identifier for inventory", - "type": "string" - }, "managementResourceArmId": { "description": "Arm Id of the management resource to which inventory is to be linked\r\nFor unlink operation, enter empty string", "type": "string" @@ -572,7 +572,7 @@ "type": "object", "properties": { "armId": { - "description": "Arm ID of order item ", + "description": "Arm ID of order item", "type": "string", "readOnly": true }, @@ -667,7 +667,7 @@ "InReview", "Confirmed", "ReadyForDispatch", - "Dispatched", + "Shipped", "Delivered", "InUse" ], @@ -745,7 +745,7 @@ "description": "Order is ready for dispatch" }, { - "value": "Dispatched", + "value": "Shipped", "description": "Order is in transit to customer" }, { @@ -860,6 +860,14 @@ } }, "parameters": { + "familyIdentifierParameter": { + "name": "familyIdentifier", + "in": "path", + "description": "Unique identifier for the product family", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, "locationParameter": { "name": "location", "in": "path", @@ -896,4 +904,3 @@ } ] } - \ No newline at end of file diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json index 82db6b82d175..8643c095d423 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json @@ -33,7 +33,7 @@ "isDataAction": true }, { - "name": "Microsoft.EdgeOrderPartner/locations/inventories/manageLink/action", + "name": "Microsoft.EdgeOrderPartner/locations/productFamilies/inventories/manageLink/action", "display": { "provider": "Edge Ordering", "resource": "ArmApiRes_inventories" @@ -42,7 +42,7 @@ "isDataAction": true }, { - "name": "Microsoft.EdgeOrderPartner/locations/inventories/manageInventoryMetadata/action", + "name": "Microsoft.EdgeOrderPartner/locations/productFamilies/inventories/manageInventoryMetadata/action", "display": { "provider": "Edge Ordering", "resource": "ArmApiRes_inventories" diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json index e51738f06d4b..284e53438bf0 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.json @@ -1,14 +1,15 @@ { "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "subscriptionId": "b783ea86-c85c-4175-b76d-3992656af50d", "location": "westus", "serialNumber": "SerialNumber1", + "familyIdentifier": "AzureStackEdge", "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" + "https://localhost/subscriptions/b783ea86-c85c-4175-b76d-3992656af50d/providers/Microsoft.EdgeOrderPartner/locations/westus/productFamilies/AzureStackEdge/inventories/SerialNumber1/manageInventoryMetadata?api-version=2020-12-01-preview" ], "Content-Type": [ "application/json; charset=utf-8" @@ -17,10 +18,9 @@ "181" ], "manageInventoryMetadataRequest": { - "familyIdentifier": "FamilyIdentifier", "inventoryMetadata": "InventoryMetadata", "configurationOnDevice": { - "configurationIdentifier": "ConfigurationIdentifierOnDevice" + "configurationIdentifier": "EdgeP_High" } } }, diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json index ebe84ec17c76..84903165558c 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.json @@ -1,14 +1,15 @@ { "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "subscriptionId": "b783ea86-c85c-4175-b76d-3992656af50d", "location": "westus", "serialNumber": "SerialNumber1", + "familyIdentifier": "AzureStackEdge", "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" + "https://localhost/subscriptions/b783ea86-c85c-4175-b76d-3992656af50d/providers/Microsoft.EdgeOrderPartner/locations/westus/productFamilies/AzureStackEdge/inventories/SerialNumber1/manageLink?api-version=2020-12-01-preview" ], "Content-Type": [ "application/json; charset=utf-8" @@ -17,10 +18,9 @@ "144" ], "manageLinkRequest": { - "familyIdentifier": "FamilyIdentifier", - "managementResourceArmId": "ManagementResourceArmId", + "managementResourceArmId": "/subscriptions/c783ea86-c85c-4175-b76d-3992656af50d/resourceGroups/EdgeTestRG/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/TestEdgeDeviceName1", "operation": "Link", - "tenantId": "TenantId" + "tenantId": "a783ea86-c85c-4175-b76d-3992656af50d" } }, "responses": { diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json index 00e706c86b5f..9ce882e16954 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.json @@ -1,12 +1,12 @@ { "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "subscriptionId": "b783ea86-c85c-4175-b76d-3992656af50d", "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" + "https://localhost/subscriptions/b783ea86-c85c-4175-b76d-3992656af50d/providers/Microsoft.EdgeOrderPartner/searchInventories?api-version=2020-12-01-preview" ], "Content-Type": [ "application/json; charset=utf-8" @@ -16,7 +16,7 @@ ], "searchInventoriesRequest": { "serialNumber": "SerialNumber1", - "familyIdentifier": "FamilyIdentifier" + "familyIdentifier": "AzureStackEdge" } }, "responses": { @@ -26,27 +26,27 @@ { "properties": { "serialNumber": "SerialNumber1", + "location": "westus", "orderItem": { - "armId": "ArmId", - "orderItemType": "Purchase" + "armId": "/subscriptions/b783ea86-c85c-4175-b76d-3992656af50d/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orders/TestOrderName1", + "orderItemType": "Rental" }, "configuration": { - "familyIdentifier": "FamilyIdentifier", - "productLineIdentifier": "ProductLineIdentifier", - "productIdentifier": "ProductIdentifier", - "configurationIdentifier": "ConfigurationIdentifier", - "configurationIdentifierOnDevice": "ConfigurationIdentifierOnDevice" + "familyIdentifier": "AzureStackEdge", + "productLineIdentifier": "AzureStackEdgePL", + "productIdentifier": "AzureStackEdgeProGPU", + "configurationIdentifier": "EdgeP_Base", + "configurationIdentifierOnDevice": "EdgeP_High" }, "managementResource": { - "armId": "ArmId", - "tenantId": "guid" + "armId": "/subscriptions/c783ea86-c85c-4175-b76d-3992656af50d/resourceGroups/EdgeTestRG/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/TestEdgeDeviceName1", + "tenantId": "a783ea86-c85c-4175-b76d-3992656af50d" }, "inventory": { "status": "Healthy", "location": "Rack", - "registrationAllowed": false - }, - "location": "It can be used in update API." + "registrationAllowed": true + } } } ] diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json index 2089af3dc8b0..46191693dbae 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.json @@ -1,13 +1,13 @@ { "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "subscriptionId": "b783ea86-c85c-4175-b76d-3992656af50d", "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" + "https://localhost/subscriptions/b783ea86-c85c-4175-b76d-3992656af50d/providers/Microsoft.EdgeOrderPartner/searchInventories?api-version=2020-12-01-preview&$expand=details" ], "Content-Type": [ "application/json; charset=utf-8" @@ -17,7 +17,7 @@ ], "searchInventoriesRequest": { "serialNumber": "SerialNumber1", - "familyIdentifier": "FamilyIdentifier" + "familyIdentifier": "AzureStackEdge" } }, "responses": { @@ -27,42 +27,42 @@ { "properties": { "serialNumber": "SerialNumber1", + "location": "westus", "orderItem": { - "armId": "ArmId", - "orderItemType": "Purchase" + "armId": "/subscriptions/b783ea86-c85c-4175-b76d-3992656af50d/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orders/TestOrderName1", + "orderItemType": "Rental" }, "configuration": { - "familyIdentifier": "FamilyIdentifier", - "productLineIdentifier": "ProductLineIdentifier", - "productIdentifier": "ProductIdentifier", - "configurationIdentifier": "ConfigurationIdentifier", - "configurationIdentifierOnDevice": "ConfigurationIdentifierOnDevice" + "familyIdentifier": "AzureStackEdge", + "productLineIdentifier": "AzureStackEdgePL", + "productIdentifier": "AzureStackEdgeProGPU", + "configurationIdentifier": "EdgeP_Base", + "configurationIdentifierOnDevice": "EdgeP_High" }, "managementResource": { - "armId": "ArmId", - "tenantId": "guid" + "armId": "/subscriptions/c783ea86-c85c-4175-b76d-3992656af50d/resourceGroups/EdgeTestRG/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/TestEdgeDeviceName1", + "tenantId": "a783ea86-c85c-4175-b76d-3992656af50d" }, "inventory": { "status": "Healthy", "location": "Rack", - "registrationAllowed": false + "registrationAllowed": true }, - "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" + "stageStatus": "Succeeded", + "stageName": "Delivered", + "displayName": "Delivered - Succeeded", + "startTime": "2020-08-07T10:50:36.3341513+05:30" }, "subscription": { - "id": "guid", + "id": "b783ea86-c85c-4175-b76d-3992656af50d", "state": "Registered", "quotaId": "Internal_2014-09-01" } }, - "inventoryMetadata": "partner specific any serialzed string. Blackbox for service. Service will store and just return it.", + "inventoryMetadata": "This is currently in Japan", "configuration": { "specifications": [ { @@ -81,17 +81,16 @@ }, "inventory": { "additionalData": { - "key1": "Value1", - "key2": "Value2" + "SourceCountry": "USA", + "ManuacturingYear": "2020" } }, "billing": { - "billingType": "Example", - "status": "statusExample" + "billingType": "Pav2", + "status": "InProgress" }, - "secrets": { - "key1": "Value1", - "key2": "Value2" + "inventorySecrets": { + "PublicCert": "" } } } From aecf320286833c3189b7d0a948f57564a1067750 Mon Sep 17 00:00:00 2001 From: Pramila Dhaka Date: Mon, 29 Mar 2021 22:08:26 +0530 Subject: [PATCH 13/13] fixing secret validation error --- .../preview/2020-12-01-preview/edgeorderpartner.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json index b165d976ac91..f36549599067 100644 --- a/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json +++ b/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/edgeorderpartner.json @@ -421,8 +421,7 @@ "additionalProperties": { "type": "string" }, - "readOnly": true, - "x-ms-secret": true + "readOnly": true } } },