README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/product
Documentation
The product
SDK allows for interaction with Azure Resource Manager apimanagement
(API Version 2022-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/2022-08-01/product"
Client Initialization
client := product.NewProductClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ProductClient.CreateOrUpdate
ctx := context.TODO()
id := product.NewProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "productId")
payload := product.ProductContract{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload, product.DefaultCreateOrUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ProductClient.Delete
ctx := context.TODO()
id := product.NewProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "productId")
read, err := client.Delete(ctx, id, product.DefaultDeleteOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ProductClient.Get
ctx := context.TODO()
id := product.NewProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "productId")
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: ProductClient.GetEntityTag
ctx := context.TODO()
id := product.NewProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "productId")
read, err := client.GetEntityTag(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ProductClient.ListByService
ctx := context.TODO()
id := product.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName")
// alternatively `client.ListByService(ctx, id, product.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, product.DefaultListByServiceOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ProductClient.Update
ctx := context.TODO()
id := product.NewProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "productId")
payload := product.ProductUpdateParameters{
// ...
}
read, err := client.Update(ctx, id, payload, product.DefaultUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForProductState() []string
- func ValidateProductID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationOptions
- type CreateOrUpdateOperationResponse
- type DeleteOperationOptions
- type DeleteOperationResponse
- type GetEntityTagOperationResponse
- type GetOperationResponse
- type ListByServiceCompleteResult
- type ListByServiceCustomPager
- type ListByServiceOperationOptions
- type ListByServiceOperationResponse
- type ProductClient
- func (c ProductClient) CreateOrUpdate(ctx context.Context, id ProductId, input ProductContract, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c ProductClient) Delete(ctx context.Context, id ProductId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
- func (c ProductClient) Get(ctx context.Context, id ProductId) (result GetOperationResponse, err error)
- func (c ProductClient) GetEntityTag(ctx context.Context, id ProductId) (result GetEntityTagOperationResponse, err error)
- func (c ProductClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
- func (c ProductClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
- func (c ProductClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, ...) (result ListByServiceCompleteResult, err error)
- func (c ProductClient) Update(ctx context.Context, id ProductId, input ProductUpdateParameters, ...) (result UpdateOperationResponse, err error)
- type ProductContract
- type ProductContractOperationPredicate
- type ProductContractProperties
- type ProductId
- type ProductState
- type ProductUpdateParameters
- type ProductUpdateProperties
- type ServiceId
- type UpdateOperationOptions
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForProductState ¶
func PossibleValuesForProductState() []string
func ValidateProductID ¶
ValidateProductID checks that 'input' can be parsed as a Product ID
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a Service ID
Types ¶
type CreateOrUpdateOperationOptions ¶
type CreateOrUpdateOperationOptions struct {
IfMatch *string
}
func DefaultCreateOrUpdateOperationOptions ¶
func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions
func (CreateOrUpdateOperationOptions) ToHeaders ¶
func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers
func (CreateOrUpdateOperationOptions) ToOData ¶
func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query
func (CreateOrUpdateOperationOptions) ToQuery ¶
func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *ProductContract }
type DeleteOperationOptions ¶
func DefaultDeleteOperationOptions ¶
func DefaultDeleteOperationOptions() DeleteOperationOptions
func (DeleteOperationOptions) ToHeaders ¶
func (o DeleteOperationOptions) ToHeaders() *client.Headers
func (DeleteOperationOptions) ToOData ¶
func (o DeleteOperationOptions) ToOData() *odata.Query
func (DeleteOperationOptions) ToQuery ¶
func (o DeleteOperationOptions) ToQuery() *client.QueryParams
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *ProductContract }
type ListByServiceCompleteResult ¶
type ListByServiceCompleteResult struct { LatestHttpResponse *http.Response Items []ProductContract }
type ListByServiceCustomPager ¶ added in v0.20240628.1153531
func (*ListByServiceCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *ListByServiceCustomPager) NextPageLink() *odata.Link
type ListByServiceOperationOptions ¶
type ListByServiceOperationOptions struct { ExpandGroups *bool Filter *string Skip *int64 Tags *string Top *int64 }
func DefaultListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions() ListByServiceOperationOptions
func (ListByServiceOperationOptions) ToHeaders ¶
func (o ListByServiceOperationOptions) ToHeaders() *client.Headers
func (ListByServiceOperationOptions) ToOData ¶
func (o ListByServiceOperationOptions) ToOData() *odata.Query
func (ListByServiceOperationOptions) ToQuery ¶
func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams
type ListByServiceOperationResponse ¶
type ListByServiceOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]ProductContract }
type ProductClient ¶
type ProductClient struct {
Client *resourcemanager.Client
}
func NewProductClientWithBaseURI ¶
func NewProductClientWithBaseURI(sdkApi sdkEnv.Api) (*ProductClient, error)
func (ProductClient) CreateOrUpdate ¶
func (c ProductClient) CreateOrUpdate(ctx context.Context, id ProductId, input ProductContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (ProductClient) Delete ¶
func (c ProductClient) Delete(ctx context.Context, id ProductId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
Delete ...
func (ProductClient) Get ¶
func (c ProductClient) Get(ctx context.Context, id ProductId) (result GetOperationResponse, err error)
Get ...
func (ProductClient) GetEntityTag ¶
func (c ProductClient) GetEntityTag(ctx context.Context, id ProductId) (result GetEntityTagOperationResponse, err error)
GetEntityTag ...
func (ProductClient) ListByService ¶
func (c ProductClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
ListByService ...
func (ProductClient) ListByServiceComplete ¶
func (c ProductClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
ListByServiceComplete retrieves all the results into a single object
func (ProductClient) ListByServiceCompleteMatchingPredicate ¶
func (c ProductClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, predicate ProductContractOperationPredicate) (result ListByServiceCompleteResult, err error)
ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (ProductClient) Update ¶
func (c ProductClient) Update(ctx context.Context, id ProductId, input ProductUpdateParameters, options UpdateOperationOptions) (result UpdateOperationResponse, err error)
Update ...
type ProductContract ¶
type ProductContract struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *ProductContractProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type ProductContractOperationPredicate ¶
func (ProductContractOperationPredicate) Matches ¶
func (p ProductContractOperationPredicate) Matches(input ProductContract) bool
type ProductContractProperties ¶
type ProductContractProperties struct { ApprovalRequired *bool `json:"approvalRequired,omitempty"` Description *string `json:"description,omitempty"` DisplayName string `json:"displayName"` State *ProductState `json:"state,omitempty"` SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"` SubscriptionsLimit *int64 `json:"subscriptionsLimit,omitempty"` Terms *string `json:"terms,omitempty"` }
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) FromParseResult ¶
func (id *ProductId) FromParseResult(input resourceids.ParseResult) error
func (ProductId) Segments ¶
func (id ProductId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Product ID
type ProductState ¶
type ProductState string
const ( ProductStateNotPublished ProductState = "notPublished" ProductStatePublished ProductState = "published" )
func (*ProductState) UnmarshalJSON ¶
func (s *ProductState) UnmarshalJSON(bytes []byte) error
type ProductUpdateParameters ¶
type ProductUpdateParameters struct {
Properties *ProductUpdateProperties `json:"properties,omitempty"`
}
type ProductUpdateProperties ¶
type ProductUpdateProperties struct { ApprovalRequired *bool `json:"approvalRequired,omitempty"` Description *string `json:"description,omitempty"` DisplayName *string `json:"displayName,omitempty"` State *ProductState `json:"state,omitempty"` SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"` SubscriptionsLimit *int64 `json:"subscriptionsLimit,omitempty"` Terms *string `json:"terms,omitempty"` }
type ServiceId ¶
ServiceId is a struct representing the Resource ID for a Service
func NewServiceID ¶
NewServiceID returns a new ServiceId struct
func ParseServiceID ¶
ParseServiceID parses 'input' into a ServiceId
func ParseServiceIDInsensitively ¶
ParseServiceIDInsensitively parses 'input' case-insensitively into a ServiceId note: this method should only be used for API response data and not user input
func (*ServiceId) FromParseResult ¶
func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error
func (ServiceId) Segments ¶
func (id ServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service ID
type UpdateOperationOptions ¶
type UpdateOperationOptions struct {
IfMatch *string
}
func DefaultUpdateOperationOptions ¶
func DefaultUpdateOperationOptions() UpdateOperationOptions
func (UpdateOperationOptions) ToHeaders ¶
func (o UpdateOperationOptions) ToHeaders() *client.Headers
func (UpdateOperationOptions) ToOData ¶
func (o UpdateOperationOptions) ToOData() *odata.Query
func (UpdateOperationOptions) ToQuery ¶
func (o UpdateOperationOptions) ToQuery() *client.QueryParams
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *ProductContract }
Source Files ¶
- client.go
- constants.go
- id_product.go
- id_service.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_getentitytag.go
- method_listbyservice.go
- method_update.go
- model_productcontract.go
- model_productcontractproperties.go
- model_productupdateparameters.go
- model_productupdateproperties.go
- predicates.go
- version.go