nginxdeployment

package
v0.20240320.1143605 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 20, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/nginx/2023-04-01/nginxdeployment Documentation

The nginxdeployment 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/nginx/2023-04-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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForNginxPrivateIPAllocationMethod

func PossibleValuesForNginxPrivateIPAllocationMethod() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateNginxDeploymentID

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

ValidateNginxDeploymentID checks that 'input' can be parsed as a Nginx Deployment ID

Types

type DeploymentsCreateOrUpdateOperationResponse

type DeploymentsCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NginxDeployment
}

type DeploymentsDeleteOperationResponse

type DeploymentsDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeploymentsGetOperationResponse

type DeploymentsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NginxDeployment
}

type DeploymentsListByResourceGroupCompleteResult

type DeploymentsListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NginxDeployment
}

type DeploymentsListByResourceGroupOperationResponse

type DeploymentsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NginxDeployment
}

type DeploymentsListCompleteResult

type DeploymentsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NginxDeployment
}

type DeploymentsListOperationResponse

type DeploymentsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NginxDeployment
}

type DeploymentsUpdateOperationResponse

type DeploymentsUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NginxDeployment
}

type NginxDeployment

type NginxDeployment struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *NginxDeploymentProperties         `json:"properties,omitempty"`
	Sku        *ResourceSku                       `json:"sku,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type NginxDeploymentClient

type NginxDeploymentClient struct {
	Client *resourcemanager.Client
}

func NewNginxDeploymentClientWithBaseURI

func NewNginxDeploymentClientWithBaseURI(sdkApi sdkEnv.Api) (*NginxDeploymentClient, error)

func (NginxDeploymentClient) DeploymentsCreateOrUpdate

DeploymentsCreateOrUpdate ...

func (NginxDeploymentClient) DeploymentsCreateOrUpdateThenPoll

func (c NginxDeploymentClient) DeploymentsCreateOrUpdateThenPoll(ctx context.Context, id NginxDeploymentId, input NginxDeployment) error

DeploymentsCreateOrUpdateThenPoll performs DeploymentsCreateOrUpdate then polls until it's completed

func (NginxDeploymentClient) DeploymentsDelete

DeploymentsDelete ...

func (NginxDeploymentClient) DeploymentsDeleteThenPoll

func (c NginxDeploymentClient) DeploymentsDeleteThenPoll(ctx context.Context, id NginxDeploymentId) error

DeploymentsDeleteThenPoll performs DeploymentsDelete then polls until it's completed

func (NginxDeploymentClient) DeploymentsGet

DeploymentsGet ...

func (NginxDeploymentClient) DeploymentsList

DeploymentsList ...

func (NginxDeploymentClient) DeploymentsListByResourceGroup

DeploymentsListByResourceGroup ...

func (NginxDeploymentClient) DeploymentsListByResourceGroupComplete

DeploymentsListByResourceGroupComplete retrieves all the results into a single object

func (NginxDeploymentClient) DeploymentsListByResourceGroupCompleteMatchingPredicate

func (c NginxDeploymentClient) DeploymentsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate NginxDeploymentOperationPredicate) (result DeploymentsListByResourceGroupCompleteResult, err error)

DeploymentsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NginxDeploymentClient) DeploymentsListComplete

DeploymentsListComplete retrieves all the results into a single object

func (NginxDeploymentClient) DeploymentsListCompleteMatchingPredicate

func (c NginxDeploymentClient) DeploymentsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate NginxDeploymentOperationPredicate) (result DeploymentsListCompleteResult, err error)

DeploymentsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NginxDeploymentClient) DeploymentsUpdate

DeploymentsUpdate ...

func (NginxDeploymentClient) DeploymentsUpdateThenPoll

DeploymentsUpdateThenPoll performs DeploymentsUpdate then polls until it's completed

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 NginxDeploymentOperationPredicate

type NginxDeploymentOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (NginxDeploymentOperationPredicate) Matches

type NginxDeploymentProperties

type NginxDeploymentProperties struct {
	EnableDiagnosticsSupport *bool                             `json:"enableDiagnosticsSupport,omitempty"`
	IPAddress                *string                           `json:"ipAddress,omitempty"`
	Logging                  *NginxLogging                     `json:"logging,omitempty"`
	ManagedResourceGroup     *string                           `json:"managedResourceGroup,omitempty"`
	NetworkProfile           *NginxNetworkProfile              `json:"networkProfile,omitempty"`
	NginxVersion             *string                           `json:"nginxVersion,omitempty"`
	ProvisioningState        *ProvisioningState                `json:"provisioningState,omitempty"`
	ScalingProperties        *NginxDeploymentScalingProperties `json:"scalingProperties,omitempty"`
	UserProfile              *NginxDeploymentUserProfile       `json:"userProfile,omitempty"`
}

type NginxDeploymentScalingProperties

type NginxDeploymentScalingProperties struct {
	Capacity *int64 `json:"capacity,omitempty"`
}

type NginxDeploymentUpdateParameters

type NginxDeploymentUpdateParameters struct {
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Properties *NginxDeploymentUpdateProperties   `json:"properties,omitempty"`
	Sku        *ResourceSku                       `json:"sku,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type NginxDeploymentUpdateProperties

type NginxDeploymentUpdateProperties struct {
	EnableDiagnosticsSupport *bool                             `json:"enableDiagnosticsSupport,omitempty"`
	Logging                  *NginxLogging                     `json:"logging,omitempty"`
	ScalingProperties        *NginxDeploymentScalingProperties `json:"scalingProperties,omitempty"`
	UserProfile              *NginxDeploymentUserProfile       `json:"userProfile,omitempty"`
}

type NginxDeploymentUserProfile

type NginxDeploymentUserProfile struct {
	PreferredEmail *string `json:"preferredEmail,omitempty"`
}

type NginxFrontendIPConfiguration

type NginxFrontendIPConfiguration struct {
	PrivateIPAddresses *[]NginxPrivateIPAddress `json:"privateIPAddresses,omitempty"`
	PublicIPAddresses  *[]NginxPublicIPAddress  `json:"publicIPAddresses,omitempty"`
}

type NginxLogging

type NginxLogging struct {
	StorageAccount *NginxStorageAccount `json:"storageAccount,omitempty"`
}

type NginxNetworkInterfaceConfiguration

type NginxNetworkInterfaceConfiguration struct {
	SubnetId *string `json:"subnetId,omitempty"`
}

type NginxNetworkProfile

type NginxNetworkProfile struct {
	FrontEndIPConfiguration       *NginxFrontendIPConfiguration       `json:"frontEndIPConfiguration,omitempty"`
	NetworkInterfaceConfiguration *NginxNetworkInterfaceConfiguration `json:"networkInterfaceConfiguration,omitempty"`
}

type NginxPrivateIPAddress

type NginxPrivateIPAddress struct {
	PrivateIPAddress          *string                         `json:"privateIPAddress,omitempty"`
	PrivateIPAllocationMethod *NginxPrivateIPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`
	SubnetId                  *string                         `json:"subnetId,omitempty"`
}

type NginxPrivateIPAllocationMethod

type NginxPrivateIPAllocationMethod string
const (
	NginxPrivateIPAllocationMethodDynamic NginxPrivateIPAllocationMethod = "Dynamic"
	NginxPrivateIPAllocationMethodStatic  NginxPrivateIPAllocationMethod = "Static"
)

func (*NginxPrivateIPAllocationMethod) UnmarshalJSON

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

type NginxPublicIPAddress

type NginxPublicIPAddress struct {
	Id *string `json:"id,omitempty"`
}

type NginxStorageAccount

type NginxStorageAccount struct {
	AccountName   *string `json:"accountName,omitempty"`
	ContainerName *string `json:"containerName,omitempty"`
}

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

type ResourceSku

type ResourceSku struct {
	Name string `json:"name"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL