README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/apirelease
Documentation
The apirelease
SDK allows for interaction with the Azure Resource Manager Service 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/apirelease"
Client Initialization
client := apirelease.NewApiReleaseClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ApiReleaseClient.CreateOrUpdate
ctx := context.TODO()
id := apirelease.NewReleaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "releaseIdValue")
payload := apirelease.ApiReleaseContract{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload, apirelease.DefaultCreateOrUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ApiReleaseClient.Delete
ctx := context.TODO()
id := apirelease.NewReleaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "releaseIdValue")
read, err := client.Delete(ctx, id, apirelease.DefaultDeleteOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ApiReleaseClient.Get
ctx := context.TODO()
id := apirelease.NewReleaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "releaseIdValue")
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: ApiReleaseClient.GetEntityTag
ctx := context.TODO()
id := apirelease.NewReleaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "releaseIdValue")
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: ApiReleaseClient.ListByService
ctx := context.TODO()
id := apirelease.NewApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue")
// alternatively `client.ListByService(ctx, id, apirelease.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, apirelease.DefaultListByServiceOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ApiReleaseClient.Update
ctx := context.TODO()
id := apirelease.NewReleaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "releaseIdValue")
payload := apirelease.ApiReleaseContract{
// ...
}
read, err := client.Update(ctx, id, payload, apirelease.DefaultUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func ValidateApiID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateReleaseID(input interface{}, key string) (warnings []string, errors []error)
- type ApiId
- type ApiReleaseClient
- func (c ApiReleaseClient) CreateOrUpdate(ctx context.Context, id ReleaseId, input ApiReleaseContract, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c ApiReleaseClient) Delete(ctx context.Context, id ReleaseId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
- func (c ApiReleaseClient) Get(ctx context.Context, id ReleaseId) (result GetOperationResponse, err error)
- func (c ApiReleaseClient) GetEntityTag(ctx context.Context, id ReleaseId) (result GetEntityTagOperationResponse, err error)
- func (c ApiReleaseClient) ListByService(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (resp ListByServiceOperationResponse, err error)
- func (c ApiReleaseClient) ListByServiceComplete(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
- func (c ApiReleaseClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ApiId, options ListByServiceOperationOptions, ...) (resp ListByServiceCompleteResult, err error)
- func (c ApiReleaseClient) Update(ctx context.Context, id ReleaseId, input ApiReleaseContract, ...) (result UpdateOperationResponse, err error)
- type ApiReleaseContract
- type ApiReleaseContractOperationPredicate
- type ApiReleaseContractProperties
- func (o *ApiReleaseContractProperties) GetCreatedDateTimeAsTime() (*time.Time, error)
- func (o *ApiReleaseContractProperties) GetUpdatedDateTimeAsTime() (*time.Time, error)
- func (o *ApiReleaseContractProperties) SetCreatedDateTimeAsTime(input time.Time)
- func (o *ApiReleaseContractProperties) SetUpdatedDateTimeAsTime(input time.Time)
- type CreateOrUpdateOperationOptions
- type CreateOrUpdateOperationResponse
- type DeleteOperationOptions
- type DeleteOperationResponse
- type GetEntityTagOperationResponse
- type GetOperationResponse
- type ListByServiceCompleteResult
- type ListByServiceOperationOptions
- type ListByServiceOperationResponse
- type ReleaseId
- type UpdateOperationOptions
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateApiID ¶
ValidateApiID checks that 'input' can be parsed as a Api ID
func ValidateReleaseID ¶
ValidateReleaseID checks that 'input' can be parsed as a Release ID
Types ¶
type ApiId ¶
type ApiId struct { SubscriptionId string ResourceGroupName string ServiceName string ApiId string }
ApiId is a struct representing the Resource ID for a Api
func NewApiID ¶
func NewApiID(subscriptionId string, resourceGroupName string, serviceName string, apiId string) ApiId
NewApiID returns a new ApiId struct
func ParseApiID ¶
ParseApiID parses 'input' into a ApiId
func ParseApiIDInsensitively ¶
ParseApiIDInsensitively parses 'input' case-insensitively into a ApiId note: this method should only be used for API response data and not user input
func (ApiId) Segments ¶
func (id ApiId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Api ID
type ApiReleaseClient ¶
func NewApiReleaseClientWithBaseURI ¶
func NewApiReleaseClientWithBaseURI(endpoint string) ApiReleaseClient
func (ApiReleaseClient) CreateOrUpdate ¶
func (c ApiReleaseClient) CreateOrUpdate(ctx context.Context, id ReleaseId, input ApiReleaseContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (ApiReleaseClient) Delete ¶
func (c ApiReleaseClient) Delete(ctx context.Context, id ReleaseId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
Delete ...
func (ApiReleaseClient) Get ¶
func (c ApiReleaseClient) Get(ctx context.Context, id ReleaseId) (result GetOperationResponse, err error)
Get ...
func (ApiReleaseClient) GetEntityTag ¶
func (c ApiReleaseClient) GetEntityTag(ctx context.Context, id ReleaseId) (result GetEntityTagOperationResponse, err error)
GetEntityTag ...
func (ApiReleaseClient) ListByService ¶
func (c ApiReleaseClient) ListByService(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (resp ListByServiceOperationResponse, err error)
ListByService ...
func (ApiReleaseClient) ListByServiceComplete ¶
func (c ApiReleaseClient) ListByServiceComplete(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
ListByServiceComplete retrieves all of the results into a single object
func (ApiReleaseClient) ListByServiceCompleteMatchingPredicate ¶
func (c ApiReleaseClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ApiId, options ListByServiceOperationOptions, predicate ApiReleaseContractOperationPredicate) (resp ListByServiceCompleteResult, err error)
ListByServiceCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (ApiReleaseClient) Update ¶
func (c ApiReleaseClient) Update(ctx context.Context, id ReleaseId, input ApiReleaseContract, options UpdateOperationOptions) (result UpdateOperationResponse, err error)
Update ...
type ApiReleaseContract ¶
type ApiReleaseContract struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *ApiReleaseContractProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type ApiReleaseContractOperationPredicate ¶
func (ApiReleaseContractOperationPredicate) Matches ¶
func (p ApiReleaseContractOperationPredicate) Matches(input ApiReleaseContract) bool
type ApiReleaseContractProperties ¶
type ApiReleaseContractProperties struct { ApiId *string `json:"apiId,omitempty"` CreatedDateTime *string `json:"createdDateTime,omitempty"` Notes *string `json:"notes,omitempty"` UpdatedDateTime *string `json:"updatedDateTime,omitempty"` }
func (*ApiReleaseContractProperties) GetCreatedDateTimeAsTime ¶
func (o *ApiReleaseContractProperties) GetCreatedDateTimeAsTime() (*time.Time, error)
func (*ApiReleaseContractProperties) GetUpdatedDateTimeAsTime ¶
func (o *ApiReleaseContractProperties) GetUpdatedDateTimeAsTime() (*time.Time, error)
func (*ApiReleaseContractProperties) SetCreatedDateTimeAsTime ¶
func (o *ApiReleaseContractProperties) SetCreatedDateTimeAsTime(input time.Time)
func (*ApiReleaseContractProperties) SetUpdatedDateTimeAsTime ¶
func (o *ApiReleaseContractProperties) SetUpdatedDateTimeAsTime(input time.Time)
type CreateOrUpdateOperationOptions ¶
type CreateOrUpdateOperationOptions struct {
IfMatch *string
}
func DefaultCreateOrUpdateOperationOptions ¶
func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response Model *ApiReleaseContract }
type DeleteOperationOptions ¶
type DeleteOperationOptions struct {
IfMatch *string
}
func DefaultDeleteOperationOptions ¶
func DefaultDeleteOperationOptions() DeleteOperationOptions
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *ApiReleaseContract }
type ListByServiceCompleteResult ¶
type ListByServiceCompleteResult struct {
Items []ApiReleaseContract
}
type ListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions() ListByServiceOperationOptions
type ListByServiceOperationResponse ¶
type ListByServiceOperationResponse struct { HttpResponse *http.Response Model *[]ApiReleaseContract // contains filtered or unexported fields }
func (ListByServiceOperationResponse) HasMore ¶
func (r ListByServiceOperationResponse) HasMore() bool
func (ListByServiceOperationResponse) LoadMore ¶
func (r ListByServiceOperationResponse) LoadMore(ctx context.Context) (resp ListByServiceOperationResponse, err error)
type ReleaseId ¶
type ReleaseId struct { SubscriptionId string ResourceGroupName string ServiceName string ApiId string ReleaseId string }
ReleaseId is a struct representing the Resource ID for a Release
func NewReleaseID ¶
func NewReleaseID(subscriptionId string, resourceGroupName string, serviceName string, apiId string, releaseId string) ReleaseId
NewReleaseID returns a new ReleaseId struct
func ParseReleaseID ¶
ParseReleaseID parses 'input' into a ReleaseId
func ParseReleaseIDInsensitively ¶
ParseReleaseIDInsensitively parses 'input' case-insensitively into a ReleaseId note: this method should only be used for API response data and not user input
func (ReleaseId) Segments ¶
func (id ReleaseId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Release ID
type UpdateOperationOptions ¶
type UpdateOperationOptions struct {
IfMatch *string
}
func DefaultUpdateOperationOptions ¶
func DefaultUpdateOperationOptions() UpdateOperationOptions
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { HttpResponse *http.Response Model *ApiReleaseContract }