Microsoft.EdgeOrderPartner (preview:2020-12-01)

2025/09/19 • 4 new, 4 deleted methods

ListOperationsPartner (new)
Description :  This method gets all the operations that are exposed for customer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EdgeOrderPartner/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManageInventoryMetadata (new)
Description :  API for updating inventory metadata and inventory configuration
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/productFamilies/{familyIdentifier}/inventories/{serialNumber}/manageInventoryMetadata
{
familyIdentifier:
{
Description: Unique identifier for the product family ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location of the resource ,
Required: True ,
}
string ,
serialNumber:
{
Description: The serial number of the device ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
manageInventoryMetadataRequest:
{
Description: Updates inventory metadata and inventory configuration ,
Required: True ,
}
{
inventoryMetadata:
{
Description: Inventory metadata to be updated ,
Required: True ,
}
string ,
configurationOnDevice:
{
Description: Inventory configuration to be updated ,
Required: False ,
}
{
configurationIdentifier:
{
Description: Configuration identifier on device ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SearchInventories (new)
Description :  API for Search inventories
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/searchInventories
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchInventoriesRequest:
{
Description: Searches inventories with the given filters and returns in the form of a list ,
Required: True ,
}
{
serialNumber:
{
Description: Serial number of the inventory ,
Required: True ,
}
string ,
familyIdentifier:
{
Description: Family identifier for inventory ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of partner inventories ,
Required: False ,
}
[
{
properties:
{
Description: Inventory properties ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
orderItem:
{
Description: Represents basic order item data. ,
Required: False ,
}
{
armId:
{
Description: Arm ID of order item ,
Required: False ,
}
string ,
orderItemType:
{
Description: Order item type - purchase or rental ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: False ,
}
enum ,
}
,
configuration:
{
Description: Represents basic configuration data. ,
Required: False ,
}
{
familyIdentifier:
{
Description: Family identifier of inventory ,
Required: False ,
}
string ,
productLineIdentifier:
{
Description: Product Line identifier of inventory ,
Required: False ,
}
string ,
productIdentifier:
{
Description: Product identifier of inventory ,
Required: False ,
}
string ,
configurationIdentifier:
{
Description: Configuration identifier of inventory ,
Required: False ,
}
string ,
configurationIdentifierOnDevice:
{
Description: Configuration identifier on device - this is used in case of any mismatch between actual configuration on inventory and configuration stored in service ,
Required: False ,
}
string ,
}
,
managementResource:
{
Description: Represents management resource data associated with inventory. ,
Required: False ,
}
{
armId:
{
Description: Arm ID of management resource associated with inventory ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of management resource associated with inventory ,
Required: False ,
}
string ,
}
,
inventory:
{
Description: Represents basic inventory data. ,
Required: False ,
}
{
status:
{
Description: Inventory status ,
Required: False ,
}
string ,
location:
{
Description: Inventory location ,
Required: False ,
}
string ,
registrationAllowed:
{
Description: Boolean flag to indicate if registration is allowed ,
Required: False ,
}
boolean ,
}
,
location:
{
Description: Location of inventory ,
Required: False ,
}
string ,
details:
{
Description: Represents additional details of inventory ,
Required: False ,
}
{
orderItem:
{
Description: Represents additional details about the order item ,
Required: False ,
}
{
status:
{
Description: Order item status ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
PickedUp: Device has been picked up from user and in transit to Azure datacenter. ,
AtAzureDC: Device has been received at Azure datacenter from the user. ,
DataCopy: Data copy from the device at Azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Aborted: Order has been aborted. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Placed: Currently in draft mode and can still be cancelled ,
InReview: Order is currently in draft mode and can still be cancelled ,
Confirmed: Order is confirmed ,
ReadyForDispatch: Order is ready for dispatch ,
Shipped: Order is in transit to customer ,
Delivered: Order is delivered to customer ,
InUse: Order is in use at customer site ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
subscription:
{
Description: Subscription details ,
Required: False ,
}
{
id:
{
Description: Subscription Id ,
Required: False ,
}
string ,
state:
{
Description: Subscription State ,
Required: False ,
}
string ,
quotaId:
{
Description: Subscription QuotaId ,
Required: False ,
}
string ,
}
,
}
,
inventoryMetadata:
{
Description: Contains inventory metadata ,
Required: False ,
}
string ,
configuration:
{
Description: Represents additional details about the configuration ,
Required: False ,
}
{
specifications:
{
Description: Collection of specification details about the inventory ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification property ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification property ,
Required: False ,
}
string ,
}
,
]
,
}
,
inventory:
{
Description: Represents additional data about the inventory ,
Required: False ,
}
{
additionalData:
{
Description: Additional Data ,
Required: False ,
}
object ,
}
,
billing:
{
Description: Represents additional details about billing for the inventory ,
Required: False ,
}
{
billingType:
{
Description: Billing type for the inventory ,
Required: False ,
}
string ,
status:
{
Description: Billing status for the inventory ,
Required: False ,
}
string ,
}
,
inventorySecrets:
{
Description: Represents secrets on the inventory ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of partner inventories. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ListOperationsPartner (removed)
Description :  This method gets all the operations that are exposed for customer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EdgeOrderPartner/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManageInventoryMetadata (removed)
Description :  API for updating inventory metadata and inventory configuration
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/locations/{location}/productFamilies/{familyIdentifier}/inventories/{serialNumber}/manageInventoryMetadata
{
familyIdentifier:
{
Description: Unique identifier for the product family ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location of the resource ,
Required: True ,
}
string ,
serialNumber:
{
Description: The serial number of the device ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
manageInventoryMetadataRequest:
{
Description: Updates inventory metadata and inventory configuration ,
Required: True ,
}
{
inventoryMetadata:
{
Description: Inventory metadata to be updated ,
Required: True ,
}
string ,
configurationOnDevice:
{
Description: Inventory configuration to be updated ,
Required: False ,
}
{
configurationIdentifier:
{
Description: Configuration identifier on device ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SearchInventories (removed)
Description :  API for Search inventories
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrderPartner/searchInventories
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchInventoriesRequest:
{
Description: Searches inventories with the given filters and returns in the form of a list ,
Required: True ,
}
{
serialNumber:
{
Description: Serial number of the inventory ,
Required: True ,
}
string ,
familyIdentifier:
{
Description: Family identifier for inventory ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of partner inventories ,
Required: False ,
}
[
{
properties:
{
Description: Inventory properties ,
Required: False ,
}
{
serialNumber:
{
Description: Serial number of the device. ,
Required: False ,
}
string ,
orderItem:
{
Description: Represents basic order item data. ,
Required: False ,
}
{
armId:
{
Description: Arm ID of order item ,
Required: False ,
}
string ,
orderItemType:
{
Description: Order item type - purchase or rental ,
Enum:
{
Purchase: Purchase OrderItem. ,
Rental: Rental OrderItem. ,
}
,
Required: False ,
}
enum ,
}
,
configuration:
{
Description: Represents basic configuration data. ,
Required: False ,
}
{
familyIdentifier:
{
Description: Family identifier of inventory ,
Required: False ,
}
string ,
productLineIdentifier:
{
Description: Product Line identifier of inventory ,
Required: False ,
}
string ,
productIdentifier:
{
Description: Product identifier of inventory ,
Required: False ,
}
string ,
configurationIdentifier:
{
Description: Configuration identifier of inventory ,
Required: False ,
}
string ,
configurationIdentifierOnDevice:
{
Description: Configuration identifier on device - this is used in case of any mismatch between actual configuration on inventory and configuration stored in service ,
Required: False ,
}
string ,
}
,
managementResource:
{
Description: Represents management resource data associated with inventory. ,
Required: False ,
}
{
armId:
{
Description: Arm ID of management resource associated with inventory ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of management resource associated with inventory ,
Required: False ,
}
string ,
}
,
inventory:
{
Description: Represents basic inventory data. ,
Required: False ,
}
{
status:
{
Description: Inventory status ,
Required: False ,
}
string ,
location:
{
Description: Inventory location ,
Required: False ,
}
string ,
registrationAllowed:
{
Description: Boolean flag to indicate if registration is allowed ,
Required: False ,
}
boolean ,
}
,
location:
{
Description: Location of inventory ,
Required: False ,
}
string ,
details:
{
Description: Represents additional details of inventory ,
Required: False ,
}
{
orderItem:
{
Description: Represents additional details about the order item ,
Required: False ,
}
{
status:
{
Description: Order item status ,
Required: False ,
}
{
stageStatus:
{
Description: Stage status. ,
Enum:
{
None: No status available yet. ,
InProgress: Stage is in progress. ,
Succeeded: Stage has succeeded. ,
Failed: Stage has failed. ,
Cancelled: Stage has been cancelled. ,
Cancelling: Stage is cancelling. ,
}
,
Required: False ,
}
enum ,
stageName:
{
Description: Stage name ,
Enum:
{
DeviceOrdered: An order has been created. ,
DevicePrepared: A device has been prepared for the order. ,
PickedUp: Device has been picked up from user and in transit to Azure datacenter. ,
AtAzureDC: Device has been received at Azure datacenter from the user. ,
DataCopy: Data copy from the device at Azure datacenter. ,
Completed: Order has completed. ,
CompletedWithErrors: Order has completed with errors. ,
Cancelled: Order has been cancelled. ,
Aborted: Order has been aborted. ,
CompletedWithWarnings: Order has completed with warnings. ,
ReadyToDispatchFromAzureDC: Device is ready to be handed to customer from Azure DC. ,
ReadyToReceiveAtAzureDC: Device can be dropped off at Azure DC. ,
Placed: Currently in draft mode and can still be cancelled ,
InReview: Order is currently in draft mode and can still be cancelled ,
Confirmed: Order is confirmed ,
ReadyForDispatch: Order is ready for dispatch ,
Shipped: Order is in transit to customer ,
Delivered: Order is delivered to customer ,
InUse: Order is in use at customer site ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the resource stage. ,
Required: False ,
}
string ,
startTime:
{
Description: Stage start time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
subscription:
{
Description: Subscription details ,
Required: False ,
}
{
id:
{
Description: Subscription Id ,
Required: False ,
}
string ,
state:
{
Description: Subscription State ,
Required: False ,
}
string ,
quotaId:
{
Description: Subscription QuotaId ,
Required: False ,
}
string ,
}
,
}
,
inventoryMetadata:
{
Description: Contains inventory metadata ,
Required: False ,
}
string ,
configuration:
{
Description: Represents additional details about the configuration ,
Required: False ,
}
{
specifications:
{
Description: Collection of specification details about the inventory ,
Required: False ,
}
[
{
name:
{
Description: Name of the specification property ,
Required: False ,
}
string ,
value:
{
Description: Value of the specification property ,
Required: False ,
}
string ,
}
,
]
,
}
,
inventory:
{
Description: Represents additional data about the inventory ,
Required: False ,
}
{
additionalData:
{
Description: Additional Data ,
Required: False ,
}
object ,
}
,
billing:
{
Description: Represents additional details about billing for the inventory ,
Required: False ,
}
{
billingType:
{
Description: Billing type for the inventory ,
Required: False ,
}
string ,
status:
{
Description: Billing status for the inventory ,
Required: False ,
}
string ,
}
,
inventorySecrets:
{
Description: Represents secrets on the inventory ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of partner inventories. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}