README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/nginx/2023-09-01/nginxconfiguration
Documentation
The nginxconfiguration
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-sdk/resource-manager/nginx/2023-09-01/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
}
Documentation ¶
Index ¶
- func PossibleValuesForProvisioningState() []string
- func ValidateConfigurationID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateNginxDeploymentID(input interface{}, key string) (warnings []string, errors []error)
- type ConfigurationId
- type ConfigurationsCreateOrUpdateOperationResponse
- type ConfigurationsDeleteOperationResponse
- type ConfigurationsGetOperationResponse
- type ConfigurationsListCompleteResult
- type ConfigurationsListOperationResponse
- type NginxConfiguration
- type NginxConfigurationClient
- func (c NginxConfigurationClient) ConfigurationsCreateOrUpdate(ctx context.Context, id ConfigurationId, input NginxConfiguration) (result ConfigurationsCreateOrUpdateOperationResponse, err error)
- func (c NginxConfigurationClient) ConfigurationsCreateOrUpdateThenPoll(ctx context.Context, id ConfigurationId, input NginxConfiguration) error
- func (c NginxConfigurationClient) ConfigurationsDelete(ctx context.Context, id ConfigurationId) (result ConfigurationsDeleteOperationResponse, err error)
- func (c NginxConfigurationClient) ConfigurationsDeleteThenPoll(ctx context.Context, id ConfigurationId) error
- func (c NginxConfigurationClient) ConfigurationsGet(ctx context.Context, id ConfigurationId) (result ConfigurationsGetOperationResponse, err error)
- func (c NginxConfigurationClient) ConfigurationsList(ctx context.Context, id NginxDeploymentId) (result ConfigurationsListOperationResponse, err error)
- func (c NginxConfigurationClient) ConfigurationsListComplete(ctx context.Context, id NginxDeploymentId) (ConfigurationsListCompleteResult, error)
- func (c NginxConfigurationClient) ConfigurationsListCompleteMatchingPredicate(ctx context.Context, id NginxDeploymentId, ...) (result ConfigurationsListCompleteResult, err error)
- type NginxConfigurationFile
- type NginxConfigurationOperationPredicate
- type NginxConfigurationPackage
- type NginxConfigurationProperties
- type NginxDeploymentId
- type ProvisioningState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func ValidateConfigurationID ¶
ValidateConfigurationID checks that 'input' can be parsed as a Configuration ID
func ValidateNginxDeploymentID ¶
ValidateNginxDeploymentID checks that 'input' can be parsed as a Nginx Deployment ID
Types ¶
type ConfigurationId ¶
type ConfigurationId struct { SubscriptionId string ResourceGroupName string NginxDeploymentName string ConfigurationName string }
ConfigurationId is a struct representing the Resource ID for a Configuration
func NewConfigurationID ¶
func NewConfigurationID(subscriptionId string, resourceGroupName string, nginxDeploymentName string, configurationName string) ConfigurationId
NewConfigurationID returns a new ConfigurationId struct
func ParseConfigurationID ¶
func ParseConfigurationID(input string) (*ConfigurationId, error)
ParseConfigurationID parses 'input' into a ConfigurationId
func ParseConfigurationIDInsensitively ¶
func ParseConfigurationIDInsensitively(input string) (*ConfigurationId, error)
ParseConfigurationIDInsensitively parses 'input' case-insensitively into a ConfigurationId note: this method should only be used for API response data and not user input
func (*ConfigurationId) FromParseResult ¶
func (id *ConfigurationId) FromParseResult(input resourceids.ParseResult) error
func (ConfigurationId) ID ¶
func (id ConfigurationId) ID() string
ID returns the formatted Configuration ID
func (ConfigurationId) Segments ¶
func (id ConfigurationId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Configuration ID
func (ConfigurationId) String ¶
func (id ConfigurationId) String() string
String returns a human-readable description of this Configuration ID
type ConfigurationsGetOperationResponse ¶
type ConfigurationsGetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *NginxConfiguration }
type ConfigurationsListCompleteResult ¶
type ConfigurationsListCompleteResult struct { LatestHttpResponse *http.Response Items []NginxConfiguration }
type ConfigurationsListOperationResponse ¶
type ConfigurationsListOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]NginxConfiguration }
type NginxConfiguration ¶
type NginxConfiguration struct { Id *string `json:"id,omitempty"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` Properties *NginxConfigurationProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type NginxConfigurationClient ¶
type NginxConfigurationClient struct {
Client *resourcemanager.Client
}
func NewNginxConfigurationClientWithBaseURI ¶
func NewNginxConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*NginxConfigurationClient, error)
func (NginxConfigurationClient) ConfigurationsCreateOrUpdate ¶
func (c NginxConfigurationClient) ConfigurationsCreateOrUpdate(ctx context.Context, id ConfigurationId, input NginxConfiguration) (result ConfigurationsCreateOrUpdateOperationResponse, err error)
ConfigurationsCreateOrUpdate ...
func (NginxConfigurationClient) ConfigurationsCreateOrUpdateThenPoll ¶
func (c NginxConfigurationClient) ConfigurationsCreateOrUpdateThenPoll(ctx context.Context, id ConfigurationId, input NginxConfiguration) error
ConfigurationsCreateOrUpdateThenPoll performs ConfigurationsCreateOrUpdate then polls until it's completed
func (NginxConfigurationClient) ConfigurationsDelete ¶
func (c NginxConfigurationClient) ConfigurationsDelete(ctx context.Context, id ConfigurationId) (result ConfigurationsDeleteOperationResponse, err error)
ConfigurationsDelete ...
func (NginxConfigurationClient) ConfigurationsDeleteThenPoll ¶
func (c NginxConfigurationClient) ConfigurationsDeleteThenPoll(ctx context.Context, id ConfigurationId) error
ConfigurationsDeleteThenPoll performs ConfigurationsDelete then polls until it's completed
func (NginxConfigurationClient) ConfigurationsGet ¶
func (c NginxConfigurationClient) ConfigurationsGet(ctx context.Context, id ConfigurationId) (result ConfigurationsGetOperationResponse, err error)
ConfigurationsGet ...
func (NginxConfigurationClient) ConfigurationsList ¶
func (c NginxConfigurationClient) ConfigurationsList(ctx context.Context, id NginxDeploymentId) (result ConfigurationsListOperationResponse, err error)
ConfigurationsList ...
func (NginxConfigurationClient) ConfigurationsListComplete ¶
func (c NginxConfigurationClient) ConfigurationsListComplete(ctx context.Context, id NginxDeploymentId) (ConfigurationsListCompleteResult, error)
ConfigurationsListComplete retrieves all the results into a single object
func (NginxConfigurationClient) ConfigurationsListCompleteMatchingPredicate ¶
func (c NginxConfigurationClient) ConfigurationsListCompleteMatchingPredicate(ctx context.Context, id NginxDeploymentId, predicate NginxConfigurationOperationPredicate) (result ConfigurationsListCompleteResult, err error)
ConfigurationsListCompleteMatchingPredicate retrieves all the results and then applies the predicate
type NginxConfigurationFile ¶
type NginxConfigurationOperationPredicate ¶
type NginxConfigurationOperationPredicate struct { Id *string Location *string Name *string Type *string }
func (NginxConfigurationOperationPredicate) Matches ¶
func (p NginxConfigurationOperationPredicate) Matches(input NginxConfiguration) bool
type NginxConfigurationProperties ¶
type NginxConfigurationProperties struct { Files *[]NginxConfigurationFile `json:"files,omitempty"` Package *NginxConfigurationPackage `json:"package,omitempty"` ProtectedFiles *[]NginxConfigurationFile `json:"protectedFiles,omitempty"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` RootFile *string `json:"rootFile,omitempty"` }
type NginxDeploymentId ¶
type NginxDeploymentId struct { SubscriptionId string ResourceGroupName string NginxDeploymentName string }
NginxDeploymentId is a struct representing the Resource ID for a Nginx Deployment
func NewNginxDeploymentID ¶
func NewNginxDeploymentID(subscriptionId string, resourceGroupName string, nginxDeploymentName string) NginxDeploymentId
NewNginxDeploymentID returns a new NginxDeploymentId struct
func ParseNginxDeploymentID ¶
func ParseNginxDeploymentID(input string) (*NginxDeploymentId, error)
ParseNginxDeploymentID parses 'input' into a NginxDeploymentId
func ParseNginxDeploymentIDInsensitively ¶
func ParseNginxDeploymentIDInsensitively(input string) (*NginxDeploymentId, error)
ParseNginxDeploymentIDInsensitively parses 'input' case-insensitively into a NginxDeploymentId note: this method should only be used for API response data and not user input
func (*NginxDeploymentId) FromParseResult ¶
func (id *NginxDeploymentId) FromParseResult(input resourceids.ParseResult) error
func (NginxDeploymentId) ID ¶
func (id NginxDeploymentId) ID() string
ID returns the formatted Nginx Deployment ID
func (NginxDeploymentId) Segments ¶
func (id NginxDeploymentId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Nginx Deployment ID
func (NginxDeploymentId) String ¶
func (id NginxDeploymentId) String() string
String returns a human-readable description of this Nginx Deployment ID
type ProvisioningState ¶
type ProvisioningState string
const ( ProvisioningStateAccepted ProvisioningState = "Accepted" ProvisioningStateCanceled ProvisioningState = "Canceled" ProvisioningStateCreating ProvisioningState = "Creating" ProvisioningStateDeleted ProvisioningState = "Deleted" ProvisioningStateDeleting ProvisioningState = "Deleting" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStateNotSpecified ProvisioningState = "NotSpecified" ProvisioningStateSucceeded ProvisioningState = "Succeeded" ProvisioningStateUpdating ProvisioningState = "Updating" )
func (*ProvisioningState) UnmarshalJSON ¶
func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
Source Files ¶
- client.go
- constants.go
- id_configuration.go
- id_nginxdeployment.go
- method_configurationscreateorupdate.go
- method_configurationsdelete.go
- method_configurationsget.go
- method_configurationslist.go
- model_nginxconfiguration.go
- model_nginxconfigurationfile.go
- model_nginxconfigurationpackage.go
- model_nginxconfigurationproperties.go
- predicates.go
- version.go