package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# README

github.com/hashicorp/go-azure-sdk/resource-manager/marketplaceordering/2015-06-01/agreements Documentation

The agreements SDK allows for interaction with the Azure Resource Manager Service marketplaceordering (API Version 2015-06-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/marketplaceordering/2015-06-01/agreements"

Client Initialization

client := agreements.NewAgreementsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AgreementsClient.MarketplaceAgreementsCancel

ctx := context.TODO()
id := agreements.NewPlanID("12345678-1234-9876-4563-123456789012", "publisherIdValue", "offerIdValue", "planIdValue")

read, err := client.MarketplaceAgreementsCancel(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AgreementsClient.MarketplaceAgreementsCreate

ctx := context.TODO()
id := agreements.NewOfferPlanID("12345678-1234-9876-4563-123456789012", "publisherIdValue", "offerIdValue", "planIdValue")

payload := agreements.AgreementTerms{
	// ...
}


read, err := client.MarketplaceAgreementsCreate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AgreementsClient.MarketplaceAgreementsGet

ctx := context.TODO()
id := agreements.NewOfferPlanID("12345678-1234-9876-4563-123456789012", "publisherIdValue", "offerIdValue", "planIdValue")

read, err := client.MarketplaceAgreementsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AgreementsClient.MarketplaceAgreementsGetAgreement

ctx := context.TODO()
id := agreements.NewPlanID("12345678-1234-9876-4563-123456789012", "publisherIdValue", "offerIdValue", "planIdValue")

read, err := client.MarketplaceAgreementsGetAgreement(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AgreementsClient.MarketplaceAgreementsList

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

read, err := client.MarketplaceAgreementsList(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AgreementsClient.MarketplaceAgreementsSign

ctx := context.TODO()
id := agreements.NewPlanID("12345678-1234-9876-4563-123456789012", "publisherIdValue", "offerIdValue", "planIdValue")

read, err := client.MarketplaceAgreementsSign(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

# Functions

No description provided by the author
NewOfferPlanID returns a new OfferPlanId struct.
NewPlanID returns a new PlanId struct.
ParseOfferPlanID parses 'input' into a OfferPlanId.
ParseOfferPlanIDInsensitively parses 'input' case-insensitively into a OfferPlanId note: this method should only be used for API response data and not user input.
ParsePlanID parses 'input' into a PlanId.
ParsePlanIDInsensitively parses 'input' case-insensitively into a PlanId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateOfferPlanID checks that 'input' can be parsed as a Offer Plan ID.
ValidatePlanID checks that 'input' can be parsed as a Plan ID.

# Constants

No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OfferPlanId is a struct representing the Resource ID for a Offer Plan.
No description provided by the author
No description provided by the author
PlanId is a struct representing the Resource ID for a Plan.

# Type aliases

No description provided by the author