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/2023-09-01/nginxdeployment
Documentation
The nginxdeployment
SDK allows for interaction with the Azure Resource Manager Service nginx
(API Version 2023-09-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/nginx/2023-09-01/nginxdeployment"
Client Initialization
client := nginxdeployment.NewNginxDeploymentClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: NginxDeploymentClient.DeploymentsCreateOrUpdate
ctx := context.TODO()
id := nginxdeployment.NewNginxDeploymentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue")
payload := nginxdeployment.NginxDeployment{
// ...
}
if err := client.DeploymentsCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: NginxDeploymentClient.DeploymentsDelete
ctx := context.TODO()
id := nginxdeployment.NewNginxDeploymentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue")
if err := client.DeploymentsDeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: NginxDeploymentClient.DeploymentsGet
ctx := context.TODO()
id := nginxdeployment.NewNginxDeploymentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue")
read, err := client.DeploymentsGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NginxDeploymentClient.DeploymentsList
ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// alternatively `client.DeploymentsList(ctx, id)` can be used to do batched pagination
items, err := client.DeploymentsListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: NginxDeploymentClient.DeploymentsListByResourceGroup
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
// alternatively `client.DeploymentsListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.DeploymentsListByResourceGroupComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: NginxDeploymentClient.DeploymentsUpdate
ctx := context.TODO()
id := nginxdeployment.NewNginxDeploymentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue")
payload := nginxdeployment.NginxDeploymentUpdateParameters{
// ...
}
if err := client.DeploymentsUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
# Functions
No description provided by the author
NewNginxDeploymentID returns a new NginxDeploymentId struct.
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
No description provided by the author
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
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
NginxDeploymentId is a struct representing the Resource ID for a Nginx Deployment.
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
# Type aliases
No description provided by the author
No description provided by the author