Marketplace Agreements - Get Agreement

Servicio:

Marketplace Ordering

Versión de la API:

2021-01-01

Obtener el contrato de Marketplace.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
offerId	path	True	string	Cadena de identificador de oferta de la imagen que se va a implementar.
planId	path	True	string	Planee la cadena de identificador de la imagen que se va a implementar.
publisherId	path	True	string	Cadena de identificador del publicador de la imagen que se va a implementar.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	OldAgreementTerms	Términos devueltos correctamente
Other Status Codes	ErrorResponse	Respuesta de error Microsoft.MarketplaceOrdering que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

SetMarketplaceTerms

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for MarketplaceAgreements GetAgreement.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2021-01-01/examples/
     * GetAgreementMarketplaceTerms.json
     */
    /**
     * Sample code: SetMarketplaceTerms.
     * 
     * @param manager Entry point to MarketplaceOrderingManager.
     */
    public static void
        setMarketplaceTerms(com.azure.resourcemanager.marketplaceordering.MarketplaceOrderingManager manager) {
        manager.marketplaceAgreements().getAgreementWithResponse("pubid", "offid", "planid",
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.marketplaceordering import MarketplaceOrderingAgreements

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-marketplaceordering
# USAGE
    python get_agreement_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.get_agreement(
        publisher_id="pubid",
        offer_id="offid",
        plan_id="planid",
    )
    print(response)


# x-ms-original-file: specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2021-01-01/examples/GetAgreementMarketplaceTerms.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

Go

package armmarketplaceordering_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/marketplaceordering/armmarketplaceordering"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2021-01-01/examples/GetAgreementMarketplaceTerms.json
func ExampleMarketplaceAgreementsClient_GetAgreement() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmarketplaceordering.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMarketplaceAgreementsClient().GetAgreement(ctx, "pubid", "offid", "planid", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AgreementTerms = armmarketplaceordering.AgreementTerms{
	// 	Name: to.Ptr("planid"),
	// 	Type: to.Ptr("Microsoft.MarketplaceOrdering/offertypes"),
	// 	ID: to.Ptr("id"),
	// 	Properties: &armmarketplaceordering.AgreementProperties{
	// 		Accepted: to.Ptr(true),
	// 		LicenseTextLink: to.Ptr("test.licenseLink"),
	// 		MarketplaceTermsLink: to.Ptr("test.marketplaceTermsLink"),
	// 		Plan: to.Ptr("planid"),
	// 		PrivacyPolicyLink: to.Ptr("test.privacyPolicyLink"),
	// 		Product: to.Ptr("offid"),
	// 		Publisher: to.Ptr("pubid"),
	// 		RetrieveDatetime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-15T11:33:07.121Z"); return t}()),
	// 		Signature: to.Ptr("ASDFSDAFWEFASDGWERLWER"),
	// 	},
	// }
}

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

JavaScript

const { MarketplaceOrderingAgreements } = require("@azure/arm-marketplaceordering");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get marketplace agreement.
 *
 * @summary Get marketplace agreement.
 * x-ms-original-file: specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2021-01-01/examples/GetAgreementMarketplaceTerms.json
 */
async function setMarketplaceTerms() {
  const subscriptionId = process.env["MARKETPLACEORDERING_SUBSCRIPTION_ID"] || "subid";
  const publisherId = "pubid";
  const offerId = "offid";
  const planId = "planid";
  const credential = new DefaultAzureCredential();
  const client = new MarketplaceOrderingAgreements(credential, subscriptionId);
  const result = await client.marketplaceAgreements.getAgreement(publisherId, offerId, planId);
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.MarketplaceOrdering;

// Generated from example definition: specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2021-01-01/examples/GetAgreementMarketplaceTerms.json
// this example is just showing the usage of "MarketplaceAgreements_GetAgreement" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this MarketplaceAgreementResource
MarketplaceAgreementCollection collection = subscriptionResource.GetMarketplaceAgreements();

// invoke the operation
string publisherId = "pubid";
string offerId = "offid";
string planId = "planid";
NullableResponse<MarketplaceAgreementResource> response = await collection.GetIfExistsAsync(publisherId, offerId, planId);
MarketplaceAgreementResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    MarketplaceAgreementTermData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Respuesta de muestra

status code:

200

{
  "id": "id",
  "name": "planid",
  "type": "Microsoft.MarketplaceOrdering/agreements",
  "properties": {
    "publisher": "pubid",
    "offer": "offid",
    "signDate": "2022-12-07T13:30:23.0665141Z",
    "state": "Active"
  }
}

Definiciones

Nombre	Description
Error	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio Microsoft.MarketplaceOrdering no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
OldAgreementTerms	Propiedades de términos para la tupla de publicador/oferta/plan proporcionadas
state	Si el contrato está activo o cancelado

Error

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponse

Object

La respuesta de error indica que el servicio Microsoft.MarketplaceOrdering no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	Error	Detalles del error.

OldAgreementTerms

Object

Propiedades de términos para la tupla de publicador/oferta/plan proporcionadas

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.cancelDate	string (date-time)	Fecha y hora en UTC de la cancelación de los términos. Esto está vacío si el estado está activo.
properties.id	string	Identificador único del contrato.
properties.offer	string	Cadena de identificador de oferta de la imagen que se va a implementar.
properties.publisher	string	Cadena de identificador del publicador de la imagen que se va a implementar.
properties.signDate	string (date-time)	Fecha y hora en UTC de cuándo se aceptaron los términos. Esto está vacío si se cancela el estado.
properties.state	state	Si el contrato está activo o cancelado
type	string	Tipo de recurso.

state

Enumeración

Si el contrato está activo o cancelado

Valor	Description
Active
Canceled