Microsoft.EdgeMarketplace (stable:2024-10-01)

2025/10/10 • 9 new methods

Offers_List (new)
Description :  List Offer resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.EdgeMarketplace/offers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: Filter the result list using the given expression. ,
Required: False ,
}
string ,
$skipToken:
{
Description: Skip over when retrieving results. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Offer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
contentVersion:
{
Description: The content version ,
Required: False ,
}
string ,
contentUrl:
{
Description: The content url ,
Required: False ,
}
string ,
offerContent:
{
Description: The offer content ,
Required: True ,
}
{
displayName:
{
Description: The display name of the offer ,
Required: True ,
}
string ,
summary:
{
Description: The summary ,
Required: False ,
}
string ,
longSummary:
{
Description: The long summary ,
Required: False ,
}
string ,
description:
{
Description: The description ,
Required: False ,
}
string ,
offerId:
{
Description: The offer id ,
Required: True ,
}
string ,
offerType:
{
Description: The offer type ,
Required: False ,
}
string ,
supportUri:
{
Description: The support uri ,
Required: False ,
}
string ,
popularity:
{
Description: The popularity of the offer ,
Format: int32 ,
Required: False ,
}
integer ,
offerPublisher:
{
Description: The publisher of the offer ,
Required: False ,
}
{
publisherId:
{
Description: The publisher Id ,
Required: True ,
}
string ,
publisherDisplayName:
{
Description: The publisher name ,
Required: True ,
}
string ,
}
,
availability:
{
Description: The availability of the offer ,
Enum:
{
Private: The offer availability is private ,
Public: The offer availability is public ,
}
,
Required: False ,
}
enum ,
releaseType:
{
Description: The release type of the offer ,
Enum:
{
Preview: The offer in preview ,
GA: The offer in GA ,
}
,
Required: False ,
}
enum ,
iconFileUris:
{
Description: The icon files ,
Required: False ,
}
{
small:
{
Description: uri of small icon ,
Required: False ,
}
string ,
medium:
{
Description: uri of medium icon ,
Required: False ,
}
string ,
wide:
{
Description: uri of wide icon ,
Required: False ,
}
string ,
large:
{
Description: uri of large icon ,
Required: False ,
}
string ,
}
,
termsAndConditions:
{
Description: The terms and conditions ,
Required: False ,
}
{
legalTermsUri:
{
Description: The legal terms and conditions uri ,
Required: False ,
}
string ,
legalTermsType:
{
Description: The type of legal terms ,
Required: False ,
}
string ,
privacyPolicyUri:
{
Description: The privacy policy uri ,
Required: False ,
}
string ,
}
,
categoryIds:
{
Description: The category ids ,
Required: False ,
}
[
string ,
]
,
operatingSystems:
{
Description: The operating systems ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The resource provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
marketplaceSkus:
{
Description: The marketplace skus ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: The catalog plan id ,
Required: True ,
}
string ,
marketplaceSkuId:
{
Description: The marketplace sku id ,
Required: True ,
}
string ,
type:
{
Description: The type of marketplace sku ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of marketplace sku ,
Required: False ,
}
string ,
summary:
{
Description: The summary ,
Required: False ,
}
string ,
longSummary:
{
Description: The long summary ,
Required: False ,
}
string ,
description:
{
Description: The description ,
Required: False ,
}
string ,
generation:
{
Description: The generation ,
Required: False ,
}
string ,
displayRank:
{
Description: The display rank of the sku ,
Format: int32 ,
Required: False ,
}
integer ,
operatingSystem:
{
Description: The operating system supported ,
Required: False ,
}
{
family:
{
Description: The family of the operating system ,
Required: False ,
}
string ,
type:
{
Description: The type of the operating system ,
Required: False ,
}
string ,
name:
{
Description: The name of the operating system ,
Required: True ,
}
string ,
}
,
marketplaceSkuVersions:
{
Description: The marketplace sku version ,
Required: False ,
}
[
{
name:
{
Description: The name of sku version ,
Required: True ,
}
string ,
sizeOnDiskInMb:
{
Description: The size of the image ,
Format: int32 ,
Required: False ,
}
integer ,
minimumDownloadSizeInMb:
{
Description: The size of the download ,
Format: int32 ,
Required: False ,
}
integer ,
stageName:
{
Description: The stage name ,
Required: False ,
}
string ,
launchType:
{
Description: The launch type ,
Enum:
{
Trusted: The offer has been certified ,
Unknown: The offer has not been certified ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Offers_Get (new)
Description :  Get a Offer
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.EdgeMarketplace/offers/{offerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
offerId:
{
Description: Id of the offer ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
contentVersion:
{
Description: The content version ,
Required: False ,
}
string ,
contentUrl:
{
Description: The content url ,
Required: False ,
}
string ,
offerContent:
{
Description: The offer content ,
Required: True ,
}
{
displayName:
{
Description: The display name of the offer ,
Required: True ,
}
string ,
summary:
{
Description: The summary ,
Required: False ,
}
string ,
longSummary:
{
Description: The long summary ,
Required: False ,
}
string ,
description:
{
Description: The description ,
Required: False ,
}
string ,
offerId:
{
Description: The offer id ,
Required: True ,
}
string ,
offerType:
{
Description: The offer type ,
Required: False ,
}
string ,
supportUri:
{
Description: The support uri ,
Required: False ,
}
string ,
popularity:
{
Description: The popularity of the offer ,
Format: int32 ,
Required: False ,
}
integer ,
offerPublisher:
{
Description: The publisher of the offer ,
Required: False ,
}
{
publisherId:
{
Description: The publisher Id ,
Required: True ,
}
string ,
publisherDisplayName:
{
Description: The publisher name ,
Required: True ,
}
string ,
}
,
availability:
{
Description: The availability of the offer ,
Enum:
{
Private: The offer availability is private ,
Public: The offer availability is public ,
}
,
Required: False ,
}
enum ,
releaseType:
{
Description: The release type of the offer ,
Enum:
{
Preview: The offer in preview ,
GA: The offer in GA ,
}
,
Required: False ,
}
enum ,
iconFileUris:
{
Description: The icon files ,
Required: False ,
}
{
small:
{
Description: uri of small icon ,
Required: False ,
}
string ,
medium:
{
Description: uri of medium icon ,
Required: False ,
}
string ,
wide:
{
Description: uri of wide icon ,
Required: False ,
}
string ,
large:
{
Description: uri of large icon ,
Required: False ,
}
string ,
}
,
termsAndConditions:
{
Description: The terms and conditions ,
Required: False ,
}
{
legalTermsUri:
{
Description: The legal terms and conditions uri ,
Required: False ,
}
string ,
legalTermsType:
{
Description: The type of legal terms ,
Required: False ,
}
string ,
privacyPolicyUri:
{
Description: The privacy policy uri ,
Required: False ,
}
string ,
}
,
categoryIds:
{
Description: The category ids ,
Required: False ,
}
[
string ,
]
,
operatingSystems:
{
Description: The operating systems ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The resource provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
marketplaceSkus:
{
Description: The marketplace skus ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: The catalog plan id ,
Required: True ,
}
string ,
marketplaceSkuId:
{
Description: The marketplace sku id ,
Required: True ,
}
string ,
type:
{
Description: The type of marketplace sku ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of marketplace sku ,
Required: False ,
}
string ,
summary:
{
Description: The summary ,
Required: False ,
}
string ,
longSummary:
{
Description: The long summary ,
Required: False ,
}
string ,
description:
{
Description: The description ,
Required: False ,
}
string ,
generation:
{
Description: The generation ,
Required: False ,
}
string ,
displayRank:
{
Description: The display rank of the sku ,
Format: int32 ,
Required: False ,
}
integer ,
operatingSystem:
{
Description: The operating system supported ,
Required: False ,
}
{
family:
{
Description: The family of the operating system ,
Required: False ,
}
string ,
type:
{
Description: The type of the operating system ,
Required: False ,
}
string ,
name:
{
Description: The name of the operating system ,
Required: True ,
}
string ,
}
,
marketplaceSkuVersions:
{
Description: The marketplace sku version ,
Required: False ,
}
[
{
name:
{
Description: The name of sku version ,
Required: True ,
}
string ,
sizeOnDiskInMb:
{
Description: The size of the image ,
Format: int32 ,
Required: False ,
}
integer ,
minimumDownloadSizeInMb:
{
Description: The size of the download ,
Format: int32 ,
Required: False ,
}
integer ,
stageName:
{
Description: The stage name ,
Required: False ,
}
string ,
launchType:
{
Description: The launch type ,
Enum:
{
Trusted: The offer has been certified ,
Unknown: The offer has not been certified ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Offers_GenerateAccessToken (new)
Description :  A long-running resource action.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.EdgeMarketplace/offers/{offerId}/generateAccessToken
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
offerId:
{
Description: Id of the offer ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
publisherName:
{
Description: The name of the publisher. ,
Required: False ,
}
string ,
edgeMarketPlaceRegion:
{
Description: The region where the disk will be created. ,
Required: True ,
}
string ,
egeMarketPlaceResourceId:
{
Description: The region where the disk will be created. ,
Required: False ,
}
string ,
hypervGeneration:
{
Description: The hyperv version. ,
Required: False ,
}
string ,
marketPlaceSku:
{
Description: The marketplace sku. ,
Required: False ,
}
string ,
marketPlaceSkuVersion:
{
Description: The marketplace sku version. ,
Required: False ,
}
string ,
deviceSku:
{
Description: The device sku. ,
Required: False ,
}
string ,
deviceVersion:
{
Description: The device sku version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
diskId:
{
Description: The disk id. ,
Required: False ,
}
string ,
status:
{
Description: The access token creation status. ,
Required: False ,
}
string ,
accessToken:
{
Description: The access token. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Offers_GetAccessToken (new)
Description :  get access token.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.EdgeMarketplace/offers/{offerId}/getAccessToken
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
offerId:
{
Description: Id of the offer ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
requestId:
{
Description: The name of the publisher. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
diskId:
{
Description: The disk id. ,
Required: False ,
}
string ,
status:
{
Description: The access token creation status. ,
Required: False ,
}
string ,
accessToken:
{
Description: The access token. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
Publishers_List (new)
Description :  List Publisher resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.EdgeMarketplace/publishers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: Filter the result list using the given expression. ,
Required: False ,
}
string ,
$skipToken:
{
Description: Skip over when retrieving results. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Publisher items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Publishers_Get (new)
Description :  Get a Publisher
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.EdgeMarketplace/publishers/{publisherName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
publisherName:
{
Description: Name of the publisher ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EdgeMarketplace/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). ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Offers_ListBySubscription (new)
Description :  List Offer resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeMarketplace/offers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Offer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
contentVersion:
{
Description: The content version ,
Required: False ,
}
string ,
contentUrl:
{
Description: The content url ,
Required: False ,
}
string ,
offerContent:
{
Description: The offer content ,
Required: True ,
}
{
displayName:
{
Description: The display name of the offer ,
Required: True ,
}
string ,
summary:
{
Description: The summary ,
Required: False ,
}
string ,
longSummary:
{
Description: The long summary ,
Required: False ,
}
string ,
description:
{
Description: The description ,
Required: False ,
}
string ,
offerId:
{
Description: The offer id ,
Required: True ,
}
string ,
offerType:
{
Description: The offer type ,
Required: False ,
}
string ,
supportUri:
{
Description: The support uri ,
Required: False ,
}
string ,
popularity:
{
Description: The popularity of the offer ,
Format: int32 ,
Required: False ,
}
integer ,
offerPublisher:
{
Description: The publisher of the offer ,
Required: False ,
}
{
publisherId:
{
Description: The publisher Id ,
Required: True ,
}
string ,
publisherDisplayName:
{
Description: The publisher name ,
Required: True ,
}
string ,
}
,
availability:
{
Description: The availability of the offer ,
Enum:
{
Private: The offer availability is private ,
Public: The offer availability is public ,
}
,
Required: False ,
}
enum ,
releaseType:
{
Description: The release type of the offer ,
Enum:
{
Preview: The offer in preview ,
GA: The offer in GA ,
}
,
Required: False ,
}
enum ,
iconFileUris:
{
Description: The icon files ,
Required: False ,
}
{
small:
{
Description: uri of small icon ,
Required: False ,
}
string ,
medium:
{
Description: uri of medium icon ,
Required: False ,
}
string ,
wide:
{
Description: uri of wide icon ,
Required: False ,
}
string ,
large:
{
Description: uri of large icon ,
Required: False ,
}
string ,
}
,
termsAndConditions:
{
Description: The terms and conditions ,
Required: False ,
}
{
legalTermsUri:
{
Description: The legal terms and conditions uri ,
Required: False ,
}
string ,
legalTermsType:
{
Description: The type of legal terms ,
Required: False ,
}
string ,
privacyPolicyUri:
{
Description: The privacy policy uri ,
Required: False ,
}
string ,
}
,
categoryIds:
{
Description: The category ids ,
Required: False ,
}
[
string ,
]
,
operatingSystems:
{
Description: The operating systems ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The resource provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
marketplaceSkus:
{
Description: The marketplace skus ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: The catalog plan id ,
Required: True ,
}
string ,
marketplaceSkuId:
{
Description: The marketplace sku id ,
Required: True ,
}
string ,
type:
{
Description: The type of marketplace sku ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of marketplace sku ,
Required: False ,
}
string ,
summary:
{
Description: The summary ,
Required: False ,
}
string ,
longSummary:
{
Description: The long summary ,
Required: False ,
}
string ,
description:
{
Description: The description ,
Required: False ,
}
string ,
generation:
{
Description: The generation ,
Required: False ,
}
string ,
displayRank:
{
Description: The display rank of the sku ,
Format: int32 ,
Required: False ,
}
integer ,
operatingSystem:
{
Description: The operating system supported ,
Required: False ,
}
{
family:
{
Description: The family of the operating system ,
Required: False ,
}
string ,
type:
{
Description: The type of the operating system ,
Required: False ,
}
string ,
name:
{
Description: The name of the operating system ,
Required: True ,
}
string ,
}
,
marketplaceSkuVersions:
{
Description: The marketplace sku version ,
Required: False ,
}
[
{
name:
{
Description: The name of sku version ,
Required: True ,
}
string ,
sizeOnDiskInMb:
{
Description: The size of the image ,
Format: int32 ,
Required: False ,
}
integer ,
minimumDownloadSizeInMb:
{
Description: The size of the download ,
Format: int32 ,
Required: False ,
}
integer ,
stageName:
{
Description: The stage name ,
Required: False ,
}
string ,
launchType:
{
Description: The launch type ,
Enum:
{
Trusted: The offer has been certified ,
Unknown: The offer has not been certified ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Publishers_ListBySubscription (new)
Description :  List Publisher resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeMarketplace/publishers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Publisher items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}