Marketplace Agreements - Create

Layanan:

Marketplace Ordering

Versi API:

2021-01-01

Simpan persyaratan marketplace.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
offerId	path	True	string	Menawarkan string gambar pengidentifikasi yang sedang disebarkan.
offerType	path	True	OfferType	Jenis Penawaran, saat ini hanya jenis virtualmachine yang didukung.
planId	path	True	string	Untai (karakter) pengidentifikasi rencana gambar yang sedang disebarkan.
publisherId	path	True	string	String gambar pengidentifikasi penerbit sedang disebarkan.
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang akan digunakan untuk permintaan tersebut.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.accepted	boolean	Jika ada versi persyaratan yang telah diterima, jika tidak salah.
properties.licenseTextLink	string	Tautkan ke HTML dengan istilah Microsoft dan Publisher.
properties.marketplaceTermsLink	string	Tautkan ke HTML dengan istilah Marketplace Azure.
properties.plan	string	Untai (karakter) pengidentifikasi rencana gambar yang sedang disebarkan.
properties.privacyPolicyLink	string	Tautkan ke kebijakan privasi penerbit.
properties.product	string	Menawarkan string gambar pengidentifikasi yang sedang disebarkan.
properties.publisher	string	String gambar pengidentifikasi penerbit sedang disebarkan.
properties.retrieveDatetime	string (date-time)	Tanggal dan waktu dalam UTC ketika persyaratan diterima. Ini kosong jika Diterima salah.
properties.signature	string	Tanda tangan istilah.

Respons

Nama	Jenis	Deskripsi
200 OK	AgreementTerms	OKE. Permintaan berhasil diproses dan persyaratan diterima atau penerimaan dicabut sesuai isi permintaan.
Other Status Codes	ErrorResponse	Respons kesalahan Microsoft.MarketplaceOrdering yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

SetMarketplaceTerms

Permintaan sampel

HTTP

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

{
  "properties": {
    "publisher": "pubid",
    "product": "offid",
    "plan": "planid",
    "licenseTextLink": "test.licenseLink",
    "privacyPolicyLink": "test.privacyPolicyLink",
    "marketplaceTermsLink": "test.marketplaceTermsLink",
    "retrieveDatetime": "2017-08-15T11:33:07.12132Z",
    "signature": "ASDFSDAFWEFASDGWERLWER",
    "accepted": false
  }
}

Java

import com.azure.resourcemanager.marketplaceordering.fluent.models.AgreementTermsInner;
import com.azure.resourcemanager.marketplaceordering.models.OfferType;
import java.time.OffsetDateTime;

/**
 * Samples for MarketplaceAgreements Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2021-01-01/examples/
     * SetMarketplaceTerms.json
     */
    /**
     * Sample code: SetMarketplaceTerms.
     * 
     * @param manager Entry point to MarketplaceOrderingManager.
     */
    public static void
        setMarketplaceTerms(com.azure.resourcemanager.marketplaceordering.MarketplaceOrderingManager manager) {
        manager.marketplaceAgreements().createWithResponse(OfferType.VIRTUALMACHINE, "pubid", "offid", "planid",
            new AgreementTermsInner().withPublisher("pubid").withProduct("offid").withPlan("planid")
                .withLicenseTextLink("test.licenseLink").withPrivacyPolicyLink("test.privacyPolicyLink")
                .withMarketplaceTermsLink("test.marketplaceTermsLink")
                .withRetrieveDatetime(OffsetDateTime.parse("2017-08-15T11:33:07.12132Z"))
                .withSignature("ASDFSDAFWEFASDGWERLWER").withAccepted(false),
            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 set_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.create(
        offer_type="virtualmachine",
        publisher_id="pubid",
        offer_id="offid",
        plan_id="planid",
        parameters={
            "properties": {
                "accepted": False,
                "licenseTextLink": "test.licenseLink",
                "marketplaceTermsLink": "test.marketplaceTermsLink",
                "plan": "planid",
                "privacyPolicyLink": "test.privacyPolicyLink",
                "product": "offid",
                "publisher": "pubid",
                "retrieveDatetime": "2017-08-15T11:33:07.12132Z",
                "signature": "ASDFSDAFWEFASDGWERLWER",
            }
        },
    )
    print(response)


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

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/SetMarketplaceTerms.json
func ExampleMarketplaceAgreementsClient_Create() {
	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().Create(ctx, armmarketplaceordering.OfferTypeVirtualmachine, "pubid", "offid", "planid", armmarketplaceordering.AgreementTerms{
		Properties: &armmarketplaceordering.AgreementProperties{
			Accepted:             to.Ptr(false),
			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"),
		},
	}, 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 Save marketplace terms.
 *
 * @summary Save marketplace terms.
 * x-ms-original-file: specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2021-01-01/examples/SetMarketplaceTerms.json
 */
async function setMarketplaceTerms() {
  const subscriptionId = process.env["MARKETPLACEORDERING_SUBSCRIPTION_ID"] || "subid";
  const offerType = "virtualmachine";
  const publisherId = "pubid";
  const offerId = "offid";
  const planId = "planid";
  const parameters = {
    accepted: false,
    licenseTextLink: "test.licenseLink",
    marketplaceTermsLink: "test.marketplaceTermsLink",
    plan: "planid",
    privacyPolicyLink: "test.privacyPolicyLink",
    product: "offid",
    publisher: "pubid",
    retrieveDatetime: "2017-08-15T11:33:07.12132Z",
    signature: "ASDFSDAFWEFASDGWERLWER",
  };
  const credential = new DefaultAzureCredential();
  const client = new MarketplaceOrderingAgreements(credential, subscriptionId);
  const result = await client.marketplaceAgreements.create(
    offerType,
    publisherId,
    offerId,
    planId,
    parameters
  );
  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.MarketplaceOrdering.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.MarketplaceOrdering;

// Generated from example definition: specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2021-01-01/examples/SetMarketplaceTerms.json
// this example is just showing the usage of "MarketplaceAgreements_Create" 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 MarketplaceAgreementTermResource
MarketplaceAgreementTermCollection collection = subscriptionResource.GetMarketplaceAgreementTerms();

// invoke the operation
AgreementOfferType offerType = AgreementOfferType.Virtualmachine;
string publisherId = "pubid";
string offerId = "offid";
string planId = "planid";
MarketplaceAgreementTermData data = new MarketplaceAgreementTermData
{
    Publisher = "pubid",
    Product = "offid",
    Plan = "planid",
    LicenseTextLink = new Uri("test.licenseLink"),
    PrivacyPolicyLink = new Uri("test.privacyPolicyLink"),
    MarketplaceTermsLink = new Uri("test.marketplaceTermsLink"),
    RetrievedOn = DateTimeOffset.Parse("2017-08-15T11:33:07.12132Z"),
    Signature = "ASDFSDAFWEFASDGWERLWER",
    IsAccepted = false,
};
ArmOperation<MarketplaceAgreementTermResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, offerType, publisherId, offerId, planId, data);
MarketplaceAgreementTermResource result = lro.Value;

// 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

Respon sampel

Kode status:

200

{
  "id": "id",
  "name": "planid",
  "type": "Microsoft.MarketplaceOrdering/offertypes",
  "properties": {
    "publisher": "pubid",
    "product": "offid",
    "plan": "planid",
    "licenseTextLink": "test.licenseLink",
    "privacyPolicyLink": "test.privacyPolicyLink",
    "marketplaceTermsLink": "test.marketplaceTermsLink",
    "retrieveDatetime": "2017-08-15T11:33:07.12132Z",
    "signature": "ASDFSDAFWEFASDGWERLWER",
    "accepted": true
  }
}

Definisi

Nama	Deskripsi
AgreementTerms	Properti istilah untuk penerbit/penawaran/paket tuple yang disediakan
createdByType	Jenis identitas yang membuat sumber daya.
Error	Detail kesalahan.
ErrorResponse	Respons kesalahan menunjukkan layanan Microsoft.MarketplaceOrdering tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.
OfferType	Jenis Penawaran, saat ini hanya jenis virtualmachine yang didukung.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AgreementTerms

Objek

Properti istilah untuk penerbit/penawaran/paket tuple yang disediakan

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.accepted	boolean	Jika ada versi persyaratan yang telah diterima, jika tidak salah.
properties.licenseTextLink	string	Tautkan ke HTML dengan istilah Microsoft dan Publisher.
properties.marketplaceTermsLink	string	Tautkan ke HTML dengan istilah Marketplace Azure.
properties.plan	string	Untai (karakter) pengidentifikasi rencana gambar yang sedang disebarkan.
properties.privacyPolicyLink	string	Tautkan ke kebijakan privasi penerbit.
properties.product	string	Menawarkan string gambar pengidentifikasi yang sedang disebarkan.
properties.publisher	string	String gambar pengidentifikasi penerbit sedang disebarkan.
properties.retrieveDatetime	string (date-time)	Tanggal dan waktu dalam UTC ketika persyaratan diterima. Ini kosong jika Diterima salah.
properties.signature	string	Tanda tangan istilah.
systemData	systemData	Data meta sistem yang berkaitan dengan sumber daya ini.
type	string	Jenis sumber daya.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
Application
Key
ManagedIdentity
User

Error

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

ErrorResponse

Objek

Respons kesalahan menunjukkan layanan Microsoft.MarketplaceOrdering tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Nama	Jenis	Deskripsi
error	Error	Detail kesalahan.

OfferType

Enumeration

Jenis Penawaran, saat ini hanya jenis virtualmachine yang didukung.

Nilai	Deskripsi
virtualmachine

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.