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-04-01/nginxcertificate
Documentation
The nginxcertificate
SDK allows for interaction with the Azure Resource Manager Service nginx
(API Version 2023-04-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-sdk/resource-manager/nginx/2023-04-01/nginxcertificate"
Client Initialization
client := nginxcertificate.NewNginxCertificateClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: NginxCertificateClient.CertificatesCreateOrUpdate
ctx := context.TODO()
id := nginxcertificate.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue", "certificateValue")
payload := nginxcertificate.NginxCertificate{
// ...
}
if err := client.CertificatesCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: NginxCertificateClient.CertificatesDelete
ctx := context.TODO()
id := nginxcertificate.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue", "certificateValue")
if err := client.CertificatesDeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: NginxCertificateClient.CertificatesGet
ctx := context.TODO()
id := nginxcertificate.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue", "certificateValue")
read, err := client.CertificatesGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NginxCertificateClient.CertificatesList
ctx := context.TODO()
id := nginxcertificate.NewNginxDeploymentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue")
// alternatively `client.CertificatesList(ctx, id)` can be used to do batched pagination
items, err := client.CertificatesListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
# Functions
NewCertificateID returns a new CertificateId struct.
No description provided by the author
NewNginxDeploymentID returns a new NginxDeploymentId struct.
ParseCertificateID parses 'input' into a CertificateId.
ParseCertificateIDInsensitively parses 'input' case-insensitively into a CertificateId 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
ValidateCertificateID checks that 'input' can be parsed as a Certificate 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
CertificateId is a struct representing the Resource ID for a Certificate.
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