Marketplace Agreements - List

Service:: Marketplace Ordering

API Version:: 2021-01-01

List marketplace agreements in the subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements?api-version=2021-01-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	OldAgreementTermsList	Terms returned successfully
Other Status Codes	ErrorResponse	Microsoft.MarketplaceOrdering error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ListMarketplaceTerms

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.MarketplaceOrdering/agreements?api-version=2021-01-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.marketplaceordering import MarketplaceOrderingAgreements

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-marketplaceordering
# USAGE
    python list_marketplace_terms.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MarketplaceOrderingAgreements(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.marketplace_agreements.list()
    print(response)


# x-ms-original-file: specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/MarketplaceOrdering/stable/2021-01-01/examples/ListMarketplaceTerms.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "id1",
      "name": "planid1",
      "type": "Microsoft.MarketplaceOrdering/agreements",
      "properties": {
        "publisher": "publisher1",
        "offer": "offer1",
        "signDate": "2021-05-01T08:05:53.8374396Z",
        "state": "Active"
      }
    },
    {
      "id": "id2",
      "name": "planid2",
      "type": "Microsoft.MarketplaceOrdering/agreements",
      "properties": {
        "publisher": "publisher2",
        "offer": "offer2",
        "cancelDate": "2021-11-14T16:21:43.6945196Z",
        "state": "Canceled"
      }
    }
  ]
}

Definitions

Name	Description
Error	The details of the error.
ErrorResponse	Error response indicates Microsoft.MarketplaceOrdering service is not able to process the incoming request. The reason is provided in the error message.
OldAgreementTerms	Terms properties for provided Publisher/Offer/Plan tuple
OldAgreementTermsList	Agreement Terms definition list
state	Whether the agreement is active or cancelled

Error

Object

The details of the error.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ErrorResponse

Object

Error response indicates Microsoft.MarketplaceOrdering service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
error	Error	The details of the error.

OldAgreementTerms

Object

Terms properties for provided Publisher/Offer/Plan tuple

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.cancelDate	string (date-time)	Date and time in UTC of when the terms were cancelled. This is empty if state is active.
properties.id	string	A unique identifier of the agreement.
properties.offer	string	Offer identifier string of image being deployed.
properties.publisher	string	Publisher identifier string of image being deployed.
properties.signDate	string (date-time)	Date and time in UTC of when the terms were accepted. This is empty if state is cancelled.
properties.state	state	Whether the agreement is active or cancelled
type	string	Resource type.

OldAgreementTermsList

Object

Agreement Terms definition list

Name	Type	Description
value	OldAgreementTerms[]	Terms properties for provided Publisher/Offer/Plan tuple

state

Enumeration

Whether the agreement is active or cancelled

Value	Description
Active
Canceled