productgroup

package
v0.20221025.1104718 Latest Latest
Warning

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

 Go to latest Published: Oct 25, 2022 License: MPL-2.0 Imports: 8 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/productgroup Documentation

The productgroup SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2021-08-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/apimanagement/2021-08-01/productgroup"

Client Initialization

client := productgroup.NewProductGroupClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProductGroupClient.CheckEntityExists

ctx := context.TODO()
id := productgroup.NewGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "groupIdValue")

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

Example Usage: ProductGroupClient.CreateOrUpdate

ctx := context.TODO()
id := productgroup.NewGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "groupIdValue")

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

Example Usage: ProductGroupClient.Delete

ctx := context.TODO()
id := productgroup.NewGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "groupIdValue")

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

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

// alternatively `client.ListByProduct(ctx, id, productgroup.DefaultListByProductOperationOptions())` can be used to do batched pagination
items, err := client.ListByProductComplete(ctx, id, productgroup.DefaultListByProductOperationOptions())
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 PossibleValuesForGroupType 

func PossibleValuesForGroupType() []string

func ValidateGroupID 

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

ValidateGroupID checks that 'input' can be parsed as a Group ID

func ValidateProductID 

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

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

Types

type CheckEntityExistsOperationResponse 

type CheckEntityExistsOperationResponse struct {
	HttpResponse *http.Response
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *GroupContract
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GroupContract 

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

type GroupContractOperationPredicate 

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

func (GroupContractOperationPredicate) Matches 

func (p GroupContractOperationPredicate) Matches(input GroupContract) bool

type GroupContractProperties 

type GroupContractProperties struct {
	BuiltIn     *bool      `json:"builtIn,omitempty"`
	Description *string    `json:"description,omitempty"`
	DisplayName string     `json:"displayName"`
	ExternalId  *string    `json:"externalId,omitempty"`
	Type        *GroupType `json:"type,omitempty"`
}

type GroupId 

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

GroupId is a struct representing the Resource ID for a Group

func NewGroupID 

func NewGroupID(subscriptionId string, resourceGroupName string, serviceName string, groupId string) GroupId

NewGroupID returns a new GroupId struct

func ParseGroupID 

func ParseGroupID(input string) (*GroupId, error)

ParseGroupID parses 'input' into a GroupId

func ParseGroupIDInsensitively 

func ParseGroupIDInsensitively(input string) (*GroupId, error)

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

func (GroupId) ID 

func (id GroupId) ID() string

ID returns the formatted Group ID

func (GroupId) Segments 

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

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

func (GroupId) String 

func (id GroupId) String() string

String returns a human-readable description of this Group ID

type GroupType 

type GroupType string
const (
	GroupTypeCustom   GroupType = "custom"
	GroupTypeExternal GroupType = "external"
	GroupTypeSystem   GroupType = "system"
)

type ListByProductCompleteResult 

type ListByProductCompleteResult struct {
	Items []GroupContract
}

type ListByProductOperationOptions 

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

func DefaultListByProductOperationOptions 

func DefaultListByProductOperationOptions() ListByProductOperationOptions

type ListByProductOperationResponse 

type ListByProductOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]GroupContract
	// contains filtered or unexported fields
}

func (ListByProductOperationResponse) HasMore 

func (r ListByProductOperationResponse) HasMore() bool

func (ListByProductOperationResponse) LoadMore 

func (r ListByProductOperationResponse) LoadMore(ctx context.Context) (resp ListByProductOperationResponse, err error)

type ProductGroupClient 

type ProductGroupClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewProductGroupClientWithBaseURI 

func NewProductGroupClientWithBaseURI(endpoint string) ProductGroupClient

func (ProductGroupClient) CheckEntityExists 

func (c ProductGroupClient) CheckEntityExists(ctx context.Context, id GroupId) (result CheckEntityExistsOperationResponse, err error)

CheckEntityExists ...

func (ProductGroupClient) CreateOrUpdate 

func (c ProductGroupClient) CreateOrUpdate(ctx context.Context, id GroupId) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ProductGroupClient) Delete 

func (c ProductGroupClient) Delete(ctx context.Context, id GroupId) (result DeleteOperationResponse, err error)

Delete ...

func (ProductGroupClient) ListByProduct 

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

ListByProduct ...

func (ProductGroupClient) ListByProductComplete 

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

ListByProductComplete retrieves all of the results into a single object

func (ProductGroupClient) ListByProductCompleteMatchingPredicate 

func (c ProductGroupClient) ListByProductCompleteMatchingPredicate(ctx context.Context, id ProductId, options ListByProductOperationOptions, predicate GroupContractOperationPredicate) (resp ListByProductCompleteResult, err error)

ListByProductCompleteMatchingPredicate retrieves all of the results and then applied the predicate

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) 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

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.