productgrouplink

package
v0.20240228.1133018 Latest Latest
Warning

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

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

README

The productgrouplink SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2023-05-01-preview).

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/apimanagement/2023-05-01-preview/productgrouplink"

Client Initialization

client := productgrouplink.NewProductGroupLinkClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProductGroupLinkClient.CreateOrUpdate

ctx := context.TODO()
id := productgrouplink.NewGroupLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "productIdValue", "groupLinkIdValue")

payload := productgrouplink.ProductGroupLinkContract{
	// ...
}


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

Example Usage: ProductGroupLinkClient.Delete

ctx := context.TODO()
id := productgrouplink.NewGroupLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "productIdValue", "groupLinkIdValue")

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

Example Usage: ProductGroupLinkClient.Get

ctx := context.TODO()
id := productgrouplink.NewGroupLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "productIdValue", "groupLinkIdValue")

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: ProductGroupLinkClient.ListByProduct

ctx := context.TODO()
id := productgrouplink.NewProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "productIdValue")

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

Example Usage: ProductGroupLinkClient.WorkspaceProductGroupLinkCreateOrUpdate

ctx := context.TODO()
id := productgrouplink.NewProductGroupLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "productIdValue", "groupLinkIdValue")

payload := productgrouplink.ProductGroupLinkContract{
	// ...
}


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

Example Usage: ProductGroupLinkClient.WorkspaceProductGroupLinkDelete

ctx := context.TODO()
id := productgrouplink.NewProductGroupLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "productIdValue", "groupLinkIdValue")

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

Example Usage: ProductGroupLinkClient.WorkspaceProductGroupLinkGet

ctx := context.TODO()
id := productgrouplink.NewProductGroupLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "productIdValue", "groupLinkIdValue")

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

Example Usage: ProductGroupLinkClient.WorkspaceProductGroupLinkListByProduct

ctx := context.TODO()
id := productgrouplink.NewWorkspaceProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "productIdValue")

// alternatively `client.WorkspaceProductGroupLinkListByProduct(ctx, id, productgrouplink.DefaultWorkspaceProductGroupLinkListByProductOperationOptions())` can be used to do batched pagination
items, err := client.WorkspaceProductGroupLinkListByProductComplete(ctx, id, productgrouplink.DefaultWorkspaceProductGroupLinkListByProductOperationOptions())
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 ValidateGroupLinkID 

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

ValidateGroupLinkID checks that 'input' can be parsed as a Group Link ID

func ValidateProductGroupLinkID 

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

ValidateProductGroupLinkID checks that 'input' can be parsed as a Product Group Link ID

func ValidateProductID 

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

ValidateProductID checks that 'input' can be parsed as a Product ID

func ValidateWorkspaceProductID 

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

ValidateWorkspaceProductID checks that 'input' can be parsed as a Workspace Product ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProductGroupLinkContract
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type GroupLinkId 

type GroupLinkId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ProductId         string
	GroupLinkId       string
}

GroupLinkId is a struct representing the Resource ID for a Group Link

func NewGroupLinkID 

func NewGroupLinkID(subscriptionId string, resourceGroupName string, serviceName string, productId string, groupLinkId string) GroupLinkId

NewGroupLinkID returns a new GroupLinkId struct

func ParseGroupLinkID 

func ParseGroupLinkID(input string) (*GroupLinkId, error)

ParseGroupLinkID parses 'input' into a GroupLinkId

func ParseGroupLinkIDInsensitively 

func ParseGroupLinkIDInsensitively(input string) (*GroupLinkId, error)

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

func (*GroupLinkId) FromParseResult 

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

func (GroupLinkId) ID 

func (id GroupLinkId) ID() string

ID returns the formatted Group Link ID

func (GroupLinkId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Group Link ID

func (GroupLinkId) String 

func (id GroupLinkId) String() string

String returns a human-readable description of this Group Link ID

type ListByProductCompleteResult 

type ListByProductCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProductGroupLinkContract
}

type ListByProductOperationOptions 

type ListByProductOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

func DefaultListByProductOperationOptions 

func DefaultListByProductOperationOptions() ListByProductOperationOptions

func (ListByProductOperationOptions) ToHeaders 

func (o ListByProductOperationOptions) ToHeaders() *client.Headers

func (ListByProductOperationOptions) ToOData 

func (o ListByProductOperationOptions) ToOData() *odata.Query

func (ListByProductOperationOptions) ToQuery 

func (o ListByProductOperationOptions) ToQuery() *client.QueryParams

type ListByProductOperationResponse 

type ListByProductOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ProductGroupLinkContract
}

type ProductGroupLinkClient 

type ProductGroupLinkClient struct {
	Client *resourcemanager.Client
}

func NewProductGroupLinkClientWithBaseURI 

func NewProductGroupLinkClientWithBaseURI(sdkApi sdkEnv.Api) (*ProductGroupLinkClient, error)

func (ProductGroupLinkClient) CreateOrUpdate 

func (c ProductGroupLinkClient) CreateOrUpdate(ctx context.Context, id GroupLinkId, input ProductGroupLinkContract) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ProductGroupLinkClient) Delete 

func (c ProductGroupLinkClient) Delete(ctx context.Context, id GroupLinkId) (result DeleteOperationResponse, err error)

Delete ...

func (ProductGroupLinkClient) Get 

func (c ProductGroupLinkClient) Get(ctx context.Context, id GroupLinkId) (result GetOperationResponse, err error)

Get ...

func (ProductGroupLinkClient) ListByProduct 

func (c ProductGroupLinkClient) ListByProduct(ctx context.Context, id ProductId, options ListByProductOperationOptions) (result ListByProductOperationResponse, err error)

ListByProduct ...

func (ProductGroupLinkClient) ListByProductComplete 

func (c ProductGroupLinkClient) ListByProductComplete(ctx context.Context, id ProductId, options ListByProductOperationOptions) (ListByProductCompleteResult, error)

ListByProductComplete retrieves all the results into a single object

func (ProductGroupLinkClient) ListByProductCompleteMatchingPredicate 

func (c ProductGroupLinkClient) ListByProductCompleteMatchingPredicate(ctx context.Context, id ProductId, options ListByProductOperationOptions, predicate ProductGroupLinkContractOperationPredicate) (result ListByProductCompleteResult, err error)

ListByProductCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ProductGroupLinkClient) WorkspaceProductGroupLinkCreateOrUpdate 

func (c ProductGroupLinkClient) WorkspaceProductGroupLinkCreateOrUpdate(ctx context.Context, id ProductGroupLinkId, input ProductGroupLinkContract) (result WorkspaceProductGroupLinkCreateOrUpdateOperationResponse, err error)

WorkspaceProductGroupLinkCreateOrUpdate ...

func (ProductGroupLinkClient) WorkspaceProductGroupLinkDelete 

func (c ProductGroupLinkClient) WorkspaceProductGroupLinkDelete(ctx context.Context, id ProductGroupLinkId) (result WorkspaceProductGroupLinkDeleteOperationResponse, err error)

WorkspaceProductGroupLinkDelete ...

func (ProductGroupLinkClient) WorkspaceProductGroupLinkGet 

func (c ProductGroupLinkClient) WorkspaceProductGroupLinkGet(ctx context.Context, id ProductGroupLinkId) (result WorkspaceProductGroupLinkGetOperationResponse, err error)

WorkspaceProductGroupLinkGet ...

func (ProductGroupLinkClient) WorkspaceProductGroupLinkListByProduct 

func (c ProductGroupLinkClient) WorkspaceProductGroupLinkListByProduct(ctx context.Context, id WorkspaceProductId, options WorkspaceProductGroupLinkListByProductOperationOptions) (result WorkspaceProductGroupLinkListByProductOperationResponse, err error)

WorkspaceProductGroupLinkListByProduct ...

func (ProductGroupLinkClient) WorkspaceProductGroupLinkListByProductComplete 

func (c ProductGroupLinkClient) WorkspaceProductGroupLinkListByProductComplete(ctx context.Context, id WorkspaceProductId, options WorkspaceProductGroupLinkListByProductOperationOptions) (WorkspaceProductGroupLinkListByProductCompleteResult, error)

WorkspaceProductGroupLinkListByProductComplete retrieves all the results into a single object

func (ProductGroupLinkClient) WorkspaceProductGroupLinkListByProductCompleteMatchingPredicate 

func (c ProductGroupLinkClient) WorkspaceProductGroupLinkListByProductCompleteMatchingPredicate(ctx context.Context, id WorkspaceProductId, options WorkspaceProductGroupLinkListByProductOperationOptions, predicate ProductGroupLinkContractOperationPredicate) (result WorkspaceProductGroupLinkListByProductCompleteResult, err error)

WorkspaceProductGroupLinkListByProductCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ProductGroupLinkContract 

type ProductGroupLinkContract struct {
	Id         *string                             `json:"id,omitempty"`
	Name       *string                             `json:"name,omitempty"`
	Properties *ProductGroupLinkContractProperties `json:"properties,omitempty"`
	Type       *string                             `json:"type,omitempty"`
}

type ProductGroupLinkContractOperationPredicate 

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

func (ProductGroupLinkContractOperationPredicate) Matches 

func (p ProductGroupLinkContractOperationPredicate) Matches(input ProductGroupLinkContract) bool

type ProductGroupLinkContractProperties 

type ProductGroupLinkContractProperties struct {
	GroupId string `json:"groupId"`
}

type ProductGroupLinkId 

type ProductGroupLinkId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	ProductId         string
	GroupLinkId       string
}

ProductGroupLinkId is a struct representing the Resource ID for a Product Group Link

func NewProductGroupLinkID 

func NewProductGroupLinkID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, productId string, groupLinkId string) ProductGroupLinkId

NewProductGroupLinkID returns a new ProductGroupLinkId struct

func ParseProductGroupLinkID 

func ParseProductGroupLinkID(input string) (*ProductGroupLinkId, error)

ParseProductGroupLinkID parses 'input' into a ProductGroupLinkId

func ParseProductGroupLinkIDInsensitively 

func ParseProductGroupLinkIDInsensitively(input string) (*ProductGroupLinkId, error)

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

func (*ProductGroupLinkId) FromParseResult 

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

func (ProductGroupLinkId) ID 

func (id ProductGroupLinkId) ID() string

ID returns the formatted Product Group Link ID

func (ProductGroupLinkId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Product Group Link ID

func (ProductGroupLinkId) String 

func (id ProductGroupLinkId) String() string

String returns a human-readable description of this Product Group Link ID

type ProductId 

type ProductId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ProductId         string
}

ProductId is a struct representing the Resource ID for a Product

func NewProductID 

func NewProductID(subscriptionId string, resourceGroupName string, serviceName string, productId string) ProductId

NewProductID returns a new ProductId struct

func ParseProductID 

func ParseProductID(input string) (*ProductId, error)

ParseProductID parses 'input' into a ProductId

func ParseProductIDInsensitively 

func ParseProductIDInsensitively(input string) (*ProductId, error)

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

func (*ProductId) FromParseResult 

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

func (ProductId) ID 

func (id ProductId) ID() string

ID returns the formatted Product ID

func (ProductId) Segments 

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

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

func (ProductId) String 

func (id ProductId) String() string

String returns a human-readable description of this Product ID

type WorkspaceProductGroupLinkCreateOrUpdateOperationResponse 

type WorkspaceProductGroupLinkCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProductGroupLinkContract
}

type WorkspaceProductGroupLinkDeleteOperationResponse 

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

type WorkspaceProductGroupLinkGetOperationResponse 

type WorkspaceProductGroupLinkGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProductGroupLinkContract
}

type WorkspaceProductGroupLinkListByProductCompleteResult 

type WorkspaceProductGroupLinkListByProductCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProductGroupLinkContract
}

type WorkspaceProductGroupLinkListByProductOperationOptions 

type WorkspaceProductGroupLinkListByProductOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

func DefaultWorkspaceProductGroupLinkListByProductOperationOptions 

func DefaultWorkspaceProductGroupLinkListByProductOperationOptions() WorkspaceProductGroupLinkListByProductOperationOptions

func (WorkspaceProductGroupLinkListByProductOperationOptions) ToHeaders 

func (o WorkspaceProductGroupLinkListByProductOperationOptions) ToHeaders() *client.Headers

func (WorkspaceProductGroupLinkListByProductOperationOptions) ToOData 

func (o WorkspaceProductGroupLinkListByProductOperationOptions) ToOData() *odata.Query

func (WorkspaceProductGroupLinkListByProductOperationOptions) ToQuery 

func (o WorkspaceProductGroupLinkListByProductOperationOptions) ToQuery() *client.QueryParams

type WorkspaceProductGroupLinkListByProductOperationResponse 

type WorkspaceProductGroupLinkListByProductOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ProductGroupLinkContract
}

type WorkspaceProductId 

type WorkspaceProductId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	ProductId         string
}

WorkspaceProductId is a struct representing the Resource ID for a Workspace Product

func NewWorkspaceProductID 

func NewWorkspaceProductID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, productId string) WorkspaceProductId

NewWorkspaceProductID returns a new WorkspaceProductId struct

func ParseWorkspaceProductID 

func ParseWorkspaceProductID(input string) (*WorkspaceProductId, error)

ParseWorkspaceProductID parses 'input' into a WorkspaceProductId

func ParseWorkspaceProductIDInsensitively 

func ParseWorkspaceProductIDInsensitively(input string) (*WorkspaceProductId, error)

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

func (*WorkspaceProductId) FromParseResult 

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

func (WorkspaceProductId) ID 

func (id WorkspaceProductId) ID() string

ID returns the formatted Workspace Product ID

func (WorkspaceProductId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Workspace Product ID

func (WorkspaceProductId) String 

func (id WorkspaceProductId) String() string

String returns a human-readable description of this Workspace Product ID

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.