README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/cache
Documentation
The cache
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/cache"
Client Initialization
client := cache.NewCacheClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: CacheClient.CreateOrUpdate
ctx := context.TODO()
id := cache.NewCacheID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "cacheIdValue")
payload := cache.CacheContract{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload, cache.DefaultCreateOrUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: CacheClient.Delete
ctx := context.TODO()
id := cache.NewCacheID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "cacheIdValue")
read, err := client.Delete(ctx, id, cache.DefaultDeleteOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: CacheClient.Get
ctx := context.TODO()
id := cache.NewCacheID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "cacheIdValue")
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: CacheClient.GetEntityTag
ctx := context.TODO()
id := cache.NewCacheID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "cacheIdValue")
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: CacheClient.ListByService
ctx := context.TODO()
id := cache.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
// alternatively `client.ListByService(ctx, id, cache.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, cache.DefaultListByServiceOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: CacheClient.Update
ctx := context.TODO()
id := cache.NewCacheID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "cacheIdValue")
payload := cache.CacheUpdateParameters{
// ...
}
read, err := client.Update(ctx, id, payload, cache.DefaultUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func ValidateCacheID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type CacheClient
- func (c CacheClient) CreateOrUpdate(ctx context.Context, id CacheId, input CacheContract, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c CacheClient) Delete(ctx context.Context, id CacheId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
- func (c CacheClient) Get(ctx context.Context, id CacheId) (result GetOperationResponse, err error)
- func (c CacheClient) GetEntityTag(ctx context.Context, id CacheId) (result GetEntityTagOperationResponse, err error)
- func (c CacheClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
- func (c CacheClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
- func (c CacheClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, ...) (result ListByServiceCompleteResult, err error)
- func (c CacheClient) Update(ctx context.Context, id CacheId, input CacheUpdateParameters, ...) (result UpdateOperationResponse, err error)
- type CacheContract
- type CacheContractOperationPredicate
- type CacheContractProperties
- type CacheId
- type CacheUpdateParameters
- type CacheUpdateProperties
- type CreateOrUpdateOperationOptions
- type CreateOrUpdateOperationResponse
- type DeleteOperationOptions
- type DeleteOperationResponse
- type GetEntityTagOperationResponse
- type GetOperationResponse
- type ListByServiceCompleteResult
- type ListByServiceOperationOptions
- type ListByServiceOperationResponse
- type ServiceId
- type UpdateOperationOptions
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateCacheID ¶
ValidateCacheID checks that 'input' can be parsed as a Cache ID
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a Service ID
Types ¶
type CacheClient ¶
type CacheClient struct {
Client *resourcemanager.Client
}
func NewCacheClientWithBaseURI ¶
func NewCacheClientWithBaseURI(sdkApi sdkEnv.Api) (*CacheClient, error)
func (CacheClient) CreateOrUpdate ¶
func (c CacheClient) CreateOrUpdate(ctx context.Context, id CacheId, input CacheContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (CacheClient) Delete ¶
func (c CacheClient) Delete(ctx context.Context, id CacheId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
Delete ...
func (CacheClient) Get ¶
func (c CacheClient) Get(ctx context.Context, id CacheId) (result GetOperationResponse, err error)
Get ...
func (CacheClient) GetEntityTag ¶
func (c CacheClient) GetEntityTag(ctx context.Context, id CacheId) (result GetEntityTagOperationResponse, err error)
GetEntityTag ...
func (CacheClient) ListByService ¶
func (c CacheClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
ListByService ...
func (CacheClient) ListByServiceComplete ¶
func (c CacheClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
ListByServiceComplete retrieves all the results into a single object
func (CacheClient) ListByServiceCompleteMatchingPredicate ¶
func (c CacheClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, predicate CacheContractOperationPredicate) (result ListByServiceCompleteResult, err error)
ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (CacheClient) Update ¶
func (c CacheClient) Update(ctx context.Context, id CacheId, input CacheUpdateParameters, options UpdateOperationOptions) (result UpdateOperationResponse, err error)
Update ...
type CacheContract ¶
type CacheContract struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *CacheContractProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type CacheContractOperationPredicate ¶
func (CacheContractOperationPredicate) Matches ¶
func (p CacheContractOperationPredicate) Matches(input CacheContract) bool
type CacheContractProperties ¶
type CacheId ¶
type CacheId struct { SubscriptionId string ResourceGroupName string ServiceName string CacheId string }
CacheId is a struct representing the Resource ID for a Cache
func NewCacheID ¶
func NewCacheID(subscriptionId string, resourceGroupName string, serviceName string, cacheId string) CacheId
NewCacheID returns a new CacheId struct
func ParseCacheID ¶
ParseCacheID parses 'input' into a CacheId
func ParseCacheIDInsensitively ¶
ParseCacheIDInsensitively parses 'input' case-insensitively into a CacheId note: this method should only be used for API response data and not user input
func (*CacheId) FromParseResult ¶ added in v0.20231127.1171502
func (id *CacheId) FromParseResult(input resourceids.ParseResult) error
func (CacheId) Segments ¶
func (id CacheId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Cache ID
type CacheUpdateParameters ¶
type CacheUpdateParameters struct {
Properties *CacheUpdateProperties `json:"properties,omitempty"`
}
type CacheUpdateProperties ¶
type CreateOrUpdateOperationOptions ¶
type CreateOrUpdateOperationOptions struct {
IfMatch *string
}
func DefaultCreateOrUpdateOperationOptions ¶
func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions
func (CreateOrUpdateOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers
func (CreateOrUpdateOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query
func (CreateOrUpdateOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *CacheContract }
type DeleteOperationOptions ¶
type DeleteOperationOptions struct {
IfMatch *string
}
func DefaultDeleteOperationOptions ¶
func DefaultDeleteOperationOptions() DeleteOperationOptions
func (DeleteOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o DeleteOperationOptions) ToHeaders() *client.Headers
func (DeleteOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o DeleteOperationOptions) ToOData() *odata.Query
func (DeleteOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o DeleteOperationOptions) ToQuery() *client.QueryParams
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *CacheContract }
type ListByServiceCompleteResult ¶
type ListByServiceCompleteResult struct {
Items []CacheContract
}
type ListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions() ListByServiceOperationOptions
func (ListByServiceOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToHeaders() *client.Headers
func (ListByServiceOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToOData() *odata.Query
func (ListByServiceOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams
type ListByServiceOperationResponse ¶
type ListByServiceOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]CacheContract }
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 ¶ added in v0.20231127.1171502
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 ¶ added in v0.20230801.1071415
func (o UpdateOperationOptions) ToHeaders() *client.Headers
func (UpdateOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o UpdateOperationOptions) ToOData() *odata.Query
func (UpdateOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o UpdateOperationOptions) ToQuery() *client.QueryParams
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *CacheContract }