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/apimanagement/2023-05-01-preview/namedvalue
Documentation
The namedvalue
SDK allows for interaction with the Azure Resource Manager Service apimanagement
(API Version 2023-05-01-preview
).
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/apimanagement/2023-05-01-preview/namedvalue"
Client Initialization
client := namedvalue.NewNamedValueClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: NamedValueClient.CreateOrUpdate
ctx := context.TODO()
id := namedvalue.NewNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "namedValueIdValue")
payload := namedvalue.NamedValueCreateContract{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload, namedvalue.DefaultCreateOrUpdateOperationOptions()); err != nil {
// handle the error
}
Example Usage: NamedValueClient.Delete
ctx := context.TODO()
id := namedvalue.NewNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "namedValueIdValue")
read, err := client.Delete(ctx, id, namedvalue.DefaultDeleteOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NamedValueClient.Get
ctx := context.TODO()
id := namedvalue.NewNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "namedValueIdValue")
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: NamedValueClient.GetEntityTag
ctx := context.TODO()
id := namedvalue.NewNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "namedValueIdValue")
read, err := client.GetEntityTag(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NamedValueClient.ListByService
ctx := context.TODO()
id := namedvalue.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")
// alternatively `client.ListByService(ctx, id, namedvalue.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, namedvalue.DefaultListByServiceOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: NamedValueClient.ListValue
ctx := context.TODO()
id := namedvalue.NewNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "namedValueIdValue")
read, err := client.ListValue(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NamedValueClient.RefreshSecret
ctx := context.TODO()
id := namedvalue.NewNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "namedValueIdValue")
if err := client.RefreshSecretThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: NamedValueClient.Update
ctx := context.TODO()
id := namedvalue.NewNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "namedValueIdValue")
payload := namedvalue.NamedValueUpdateParameters{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload, namedvalue.DefaultUpdateOperationOptions()); err != nil {
// handle the error
}
Example Usage: NamedValueClient.WorkspaceNamedValueCreateOrUpdate
ctx := context.TODO()
id := namedvalue.NewWorkspaceNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "namedValueIdValue")
payload := namedvalue.NamedValueCreateContract{
// ...
}
if err := client.WorkspaceNamedValueCreateOrUpdateThenPoll(ctx, id, payload, namedvalue.DefaultWorkspaceNamedValueCreateOrUpdateOperationOptions()); err != nil {
// handle the error
}
Example Usage: NamedValueClient.WorkspaceNamedValueDelete
ctx := context.TODO()
id := namedvalue.NewWorkspaceNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "namedValueIdValue")
read, err := client.WorkspaceNamedValueDelete(ctx, id, namedvalue.DefaultWorkspaceNamedValueDeleteOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NamedValueClient.WorkspaceNamedValueGet
ctx := context.TODO()
id := namedvalue.NewWorkspaceNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "namedValueIdValue")
read, err := client.WorkspaceNamedValueGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NamedValueClient.WorkspaceNamedValueGetEntityTag
ctx := context.TODO()
id := namedvalue.NewWorkspaceNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "namedValueIdValue")
read, err := client.WorkspaceNamedValueGetEntityTag(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NamedValueClient.WorkspaceNamedValueListByService
ctx := context.TODO()
id := namedvalue.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue")
// alternatively `client.WorkspaceNamedValueListByService(ctx, id, namedvalue.DefaultWorkspaceNamedValueListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.WorkspaceNamedValueListByServiceComplete(ctx, id, namedvalue.DefaultWorkspaceNamedValueListByServiceOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: NamedValueClient.WorkspaceNamedValueListValue
ctx := context.TODO()
id := namedvalue.NewWorkspaceNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "namedValueIdValue")
read, err := client.WorkspaceNamedValueListValue(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NamedValueClient.WorkspaceNamedValueRefreshSecret
ctx := context.TODO()
id := namedvalue.NewWorkspaceNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "namedValueIdValue")
if err := client.WorkspaceNamedValueRefreshSecretThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: NamedValueClient.WorkspaceNamedValueUpdate
ctx := context.TODO()
id := namedvalue.NewWorkspaceNamedValueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "workspaceIdValue", "namedValueIdValue")
payload := namedvalue.NamedValueUpdateParameters{
// ...
}
if err := client.WorkspaceNamedValueUpdateThenPoll(ctx, id, payload, namedvalue.DefaultWorkspaceNamedValueUpdateOperationOptions()); err != nil {
// handle the error
}
# Functions
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
No description provided by the author
No description provided by the author
NewNamedValueID returns a new NamedValueId struct.
NewServiceID returns a new ServiceId struct.
NewWorkspaceID returns a new WorkspaceId struct.
NewWorkspaceNamedValueID returns a new WorkspaceNamedValueId struct.
ParseNamedValueID parses 'input' into a NamedValueId.
ParseNamedValueIDInsensitively parses 'input' case-insensitively into a NamedValueId note: this method should only be used for API response data and not user input.
ParseServiceID parses 'input' into a ServiceId.
ParseServiceIDInsensitively parses 'input' case-insensitively into a ServiceId note: this method should only be used for API response data and not user input.
ParseWorkspaceID parses 'input' into a WorkspaceId.
ParseWorkspaceIDInsensitively parses 'input' case-insensitively into a WorkspaceId note: this method should only be used for API response data and not user input.
ParseWorkspaceNamedValueID parses 'input' into a WorkspaceNamedValueId.
ParseWorkspaceNamedValueIDInsensitively parses 'input' case-insensitively into a WorkspaceNamedValueId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateNamedValueID checks that 'input' can be parsed as a Named Value ID.
ValidateServiceID checks that 'input' can be parsed as a Service ID.
ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID.
ValidateWorkspaceNamedValueID checks that 'input' can be parsed as a Workspace Named Value ID.
# Constants
No description provided by the author
No description provided by the author
# 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
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
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
NamedValueId is a struct representing the Resource ID for a Named Value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServiceId is a struct representing the Resource ID for a Service.
No description provided by the author
No description provided by the author
WorkspaceId is a struct representing the Resource ID for a Workspace.
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
WorkspaceNamedValueId is a struct representing the Resource ID for a Workspace Named Value.
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
No description provided by the author
# Type aliases
No description provided by the author