package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# README

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

The batchmanagements SDK allows for interaction with the Azure Resource Manager Service 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", "batchAccountValue", "detectorIdValue")

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", "batchAccountValue")

// 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", "locationValue")

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
}

# Functions

NewBatchAccountID returns a new BatchAccountId struct.
No description provided by the author
NewDetectorID returns a new DetectorId struct.
NewLocationID returns a new LocationId struct.
ParseBatchAccountID parses 'input' into a BatchAccountId.
ParseBatchAccountIDInsensitively parses 'input' case-insensitively into a BatchAccountId note: this method should only be used for API response data and not user input.
ParseDetectorID parses 'input' into a DetectorId.
ParseDetectorIDInsensitively parses 'input' case-insensitively into a DetectorId note: this method should only be used for API response data and not user input.
ParseLocationID parses 'input' into a LocationId.
ParseLocationIDInsensitively parses 'input' case-insensitively into a LocationId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
ValidateBatchAccountID checks that 'input' can be parsed as a Batch Account ID.
ValidateDetectorID checks that 'input' can be parsed as a Detector ID.
ValidateLocationID checks that 'input' can be parsed as a Location ID.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
BatchAccountId is a struct representing the Resource ID for a Batch Account.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DetectorId is a struct representing the Resource ID for a Detector.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LocationId is a struct representing the Resource ID for a Location.

# Type aliases

No description provided by the author
No description provided by the author