billingcontainers

README

github.com/hashicorp/go-azure-sdk/resource-manager/deviceregistry/2024-11-01/billingcontainers Documentation

The billingcontainers SDK allows for interaction with Azure Resource Manager deviceregistry (API Version 2024-11-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/deviceregistry/2024-11-01/billingcontainers"

Client Initialization

client := billingcontainers.NewBillingContainersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BillingContainersClient.Get

ctx := context.TODO()
id := billingcontainers.NewBillingContainerID("12345678-1234-9876-4563-123456789012", "billingContainerName")

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: BillingContainersClient.ListBySubscription

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

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

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• func ValidateBillingContainerID(input interface{}, key string) (warnings []string, errors []error)
• type BillingContainer
• type BillingContainerId
  • func NewBillingContainerID(subscriptionId string, billingContainerName string) BillingContainerId
  • func ParseBillingContainerID(input string) (*BillingContainerId, error)
  • func ParseBillingContainerIDInsensitively(input string) (*BillingContainerId, error)
  • func (id *BillingContainerId) FromParseResult(input resourceids.ParseResult) error
  • func (id BillingContainerId) ID() string
  • func (id BillingContainerId) Segments() []resourceids.Segment
  • func (id BillingContainerId) String() string
• type BillingContainerOperationPredicate
  • func (p BillingContainerOperationPredicate) Matches(input BillingContainer) bool
• type BillingContainerProperties
• type BillingContainersClient
  • func NewBillingContainersClientWithBaseURI(sdkApi sdkEnv.Api) (*BillingContainersClient, error)
  • func (c BillingContainersClient) Get(ctx context.Context, id BillingContainerId) (result GetOperationResponse, err error)
  • func (c BillingContainersClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
  • func (c BillingContainersClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
  • func (c BillingContainersClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)
• type GetOperationResponse
• type ListBySubscriptionCompleteResult
• type ListBySubscriptionCustomPager
  • func (p *ListBySubscriptionCustomPager) NextPageLink() *odata.Link
• type ListBySubscriptionOperationResponse
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateBillingContainerID

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

ValidateBillingContainerID checks that 'input' can be parsed as a Billing Container ID

Types

type BillingContainer

type BillingContainer struct {
	Etag       *string                     `json:"etag,omitempty"`
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *BillingContainerProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type BillingContainerId

type BillingContainerId struct {
	SubscriptionId       string
	BillingContainerName string
}

BillingContainerId is a struct representing the Resource ID for a Billing Container

func NewBillingContainerID

func NewBillingContainerID(subscriptionId string, billingContainerName string) BillingContainerId

NewBillingContainerID returns a new BillingContainerId struct

func ParseBillingContainerID

func ParseBillingContainerID(input string) (*BillingContainerId, error)

ParseBillingContainerID parses 'input' into a BillingContainerId

func ParseBillingContainerIDInsensitively

func ParseBillingContainerIDInsensitively(input string) (*BillingContainerId, error)

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

func (*BillingContainerId) FromParseResult

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

func (BillingContainerId) ID

func (id BillingContainerId) ID() string

ID returns the formatted Billing Container ID

func (BillingContainerId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Billing Container ID

func (BillingContainerId) String

func (id BillingContainerId) String() string

String returns a human-readable description of this Billing Container ID

type BillingContainerOperationPredicate

type BillingContainerOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (BillingContainerOperationPredicate) Matches

func (p BillingContainerOperationPredicate) Matches(input BillingContainer) bool

type BillingContainerProperties

type BillingContainerProperties struct {
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type BillingContainersClient

type BillingContainersClient struct {
	Client *resourcemanager.Client
}

func NewBillingContainersClientWithBaseURI

func NewBillingContainersClientWithBaseURI(sdkApi sdkEnv.Api) (*BillingContainersClient, error)

func (BillingContainersClient) Get

func (c BillingContainersClient) Get(ctx context.Context, id BillingContainerId) (result GetOperationResponse, err error)

Get ...

func (BillingContainersClient) ListBySubscription

func (c BillingContainersClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (BillingContainersClient) ListBySubscriptionComplete

func (c BillingContainersClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (BillingContainersClient) ListBySubscriptionCompleteMatchingPredicate

func (c BillingContainersClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate BillingContainerOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse

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

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []BillingContainer
}

type ListBySubscriptionCustomPager

type ListBySubscriptionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListBySubscriptionCustomPager) NextPageLink

func (p *ListBySubscriptionCustomPager) NextPageLink() *odata.Link

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]BillingContainer
}

type ProvisioningState

type ProvisioningState string

const (
	ProvisioningStateAccepted  ProvisioningState = "Accepted"
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON

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