README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/batch/2023-05-01/application
Documentation
The application
SDK allows for interaction with the Azure Resource Manager Service batch
(API Version 2023-05-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/batch/2023-05-01/application"
Client Initialization
client := application.NewApplicationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ApplicationClient.Create
ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountValue", "applicationValue")
payload := application.Application{
// ...
}
read, err := client.Create(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ApplicationClient.Delete
ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountValue", "applicationValue")
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: ApplicationClient.Get
ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountValue", "applicationValue")
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: ApplicationClient.List
ctx := context.TODO()
id := application.NewBatchAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountValue")
// alternatively `client.List(ctx, id, application.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, application.DefaultListOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ApplicationClient.Update
ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountValue", "applicationValue")
payload := application.Application{
// ...
}
read, err := client.Update(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func ValidateApplicationID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateBatchAccountID(input interface{}, key string) (warnings []string, errors []error)
- type Application
- type ApplicationClient
- func (c ApplicationClient) Create(ctx context.Context, id ApplicationId, input Application) (result CreateOperationResponse, err error)
- func (c ApplicationClient) Delete(ctx context.Context, id ApplicationId) (result DeleteOperationResponse, err error)
- func (c ApplicationClient) Get(ctx context.Context, id ApplicationId) (result GetOperationResponse, err error)
- func (c ApplicationClient) List(ctx context.Context, id BatchAccountId, options ListOperationOptions) (result ListOperationResponse, err error)
- func (c ApplicationClient) ListComplete(ctx context.Context, id BatchAccountId, options ListOperationOptions) (ListCompleteResult, error)
- func (c ApplicationClient) ListCompleteMatchingPredicate(ctx context.Context, id BatchAccountId, options ListOperationOptions, ...) (result ListCompleteResult, err error)
- func (c ApplicationClient) Update(ctx context.Context, id ApplicationId, input Application) (result UpdateOperationResponse, err error)
- type ApplicationId
- type ApplicationOperationPredicate
- type ApplicationProperties
- type BatchAccountId
- type CreateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationOptions
- type ListOperationResponse
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateApplicationID ¶
ValidateApplicationID checks that 'input' can be parsed as a Application ID
func ValidateBatchAccountID ¶
ValidateBatchAccountID checks that 'input' can be parsed as a Batch Account ID
Types ¶
type Application ¶
type Application struct { Etag *string `json:"etag,omitempty"` Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *ApplicationProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type ApplicationClient ¶
type ApplicationClient struct {
Client *resourcemanager.Client
}
func NewApplicationClientWithBaseURI ¶
func NewApplicationClientWithBaseURI(sdkApi sdkEnv.Api) (*ApplicationClient, error)
func (ApplicationClient) Create ¶
func (c ApplicationClient) Create(ctx context.Context, id ApplicationId, input Application) (result CreateOperationResponse, err error)
Create ...
func (ApplicationClient) Delete ¶
func (c ApplicationClient) Delete(ctx context.Context, id ApplicationId) (result DeleteOperationResponse, err error)
Delete ...
func (ApplicationClient) Get ¶
func (c ApplicationClient) Get(ctx context.Context, id ApplicationId) (result GetOperationResponse, err error)
Get ...
func (ApplicationClient) List ¶
func (c ApplicationClient) List(ctx context.Context, id BatchAccountId, options ListOperationOptions) (result ListOperationResponse, err error)
List ...
func (ApplicationClient) ListComplete ¶
func (c ApplicationClient) ListComplete(ctx context.Context, id BatchAccountId, options ListOperationOptions) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (ApplicationClient) ListCompleteMatchingPredicate ¶
func (c ApplicationClient) ListCompleteMatchingPredicate(ctx context.Context, id BatchAccountId, options ListOperationOptions, predicate ApplicationOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (ApplicationClient) Update ¶
func (c ApplicationClient) Update(ctx context.Context, id ApplicationId, input Application) (result UpdateOperationResponse, err error)
Update ...
type ApplicationId ¶
type ApplicationId struct { SubscriptionId string ResourceGroupName string BatchAccountName string ApplicationName string }
ApplicationId is a struct representing the Resource ID for a Application
func NewApplicationID ¶
func NewApplicationID(subscriptionId string, resourceGroupName string, batchAccountName string, applicationName string) ApplicationId
NewApplicationID returns a new ApplicationId struct
func ParseApplicationID ¶
func ParseApplicationID(input string) (*ApplicationId, error)
ParseApplicationID parses 'input' into a ApplicationId
func ParseApplicationIDInsensitively ¶
func ParseApplicationIDInsensitively(input string) (*ApplicationId, error)
ParseApplicationIDInsensitively parses 'input' case-insensitively into a ApplicationId note: this method should only be used for API response data and not user input
func (*ApplicationId) FromParseResult ¶
func (id *ApplicationId) FromParseResult(input resourceids.ParseResult) error
func (ApplicationId) ID ¶
func (id ApplicationId) ID() string
ID returns the formatted Application ID
func (ApplicationId) Segments ¶
func (id ApplicationId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Application ID
func (ApplicationId) String ¶
func (id ApplicationId) String() string
String returns a human-readable description of this Application ID
type ApplicationOperationPredicate ¶
func (ApplicationOperationPredicate) Matches ¶
func (p ApplicationOperationPredicate) Matches(input Application) bool
type ApplicationProperties ¶
type BatchAccountId ¶
type BatchAccountId struct { SubscriptionId string ResourceGroupName string BatchAccountName string }
BatchAccountId is a struct representing the Resource ID for a Batch Account
func NewBatchAccountID ¶
func NewBatchAccountID(subscriptionId string, resourceGroupName string, batchAccountName string) BatchAccountId
NewBatchAccountID returns a new BatchAccountId struct
func ParseBatchAccountID ¶
func ParseBatchAccountID(input string) (*BatchAccountId, error)
ParseBatchAccountID parses 'input' into a BatchAccountId
func ParseBatchAccountIDInsensitively ¶
func ParseBatchAccountIDInsensitively(input string) (*BatchAccountId, error)
ParseBatchAccountIDInsensitively parses 'input' case-insensitively into a BatchAccountId note: this method should only be used for API response data and not user input
func (*BatchAccountId) FromParseResult ¶
func (id *BatchAccountId) FromParseResult(input resourceids.ParseResult) error
func (BatchAccountId) ID ¶
func (id BatchAccountId) ID() string
ID returns the formatted Batch Account ID
func (BatchAccountId) Segments ¶
func (id BatchAccountId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Batch Account ID
func (BatchAccountId) String ¶
func (id BatchAccountId) String() string
String returns a human-readable description of this Batch Account ID
type CreateOperationResponse ¶
type CreateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *Application }
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *Application }
type ListCompleteResult ¶
type ListCompleteResult struct { LatestHttpResponse *http.Response Items []Application }
type ListOperationOptions ¶
type ListOperationOptions struct {
Maxresults *int64
}
func DefaultListOperationOptions ¶
func DefaultListOperationOptions() ListOperationOptions
func (ListOperationOptions) ToHeaders ¶
func (o ListOperationOptions) ToHeaders() *client.Headers
func (ListOperationOptions) ToOData ¶
func (o ListOperationOptions) ToOData() *odata.Query
func (ListOperationOptions) ToQuery ¶
func (o ListOperationOptions) ToQuery() *client.QueryParams
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]Application }
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *Application }