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 ¶
- func PossibleValuesForGroupType() []string
- func ValidateGroupID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateProductID(input interface{}, key string) (warnings []string, errors []error)
- type CheckEntityExistsOperationResponse
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GroupContract
- type GroupContractOperationPredicate
- type GroupContractProperties
- type GroupId
- type GroupType
- type ListByProductCompleteResult
- type ListByProductOperationOptions
- type ListByProductOperationResponse
- type ProductGroupClient
- func (c ProductGroupClient) CheckEntityExists(ctx context.Context, id GroupId) (result CheckEntityExistsOperationResponse, err error)
- func (c ProductGroupClient) CreateOrUpdate(ctx context.Context, id GroupId) (result CreateOrUpdateOperationResponse, err error)
- func (c ProductGroupClient) Delete(ctx context.Context, id GroupId) (result DeleteOperationResponse, err error)
- func (c ProductGroupClient) ListByProduct(ctx context.Context, id ProductId, options ListByProductOperationOptions) (resp ListByProductOperationResponse, err error)
- func (c ProductGroupClient) ListByProductComplete(ctx context.Context, id ProductId, options ListByProductOperationOptions) (ListByProductCompleteResult, error)
- func (c ProductGroupClient) ListByProductCompleteMatchingPredicate(ctx context.Context, id ProductId, options ListByProductOperationOptions, ...) (resp ListByProductCompleteResult, err error)
- type ProductId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForGroupType ¶
func PossibleValuesForGroupType() []string
func ValidateGroupID ¶
ValidateGroupID checks that 'input' can be parsed as a Group ID
func ValidateProductID ¶
ValidateProductID checks that 'input' can be parsed as a Product ID
Types ¶
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response Model *GroupContract }
type DeleteOperationResponse ¶
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 ¶
func (GroupContractOperationPredicate) Matches ¶
func (p GroupContractOperationPredicate) Matches(input GroupContract) bool
type GroupContractProperties ¶
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 ¶
ParseGroupID parses 'input' into a GroupId
func ParseGroupIDInsensitively ¶
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) Segments ¶
func (id GroupId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Group ID
type ListByProductCompleteResult ¶
type ListByProductCompleteResult struct {
Items []GroupContract
}
type ListByProductOperationOptions ¶
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 ¶
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 ¶
ParseProductID parses 'input' into a ProductId
func ParseProductIDInsensitively ¶
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) Segments ¶
func (id ProductId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Product ID