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/redhatopenshift/2023-09-04/machinepools
Documentation
The machinepools
SDK allows for interaction with the Azure Resource Manager Service redhatopenshift
(API Version 2023-09-04
).
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/redhatopenshift/2023-09-04/machinepools"
Client Initialization
client := machinepools.NewMachinePoolsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: MachinePoolsClient.CreateOrUpdate
ctx := context.TODO()
id := machinepools.NewMachinePoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "machinePoolValue")
payload := machinepools.MachinePool{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: MachinePoolsClient.Delete
ctx := context.TODO()
id := machinepools.NewMachinePoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "machinePoolValue")
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: MachinePoolsClient.Get
ctx := context.TODO()
id := machinepools.NewMachinePoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "machinePoolValue")
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: MachinePoolsClient.List
ctx := context.TODO()
id := machinepools.NewOpenShiftClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue")
// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: MachinePoolsClient.Update
ctx := context.TODO()
id := machinepools.NewMachinePoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "machinePoolValue")
payload := machinepools.MachinePoolUpdate{
// ...
}
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
}
# Functions
NewMachinePoolID returns a new MachinePoolId struct.
No description provided by the author
NewOpenShiftClusterID returns a new OpenShiftClusterId struct.
ParseMachinePoolID parses 'input' into a MachinePoolId.
ParseMachinePoolIDInsensitively parses 'input' case-insensitively into a MachinePoolId note: this method should only be used for API response data and not user input.
ParseOpenShiftClusterID parses 'input' into a OpenShiftClusterId.
ParseOpenShiftClusterIDInsensitively parses 'input' case-insensitively into a OpenShiftClusterId note: this method should only be used for API response data and not user input.
ValidateMachinePoolID checks that 'input' can be parsed as a Machine Pool ID.
ValidateOpenShiftClusterID checks that 'input' can be parsed as a Open Shift Cluster ID.
# Structs
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
No description provided by the author
MachinePoolId is a struct representing the Resource ID for a Machine Pool.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OpenShiftClusterId is a struct representing the Resource ID for a Open Shift Cluster.
No description provided by the author