graphservicesprods

package
v0.20240304.1112406 Latest Latest
Warning

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

 Go to latest Published: Mar 4, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/graphservices/2023-04-13/graphservicesprods Documentation

The graphservicesprods SDK allows for interaction with the Azure Resource Manager Service graphservices (API Version 2023-04-13).

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/graphservices/2023-04-13/graphservicesprods"

Client Initialization

client := graphservicesprods.NewGraphservicesprodsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GraphservicesprodsClient.AccountsCreateAndUpdate

ctx := context.TODO()
id := graphservicesprods.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

payload := graphservicesprods.AccountResource{
	// ...
}


if err := client.AccountsCreateAndUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: GraphservicesprodsClient.AccountsDelete

ctx := context.TODO()
id := graphservicesprods.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

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

Example Usage: GraphservicesprodsClient.AccountsGet

ctx := context.TODO()
id := graphservicesprods.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

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

Example Usage: GraphservicesprodsClient.AccountsListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

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

Example Usage: GraphservicesprodsClient.AccountsListBySubscription

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

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

Example Usage: GraphservicesprodsClient.AccountsUpdate

ctx := context.TODO()
id := graphservicesprods.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

payload := graphservicesprods.TagUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCreatedByType 

func PossibleValuesForCreatedByType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateAccountID 

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

ValidateAccountID checks that 'input' can be parsed as a Account ID

Types

type AccountId 

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID 

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID 

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively 

func ParseAccountIDInsensitively(input string) (*AccountId, error)

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

func (*AccountId) FromParseResult 

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

func (AccountId) ID 

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Account ID

func (AccountId) String 

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type AccountResource 

type AccountResource struct {
	Id         *string                    `json:"id,omitempty"`
	Location   *string                    `json:"location,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties AccountResourceProperties  `json:"properties"`
	SystemData *AccountResourceSystemData `json:"systemData,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type AccountResourceOperationPredicate 

type AccountResourceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (AccountResourceOperationPredicate) Matches 

func (p AccountResourceOperationPredicate) Matches(input AccountResource) bool

type AccountResourceProperties 

type AccountResourceProperties struct {
	AppId             string             `json:"appId"`
	BillingPlanId     *string            `json:"billingPlanId,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type AccountResourceSystemData 

type AccountResourceSystemData struct {
	CreatedAt          *string        `json:"createdAt,omitempty"`
	CreatedByType      *CreatedByType `json:"createdByType,omitempty"`
	LastModifiedAt     *string        `json:"lastModifiedAt,omitempty"`
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

func (*AccountResourceSystemData) GetCreatedAtAsTime 

func (o *AccountResourceSystemData) GetCreatedAtAsTime() (*time.Time, error)

func (*AccountResourceSystemData) GetLastModifiedAtAsTime 

func (o *AccountResourceSystemData) GetLastModifiedAtAsTime() (*time.Time, error)

func (*AccountResourceSystemData) SetCreatedAtAsTime 

func (o *AccountResourceSystemData) SetCreatedAtAsTime(input time.Time)

func (*AccountResourceSystemData) SetLastModifiedAtAsTime 

func (o *AccountResourceSystemData) SetLastModifiedAtAsTime(input time.Time)

type AccountsCreateAndUpdateOperationResponse 

type AccountsCreateAndUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccountResource
}

type AccountsDeleteOperationResponse 

type AccountsDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type AccountsGetOperationResponse 

type AccountsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccountResource
}

type AccountsListByResourceGroupCompleteResult 

type AccountsListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AccountResource
}

type AccountsListByResourceGroupOperationResponse 

type AccountsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AccountResource
}

type AccountsListBySubscriptionCompleteResult 

type AccountsListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AccountResource
}

type AccountsListBySubscriptionOperationResponse 

type AccountsListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AccountResource
}

type AccountsUpdateOperationResponse 

type AccountsUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccountResource
}

type CreatedByType 

type CreatedByType string
const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func (*CreatedByType) UnmarshalJSON 

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

type GraphservicesprodsClient 

type GraphservicesprodsClient struct {
	Client *resourcemanager.Client
}

func NewGraphservicesprodsClientWithBaseURI 

func NewGraphservicesprodsClientWithBaseURI(sdkApi sdkEnv.Api) (*GraphservicesprodsClient, error)

func (GraphservicesprodsClient) AccountsCreateAndUpdate 

func (c GraphservicesprodsClient) AccountsCreateAndUpdate(ctx context.Context, id AccountId, input AccountResource) (result AccountsCreateAndUpdateOperationResponse, err error)

AccountsCreateAndUpdate ...

func (GraphservicesprodsClient) AccountsCreateAndUpdateThenPoll 

func (c GraphservicesprodsClient) AccountsCreateAndUpdateThenPoll(ctx context.Context, id AccountId, input AccountResource) error

AccountsCreateAndUpdateThenPoll performs AccountsCreateAndUpdate then polls until it's completed

func (GraphservicesprodsClient) AccountsDelete 

func (c GraphservicesprodsClient) AccountsDelete(ctx context.Context, id AccountId) (result AccountsDeleteOperationResponse, err error)

AccountsDelete ...

func (GraphservicesprodsClient) AccountsGet 

func (c GraphservicesprodsClient) AccountsGet(ctx context.Context, id AccountId) (result AccountsGetOperationResponse, err error)

AccountsGet ...

func (GraphservicesprodsClient) AccountsListByResourceGroup 

func (c GraphservicesprodsClient) AccountsListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result AccountsListByResourceGroupOperationResponse, err error)

AccountsListByResourceGroup ...

func (GraphservicesprodsClient) AccountsListByResourceGroupComplete 

func (c GraphservicesprodsClient) AccountsListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (AccountsListByResourceGroupCompleteResult, error)

AccountsListByResourceGroupComplete retrieves all the results into a single object

func (GraphservicesprodsClient) AccountsListByResourceGroupCompleteMatchingPredicate 

func (c GraphservicesprodsClient) AccountsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate AccountResourceOperationPredicate) (result AccountsListByResourceGroupCompleteResult, err error)

AccountsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GraphservicesprodsClient) AccountsListBySubscription 

func (c GraphservicesprodsClient) AccountsListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result AccountsListBySubscriptionOperationResponse, err error)

AccountsListBySubscription ...

func (GraphservicesprodsClient) AccountsListBySubscriptionComplete 

func (c GraphservicesprodsClient) AccountsListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (AccountsListBySubscriptionCompleteResult, error)

AccountsListBySubscriptionComplete retrieves all the results into a single object

func (GraphservicesprodsClient) AccountsListBySubscriptionCompleteMatchingPredicate 

func (c GraphservicesprodsClient) AccountsListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate AccountResourceOperationPredicate) (result AccountsListBySubscriptionCompleteResult, err error)

AccountsListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GraphservicesprodsClient) AccountsUpdate 

func (c GraphservicesprodsClient) AccountsUpdate(ctx context.Context, id AccountId, input TagUpdate) (result AccountsUpdateOperationResponse, err error)

AccountsUpdate ...

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON 

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

type TagUpdate 

type TagUpdate struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

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.