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/nginx/2024-01-01-preview/nginxconfiguration
Documentation
The nginxconfiguration
SDK allows for interaction with the Azure Resource Manager Service nginx
(API Version 2024-01-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/nginx/2024-01-01-preview/nginxconfiguration"
Client Initialization
client := nginxconfiguration.NewNginxConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: NginxConfigurationClient.ConfigurationsCreateOrUpdate
ctx := context.TODO()
id := nginxconfiguration.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue", "configurationValue")
payload := nginxconfiguration.NginxConfiguration{
// ...
}
if err := client.ConfigurationsCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: NginxConfigurationClient.ConfigurationsDelete
ctx := context.TODO()
id := nginxconfiguration.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue", "configurationValue")
if err := client.ConfigurationsDeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: NginxConfigurationClient.ConfigurationsGet
ctx := context.TODO()
id := nginxconfiguration.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue", "configurationValue")
read, err := client.ConfigurationsGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NginxConfigurationClient.ConfigurationsList
ctx := context.TODO()
id := nginxconfiguration.NewNginxDeploymentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue")
// alternatively `client.ConfigurationsList(ctx, id)` can be used to do batched pagination
items, err := client.ConfigurationsListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
# Functions
NewConfigurationID returns a new ConfigurationId struct.
No description provided by the author
NewNginxDeploymentID returns a new NginxDeploymentId struct.
ParseConfigurationID parses 'input' into a ConfigurationId.
ParseConfigurationIDInsensitively parses 'input' case-insensitively into a ConfigurationId note: this method should only be used for API response data and not user input.
ParseNginxDeploymentID parses 'input' into a NginxDeploymentId.
ParseNginxDeploymentIDInsensitively parses 'input' case-insensitively into a NginxDeploymentId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateConfigurationID checks that 'input' can be parsed as a Configuration ID.
ValidateNginxDeploymentID checks that 'input' can be parsed as a Nginx Deployment ID.
# Constants
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
# Structs
ConfigurationId is a struct representing the Resource ID for a Configuration.
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
NginxDeploymentId is a struct representing the Resource ID for a Nginx Deployment.
# Type aliases
No description provided by the author