transfers

package
v0.20241209.1115630 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/billing/2024-04-01/transfers Documentation

The transfers SDK allows for interaction with Azure Resource Manager billing (API Version 2024-04-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-sdk/resource-manager/billing/2024-04-01/transfers"

Client Initialization

client := transfers.NewTransfersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TransfersClient.Cancel

ctx := context.TODO()
id := transfers.NewInvoiceSectionTransferID("billingAccountName", "billingProfileName", "invoiceSectionName", "transferName")

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

Example Usage: TransfersClient.Get

ctx := context.TODO()
id := transfers.NewInvoiceSectionTransferID("billingAccountName", "billingProfileName", "invoiceSectionName", "transferName")

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

Example Usage: TransfersClient.Initiate

ctx := context.TODO()
id := transfers.NewInvoiceSectionTransferID("billingAccountName", "billingProfileName", "invoiceSectionName", "transferName")

payload := transfers.InitiateTransferRequest{
	// ...
}


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

Example Usage: TransfersClient.List

ctx := context.TODO()
id := transfers.NewInvoiceSectionID("billingAccountName", "billingProfileName", "invoiceSectionName")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: TransfersClient.PartnerTransfersCancel

ctx := context.TODO()
id := transfers.NewCustomerTransferID("billingAccountName", "billingProfileName", "customerName", "transferName")

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

Example Usage: TransfersClient.PartnerTransfersGet

ctx := context.TODO()
id := transfers.NewCustomerTransferID("billingAccountName", "billingProfileName", "customerName", "transferName")

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

Example Usage: TransfersClient.PartnerTransfersInitiate

ctx := context.TODO()
id := transfers.NewCustomerTransferID("billingAccountName", "billingProfileName", "customerName", "transferName")

payload := transfers.PartnerInitiateTransferRequest{
	// ...
}


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

Example Usage: TransfersClient.PartnerTransfersList

ctx := context.TODO()
id := transfers.NewBillingProfileCustomerID("billingAccountName", "billingProfileName", "customerName")

// alternatively `client.PartnerTransfersList(ctx, id)` can be used to do batched pagination
items, err := client.PartnerTransfersListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForInitiatorCustomerType 

func PossibleValuesForInitiatorCustomerType() []string

func PossibleValuesForProductTransferStatus 

func PossibleValuesForProductTransferStatus() []string

func PossibleValuesForProductType 

func PossibleValuesForProductType() []string

func PossibleValuesForTransferStatus 

func PossibleValuesForTransferStatus() []string

func ValidateBillingProfileCustomerID 

func ValidateBillingProfileCustomerID(input interface{}, key string) (warnings []string, errors []error)

ValidateBillingProfileCustomerID checks that 'input' can be parsed as a Billing Profile Customer ID

func ValidateCustomerTransferID 

func ValidateCustomerTransferID(input interface{}, key string) (warnings []string, errors []error)

ValidateCustomerTransferID checks that 'input' can be parsed as a Customer Transfer ID

func ValidateInvoiceSectionID 

func ValidateInvoiceSectionID(input interface{}, key string) (warnings []string, errors []error)

ValidateInvoiceSectionID checks that 'input' can be parsed as a Invoice Section ID

func ValidateInvoiceSectionTransferID 

func ValidateInvoiceSectionTransferID(input interface{}, key string) (warnings []string, errors []error)

ValidateInvoiceSectionTransferID checks that 'input' can be parsed as a Invoice Section Transfer ID

Types

type BillingProfileCustomerId 

type BillingProfileCustomerId struct {
	BillingAccountName string
	BillingProfileName string
	CustomerName       string
}

BillingProfileCustomerId is a struct representing the Resource ID for a Billing Profile Customer

func NewBillingProfileCustomerID 

func NewBillingProfileCustomerID(billingAccountName string, billingProfileName string, customerName string) BillingProfileCustomerId

NewBillingProfileCustomerID returns a new BillingProfileCustomerId struct

func ParseBillingProfileCustomerID 

func ParseBillingProfileCustomerID(input string) (*BillingProfileCustomerId, error)

ParseBillingProfileCustomerID parses 'input' into a BillingProfileCustomerId

func ParseBillingProfileCustomerIDInsensitively 

func ParseBillingProfileCustomerIDInsensitively(input string) (*BillingProfileCustomerId, error)

ParseBillingProfileCustomerIDInsensitively parses 'input' case-insensitively into a BillingProfileCustomerId note: this method should only be used for API response data and not user input

func (*BillingProfileCustomerId) FromParseResult 

func (id *BillingProfileCustomerId) FromParseResult(input resourceids.ParseResult) error

func (BillingProfileCustomerId) ID 

func (id BillingProfileCustomerId) ID() string

ID returns the formatted Billing Profile Customer ID

func (BillingProfileCustomerId) Segments 

func (id BillingProfileCustomerId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Billing Profile Customer ID

func (BillingProfileCustomerId) String 

func (id BillingProfileCustomerId) String() string

String returns a human-readable description of this Billing Profile Customer ID

type CancelOperationResponse 

type CancelOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TransferDetails
}

type CustomerTransferId 

type CustomerTransferId struct {
	BillingAccountName string
	BillingProfileName string
	CustomerName       string
	TransferName       string
}

CustomerTransferId is a struct representing the Resource ID for a Customer Transfer

func NewCustomerTransferID 

func NewCustomerTransferID(billingAccountName string, billingProfileName string, customerName string, transferName string) CustomerTransferId

NewCustomerTransferID returns a new CustomerTransferId struct

func ParseCustomerTransferID 

func ParseCustomerTransferID(input string) (*CustomerTransferId, error)

ParseCustomerTransferID parses 'input' into a CustomerTransferId

func ParseCustomerTransferIDInsensitively 

func ParseCustomerTransferIDInsensitively(input string) (*CustomerTransferId, error)

ParseCustomerTransferIDInsensitively parses 'input' case-insensitively into a CustomerTransferId note: this method should only be used for API response data and not user input

func (*CustomerTransferId) FromParseResult 

func (id *CustomerTransferId) FromParseResult(input resourceids.ParseResult) error

func (CustomerTransferId) ID 

func (id CustomerTransferId) ID() string

ID returns the formatted Customer Transfer ID

func (CustomerTransferId) Segments 

func (id CustomerTransferId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Customer Transfer ID

func (CustomerTransferId) String 

func (id CustomerTransferId) String() string

String returns a human-readable description of this Customer Transfer ID

type DetailedTransferStatus 

type DetailedTransferStatus struct {
	ErrorDetails   *TransferError         `json:"errorDetails,omitempty"`
	ProductId      *string                `json:"productId,omitempty"`
	ProductName    *string                `json:"productName,omitempty"`
	ProductType    *ProductType           `json:"productType,omitempty"`
	SkuDescription *string                `json:"skuDescription,omitempty"`
	TransferStatus *ProductTransferStatus `json:"transferStatus,omitempty"`
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TransferDetails
}

type InitiateOperationResponse 

type InitiateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TransferDetails
}

type InitiateTransferProperties 

type InitiateTransferProperties struct {
	RecipientEmailId *string `json:"recipientEmailId,omitempty"`
}

type InitiateTransferRequest 

type InitiateTransferRequest struct {
	Properties *InitiateTransferProperties `json:"properties,omitempty"`
}

type InitiatorCustomerType 

type InitiatorCustomerType string
const (
	InitiatorCustomerTypeEA      InitiatorCustomerType = "EA"
	InitiatorCustomerTypePartner InitiatorCustomerType = "Partner"
)

func (*InitiatorCustomerType) UnmarshalJSON 

func (s *InitiatorCustomerType) UnmarshalJSON(bytes []byte) error

type InvoiceSectionId 

type InvoiceSectionId struct {
	BillingAccountName string
	BillingProfileName string
	InvoiceSectionName string
}

InvoiceSectionId is a struct representing the Resource ID for a Invoice Section

func NewInvoiceSectionID 

func NewInvoiceSectionID(billingAccountName string, billingProfileName string, invoiceSectionName string) InvoiceSectionId

NewInvoiceSectionID returns a new InvoiceSectionId struct

func ParseInvoiceSectionID 

func ParseInvoiceSectionID(input string) (*InvoiceSectionId, error)

ParseInvoiceSectionID parses 'input' into a InvoiceSectionId

func ParseInvoiceSectionIDInsensitively 

func ParseInvoiceSectionIDInsensitively(input string) (*InvoiceSectionId, error)

ParseInvoiceSectionIDInsensitively parses 'input' case-insensitively into a InvoiceSectionId note: this method should only be used for API response data and not user input

func (*InvoiceSectionId) FromParseResult 

func (id *InvoiceSectionId) FromParseResult(input resourceids.ParseResult) error

func (InvoiceSectionId) ID 

func (id InvoiceSectionId) ID() string

ID returns the formatted Invoice Section ID

func (InvoiceSectionId) Segments 

func (id InvoiceSectionId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Invoice Section ID

func (InvoiceSectionId) String 

func (id InvoiceSectionId) String() string

String returns a human-readable description of this Invoice Section ID

type InvoiceSectionTransferId 

type InvoiceSectionTransferId struct {
	BillingAccountName string
	BillingProfileName string
	InvoiceSectionName string
	TransferName       string
}

InvoiceSectionTransferId is a struct representing the Resource ID for a Invoice Section Transfer

func NewInvoiceSectionTransferID 

func NewInvoiceSectionTransferID(billingAccountName string, billingProfileName string, invoiceSectionName string, transferName string) InvoiceSectionTransferId

NewInvoiceSectionTransferID returns a new InvoiceSectionTransferId struct

func ParseInvoiceSectionTransferID 

func ParseInvoiceSectionTransferID(input string) (*InvoiceSectionTransferId, error)

ParseInvoiceSectionTransferID parses 'input' into a InvoiceSectionTransferId

func ParseInvoiceSectionTransferIDInsensitively 

func ParseInvoiceSectionTransferIDInsensitively(input string) (*InvoiceSectionTransferId, error)

ParseInvoiceSectionTransferIDInsensitively parses 'input' case-insensitively into a InvoiceSectionTransferId note: this method should only be used for API response data and not user input

func (*InvoiceSectionTransferId) FromParseResult 

func (id *InvoiceSectionTransferId) FromParseResult(input resourceids.ParseResult) error

func (InvoiceSectionTransferId) ID 

func (id InvoiceSectionTransferId) ID() string

ID returns the formatted Invoice Section Transfer ID

func (InvoiceSectionTransferId) Segments 

func (id InvoiceSectionTransferId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Invoice Section Transfer ID

func (InvoiceSectionTransferId) String 

func (id InvoiceSectionTransferId) String() string

String returns a human-readable description of this Invoice Section Transfer ID

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TransferDetails
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TransferDetails
}

type PartnerInitiateTransferProperties 

type PartnerInitiateTransferProperties struct {
	RecipientEmailId *string `json:"recipientEmailId,omitempty"`
	ResellerId       *string `json:"resellerId,omitempty"`
}

type PartnerInitiateTransferRequest 

type PartnerInitiateTransferRequest struct {
	Properties *PartnerInitiateTransferProperties `json:"properties,omitempty"`
}

type PartnerTransferDetails 

type PartnerTransferDetails struct {
	Id         *string                    `json:"id,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *PartnerTransferProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData     `json:"systemData,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type PartnerTransferDetailsOperationPredicate 

type PartnerTransferDetailsOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (PartnerTransferDetailsOperationPredicate) Matches 

func (p PartnerTransferDetailsOperationPredicate) Matches(input PartnerTransferDetails) bool

type PartnerTransferProperties 

type PartnerTransferProperties struct {
	CanceledBy             *string                   `json:"canceledBy,omitempty"`
	DetailedTransferStatus *[]DetailedTransferStatus `json:"detailedTransferStatus,omitempty"`
	ExpirationTime         *string                   `json:"expirationTime,omitempty"`
	InitiatorCustomerType  *InitiatorCustomerType    `json:"initiatorCustomerType,omitempty"`
	InitiatorEmailId       *string                   `json:"initiatorEmailId,omitempty"`
	RecipientEmailId       *string                   `json:"recipientEmailId,omitempty"`
	ResellerId             *string                   `json:"resellerId,omitempty"`
	ResellerName           *string                   `json:"resellerName,omitempty"`
	TransferStatus         *TransferStatus           `json:"transferStatus,omitempty"`
}

func (*PartnerTransferProperties) GetExpirationTimeAsTime 

func (o *PartnerTransferProperties) GetExpirationTimeAsTime() (*time.Time, error)

func (*PartnerTransferProperties) SetExpirationTimeAsTime 

func (o *PartnerTransferProperties) SetExpirationTimeAsTime(input time.Time)

type PartnerTransfersCancelOperationResponse 

type PartnerTransfersCancelOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerTransferDetails
}

type PartnerTransfersGetOperationResponse 

type PartnerTransfersGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerTransferDetails
}

type PartnerTransfersInitiateOperationResponse 

type PartnerTransfersInitiateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PartnerTransferDetails
}

type PartnerTransfersListCompleteResult 

type PartnerTransfersListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PartnerTransferDetails
}

type PartnerTransfersListCustomPager added in v0.20240628.1153531 

type PartnerTransfersListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *PartnerTransfersListCustomPager) NextPageLink() *odata.Link

type PartnerTransfersListOperationResponse 

type PartnerTransfersListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PartnerTransferDetails
}

type ProductTransferStatus 

type ProductTransferStatus string
const (
	ProductTransferStatusCompleted  ProductTransferStatus = "Completed"
	ProductTransferStatusFailed     ProductTransferStatus = "Failed"
	ProductTransferStatusInProgress ProductTransferStatus = "InProgress"
	ProductTransferStatusNotStarted ProductTransferStatus = "NotStarted"
)

func (*ProductTransferStatus) UnmarshalJSON 

func (s *ProductTransferStatus) UnmarshalJSON(bytes []byte) error

type ProductType 

type ProductType string
const (
	ProductTypeAzureReservation  ProductType = "AzureReservation"
	ProductTypeAzureSubscription ProductType = "AzureSubscription"
	ProductTypeDepartment        ProductType = "Department"
	ProductTypeSAAS              ProductType = "SAAS"
	ProductTypeSavingsPlan       ProductType = "SavingsPlan"
)

func (*ProductType) UnmarshalJSON 

func (s *ProductType) UnmarshalJSON(bytes []byte) error

type TransferDetails 

type TransferDetails struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *TransferProperties    `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type TransferDetailsOperationPredicate 

type TransferDetailsOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (TransferDetailsOperationPredicate) Matches 

func (p TransferDetailsOperationPredicate) Matches(input TransferDetails) bool

type TransferError 

type TransferError struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type TransferProperties 

type TransferProperties struct {
	CanceledBy             *string                   `json:"canceledBy,omitempty"`
	DetailedTransferStatus *[]DetailedTransferStatus `json:"detailedTransferStatus,omitempty"`
	ExpirationTime         *string                   `json:"expirationTime,omitempty"`
	InitiatorEmailId       *string                   `json:"initiatorEmailId,omitempty"`
	RecipientEmailId       *string                   `json:"recipientEmailId,omitempty"`
	TransferStatus         *TransferStatus           `json:"transferStatus,omitempty"`
}

func (*TransferProperties) GetExpirationTimeAsTime 

func (o *TransferProperties) GetExpirationTimeAsTime() (*time.Time, error)

func (*TransferProperties) SetExpirationTimeAsTime 

func (o *TransferProperties) SetExpirationTimeAsTime(input time.Time)

type TransferStatus 

type TransferStatus string
const (
	TransferStatusCanceled            TransferStatus = "Canceled"
	TransferStatusCompleted           TransferStatus = "Completed"
	TransferStatusCompletedWithErrors TransferStatus = "CompletedWithErrors"
	TransferStatusDeclined            TransferStatus = "Declined"
	TransferStatusExpired             TransferStatus = "Expired"
	TransferStatusFailed              TransferStatus = "Failed"
	TransferStatusInProgress          TransferStatus = "InProgress"
	TransferStatusPending             TransferStatus = "Pending"
)

func (*TransferStatus) UnmarshalJSON 

func (s *TransferStatus) UnmarshalJSON(bytes []byte) error

type TransfersClient 

type TransfersClient struct {
	Client *resourcemanager.Client
}

func NewTransfersClientWithBaseURI 

func NewTransfersClientWithBaseURI(sdkApi sdkEnv.Api) (*TransfersClient, error)

func (TransfersClient) Cancel 

func (c TransfersClient) Cancel(ctx context.Context, id InvoiceSectionTransferId) (result CancelOperationResponse, err error)

Cancel ...

func (TransfersClient) Get 

func (c TransfersClient) Get(ctx context.Context, id InvoiceSectionTransferId) (result GetOperationResponse, err error)

Get ...

func (TransfersClient) Initiate 

func (c TransfersClient) Initiate(ctx context.Context, id InvoiceSectionTransferId, input InitiateTransferRequest) (result InitiateOperationResponse, err error)

Initiate ...

func (TransfersClient) List 

func (c TransfersClient) List(ctx context.Context, id InvoiceSectionId) (result ListOperationResponse, err error)

List ...

func (TransfersClient) ListComplete 

func (c TransfersClient) ListComplete(ctx context.Context, id InvoiceSectionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (TransfersClient) ListCompleteMatchingPredicate 

func (c TransfersClient) ListCompleteMatchingPredicate(ctx context.Context, id InvoiceSectionId, predicate TransferDetailsOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TransfersClient) PartnerTransfersCancel 

func (c TransfersClient) PartnerTransfersCancel(ctx context.Context, id CustomerTransferId) (result PartnerTransfersCancelOperationResponse, err error)

PartnerTransfersCancel ...

func (TransfersClient) PartnerTransfersGet 

func (c TransfersClient) PartnerTransfersGet(ctx context.Context, id CustomerTransferId) (result PartnerTransfersGetOperationResponse, err error)

PartnerTransfersGet ...

func (TransfersClient) PartnerTransfersInitiate 

func (c TransfersClient) PartnerTransfersInitiate(ctx context.Context, id CustomerTransferId, input PartnerInitiateTransferRequest) (result PartnerTransfersInitiateOperationResponse, err error)

PartnerTransfersInitiate ...

func (TransfersClient) PartnerTransfersList 

func (c TransfersClient) PartnerTransfersList(ctx context.Context, id BillingProfileCustomerId) (result PartnerTransfersListOperationResponse, err error)

PartnerTransfersList ...

func (TransfersClient) PartnerTransfersListComplete 

func (c TransfersClient) PartnerTransfersListComplete(ctx context.Context, id BillingProfileCustomerId) (PartnerTransfersListCompleteResult, error)

PartnerTransfersListComplete retrieves all the results into a single object

func (TransfersClient) PartnerTransfersListCompleteMatchingPredicate 

func (c TransfersClient) PartnerTransfersListCompleteMatchingPredicate(ctx context.Context, id BillingProfileCustomerId, predicate PartnerTransferDetailsOperationPredicate) (result PartnerTransfersListCompleteResult, err error)

PartnerTransfersListCompleteMatchingPredicate retrieves all the results and then applies the predicate

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.