Microsoft.MarketplaceOrdering (stable:2021-01-01)

2025/10/23 • 7 new, 7 deleted methods

MarketplaceAgreements_Get (new)
Description :  Get marketplace terms.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/offerTypes/{offerType}/publishers/{publisherId}/offers/{offerId}/plans/{planId}/agreements/current
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
offerType:
{
Description: Offer Type, currently only virtualmachine type is supported. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher identifier string of image being deployed. ,
Required: True ,
}
string ,
offerId:
{
Description: Offer identifier string of image being deployed. ,
Required: True ,
}
string ,
planId:
{
Description: Plan identifier string of image being deployed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
product:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
plan:
{
Description: Plan identifier string of image being deployed. ,
Required: False ,
}
string ,
licenseTextLink:
{
Description: Link to HTML with Microsoft and Publisher terms. ,
Required: False ,
}
string ,
privacyPolicyLink:
{
Description: Link to the privacy policy of the publisher. ,
Required: False ,
}
string ,
marketplaceTermsLink:
{
Description: Link to HTML with Azure Marketplace terms. ,
Required: False ,
}
string ,
retrieveDatetime:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. ,
Format: date-time ,
Required: False ,
}
string ,
signature:
{
Description: Terms signature. ,
Required: False ,
}
string ,
accepted:
{
Description: If any version of the terms have been accepted, otherwise false. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_Create (new)
Description :  Save marketplace terms.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/offerTypes/{offerType}/publishers/{publisherId}/offers/{offerId}/plans/{planId}/agreements/current
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
offerType:
{
Description: Offer Type, currently only virtualmachine type is supported. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher identifier string of image being deployed. ,
Required: True ,
}
string ,
offerId:
{
Description: Offer identifier string of image being deployed. ,
Required: True ,
}
string ,
planId:
{
Description: Plan identifier string of image being deployed. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Marketplace Terms operation. ,
Required: True ,
}
{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
product:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
plan:
{
Description: Plan identifier string of image being deployed. ,
Required: False ,
}
string ,
licenseTextLink:
{
Description: Link to HTML with Microsoft and Publisher terms. ,
Required: False ,
}
string ,
privacyPolicyLink:
{
Description: Link to the privacy policy of the publisher. ,
Required: False ,
}
string ,
marketplaceTermsLink:
{
Description: Link to HTML with Azure Marketplace terms. ,
Required: False ,
}
string ,
retrieveDatetime:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. ,
Format: date-time ,
Required: False ,
}
string ,
signature:
{
Description: Terms signature. ,
Required: False ,
}
string ,
accepted:
{
Description: If any version of the terms have been accepted, otherwise false. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
product:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
plan:
{
Description: Plan identifier string of image being deployed. ,
Required: False ,
}
string ,
licenseTextLink:
{
Description: Link to HTML with Microsoft and Publisher terms. ,
Required: False ,
}
string ,
privacyPolicyLink:
{
Description: Link to the privacy policy of the publisher. ,
Required: False ,
}
string ,
marketplaceTermsLink:
{
Description: Link to HTML with Azure Marketplace terms. ,
Required: False ,
}
string ,
retrieveDatetime:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. ,
Format: date-time ,
Required: False ,
}
string ,
signature:
{
Description: Terms signature. ,
Required: False ,
}
string ,
accepted:
{
Description: If any version of the terms have been accepted, otherwise false. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all of the available Microsoft.MarketplaceOrdering REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.MarketplaceOrdering/operations
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.MarketplaceOrdering operations supported by the Microsoft.MarketplaceOrdering resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.MarketplaceOrdering ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Agreement, virtualmachine, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Get Agreement, Sign Agreement, Cancel Agreement etc. ,
Required: False ,
}
string ,
description:
{
Description: Operation description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_Sign (new)
Description :  Sign marketplace terms.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}/sign
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher identifier string of image being deployed. ,
Required: True ,
}
string ,
offerId:
{
Description: Offer identifier string of image being deployed. ,
Required: True ,
}
string ,
planId:
{
Description: Plan identifier string of image being deployed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
id:
{
Description: A unique identifier of the agreement. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
offer:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
signDate:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if state is cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
cancelDate:
{
Description: Date and time in UTC of when the terms were cancelled. This is empty if state is active. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Whether the agreement is active or cancelled ,
Enum:
{
Active: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_Cancel (new)
Description :  Cancel marketplace terms.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}/cancel
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher identifier string of image being deployed. ,
Required: True ,
}
string ,
offerId:
{
Description: Offer identifier string of image being deployed. ,
Required: True ,
}
string ,
planId:
{
Description: Plan identifier string of image being deployed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
id:
{
Description: A unique identifier of the agreement. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
offer:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
signDate:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if state is cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
cancelDate:
{
Description: Date and time in UTC of when the terms were cancelled. This is empty if state is active. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Whether the agreement is active or cancelled ,
Enum:
{
Active: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_GetAgreement (new)
Description :  Get marketplace agreement.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher identifier string of image being deployed. ,
Required: True ,
}
string ,
offerId:
{
Description: Offer identifier string of image being deployed. ,
Required: True ,
}
string ,
planId:
{
Description: Plan identifier string of image being deployed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
id:
{
Description: A unique identifier of the agreement. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
offer:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
signDate:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if state is cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
cancelDate:
{
Description: Date and time in UTC of when the terms were cancelled. This is empty if state is active. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Whether the agreement is active or cancelled ,
Enum:
{
Active: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_List (new)
Description :  List marketplace agreements in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
id:
{
Description: A unique identifier of the agreement. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
offer:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
signDate:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if state is cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
cancelDate:
{
Description: Date and time in UTC of when the terms were cancelled. This is empty if state is active. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Whether the agreement is active or cancelled ,
Enum:
{
Active: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_Get (removed)
Description :  Get marketplace terms.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/offerTypes/{offerType}/publishers/{publisherId}/offers/{offerId}/plans/{planId}/agreements/current
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
offerType:
{
Description: Offer Type, currently only virtualmachine type is supported. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher identifier string of image being deployed. ,
Required: True ,
}
string ,
offerId:
{
Description: Offer identifier string of image being deployed. ,
Required: True ,
}
string ,
planId:
{
Description: Plan identifier string of image being deployed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
product:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
plan:
{
Description: Plan identifier string of image being deployed. ,
Required: False ,
}
string ,
licenseTextLink:
{
Description: Link to HTML with Microsoft and Publisher terms. ,
Required: False ,
}
string ,
privacyPolicyLink:
{
Description: Link to the privacy policy of the publisher. ,
Required: False ,
}
string ,
marketplaceTermsLink:
{
Description: Link to HTML with Azure Marketplace terms. ,
Required: False ,
}
string ,
retrieveDatetime:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. ,
Format: date-time ,
Required: False ,
}
string ,
signature:
{
Description: Terms signature. ,
Required: False ,
}
string ,
accepted:
{
Description: If any version of the terms have been accepted, otherwise false. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_Create (removed)
Description :  Save marketplace terms.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/offerTypes/{offerType}/publishers/{publisherId}/offers/{offerId}/plans/{planId}/agreements/current
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
offerType:
{
Description: Offer Type, currently only virtualmachine type is supported. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher identifier string of image being deployed. ,
Required: True ,
}
string ,
offerId:
{
Description: Offer identifier string of image being deployed. ,
Required: True ,
}
string ,
planId:
{
Description: Plan identifier string of image being deployed. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Marketplace Terms operation. ,
Required: True ,
}
{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
product:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
plan:
{
Description: Plan identifier string of image being deployed. ,
Required: False ,
}
string ,
licenseTextLink:
{
Description: Link to HTML with Microsoft and Publisher terms. ,
Required: False ,
}
string ,
privacyPolicyLink:
{
Description: Link to the privacy policy of the publisher. ,
Required: False ,
}
string ,
marketplaceTermsLink:
{
Description: Link to HTML with Azure Marketplace terms. ,
Required: False ,
}
string ,
retrieveDatetime:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. ,
Format: date-time ,
Required: False ,
}
string ,
signature:
{
Description: Terms signature. ,
Required: False ,
}
string ,
accepted:
{
Description: If any version of the terms have been accepted, otherwise false. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
product:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
plan:
{
Description: Plan identifier string of image being deployed. ,
Required: False ,
}
string ,
licenseTextLink:
{
Description: Link to HTML with Microsoft and Publisher terms. ,
Required: False ,
}
string ,
privacyPolicyLink:
{
Description: Link to the privacy policy of the publisher. ,
Required: False ,
}
string ,
marketplaceTermsLink:
{
Description: Link to HTML with Azure Marketplace terms. ,
Required: False ,
}
string ,
retrieveDatetime:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. ,
Format: date-time ,
Required: False ,
}
string ,
signature:
{
Description: Terms signature. ,
Required: False ,
}
string ,
accepted:
{
Description: If any version of the terms have been accepted, otherwise false. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available Microsoft.MarketplaceOrdering REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.MarketplaceOrdering/operations
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.MarketplaceOrdering operations supported by the Microsoft.MarketplaceOrdering resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.MarketplaceOrdering ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Agreement, virtualmachine, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Get Agreement, Sign Agreement, Cancel Agreement etc. ,
Required: False ,
}
string ,
description:
{
Description: Operation description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_Sign (removed)
Description :  Sign marketplace terms.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}/sign
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher identifier string of image being deployed. ,
Required: True ,
}
string ,
offerId:
{
Description: Offer identifier string of image being deployed. ,
Required: True ,
}
string ,
planId:
{
Description: Plan identifier string of image being deployed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
id:
{
Description: A unique identifier of the agreement. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
offer:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
signDate:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if state is cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
cancelDate:
{
Description: Date and time in UTC of when the terms were cancelled. This is empty if state is active. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Whether the agreement is active or cancelled ,
Enum:
{
Active: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_Cancel (removed)
Description :  Cancel marketplace terms.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}/cancel
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher identifier string of image being deployed. ,
Required: True ,
}
string ,
offerId:
{
Description: Offer identifier string of image being deployed. ,
Required: True ,
}
string ,
planId:
{
Description: Plan identifier string of image being deployed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
id:
{
Description: A unique identifier of the agreement. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
offer:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
signDate:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if state is cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
cancelDate:
{
Description: Date and time in UTC of when the terms were cancelled. This is empty if state is active. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Whether the agreement is active or cancelled ,
Enum:
{
Active: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_GetAgreement (removed)
Description :  Get marketplace agreement.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher identifier string of image being deployed. ,
Required: True ,
}
string ,
offerId:
{
Description: Offer identifier string of image being deployed. ,
Required: True ,
}
string ,
planId:
{
Description: Plan identifier string of image being deployed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
id:
{
Description: A unique identifier of the agreement. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
offer:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
signDate:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if state is cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
cancelDate:
{
Description: Date and time in UTC of when the terms were cancelled. This is empty if state is active. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Whether the agreement is active or cancelled ,
Enum:
{
Active: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MarketplaceAgreements_List (removed)
Description :  List marketplace agreements in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
id:
{
Description: A unique identifier of the agreement. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher identifier string of image being deployed. ,
Required: False ,
}
string ,
offer:
{
Description: Offer identifier string of image being deployed. ,
Required: False ,
}
string ,
signDate:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if state is cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
cancelDate:
{
Description: Date and time in UTC of when the terms were cancelled. This is empty if state is active. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Whether the agreement is active or cancelled ,
Enum:
{
Active: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}