nginxconfigurationanalysis

README

github.com/hashicorp/go-azure-sdk/resource-manager/nginx/2024-11-01-preview/nginxconfigurationanalysis Documentation

The nginxconfigurationanalysis SDK allows for interaction with Azure Resource Manager nginx (API Version 2024-11-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-11-01-preview/nginxconfigurationanalysis"

Client Initialization

client := nginxconfigurationanalysis.NewNginxConfigurationAnalysisClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NginxConfigurationAnalysisClient.ConfigurationsAnalysis

ctx := context.TODO()
id := nginxconfigurationanalysis.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentName", "configurationName")

payload := nginxconfigurationanalysis.AnalysisCreate{
	// ...
}


read, err := client.ConfigurationsAnalysis(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func PossibleValuesForLevel() []string
• func ValidateConfigurationID(input interface{}, key string) (warnings []string, errors []error)
• type AnalysisCreate
• type AnalysisCreateConfig
• type AnalysisDiagnostic
• type AnalysisResult
• type AnalysisResultData
• type ConfigurationId
  • func NewConfigurationID(subscriptionId string, resourceGroupName string, nginxDeploymentName string, ...) ConfigurationId
  • func ParseConfigurationID(input string) (*ConfigurationId, error)
  • func ParseConfigurationIDInsensitively(input string) (*ConfigurationId, error)
  • func (id *ConfigurationId) FromParseResult(input resourceids.ParseResult) error
  • func (id ConfigurationId) ID() string
  • func (id ConfigurationId) Segments() []resourceids.Segment
  • func (id ConfigurationId) String() string
• type ConfigurationsAnalysisOperationResponse
• type DiagnosticItem
• type Level
  • func (s *Level) UnmarshalJSON(bytes []byte) error
• type NginxConfigurationAnalysisClient
  • func NewNginxConfigurationAnalysisClientWithBaseURI(sdkApi sdkEnv.Api) (*NginxConfigurationAnalysisClient, error)
  • func (c NginxConfigurationAnalysisClient) ConfigurationsAnalysis(ctx context.Context, id ConfigurationId, input AnalysisCreate) (result ConfigurationsAnalysisOperationResponse, err error)
• type NginxConfigurationFile
• type NginxConfigurationPackage
• type NginxConfigurationProtectedFileRequest

Functions

func PossibleValuesForLevel

func PossibleValuesForLevel() []string

func ValidateConfigurationID

func ValidateConfigurationID(input interface{}, key string) (warnings []string, errors []error)

ValidateConfigurationID checks that 'input' can be parsed as a Configuration ID

Types

type AnalysisCreate

type AnalysisCreate struct {
	Config AnalysisCreateConfig `json:"config"`
}

type AnalysisCreateConfig

type AnalysisCreateConfig struct {
	Files          *[]NginxConfigurationFile                 `json:"files,omitempty"`
	Package        *NginxConfigurationPackage                `json:"package,omitempty"`
	ProtectedFiles *[]NginxConfigurationProtectedFileRequest `json:"protectedFiles,omitempty"`
	RootFile       *string                                   `json:"rootFile,omitempty"`
}

type AnalysisDiagnostic

type AnalysisDiagnostic struct {
	Description string  `json:"description"`
	Directive   string  `json:"directive"`
	File        string  `json:"file"`
	Id          *string `json:"id,omitempty"`
	Line        float64 `json:"line"`
	Message     string  `json:"message"`
	Rule        string  `json:"rule"`
}

type AnalysisResult

type AnalysisResult struct {
	Data   *AnalysisResultData `json:"data,omitempty"`
	Status string              `json:"status"`
}

type AnalysisResultData

type AnalysisResultData struct {
	Diagnostics *[]DiagnosticItem     `json:"diagnostics,omitempty"`
	Errors      *[]AnalysisDiagnostic `json:"errors,omitempty"`
}

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 ConfigurationsAnalysisOperationResponse

type ConfigurationsAnalysisOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AnalysisResult
}

type DiagnosticItem

type DiagnosticItem struct {
	Category    *string `json:"category,omitempty"`
	Description string  `json:"description"`
	Directive   string  `json:"directive"`
	File        string  `json:"file"`
	Id          *string `json:"id,omitempty"`
	Level       Level   `json:"level"`
	Line        float64 `json:"line"`
	Message     string  `json:"message"`
	Rule        string  `json:"rule"`
}

type Level

type Level string

const (
	LevelInfo    Level = "Info"
	LevelWarning Level = "Warning"
)

func (*Level) UnmarshalJSON

func (s *Level) UnmarshalJSON(bytes []byte) error

type NginxConfigurationAnalysisClient

type NginxConfigurationAnalysisClient struct {
	Client *resourcemanager.Client
}

func NewNginxConfigurationAnalysisClientWithBaseURI

func NewNginxConfigurationAnalysisClientWithBaseURI(sdkApi sdkEnv.Api) (*NginxConfigurationAnalysisClient, error)

func (NginxConfigurationAnalysisClient) ConfigurationsAnalysis

func (c NginxConfigurationAnalysisClient) ConfigurationsAnalysis(ctx context.Context, id ConfigurationId, input AnalysisCreate) (result ConfigurationsAnalysisOperationResponse, err error)

ConfigurationsAnalysis ...

type NginxConfigurationFile

type NginxConfigurationFile struct {
	Content     *string `json:"content,omitempty"`
	VirtualPath *string `json:"virtualPath,omitempty"`
}

type NginxConfigurationPackage

type NginxConfigurationPackage struct {
	Data           *string   `json:"data,omitempty"`
	ProtectedFiles *[]string `json:"protectedFiles,omitempty"`
}

type NginxConfigurationProtectedFileRequest

type NginxConfigurationProtectedFileRequest struct {
	Content     *string `json:"content,omitempty"`
	ContentHash *string `json:"contentHash,omitempty"`
	VirtualPath *string `json:"virtualPath,omitempty"`
}