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/secrets Documentation

The secrets 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/secrets"

Client Initialization

client := secrets.NewSecretsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecretsClient.CreateOrUpdate

ctx := context.TODO()
id := secrets.NewSecretID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "secretValue")

payload := secrets.Secret{
	// ...
}


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: SecretsClient.Delete

ctx := context.TODO()
id := secrets.NewSecretID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "secretValue")

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: SecretsClient.Get

ctx := context.TODO()
id := secrets.NewSecretID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "secretValue")

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: SecretsClient.List

ctx := context.TODO()
id := secrets.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: SecretsClient.Update

ctx := context.TODO()
id := secrets.NewSecretID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "secretValue")

payload := secrets.SecretUpdate{
	// ...
}


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

NewOpenShiftClusterID returns a new OpenShiftClusterId struct.
NewSecretID returns a new SecretId struct.
No description provided by the author
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.
ParseSecretID parses 'input' into a SecretId.
ParseSecretIDInsensitively parses 'input' case-insensitively into a SecretId note: this method should only be used for API response data and not user input.
ValidateOpenShiftClusterID checks that 'input' can be parsed as a Open Shift Cluster ID.
ValidateSecretID checks that 'input' can be parsed as a Secret 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
OpenShiftClusterId is a struct representing the Resource ID for a Open Shift Cluster.
No description provided by the author
SecretId is a struct representing the Resource ID for a Secret.
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