batchmanagements

package
v0.20241209.1115630 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 9, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/batch/2024-02-01/batchmanagements Documentation

The batchmanagements SDK allows for interaction with Azure Resource Manager batch (API Version 2024-02-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/2024-02-01/batchmanagements"

Client Initialization

client := batchmanagements.NewBatchManagementsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BatchManagementsClient.BatchAccountGetDetector

ctx := context.TODO()
id := batchmanagements.NewDetectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountName", "detectorId")

read, err := client.BatchAccountGetDetector(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: BatchManagementsClient.BatchAccountListDetectors

ctx := context.TODO()
id := batchmanagements.NewBatchAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountName")

// alternatively `client.BatchAccountListDetectors(ctx, id)` can be used to do batched pagination
items, err := client.BatchAccountListDetectorsComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: BatchManagementsClient.LocationCheckNameAvailability

ctx := context.TODO()
id := batchmanagements.NewLocationID("12345678-1234-9876-4563-123456789012", "locationName")

payload := batchmanagements.CheckNameAvailabilityParameters{
	// ...
}


read, err := client.LocationCheckNameAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForNameAvailabilityReason

func PossibleValuesForNameAvailabilityReason() []string

func PossibleValuesForResourceType

func PossibleValuesForResourceType() []string

func ValidateBatchAccountID

func ValidateBatchAccountID(input interface{}, key string) (warnings []string, errors []error)

ValidateBatchAccountID checks that 'input' can be parsed as a Batch Account ID

func ValidateDetectorID

func ValidateDetectorID(input interface{}, key string) (warnings []string, errors []error)

ValidateDetectorID checks that 'input' can be parsed as a Detector ID

func ValidateLocationID

func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type BatchAccountGetDetectorOperationResponse

type BatchAccountGetDetectorOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DetectorResponse
}

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 BatchAccountListDetectorsCompleteResult

type BatchAccountListDetectorsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DetectorResponse
}

type BatchAccountListDetectorsCustomPager added in v0.20240628.1153531

type BatchAccountListDetectorsCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *BatchAccountListDetectorsCustomPager) NextPageLink() *odata.Link

type BatchAccountListDetectorsOperationResponse

type BatchAccountListDetectorsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DetectorResponse
}

type BatchManagementsClient

type BatchManagementsClient struct {
	Client *resourcemanager.Client
}

func NewBatchManagementsClientWithBaseURI

func NewBatchManagementsClientWithBaseURI(sdkApi sdkEnv.Api) (*BatchManagementsClient, error)

func (BatchManagementsClient) BatchAccountGetDetector

func (c BatchManagementsClient) BatchAccountGetDetector(ctx context.Context, id DetectorId) (result BatchAccountGetDetectorOperationResponse, err error)

BatchAccountGetDetector ...

func (BatchManagementsClient) BatchAccountListDetectors

func (c BatchManagementsClient) BatchAccountListDetectors(ctx context.Context, id BatchAccountId) (result BatchAccountListDetectorsOperationResponse, err error)

BatchAccountListDetectors ...

func (BatchManagementsClient) BatchAccountListDetectorsComplete

BatchAccountListDetectorsComplete retrieves all the results into a single object

func (BatchManagementsClient) BatchAccountListDetectorsCompleteMatchingPredicate

func (c BatchManagementsClient) BatchAccountListDetectorsCompleteMatchingPredicate(ctx context.Context, id BatchAccountId, predicate DetectorResponseOperationPredicate) (result BatchAccountListDetectorsCompleteResult, err error)

BatchAccountListDetectorsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BatchManagementsClient) LocationCheckNameAvailability

LocationCheckNameAvailability ...

type CheckNameAvailabilityParameters

type CheckNameAvailabilityParameters struct {
	Name string       `json:"name"`
	Type ResourceType `json:"type"`
}

type CheckNameAvailabilityResult

type CheckNameAvailabilityResult struct {
	Message       *string                 `json:"message,omitempty"`
	NameAvailable *bool                   `json:"nameAvailable,omitempty"`
	Reason        *NameAvailabilityReason `json:"reason,omitempty"`
}

type DetectorId

type DetectorId struct {
	SubscriptionId    string
	ResourceGroupName string
	BatchAccountName  string
	DetectorId        string
}

DetectorId is a struct representing the Resource ID for a Detector

func NewDetectorID

func NewDetectorID(subscriptionId string, resourceGroupName string, batchAccountName string, detectorId string) DetectorId

NewDetectorID returns a new DetectorId struct

func ParseDetectorID

func ParseDetectorID(input string) (*DetectorId, error)

ParseDetectorID parses 'input' into a DetectorId

func ParseDetectorIDInsensitively

func ParseDetectorIDInsensitively(input string) (*DetectorId, error)

ParseDetectorIDInsensitively parses 'input' case-insensitively into a DetectorId note: this method should only be used for API response data and not user input

func (*DetectorId) FromParseResult

func (id *DetectorId) FromParseResult(input resourceids.ParseResult) error

func (DetectorId) ID

func (id DetectorId) ID() string

ID returns the formatted Detector ID

func (DetectorId) Segments

func (id DetectorId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Detector ID

func (DetectorId) String

func (id DetectorId) String() string

String returns a human-readable description of this Detector ID

type DetectorResponse

type DetectorResponse struct {
	Etag       *string                     `json:"etag,omitempty"`
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *DetectorResponseProperties `json:"properties,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type DetectorResponseOperationPredicate

type DetectorResponseOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (DetectorResponseOperationPredicate) Matches

type DetectorResponseProperties

type DetectorResponseProperties struct {
	Value *string `json:"value,omitempty"`
}

type LocationCheckNameAvailabilityOperationResponse

type LocationCheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameAvailabilityResult
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

ParseLocationIDInsensitively parses 'input' case-insensitively into a LocationId note: this method should only be used for API response data and not user input

func (*LocationId) FromParseResult

func (id *LocationId) FromParseResult(input resourceids.ParseResult) error

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

func (id LocationId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type NameAvailabilityReason

type NameAvailabilityReason string
const (
	NameAvailabilityReasonAlreadyExists NameAvailabilityReason = "AlreadyExists"
	NameAvailabilityReasonInvalid       NameAvailabilityReason = "Invalid"
)

func (*NameAvailabilityReason) UnmarshalJSON

func (s *NameAvailabilityReason) UnmarshalJSON(bytes []byte) error

type ResourceType

type ResourceType string
const (
	ResourceTypeMicrosoftPointBatchBatchAccounts ResourceType = "Microsoft.Batch/batchAccounts"
)

func (*ResourceType) UnmarshalJSON

func (s *ResourceType) UnmarshalJSON(bytes []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL