diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/edgeorder.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/edgeorder.json new file mode 100644 index 000000000000..5c333bb749f2 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/edgeorder.json @@ -0,0 +1,3893 @@ +{ + "swagger": "2.0", + "info": { + "version": "2022-05-01-preview", + "title": "Edge Ordering Service-Customer" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.EdgeOrder/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "List all the supported operations.", + "operationId": "Operations_List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The supported operations list.", + "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": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/addresses": { + "get": { + "tags": [ + "Addresses" + ], + "description": "List all the addresses available under the subscription.", + "operationId": "Addresses_ListBySubscription", + "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": "$filter", + "in": "query", + "description": "$filter is supported to filter based on shipping address properties. Filter supports only equals operation.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of addresses, which provides the next page in the list of addresses.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of addresses available under the subscription.", + "schema": { + "$ref": "#/definitions/AddressResourceList" + } + }, + "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": { + "ListAddressesAtSubscriptionLevel": { + "$ref": "./examples/ListAddressesAtSubscriptionLevel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listConfigurations": { + "post": { + "tags": [ + "ProductsAndConfigurations" + ], + "description": "List configurations for the given product family, product line and product for the given subscription.", + "operationId": "ProductsAndConfigurations_ListConfigurations", + "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": "$skipToken", + "in": "query", + "description": "$skipToken is supported on list of configurations, which provides the next page in the list of configurations.", + "required": false, + "type": "string" + }, + { + "name": "configurationsRequest", + "in": "body", + "description": "Filters for showing the configurations.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationsRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of configurations for the given product family, product line and product for the given subscription.", + "schema": { + "$ref": "#/definitions/Configurations" + } + }, + "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": { + "ListConfigurations": { + "$ref": "./examples/ListConfigurations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listProductFamilies": { + "post": { + "tags": [ + "ProductsAndConfigurations" + ], + "description": "List product families for the given subscription.", + "operationId": "ProductsAndConfigurations_ListProductFamilies", + "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": "$expand", + "in": "query", + "description": "$expand is supported on configurations parameter for product, which provides details on the configurations for the product.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on list of product families, which provides the next page in the list of product families.", + "required": false, + "type": "string" + }, + { + "name": "productFamiliesRequest", + "in": "body", + "description": "Filters for showing the product families.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductFamiliesRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of available product families for the given subscription.", + "schema": { + "$ref": "#/definitions/ProductFamilies" + } + }, + "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": { + "ListProductFamilies": { + "$ref": "./examples/ListProductFamilies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orderItems": { + "get": { + "tags": [ + "OrderItems" + ], + "description": "List order items at subscription level.", + "operationId": "OrderItems_ListBySubscription", + "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": "$filter", + "in": "query", + "description": "$filter is supported to filter based on order id. Filter supports only equals operation.", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of order items, which provides the next page in the list of order items.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of order items available under the subscription.", + "schema": { + "$ref": "#/definitions/OrderItemResourceList" + } + }, + "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": { + "ListOrderItemsAtSubscriptionLevel": { + "$ref": "./examples/ListOrderItemsAtSubscriptionLevel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders": { + "get": { + "tags": [ + "Order" + ], + "description": "List orders at subscription level.", + "operationId": "Orders_ListBySubscription", + "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": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of orders, which provides the next page in the list of orders.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of orders available under the subscription.", + "schema": { + "$ref": "#/definitions/OrderResourceList" + } + }, + "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": { + "ListOrderAtSubscriptionLevel": { + "$ref": "./examples/ListOrderAtSubscriptionLevel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/productFamiliesMetadata": { + "post": { + "tags": [ + "ProductFamilyMetadata" + ], + "description": "List product families metadata for the given subscription.", + "operationId": "ProductsAndConfigurations_ListProductFamiliesMetadata", + "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": "$skipToken", + "in": "query", + "description": "$skipToken is supported on list of product families metadata, which provides the next page in the list of product families metadata.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The list of available product families for the given subscription.", + "schema": { + "$ref": "#/definitions/ProductFamiliesMetadata" + } + }, + "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": { + "ListProductFamiliesMetadata": { + "$ref": "./examples/ListProductFamiliesMetadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses": { + "get": { + "tags": [ + "Addresses" + ], + "description": "List all the addresses available under the given resource group.", + "operationId": "Addresses_ListByResourceGroup", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "$filter is supported to filter based on shipping address properties. Filter supports only equals operation.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of addresses, which provides the next page in the list of addresses.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of addresses available under the resource group.", + "schema": { + "$ref": "#/definitions/AddressResourceList" + } + }, + "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": { + "ListAddressesAtResourceGroupLevel": { + "$ref": "./examples/ListAddressesAtResourceGroupLevel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}": { + "get": { + "tags": [ + "Addresses" + ], + "description": "Get information about the specified address.", + "operationId": "Addresses_Get", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/addressNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Address object.", + "schema": { + "$ref": "#/definitions/AddressResource" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAddressByName": { + "$ref": "./examples/GetAddressByName.json" + } + } + }, + "put": { + "tags": [ + "Addresses" + ], + "description": "Create a new address with the specified parameters. Existing address cannot be updated with this API and should\r\ninstead be updated with the Update address API.", + "operationId": "Addresses_Create", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/addressNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "addressResource", + "in": "body", + "description": "Address details from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/AddressResource" + } + } + ], + "responses": { + "200": { + "description": "Address resource object.", + "schema": { + "$ref": "#/definitions/AddressResource" + } + }, + "202": { + "description": "Accepted request for create Address." + }, + "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": { + "CreateAddress": { + "$ref": "./examples/CreateAddress.json" + } + } + }, + "delete": { + "tags": [ + "Addresses" + ], + "description": "Delete an address.", + "operationId": "Addresses_Delete", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/addressNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Address deleted." + }, + "202": { + "description": "Accepted request for delete address." + }, + "204": { + "description": "No content. Address deleted." + }, + "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": { + "DeleteAddressByName": { + "$ref": "./examples/DeleteAddressByName.json" + } + } + }, + "patch": { + "tags": [ + "Addresses" + ], + "description": "Update the properties of an existing address.", + "operationId": "Addresses_Update", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/addressNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.", + "required": false, + "type": "string" + }, + { + "name": "addressUpdateParameter", + "in": "body", + "description": "Address update parameters from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/AddressUpdateParameter" + } + } + ], + "responses": { + "202": { + "description": "Accepted request for address update." + }, + "200": { + "description": "Address resource object.", + "schema": { + "$ref": "#/definitions/AddressResource" + } + }, + "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": { + "UpdateAddress": { + "$ref": "./examples/UpdateAddress.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/locations/{location}/orders/{orderName}": { + "get": { + "tags": [ + "Order" + ], + "description": "Get an order.", + "operationId": "Orders_Get", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/orderNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Order resource object.", + "schema": { + "$ref": "#/definitions/OrderResource" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetOrderByName": { + "$ref": "./examples/GetOrderByName.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems": { + "get": { + "tags": [ + "OrderItems" + ], + "description": "List order items at resource group level.", + "operationId": "OrderItems_ListByResourceGroup", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "$filter is supported to filter based on order id. Filter supports only equals operation.", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of order items, which provides the next page in the list of order items.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of order items available under the resource group.", + "schema": { + "$ref": "#/definitions/OrderItemResourceList" + } + }, + "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": { + "ListOrderItemsAtResourceGroupLevel": { + "$ref": "./examples/ListOrderItemsAtResourceGroupLevel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}": { + "get": { + "tags": [ + "OrderItems" + ], + "description": "Get an order item.", + "operationId": "OrderItems_Get", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Order item object.", + "schema": { + "$ref": "#/definitions/OrderItemResource" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetOrderItemByName": { + "$ref": "./examples/GetOrderItemByName.json" + } + } + }, + "put": { + "tags": [ + "OrderItems" + ], + "description": "Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item\r\nAPI.", + "operationId": "OrderItems_Create", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "orderItemResource", + "in": "body", + "description": "Order item details from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/OrderItemResource" + } + } + ], + "responses": { + "200": { + "description": "Order resource object.", + "schema": { + "$ref": "#/definitions/OrderItemResource" + } + }, + "202": { + "description": "Accepted request to create order item." + }, + "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": { + "CreateOrderItem": { + "$ref": "./examples/CreateOrderItem.json" + } + } + }, + "delete": { + "tags": [ + "OrderItems" + ], + "description": "Delete an order item.", + "operationId": "OrderItems_Delete", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Order item deleted." + }, + "202": { + "description": "Accepted delete request for an order item." + }, + "204": { + "description": "No content. Order item deleted." + }, + "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": { + "DeleteOrderItemByName": { + "$ref": "./examples/DeleteOrderItemByName.json" + } + } + }, + "patch": { + "tags": [ + "OrderItems" + ], + "description": "Update the properties of an existing order item.", + "operationId": "OrderItems_Update", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value.", + "required": false, + "type": "string" + }, + { + "name": "orderItemUpdateParameter", + "in": "body", + "description": "Order item update parameters from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/OrderItemUpdateParameter" + } + } + ], + "responses": { + "202": { + "description": "Accepted request for order item update." + }, + "200": { + "description": "Order item resource object.", + "schema": { + "$ref": "#/definitions/OrderItemResource" + } + }, + "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": { + "UpdateOrderItem": { + "$ref": "./examples/UpdateOrderItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/cancel": { + "post": { + "tags": [ + "OrderItems" + ], + "description": "Cancel order item.", + "operationId": "OrderItems_Cancel", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "cancellationReason", + "in": "body", + "description": "Reason for cancellation.", + "required": true, + "schema": { + "$ref": "#/definitions/CancellationReason" + } + } + ], + "responses": { + "200": { + "description": "Order item cancelled." + }, + "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": { + "CancelOrderItem": { + "$ref": "./examples/CancelOrderItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/return": { + "post": { + "tags": [ + "OrderItems" + ], + "description": "Return order item.", + "operationId": "OrderItems_Return", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/orderItemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "returnOrderItemDetails", + "in": "body", + "description": "Return order item details.", + "required": true, + "schema": { + "$ref": "#/definitions/ReturnOrderItemDetails" + } + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Return order item request accepted." + }, + "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": { + "ReturnOrderItem": { + "$ref": "./examples/ReturnOrderItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orders": { + "get": { + "tags": [ + "Order" + ], + "description": "List orders at resource group level.", + "operationId": "Orders_ListByResourceGroup", + "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/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of orders, which provides the next page in the list of orders.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "List of orders available under the resource group.", + "schema": { + "$ref": "#/definitions/OrderResourceList" + } + }, + "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": { + "ListOrderAtResourceGroupLevel": { + "$ref": "./examples/ListOrderAtResourceGroupLevel.json" + } + } + } + } + }, + "definitions": { + "AdditionalConfiguration": { + "description": "Additional Configuration details.", + "required": [ + "hierarchyInformation", + "quantity" + ], + "type": "object", + "properties": { + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Hierarchy of the product which uniquely identifies the configuration." + }, + "quantity": { + "format": "int32", + "description": "Quantity of the product.", + "type": "integer" + } + } + }, + "AddressDetails": { + "description": "Address details for an order item.", + "required": [ + "forwardAddress" + ], + "type": "object", + "properties": { + "forwardAddress": { + "$ref": "#/definitions/AddressProperties", + "description": "Customer address and contact details." + }, + "returnAddress": { + "$ref": "#/definitions/AddressProperties", + "description": "Return shipping address.", + "readOnly": true + } + } + }, + "AddressProperties": { + "description": "Address Properties.", + "required": [ + "contactDetails" + ], + "type": "object", + "properties": { + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping details for the address." + }, + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for the address." + }, + "addressValidationStatus": { + "description": "Status of address validation.", + "enum": [ + "Valid", + "Invalid", + "Ambiguous" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AddressValidationStatus", + "modelAsString": true, + "values": [ + { + "value": "Valid", + "description": "Address provided is valid." + }, + { + "value": "Invalid", + "description": "Address provided is invalid or not supported." + }, + { + "value": "Ambiguous", + "description": "Address provided is ambiguous, please choose one of the alternate addresses returned." + } + ] + } + } + } + }, + "AddressResource": { + "description": "Address Resource.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AddressProperties", + "description": "Properties of an address.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Represents resource creation and update time.", + "readOnly": true + } + } + }, + "AddressResourceList": { + "description": "Address Resource Collection.", + "type": "object", + "properties": { + "value": { + "description": "List of address resources.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/AddressResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of job resources.", + "type": "string" + } + } + }, + "AddressUpdateParameter": { + "description": "The Address update parameters.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddressUpdateProperties", + "description": "Properties of an address to be updated.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AddressUpdateProperties": { + "description": "Address Update Properties.", + "type": "object", + "properties": { + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping details for the address." + }, + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for the address." + } + } + }, + "AvailabilityInformation": { + "description": "Availability information of a product system.", + "type": "object", + "properties": { + "availabilityStage": { + "description": "Current availability stage of the product.", + "enum": [ + "Available", + "Preview", + "Signup", + "Discoverable", + "ComingSoon", + "Unavailable", + "Deprecated" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AvailabilityStage", + "modelAsString": true, + "values": [ + { + "value": "Available", + "description": "Product is available." + }, + { + "value": "Preview", + "description": "Product is in preview." + }, + { + "value": "Signup", + "description": "Product is available only on signup." + }, + { + "value": "Discoverable", + "description": "Product is not available in our service but can be discovered from other sources." + }, + { + "value": "ComingSoon", + "description": "Product is coming soon." + }, + { + "value": "Unavailable", + "description": "Product is not available." + }, + { + "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", + "modelAsString": 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, + "x-ms-identifiers": [] + }, + "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 + }, + "fulfilledBy": { + "description": "The entity responsible for fulfillment of the item at the given hierarchy level.", + "enum": [ + "Microsoft", + "External" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FulfillmentType", + "modelAsString": true, + "values": [ + { + "value": "Microsoft", + "description": "The fulfillment (the whole journey of the product offering) is handled by microsoft." + }, + { + "value": "External", + "description": "The fulfillment (the whole journey of the product offering) is handled by external third party entities." + } + ] + } + } + } + }, + "BillingMeterDetails": { + "description": "Holds billing meter details for each type of billing.", + "type": "object", + "properties": { + "name": { + "description": "Represents Billing type name.", + "type": "string", + "readOnly": true + }, + "meterDetails": { + "$ref": "#/definitions/MeterDetails", + "description": "Represents MeterDetails.", + "readOnly": true + }, + "meteringType": { + "description": "Represents Metering type (eg one-time or recurrent).", + "enum": [ + "OneTime", + "Recurring", + "Adhoc" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MeteringType", + "modelAsString": true, + "values": [ + { + "value": "OneTime", + "description": "One time billing." + }, + { + "value": "Recurring", + "description": "Recurring billing." + }, + { + "value": "Adhoc", + "description": "Adhoc billing." + } + ] + } + }, + "frequency": { + "description": "Frequency of recurrence.", + "type": "string", + "readOnly": true + } + } + }, + "CancellationReason": { + "description": "Reason for cancellation.", + "required": [ + "reason" + ], + "type": "object", + "properties": { + "reason": { + "description": "Reason for cancellation.", + "type": "string" + } + } + }, + "CategoryInformation": { + "description": "Category related properties of a child configuration.", + "type": "object", + "properties": { + "categoryName": { + "description": "Category name of the child configuration.", + "type": "string" + }, + "categoryDisplayName": { + "description": "Category display name of the child configuration.", + "type": "string" + }, + "description": { + "description": "Description text for the category.", + "type": "string" + }, + "links": { + "description": "Links for the category.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Link" + }, + "x-ms-identifiers": [] + } + } + }, + "ChildConfiguration": { + "description": "Child configuration object.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ChildConfigurationProperties", + "description": "Properties of child configuration.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ChildConfigurationFilter": { + "description": "Child configuration filter.", + "type": "object", + "properties": { + "hierarchyInformations": { + "description": "The list of child configuration hierarchy customer wants to filter for the given configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/HierarchyInformation" + }, + "x-ms-identifiers": [] + }, + "childConfigurationTypes": { + "description": "Filter to fetch all child configurations belonging to the given list of configuration types.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "DeviceConfiguration", + "AdditionalConfiguration" + ], + "type": "string", + "x-ms-enum": { + "name": "ChildConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "DeviceConfiguration", + "description": "Child configuration is a device configuration." + }, + { + "value": "AdditionalConfiguration", + "description": "Child configuration is an additional configuration." + } + ] + } + } + } + } + }, + "ChildConfigurationProperties": { + "description": "Properties of child configuration.", + "type": "object", + "properties": { + "childConfigurationType": { + "description": "Child configuration type.", + "enum": [ + "DeviceConfiguration", + "AdditionalConfiguration" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ChildConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "DeviceConfiguration", + "description": "Child configuration is a device configuration." + }, + { + "value": "AdditionalConfiguration", + "description": "Child configuration is an additional configuration." + } + ] + } + }, + "isPartOfBaseConfiguration": { + "description": "Flag to indicate if the child configuration is part of the base configuration, which means the customer need not pass this configuration in OptInAdditionalConfigurations while placing an order, it will be shipped by default.", + "type": "boolean", + "readOnly": true + }, + "minimumQuantity": { + "format": "int32", + "description": "Minimum quantity a customer can order while choosing this configuration.", + "type": "integer", + "readOnly": true + }, + "maximumQuantity": { + "format": "int32", + "description": "Maximum quantity a customer can order while choosing this configuration.", + "type": "integer", + "readOnly": true + }, + "specifications": { + "description": "Specifications of the configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Specification" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "dimensions": { + "$ref": "#/definitions/Dimensions", + "description": "Dimensions of the configuration.", + "readOnly": true + }, + "childConfigurationTypes": { + "description": "Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "DeviceConfiguration", + "AdditionalConfiguration" + ], + "type": "string", + "x-ms-enum": { + "name": "ChildConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "DeviceConfiguration", + "description": "Child configuration is a device configuration." + }, + { + "value": "AdditionalConfiguration", + "description": "Child configuration is an additional configuration." + } + ] + } + }, + "readOnly": true + }, + "groupedChildConfigurations": { + "description": "Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GroupedChildConfigurations" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "filterableProperties": { + "description": "List of filters supported for a product.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/FilterableProperty" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "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, + "x-ms-identifiers": [] + }, + "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 + }, + "fulfilledBy": { + "description": "The entity responsible for fulfillment of the item at the given hierarchy level.", + "enum": [ + "Microsoft", + "External" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FulfillmentType", + "modelAsString": true, + "values": [ + { + "value": "Microsoft", + "description": "The fulfillment (the whole journey of the product offering) is handled by microsoft." + }, + { + "value": "External", + "description": "The fulfillment (the whole journey of the product offering) is handled by external third party entities." + } + ] + } + } + } + }, + "CommonProperties": { + "description": "Represents common properties across 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, + "x-ms-identifiers": [] + } + } + }, + "Configuration": { + "description": "Configuration object.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "description": "Properties of configuration.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ConfigurationDeviceDetails": { + "description": "Device details for configuration.", + "type": "object", + "properties": { + "displayInfo": { + "$ref": "#/definitions/DisplayInfo", + "description": "Display details of the product." + }, + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Hierarchy of the product which uniquely identifies the configuration.", + "readOnly": true + }, + "quantity": { + "format": "int32", + "description": "Quantity of the product.", + "type": "integer", + "readOnly": true + }, + "identificationType": { + "description": "Identification type of the configuration.", + "enum": [ + "NotSupported", + "SerialNumber" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IdentificationType", + "modelAsString": true, + "values": [ + { + "value": "NotSupported", + "description": "Product does not have any explicit identifier." + }, + { + "value": "SerialNumber", + "description": "Product is identifiable by serial number." + } + ] + } + }, + "deviceDetails": { + "description": "List of device details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DeviceDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ConfigurationFilter": { + "description": "Configuration filters.", + "required": [ + "hierarchyInformation" + ], + "type": "object", + "properties": { + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Product hierarchy information." + }, + "filterableProperty": { + "description": "Filters specific to product.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/FilterableProperty" + }, + "x-ms-identifiers": [] + }, + "childConfigurationFilter": { + "$ref": "#/definitions/ChildConfigurationFilter", + "description": "Filter to fetch specific child configurations that exist in the configuration. This must be passed to either fetch a list of specific child configurations, or all child configurations of specific types of child configurations." + } + } + }, + "ConfigurationProperties": { + "description": "Properties of configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonProperties" + } + ], + "properties": { + "specifications": { + "description": "Specifications of the configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Specification" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "dimensions": { + "$ref": "#/definitions/Dimensions", + "description": "Dimensions of the configuration.", + "readOnly": true + }, + "childConfigurationTypes": { + "description": "Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "DeviceConfiguration", + "AdditionalConfiguration" + ], + "type": "string", + "x-ms-enum": { + "name": "ChildConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "DeviceConfiguration", + "description": "Child configuration is a device configuration." + }, + { + "value": "AdditionalConfiguration", + "description": "Child configuration is an additional configuration." + } + ] + } + }, + "readOnly": true + }, + "groupedChildConfigurations": { + "description": "Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GroupedChildConfigurations" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "Configurations": { + "description": "The list of configurations.", + "type": "object", + "properties": { + "value": { + "description": "List of configurations.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link for the next set of configurations.", + "type": "string" + } + } + }, + "ConfigurationsRequest": { + "description": "Configuration request object.", + "type": "object", + "properties": { + "configurationFilter": { + "$ref": "#/definitions/ConfigurationFilter", + "description": "Holds details about product hierarchy information and filterable property." + }, + "customerSubscriptionDetails": { + "$ref": "#/definitions/CustomerSubscriptionDetails", + "description": "Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details." + } + } + }, + "ContactDetails": { + "description": "Contact Details.", + "required": [ + "contactName", + "phone", + "emailList" + ], + "type": "object", + "properties": { + "contactName": { + "description": "Contact name of the person.", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact person.", + "type": "string" + }, + "phoneExtension": { + "description": "Phone extension number of the contact person.", + "type": "string" + }, + "mobile": { + "description": "Mobile number of the contact person.", + "type": "string" + }, + "emailList": { + "description": "List of Email-ids to be notified about job progress.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CostInformation": { + "description": "Cost information for the product system.", + "type": "object", + "properties": { + "billingMeterDetails": { + "description": "Details on the various billing aspects for the product system.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BillingMeterDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "billingInfoUrl": { + "description": "Default url to display billing information.", + "type": "string", + "readOnly": true + } + } + }, + "CustomerSubscriptionDetails": { + "description": "Holds Customer subscription details. Clients can display available products to unregistered customers by explicitly passing subscription details.", + "required": [ + "quotaId" + ], + "type": "object", + "properties": { + "registeredFeatures": { + "description": "List of registered feature flags for subscription.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CustomerSubscriptionRegisteredFeatures" + }, + "x-ms-identifiers": [] + }, + "locationPlacementId": { + "description": "Location placement Id of a subscription.", + "type": "string" + }, + "quotaId": { + "description": "Quota ID of a subscription.", + "type": "string" + } + } + }, + "CustomerSubscriptionRegisteredFeatures": { + "description": "Represents subscription registered features.", + "type": "object", + "properties": { + "name": { + "description": "Name of subscription registered feature.", + "type": "string" + }, + "state": { + "description": "State of subscription registered feature.", + "type": "string" + } + } + }, + "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", + "modelAsString": 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, + "x-ms-identifiers": [] + } + } + }, + "DeviceDetails": { + "description": "Device details.", + "type": "object", + "properties": { + "serialNumber": { + "description": "Device serial number.", + "type": "string", + "readOnly": true + }, + "managementResourceId": { + "description": "Management Resource Id.", + "type": "string", + "readOnly": true + }, + "managementResourceTenantId": { + "description": "Management Resource Tenant ID.", + "type": "string", + "readOnly": true + } + } + }, + "Dimensions": { + "description": "Dimensions of a configuration.", + "type": "object", + "properties": { + "length": { + "format": "double", + "description": "Length of the device.", + "type": "number", + "readOnly": true + }, + "height": { + "format": "double", + "description": "Height of the device.", + "type": "number", + "readOnly": true + }, + "width": { + "format": "double", + "description": "Width of the device.", + "type": "number", + "readOnly": true + }, + "lengthHeightUnit": { + "description": "Unit for the dimensions of length, height and width.", + "enum": [ + "IN", + "CM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "LengthHeightUnit", + "modelAsString": true, + "values": [ + { + "value": "IN", + "description": "Inch, applicable for West US." + }, + { + "value": "CM", + "description": "Centimeter." + } + ] + } + }, + "weight": { + "format": "double", + "description": "Weight of the device.", + "type": "number", + "readOnly": true + }, + "depth": { + "format": "double", + "description": "Depth of the device.", + "type": "number", + "readOnly": true + }, + "weightUnit": { + "description": "Unit for the dimensions of weight.", + "enum": [ + "LBS", + "KGS" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "WeightMeasurementUnit", + "modelAsString": true, + "values": [ + { + "value": "LBS", + "description": "Pounds." + }, + { + "value": "KGS", + "description": "Kilograms." + } + ] + } + } + } + }, + "DisplayInfo": { + "description": "Describes product display information.", + "type": "object", + "properties": { + "productFamilyDisplayName": { + "description": "Product family display name.", + "type": "string", + "readOnly": true + }, + "configurationDisplayName": { + "description": "Configuration display name.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionPreferences": { + "description": "Preferences related to the double encryption.", + "type": "object", + "properties": { + "doubleEncryptionStatus": { + "description": "Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DoubleEncryptionStatus", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "Double encryption is disabled." + }, + { + "value": "Enabled", + "description": "Double encryption is enabled." + } + ] + } + } + } + }, + "FilterableProperty": { + "description": "Different types of filters supported and its values.", + "required": [ + "type", + "supportedValues" + ], + "type": "object", + "properties": { + "type": { + "description": "Type of product filter.", + "enum": [ + "ShipToCountries", + "DoubleEncryptionStatus" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportedFilterTypes", + "modelAsString": true, + "values": [ + { + "value": "ShipToCountries", + "description": "Ship to country." + }, + { + "value": "DoubleEncryptionStatus", + "description": "Double encryption status." + } + ] + } + }, + "supportedValues": { + "description": "Values to be filtered.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ForwardShippingDetails": { + "description": "Forward shipment details.", + "type": "object", + "properties": { + "carrierName": { + "description": "Name of the carrier.", + "type": "string", + "readOnly": true + }, + "carrierDisplayName": { + "description": "Carrier Name for display purpose. Not to be used for any processing.", + "type": "string", + "readOnly": true + }, + "trackingId": { + "description": "TrackingId of the package.", + "type": "string", + "readOnly": true + }, + "trackingUrl": { + "description": "TrackingUrl of the package.", + "type": "string", + "readOnly": true + } + } + }, + "GroupedChildConfigurations": { + "description": "Grouped child configuration object.", + "type": "object", + "properties": { + "categoryInformation": { + "$ref": "#/definitions/CategoryInformation", + "description": "Category information.", + "readOnly": true + }, + "childConfigurations": { + "description": "List of child configurations.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ChildConfiguration" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "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", + "modelAsString": 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 + } + } + }, + "Link": { + "description": "Returns link related to the product.", + "type": "object", + "properties": { + "linkType": { + "description": "Type of link.", + "enum": [ + "Generic", + "TermsAndConditions", + "Specification", + "Documentation", + "KnowMore", + "SignUp", + "Discoverable" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "LinkType", + "modelAsString": 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." + }, + { + "value": "Discoverable", + "description": "Link to order the product from another source and not from Azure Edge Hardware Center." + } + ] + } + }, + "linkUrl": { + "description": "Url of the link.", + "type": "string", + "readOnly": true + } + } + }, + "ManagementResourcePreferences": { + "description": "Management resource preference to link device.", + "type": "object", + "properties": { + "preferredManagementResourceId": { + "description": "Customer preferred Management resource ARM ID.", + "type": "string" + } + } + }, + "MeterDetails": { + "description": "Holds details about billing type and its meter guids.", + "required": [ + "billingType" + ], + "type": "object", + "properties": { + "billingType": { + "description": "Represents billing type.", + "enum": [ + "Pav2", + "Purchase" + ], + "type": "string", + "x-ms-enum": { + "name": "BillingType", + "modelAsString": true, + "values": [ + { + "value": "Pav2", + "description": "PaV2 billing." + }, + { + "value": "Purchase", + "description": "Purchase billing." + } + ] + } + }, + "multiplier": { + "format": "double", + "description": "Billing unit applicable for Pav2 billing.", + "type": "number", + "readOnly": true + }, + "chargingType": { + "description": "Charging type.", + "enum": [ + "PerOrder", + "PerDevice" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ChargingType", + "modelAsString": true, + "values": [ + { + "value": "PerOrder", + "description": "Per order charging type." + }, + { + "value": "PerDevice", + "description": "Per device charging type." + } + ] + } + } + }, + "discriminator": "billingType" + }, + "NotificationPreference": { + "description": "Notification preference for a job stage.", + "required": [ + "stageName", + "sendNotification" + ], + "type": "object", + "properties": { + "stageName": { + "description": "Name of the stage.", + "enum": [ + "Shipped", + "Delivered" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationStageName", + "modelAsString": true, + "values": [ + { + "value": "Shipped", + "description": "Notification at order item shipped from microsoft datacenter." + }, + { + "value": "Delivered", + "description": "Notification at order item delivered to customer." + } + ] + } + }, + "sendNotification": { + "description": "Notification is required or not.", + "type": "boolean" + } + } + }, + "OrderItemDetails": { + "description": "Order item details.", + "required": [ + "productDetails", + "orderItemType" + ], + "type": "object", + "properties": { + "productDetails": { + "$ref": "#/definitions/ProductDetails", + "description": "Unique identifier for configuration." + }, + "orderItemType": { + "description": "Order item type.", + "enum": [ + "Purchase", + "Rental" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderItemType", + "modelAsString": true, + "values": [ + { + "value": "Purchase", + "description": "Purchase OrderItem." + }, + { + "value": "Rental", + "description": "Rental OrderItem." + } + ] + } + }, + "orderItemMode": { + "description": "Defines the mode of the Order item.", + "enum": [ + "Default", + "DoNotFulfill" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderMode", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Default Order mode." + }, + { + "value": "DoNotFulfill", + "description": "Mode in which the Order will not be fulfilled." + } + ] + } + }, + "currentStage": { + "$ref": "#/definitions/StageDetails", + "description": "Current Order item Status.", + "readOnly": true + }, + "orderItemStageHistory": { + "description": "Order item status history.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/StageDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "preferences": { + "$ref": "#/definitions/Preferences", + "description": "Customer notification Preferences." + }, + "forwardShippingDetails": { + "$ref": "#/definitions/ForwardShippingDetails", + "description": "Forward Package Shipping details.", + "readOnly": true + }, + "reverseShippingDetails": { + "$ref": "#/definitions/ReverseShippingDetails", + "description": "Reverse Package Shipping details.", + "readOnly": true + }, + "notificationEmailList": { + "description": "Additional notification email list.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "cancellationReason": { + "description": "Cancellation reason.", + "type": "string", + "readOnly": true + }, + "cancellationStatus": { + "description": "Describes whether the order item is cancellable or not.", + "enum": [ + "Cancellable", + "CancellableWithFee", + "NotCancellable" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OrderItemCancellationEnum", + "modelAsString": true, + "values": [ + { + "value": "Cancellable", + "description": "Order item can be cancelled without fee." + }, + { + "value": "CancellableWithFee", + "description": "Order item can be cancelled with fee." + }, + { + "value": "NotCancellable", + "description": "Order item not cancellable." + } + ] + } + }, + "deletionStatus": { + "description": "Describes whether the order item is deletable or not.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ActionStatusEnum", + "modelAsString": true, + "values": [ + { + "value": "Allowed", + "description": "Allowed flag." + }, + { + "value": "NotAllowed", + "description": "Not Allowed flag." + } + ] + } + }, + "returnReason": { + "description": "Return reason.", + "type": "string", + "readOnly": true + }, + "returnStatus": { + "description": "Describes whether the order item is returnable or not.", + "enum": [ + "Returnable", + "ReturnableWithFee", + "NotReturnable" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OrderItemReturnEnum", + "modelAsString": true, + "values": [ + { + "value": "Returnable", + "description": "Order item can be returned without fee." + }, + { + "value": "ReturnableWithFee", + "description": "Order item can be returned with fee." + }, + { + "value": "NotReturnable", + "description": "Order item not returnable." + } + ] + } + }, + "managementRpDetailsList": { + "description": "List of parent RP details supported for configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail", + "description": "Top level error for the job.", + "readOnly": true + } + } + }, + "OrderItemProperties": { + "description": "Represents order item properties.", + "required": [ + "orderItemDetails", + "addressDetails", + "orderId" + ], + "type": "object", + "properties": { + "orderItemDetails": { + "$ref": "#/definitions/OrderItemDetails", + "description": "Represents order item details." + }, + "addressDetails": { + "$ref": "#/definitions/AddressDetails", + "description": "Represents shipping and return address for order item." + }, + "startTime": { + "format": "date-time", + "description": "Start time of order item.", + "type": "string", + "readOnly": true + }, + "orderId": { + "description": "Id of the order to which order item belongs to.", + "type": "string" + } + } + }, + "OrderItemResource": { + "description": "Represents order item resource.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OrderItemProperties", + "description": "Order item properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Represents resource creation and update time.", + "readOnly": true + } + } + }, + "OrderItemResourceList": { + "description": "List of order items.", + "type": "object", + "properties": { + "value": { + "description": "List of order item resources.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OrderItemResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of order item resources.", + "type": "string" + } + } + }, + "OrderItemUpdateParameter": { + "description": "Updates order item parameters.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OrderItemUpdateProperties", + "description": "Order item update properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OrderItemUpdateProperties": { + "description": "Order item update properties.", + "type": "object", + "properties": { + "forwardAddress": { + "$ref": "#/definitions/AddressProperties", + "description": "Updates forward shipping address and contact details." + }, + "preferences": { + "$ref": "#/definitions/Preferences", + "description": "Customer preference." + }, + "notificationEmailList": { + "description": "Additional notification email list.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "OrderProperties": { + "description": "Represents order details.", + "type": "object", + "properties": { + "orderItemIds": { + "description": "List of order item ARM Ids which are part of an order.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "currentStage": { + "$ref": "#/definitions/StageDetails", + "description": "Order current status.", + "readOnly": true + }, + "orderStageHistory": { + "description": "Order status history.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/StageDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "orderMode": { + "description": "Order mode.", + "enum": [ + "Default", + "DoNotFulfill" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OrderMode", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Default Order mode." + }, + { + "value": "DoNotFulfill", + "description": "Mode in which the Order will not be fulfilled." + } + ] + } + } + } + }, + "OrderResource": { + "description": "Specifies the properties or parameters for an order. Order is a grouping of one or more order items.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OrderProperties", + "description": "Order properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Represents resource creation and update time.", + "readOnly": true + } + } + }, + "OrderResourceList": { + "description": "List of orders.", + "type": "object", + "properties": { + "value": { + "description": "List of order resources.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OrderResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of order resources.", + "type": "string" + } + } + }, + "Pav2MeterDetails": { + "description": "Billing type PAV2 meter details.", + "required": [ + "billingType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MeterDetails" + } + ], + "properties": { + "meterGuid": { + "description": "Validation status of requested data center and transport.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "Pav2" + }, + "Preferences": { + "description": "Preferences related to the order.", + "type": "object", + "properties": { + "notificationPreferences": { + "description": "Notification preferences.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/NotificationPreference" + }, + "x-ms-identifiers": [] + }, + "transportPreferences": { + "$ref": "#/definitions/TransportPreferences", + "description": "Preferences related to the shipment logistics of the order." + }, + "encryptionPreferences": { + "$ref": "#/definitions/EncryptionPreferences", + "description": "Preferences related to the Encryption." + }, + "managementResourcePreferences": { + "$ref": "#/definitions/ManagementResourcePreferences", + "description": "Preferences related to the Management resource." + } + } + }, + "Product": { + "description": "Represents a product.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ProductProperties", + "description": "Properties of product.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ProductDetails": { + "description": "Represents product details.", + "required": [ + "hierarchyInformation" + ], + "type": "object", + "properties": { + "displayInfo": { + "$ref": "#/definitions/DisplayInfo", + "description": "Display details of the product." + }, + "hierarchyInformation": { + "$ref": "#/definitions/HierarchyInformation", + "description": "Hierarchy of the product which uniquely identifies the product." + }, + "productDoubleEncryptionStatus": { + "description": "Double encryption status of the configuration. Read-only field.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DoubleEncryptionStatus", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "Double encryption is disabled." + }, + { + "value": "Enabled", + "description": "Double encryption is enabled." + } + ] + } + }, + "identificationType": { + "description": "Identification type of the configuration.", + "enum": [ + "NotSupported", + "SerialNumber" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IdentificationType", + "modelAsString": true, + "values": [ + { + "value": "NotSupported", + "description": "Product does not have any explicit identifier." + }, + { + "value": "SerialNumber", + "description": "Product is identifiable by serial number." + } + ] + } + }, + "parentDeviceDetails": { + "$ref": "#/definitions/DeviceDetails", + "description": "Device details of the parent configuration.", + "readOnly": true + }, + "optInAdditionalConfigurations": { + "description": "List of additional configurations customer wants in the order item apart from the ones included in the base configuration.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalConfiguration" + }, + "x-ms-identifiers": [] + }, + "childConfigurationDeviceDetails": { + "description": "Details of all child configurations that are part of the order item.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationDeviceDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ProductFamilies": { + "description": "The list of product families.", + "type": "object", + "properties": { + "value": { + "description": "List of product families.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ProductFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link for the next set of product families.", + "type": "string" + } + } + }, + "ProductFamiliesMetadata": { + "description": "Holds details about product family metadata.", + "type": "object", + "properties": { + "value": { + "description": "List of product family metadata details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ProductFamiliesMetadataDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link for the next set of product families.", + "type": "string", + "readOnly": true + } + } + }, + "ProductFamiliesMetadataDetails": { + "description": "Product families metadata details.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ProductFamilyProperties", + "description": "Product family properties.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ProductFamiliesRequest": { + "description": "The filters for showing the product families.", + "required": [ + "filterableProperties" + ], + "type": "object", + "properties": { + "filterableProperties": { + "description": "Dictionary of filterable properties on product family.", + "type": "object", + "additionalProperties": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/FilterableProperty" + }, + "x-ms-identifiers": [] + } + }, + "customerSubscriptionDetails": { + "$ref": "#/definitions/CustomerSubscriptionDetails", + "description": "Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details." + } + } + }, + "ProductFamily": { + "description": "Product Family.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ProductFamilyProperties", + "description": "Properties of product family.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ProductFamilyProperties": { + "description": "Properties of product family.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonProperties" + } + ], + "properties": { + "productLines": { + "description": "List of product lines supported in the product family.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ProductLine" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "resourceProviderDetails": { + "description": "Contains details related to resource provider.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "ProductLine": { + "description": "Product line.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ProductLineProperties", + "description": "Properties of product line.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ProductLineProperties": { + "description": "Properties of product line.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonProperties" + } + ], + "properties": { + "products": { + "description": "List of products in the product line.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Product" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ProductProperties": { + "description": "Properties of product.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonProperties" + } + ], + "properties": { + "configurations": { + "description": "List of configurations for the product.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "PurchaseMeterDetails": { + "description": "Billing type Purchase meter details.", + "required": [ + "billingType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MeterDetails" + } + ], + "properties": { + "productId": { + "description": "Product Id.", + "type": "string", + "readOnly": true + }, + "skuId": { + "description": "Sku Id.", + "type": "string", + "readOnly": true + }, + "termId": { + "description": "Term Id.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "Purchase" + }, + "ResourceMoveRequest": { + "type": "object", + "properties": { + "targetResourceGroup": { + "type": "string" + }, + "resources": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ResourceProviderDetails": { + "description": "Management RP details.", + "type": "object", + "properties": { + "resourceProviderNamespace": { + "description": "Resource provider namespace.", + "type": "string", + "readOnly": true + } + } + }, + "ReturnOrderItemDetails": { + "description": "Return order item request body.", + "required": [ + "returnReason" + ], + "type": "object", + "properties": { + "returnAddress": { + "$ref": "#/definitions/AddressProperties", + "description": "Customer return address." + }, + "returnReason": { + "description": "Return Reason.", + "type": "string" + }, + "serviceTag": { + "description": "Service tag (located on the bottom-right corner of the device).", + "type": "string" + }, + "shippingBoxRequired": { + "description": "Shipping Box required.", + "default": false, + "type": "boolean" + } + } + }, + "ReverseShippingDetails": { + "description": "Reverse shipment details.", + "type": "object", + "properties": { + "sasKeyForLabel": { + "description": "SAS key to download the reverse shipment label of the package.", + "type": "string", + "readOnly": true + }, + "carrierName": { + "description": "Name of the carrier.", + "type": "string", + "readOnly": true + }, + "carrierDisplayName": { + "description": "Carrier Name for display purpose. Not to be used for any processing.", + "type": "string", + "readOnly": true + }, + "trackingId": { + "description": "TrackingId of the package.", + "type": "string", + "readOnly": true + }, + "trackingUrl": { + "description": "TrackingUrl of the package.", + "type": "string", + "readOnly": true + } + } + }, + "ShippingAddress": { + "description": "Shipping address where customer wishes to receive the device.", + "required": [ + "streetAddress1", + "country" + ], + "type": "object", + "properties": { + "streetAddress1": { + "description": "Street Address line 1.", + "type": "string" + }, + "streetAddress2": { + "description": "Street Address line 2.", + "type": "string" + }, + "streetAddress3": { + "description": "Street Address line 3.", + "type": "string" + }, + "city": { + "description": "Name of the City.", + "type": "string" + }, + "stateOrProvince": { + "description": "Name of the State or Province.", + "type": "string" + }, + "country": { + "description": "Name of the Country.", + "type": "string" + }, + "postalCode": { + "description": "Postal code.", + "type": "string" + }, + "zipExtendedCode": { + "description": "Extended Zip Code.", + "type": "string" + }, + "companyName": { + "description": "Name of the company.", + "type": "string" + }, + "addressType": { + "description": "Type of address.", + "enum": [ + "None", + "Residential", + "Commercial" + ], + "type": "string", + "x-ms-enum": { + "name": "AddressType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Address type not known." + }, + { + "value": "Residential", + "description": "Residential Address." + }, + { + "value": "Commercial", + "description": "Commercial Address." + } + ] + } + } + } + }, + "Specification": { + "description": "Specification of the configurations.", + "type": "object", + "properties": { + "name": { + "description": "Name of the specification.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Value of the specification.", + "type": "string", + "readOnly": true + } + } + }, + "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", + "modelAsString": 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": [ + "Placed", + "InReview", + "Confirmed", + "ReadyToShip", + "Shipped", + "Delivered", + "InUse", + "ReturnInitiated", + "ReturnPickedUp", + "ReturnedToMicrosoft", + "ReturnCompleted", + "Cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageName", + "modelAsString": true, + "values": [ + { + "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": "ReadyToShip", + "description": "Order is ready to ship." + }, + { + "value": "Shipped", + "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." + }, + { + "value": "ReturnInitiated", + "description": "Return has been initiated by customer." + }, + { + "value": "ReturnPickedUp", + "description": "Order is in transit from customer to Microsoft." + }, + { + "value": "ReturnedToMicrosoft", + "description": "Order has been received back to Microsoft." + }, + { + "value": "ReturnCompleted", + "description": "Return has now completed." + }, + { + "value": "Cancelled", + "description": "Order has been cancelled." + } + ] + } + }, + "displayName": { + "description": "Display name of the resource stage.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Stage start time.", + "type": "string", + "readOnly": true + } + } + }, + "TransportPreferences": { + "description": "Preferences related to the shipment logistics of the sku.", + "required": [ + "preferredShipmentType" + ], + "type": "object", + "properties": { + "preferredShipmentType": { + "description": "Indicates Shipment Logistics type that the customer preferred.", + "enum": [ + "CustomerManaged", + "MicrosoftManaged" + ], + "type": "string", + "x-ms-enum": { + "name": "TransportShipmentTypes", + "modelAsString": true, + "values": [ + { + "value": "CustomerManaged", + "description": "Shipment Logistics is handled by the customer." + }, + { + "value": "MicrosoftManaged", + "description": "Shipment Logistics is handled by Microsoft." + } + ] + } + } + } + } + }, + "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" + }, + "orderItemNameParameter": { + "name": "orderItemName", + "in": "path", + "description": "The name of the order item.", + "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" + ] + } + ], + "tags": [] +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/CancelOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/CancelOrderItem.json new file mode 100644 index 000000000000..f1892623bbd5 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/CancelOrderItem.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderItemName3", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3/cancel?api-version=2021-12-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "34" + ], + "cancellationReason": { + "reason": "Order cancelled" + } + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/CreateAddress.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/CreateAddress.json new file mode 100644 index 000000000000..136d37a636f0 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/CreateAddress.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "addressName": "TestAddressName2", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2?api-version=2021-12-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "527" + ], + "addressResource": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestAddressName2", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + } + }, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/CreateOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/CreateOrderItem.json new file mode 100644 index 000000000000..a99c15adc66c --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/CreateOrderItem.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderItemName2", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2?api-version=2021-12-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1228" + ], + "orderItemResource": { + "properties": { + "orderItemDetails": { + "orderItemType": "Purchase", + "productDetails": { + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + } + }, + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + } + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + } + } + }, + "orderId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "InProgress", + "stageName": "Placed", + "startTime": "2022-03-04T10:58:27.5824859+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "None", + "stageName": "Placed" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:58:27.5824859+05:30", + "orderId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName2", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2", + "type": "Microsoft.EdgeOrder/orderItems" + } + }, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/DeleteAddressByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/DeleteAddressByName.json new file mode 100644 index 000000000000..3c8ea085958c --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/DeleteAddressByName.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "addressName": "TestAddressName1", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1?api-version=2021-12-01" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/DeleteOrderItemByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/DeleteOrderItemByName.json new file mode 100644 index 000000000000..c703c87e0960 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/DeleteOrderItemByName.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderItemName3", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3?api-version=2021-12-01" + ] + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/GetAddressByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/GetAddressByName.json new file mode 100644 index 000000000000..505d3f331b92 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/GetAddressByName.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "addressName": "TestAddressName1", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestAddressName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1", + "type": "Microsoft.EdgeOrder/addresses" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/GetOrderByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/GetOrderByName.json new file mode 100644 index 000000000000..7ee9df849908 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/GetOrderByName.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "location": "eastus", + "orderName": "TestOrderName3", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemIds": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3" + ], + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "InReview", + "startTime": "2022-03-04T11:35:20.8521455+05:30" + }, + "orderStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T11:30:30.2717243+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "InReview", + "startTime": "2022-03-04T11:35:20.8521455+05:30" + } + ] + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "name": "TestOrderName3", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3", + "type": "Microsoft.EdgeOrder/orders" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/GetOrderItemByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/GetOrderItemByName.json new file mode 100644 index 000000000000..470638e9f276 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/GetOrderItemByName.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderItemName1", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:54.3427968+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "NotCancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:55:10.2820482+05:30", + "orderId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1", + "type": "Microsoft.EdgeOrder/orderItems" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListAddressesAtResourceGroupLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListAddressesAtResourceGroupLevel.json new file mode 100644 index 000000000000..a7b3ecba746e --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListAddressesAtResourceGroupLevel.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestAddressName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1", + "type": "Microsoft.EdgeOrder/addresses" + }, + { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "YYYY YYYY", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "TestAddressName2", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListAddressesAtSubscriptionLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListAddressesAtSubscriptionLevel.json new file mode 100644 index 000000000000..dbe104935431 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListAddressesAtSubscriptionLevel.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.EdgeOrder/addresses?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestAddressName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1", + "type": "Microsoft.EdgeOrder/addresses" + }, + { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestAddressName2", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListConfigurations.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListConfigurations.json new file mode 100644 index 000000000000..42045de2e2e9 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListConfigurations.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.EdgeOrder/listConfigurations?api-version=2021-12-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "360" + ], + "configurationsRequest": { + "configurationFilter": { + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu" + }, + "filterableProperty": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "specifications": [ + { + "name": "Usable compute", + "value": "40 vCPU" + }, + { + "name": "Usable memory", + "value": "102 GB" + }, + { + "name": "Usable storage", + "value": "4.2 TB" + } + ], + "dimensions": { + "length": 50, + "height": 15, + "width": 5, + "lengthHeightUnit": "IN", + "weight": 50, + "depth": 2, + "weightUnit": "LBS" + }, + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + } + ], + "displayName": "Azure Stack Edge Pro - 1 GPU", + "description": { + "descriptionType": "Base", + "shortDescription": "", + "longDescription": "", + "keywords": [ + "GPU" + ], + "attributes": [], + "links": [] + }, + "imageInformation": [], + "costInformation": { + "billingMeterDetails": [] + }, + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + } + } + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOperations.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOperations.json new file mode 100644 index 000000000000..3aa26213d76e --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOperations.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/providers/Microsoft.EdgeOrder/operations?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.EdgeOrder/addresses/read", + "display": { + "provider": "Edge Ordering", + "resource": "Addresses", + "operation": "List or Get Addresses", + "description": "List or get the Addresses" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/addresses/delete", + "display": { + "provider": "Edge Ordering", + "resource": "Addresses", + "operation": "Delete Addresses", + "description": "Delete the Addresses" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/addresses/write", + "display": { + "provider": "Edge Ordering", + "resource": "Addresses", + "operation": "Create or Update Addresses", + "description": "Create or update the Addresses" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/locations/operationResults/read", + "display": { + "provider": "Edge Ordering", + "resource": "Operation Results", + "operation": "List or Get Operation Results", + "description": "List or get the Operation Results" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/operations/read", + "display": { + "provider": "Edge Ordering", + "resource": "Operations", + "operation": "List or Get Operations", + "description": "List or get the Operations" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/locations/orders/read", + "display": { + "provider": "Edge Ordering", + "resource": "Order", + "operation": "List or Get Order", + "description": "List or get the Order" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orders/read", + "display": { + "provider": "Edge Ordering", + "resource": "Order", + "operation": "List or Get Order", + "description": "List or get the Order" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orderItems/cancel/action", + "display": { + "provider": "Edge Ordering", + "resource": "OrderItem", + "operation": "Cancel OrderItem", + "description": "Cancels an OrderItem in progress." + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orderItems/return/action", + "display": { + "provider": "Edge Ordering", + "resource": "OrderItem", + "operation": "Return OrderItem", + "description": "Return an OrderItem." + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orderItems/read", + "display": { + "provider": "Edge Ordering", + "resource": "OrderItem", + "operation": "List or Get OrderItem", + "description": "List or get the OrderItem" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orderItems/delete", + "display": { + "provider": "Edge Ordering", + "resource": "OrderItem", + "operation": "Delete OrderItem", + "description": "Delete the OrderItem" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/orderItems/write", + "display": { + "provider": "Edge Ordering", + "resource": "OrderItem", + "operation": "Create or Update OrderItem", + "description": "Create or update the OrderItem" + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/productFamiliesMetadata/action", + "display": { + "provider": "Edge Ordering", + "resource": "ArmApiRes_Microsoft.EdgeOrder", + "operation": "List or Get product families metadata", + "description": "This method lists or gets the product families metadata." + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/listProductFamilies/read", + "display": { + "provider": "Edge Ordering", + "resource": "ArmApiRes_Microsoft.EdgeOrder", + "operation": "List Product Families", + "description": "This method returns list of product families." + }, + "origin": "user", + "isDataAction": false + }, + { + "name": "Microsoft.EdgeOrder/listConfigurations/action", + "display": { + "provider": "Edge Ordering", + "resource": "ArmApiRes_Microsoft.EdgeOrder", + "operation": "List Product Configurations", + "description": "This method returns list of product configurations." + }, + "origin": "user", + "isDataAction": false + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderAtResourceGroupLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderAtResourceGroupLevel.json new file mode 100644 index 000000000000..9835a330329f --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderAtResourceGroupLevel.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orders?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "orderItemIds": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1" + ], + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:46.9437439+05:30" + }, + "orderStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:46.9437439+05:30" + }, + { + "stageStatus": "None", + "stageName": "InReview" + } + ] + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "name": "TestOrderItemName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1", + "type": "Microsoft.EdgeOrder/orders" + }, + { + "properties": { + "orderItemIds": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2" + ], + "currentStage": { + "stageStatus": "InProgress", + "stageName": "Placed", + "startTime": "2022-03-04T10:58:46.5241979+05:30" + }, + "orderStageHistory": [ + { + "stageStatus": "None", + "stageName": "Placed" + }, + { + "stageStatus": "None", + "stageName": "InReview" + } + ] + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "name": "TestOrderItemName2", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2", + "type": "Microsoft.EdgeOrder/orders" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderAtSubscriptionLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderAtSubscriptionLevel.json new file mode 100644 index 000000000000..a89adc91482d --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderAtSubscriptionLevel.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.EdgeOrder/orders?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "orderItemIds": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1" + ], + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:46.9437439+05:30" + }, + "orderStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:46.9437439+05:30" + }, + { + "stageStatus": "None", + "stageName": "InReview" + } + ] + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "name": "TestOrderItemName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1", + "type": "Microsoft.EdgeOrder/orders" + }, + { + "properties": { + "orderItemIds": [ + "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2" + ], + "currentStage": { + "stageStatus": "InProgress", + "stageName": "Placed", + "startTime": "2022-03-04T10:58:46.5241979+05:30" + }, + "orderStageHistory": [ + { + "stageStatus": "None", + "stageName": "Placed" + }, + { + "stageStatus": "None", + "stageName": "InReview" + } + ] + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "name": "TestOrderItemName2", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2", + "type": "Microsoft.EdgeOrder/orders" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderItemsAtResourceGroupLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderItemsAtResourceGroupLevel.json new file mode 100644 index 000000000000..1420f50df7b8 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderItemsAtResourceGroupLevel.json @@ -0,0 +1,223 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:54.3427968+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "NotCancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:55:10.2820482+05:30", + "orderId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1", + "type": "Microsoft.EdgeOrder/orderItems" + }, + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:07:29.9896685+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:59:04.9701334+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:07:29.9896685+05:30" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "NotCancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:58:27.5824859+05:30", + "orderId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName2", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2", + "type": "Microsoft.EdgeOrder/orderItems" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderItemsAtSubscriptionLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderItemsAtSubscriptionLevel.json new file mode 100644 index 000000000000..49bb22c54d35 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListOrderItemsAtSubscriptionLevel.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.EdgeOrder/orderItems?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:55:54.3427968+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:05:00.3575338+05:30" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "NotCancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:55:10.2820482+05:30", + "orderId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName1", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1", + "type": "Microsoft.EdgeOrder/orderItems" + }, + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:07:29.9896685+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T10:59:04.9701334+05:30" + }, + { + "stageStatus": "Succeeded", + "stageName": "Confirmed", + "startTime": "2022-03-04T11:07:29.9896685+05:30" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "NotCancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T10:58:27.5824859+05:30", + "orderId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName2", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2", + "type": "Microsoft.EdgeOrder/orderItems" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListProductFamilies.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListProductFamilies.json new file mode 100644 index 000000000000..a82038ea03c4 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListProductFamilies.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "api-version": "2022-05-01-preview", + "$expand": "configurations", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.EdgeOrder/listProductFamilies?api-version=2021-12-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "159" + ], + "productFamiliesRequest": { + "filterableProperties": { + "azurestackedge": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "productLines": [ + { + "properties": { + "products": [ + { + "properties": { + "configurations": [ + { + "properties": { + "specifications": [ + { + "name": "Usable compute", + "value": "40 vCPU" + }, + { + "name": "Usable memory", + "value": "102 GB" + }, + { + "name": "Usable storage", + "value": "4.2 TB" + } + ], + "dimensions": { + "length": 50, + "height": 15, + "width": 5, + "lengthHeightUnit": "IN", + "weight": 50, + "depth": 2, + "weightUnit": "LBS" + }, + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + } + ], + "displayName": "Azure Stack Edge Pro - 1 GPU", + "description": { + "descriptionType": "Base", + "shortDescription": "", + "longDescription": "", + "keywords": [ + "GPU" + ], + "attributes": [], + "links": [] + }, + "imageInformation": [], + "costInformation": { + "billingMeterDetails": [] + }, + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + } + } + } + ], + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + } + ], + "displayName": "Azure Stack Edge Pro - GPU", + "description": { + "descriptionType": "Base", + "shortDescription": "Azure managed physical edge compute device", + "longDescription": "Azure Stack Edge Pro is an AI-enabled edge computing device with network data transfer capabilities. The device is powered with NVIDIA T4 GPUs to provide accelerated AI inferencing at the edge. You can choose from the following configurations based upon your business need", + "keywords": [ + "GPU" + ], + "attributes": [ + "1U rack mount device with network data transfer capabilities", + "Hardware accelerated ML using Nvidia T4 GPU", + "Azure Private Edge Zones enabled" + ], + "links": [ + { + "linkType": "Specification", + "linkUrl": "https://aka.ms/edgeHWcenter-asepro-devicespec" + }, + { + "linkType": "Generic", + "linkUrl": "https://aka.ms/ase-gpu-billing" + }, + { + "linkType": "TermsAndConditions", + "linkUrl": "https://aka.ms/ase-gpu-product-terms" + }, + { + "linkType": "KnowMore", + "linkUrl": "https://aka.ms/edgeHWcenter-asepro-documentation" + } + ] + }, + "imageInformation": [], + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "" + } + } + } + ], + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + }, + { + "type": "DoubleEncryptionStatus", + "supportedValues": [ + "Enabled" + ] + } + ], + "displayName": "Azure Stack Edge", + "description": { + "descriptionType": "Base", + "keywords": [], + "attributes": [], + "links": [] + }, + "imageInformation": [], + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "", + "configurationName": "" + } + } + } + ], + "resourceProviderDetails": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ], + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + }, + { + "type": "DoubleEncryptionStatus", + "supportedValues": [ + "Enabled" + ] + } + ], + "displayName": "Azure Stack Edge", + "description": { + "descriptionType": "Base", + "shortDescription": "Azure managed physical edge compute device", + "keywords": [], + "attributes": [], + "links": [] + }, + "imageInformation": [], + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "", + "productName": "", + "configurationName": "" + } + } + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListProductFamiliesMetadata.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListProductFamiliesMetadata.json new file mode 100644 index 000000000000..e105bb4cf7dd --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ListProductFamiliesMetadata.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.EdgeOrder/productFamiliesMetadata?api-version=2021-12-01" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "productLines": [], + "resourceProviderDetails": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ], + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + }, + { + "type": "DoubleEncryptionStatus", + "supportedValues": [ + "Enabled" + ] + } + ], + "displayName": "Azure Stack Edge", + "description": { + "descriptionType": "Base", + "shortDescription": "Azure managed physical edge compute device", + "keywords": [], + "attributes": [], + "links": [] + }, + "imageInformation": [], + "availabilityInformation": { + "availabilityStage": "Available", + "disabledReason": "None" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "", + "productName": "", + "configurationName": "" + } + } + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ReturnOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ReturnOrderItem.json new file mode 100644 index 000000000000..23681f8e9ee4 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/ReturnOrderItem.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderName4", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName4/return?api-version=2021-12-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "39" + ], + "returnOrderItemDetails": { + "returnReason": "Order returned" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/UpdateAddress.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/UpdateAddress.json new file mode 100644 index 000000000000..561fc4a3588f --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/UpdateAddress.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "addressName": "TestAddressName2", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2?api-version=2021-12-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "517" + ], + "addressUpdateParameter": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "YYYY YYYY", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "YYYY YYYY", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "TestAddressName2", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + } + }, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/UpdateOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/UpdateOrderItem.json new file mode 100644 index 000000000000..3cd5e72b468f --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/examples/UpdateOrderItem.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "YourSubscriptionId", + "resourceGroupName": "YourResourceGroupName", + "orderItemName": "TestOrderItemName3", + "api-version": "2022-05-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3?api-version=2021-12-01" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "175" + ], + "orderItemUpdateParameter": { + "properties": { + "preferences": { + "transportPreferences": { + "preferredShipmentType": "CustomerManaged" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" + }, + "productDoubleEncryptionStatus": "Disabled" + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T11:30:31.5838042+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2022-03-04T11:30:31.5838042+05:30" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "CustomerManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable", + "managementRpDetailsList": [ + { + "resourceProviderNamespace": "Microsoft.DataBoxEdge" + } + ] + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "XXXX XXXX", + "phone": "0000000000", + "phoneExtension": "", + "emailList": [ + "xxxx@xxxx.xxx" + ] + }, + "addressValidationStatus": "Valid" + } + }, + "startTime": "2022-03-04T11:29:47.3483197+05:30", + "orderId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3" + }, + "systemData": { + "createdAt": "0001-01-01T05:30:00+05:30", + "lastModifiedAt": "0001-01-01T05:30:00+05:30" + }, + "location": "eastus", + "tags": {}, + "name": "TestOrderItemName3", + "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3", + "type": "Microsoft.EdgeOrder/orderItems" + } + }, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/readme.go.md b/specification/edgeorder/resource-manager/readme.go.md index 5221a38e0fdc..1c6b9dc7ab18 100644 --- a/specification/edgeorder/resource-manager/readme.go.md +++ b/specification/edgeorder/resource-manager/readme.go.md @@ -21,17 +21,18 @@ azure-arm: true ``` yaml $(go) && $(multiapi) batch: - - tag: package-2020-12-preview + - tag: package-2022-05-preview - tag: package-2021-12 + - tag: package-2020-12-preview ``` -### Tag: package-2020-12-preview and go +### Tag: package-2022-05-preview and go -These settings apply only when `--tag=package-2020-12-preview --go` is specified on the command line. +These settings apply only when `--tag=package-2022-05-preview --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag)=='package-2020-12-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-12-01-preview/$(namespace) +``` yaml $(tag)=='package-2022-05-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2022-05-01-preview/$(namespace) ``` ### Tag: package-2021-12 and go @@ -41,4 +42,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2020-12-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-12-01-preview/$(namespace) ``` \ No newline at end of file diff --git a/specification/edgeorder/resource-manager/readme.md b/specification/edgeorder/resource-manager/readme.md index 84431199c7a2..1faf90147d9b 100644 --- a/specification/edgeorder/resource-manager/readme.md +++ b/specification/edgeorder/resource-manager/readme.md @@ -28,9 +28,19 @@ These are the global settings for the EdgeOrder API. title: EdgeOrderManagementClient description: Edge Order API's openapi-type: arm -tag: package-2021-12 +tag: package-2022-05-preview ``` +### Tag: package-2022-05-preview + +These settings apply only when `--tag=package-2022-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2022-05-preview' +input-file: +- Microsoft.EdgeOrder/preview/2022-05-01-preview/edgeorder.json +``` +--- + ### Tag: package-2021-12 These settings apply only when `--tag=package-2021-12` is specified on the command line. diff --git a/specification/edgeorder/resource-manager/readme.python.md b/specification/edgeorder/resource-manager/readme.python.md index 5c84de016e3c..2df97d5fc46e 100644 --- a/specification/edgeorder/resource-manager/readme.python.md +++ b/specification/edgeorder/resource-manager/readme.python.md @@ -23,8 +23,9 @@ Generate all API versions currently shipped for this package ```yaml $(python) multiapi: true batch: - - tag: package-2020-12-preview + - tag: package-2022-05-preview - tag: package-2021-12 + - tag: package-2020-12-preview - multiapiscript: true ``` @@ -32,14 +33,15 @@ batch: output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder/azure/mgmt/edgeorder/ perform-load: false ``` -### Tag: package-2020-12-preview and python -These settings apply only when `--tag=package-2020-12-preview --python` is specified on the command line. +### Tag: package-2022-05-preview and python + +These settings apply only when `--tag=package-2022-05-preview --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2020-12-preview' && $(python) -namespace: azure.mgmt.edgeorder.v2020_12_01_preview -output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder/azure/mgmt/edgeorder/v2020_12_01_preview +``` yaml $(tag) == 'package-2022-05-preview' && $(python) +namespace: azure.mgmt.edgeorder.v2022_05_01_preview +output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder/azure/mgmt/edgeorder/v2022_05_01_preview ``` ### Tag: package-2021-12 and python @@ -50,4 +52,14 @@ Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-12-preview' && $(python) +namespace: azure.mgmt.edgeorder.v2020_12_01_preview +output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder/azure/mgmt/edgeorder/v2020_12_01_preview ``` \ No newline at end of file