nginxapikey

package
v0.20241206.1180327 Latest Latest
Warning

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

 Go to latest Published: Dec 6, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

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

Client Initialization

client := nginxapikey.NewNginxApiKeyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NginxApiKeyClient.ApiKeysCreateOrUpdate

ctx := context.TODO()
id := nginxapikey.NewApiKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentName", "apiKeyName")

payload := nginxapikey.NginxDeploymentApiKeyRequest{
	// ...
}


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

Example Usage: NginxApiKeyClient.ApiKeysDelete

ctx := context.TODO()
id := nginxapikey.NewApiKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentName", "apiKeyName")

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

Example Usage: NginxApiKeyClient.ApiKeysGet

ctx := context.TODO()
id := nginxapikey.NewApiKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentName", "apiKeyName")

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

Example Usage: NginxApiKeyClient.ApiKeysList

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

// alternatively `client.ApiKeysList(ctx, id)` can be used to do batched pagination
items, err := client.ApiKeysListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateApiKeyID 

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

ValidateApiKeyID checks that 'input' can be parsed as a Api Key ID

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 ApiKeyId 

type ApiKeyId struct {
	SubscriptionId      string
	ResourceGroupName   string
	NginxDeploymentName string
	ApiKeyName          string
}

ApiKeyId is a struct representing the Resource ID for a Api Key

func NewApiKeyID 

func NewApiKeyID(subscriptionId string, resourceGroupName string, nginxDeploymentName string, apiKeyName string) ApiKeyId

NewApiKeyID returns a new ApiKeyId struct

func ParseApiKeyID 

func ParseApiKeyID(input string) (*ApiKeyId, error)

ParseApiKeyID parses 'input' into a ApiKeyId

func ParseApiKeyIDInsensitively 

func ParseApiKeyIDInsensitively(input string) (*ApiKeyId, error)

ParseApiKeyIDInsensitively parses 'input' case-insensitively into a ApiKeyId note: this method should only be used for API response data and not user input

func (*ApiKeyId) FromParseResult 

func (id *ApiKeyId) FromParseResult(input resourceids.ParseResult) error

func (ApiKeyId) ID 

func (id ApiKeyId) ID() string

ID returns the formatted Api Key ID

func (ApiKeyId) Segments 

func (id ApiKeyId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Api Key ID

func (ApiKeyId) String 

func (id ApiKeyId) String() string

String returns a human-readable description of this Api Key ID

type ApiKeysCreateOrUpdateOperationResponse 

type ApiKeysCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NginxDeploymentApiKeyResponse
}

type ApiKeysDeleteOperationResponse 

type ApiKeysDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ApiKeysGetOperationResponse 

type ApiKeysGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NginxDeploymentApiKeyResponse
}

type ApiKeysListCompleteResult 

type ApiKeysListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NginxDeploymentApiKeyResponse
}

type ApiKeysListCustomPager 

type ApiKeysListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ApiKeysListCustomPager) NextPageLink() *odata.Link

type ApiKeysListOperationResponse 

type ApiKeysListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NginxDeploymentApiKeyResponse
}

type NginxApiKeyClient 

type NginxApiKeyClient struct {
	Client *resourcemanager.Client
}

func NewNginxApiKeyClientWithBaseURI 

func NewNginxApiKeyClientWithBaseURI(sdkApi sdkEnv.Api) (*NginxApiKeyClient, error)

func (NginxApiKeyClient) ApiKeysCreateOrUpdate 

func (c NginxApiKeyClient) ApiKeysCreateOrUpdate(ctx context.Context, id ApiKeyId, input NginxDeploymentApiKeyRequest) (result ApiKeysCreateOrUpdateOperationResponse, err error)

ApiKeysCreateOrUpdate ...

func (NginxApiKeyClient) ApiKeysDelete 

func (c NginxApiKeyClient) ApiKeysDelete(ctx context.Context, id ApiKeyId) (result ApiKeysDeleteOperationResponse, err error)

ApiKeysDelete ...

func (NginxApiKeyClient) ApiKeysGet 

func (c NginxApiKeyClient) ApiKeysGet(ctx context.Context, id ApiKeyId) (result ApiKeysGetOperationResponse, err error)

ApiKeysGet ...

func (NginxApiKeyClient) ApiKeysList 

func (c NginxApiKeyClient) ApiKeysList(ctx context.Context, id NginxDeploymentId) (result ApiKeysListOperationResponse, err error)

ApiKeysList ...

func (NginxApiKeyClient) ApiKeysListComplete 

func (c NginxApiKeyClient) ApiKeysListComplete(ctx context.Context, id NginxDeploymentId) (ApiKeysListCompleteResult, error)

ApiKeysListComplete retrieves all the results into a single object

func (NginxApiKeyClient) ApiKeysListCompleteMatchingPredicate 

func (c NginxApiKeyClient) ApiKeysListCompleteMatchingPredicate(ctx context.Context, id NginxDeploymentId, predicate NginxDeploymentApiKeyResponseOperationPredicate) (result ApiKeysListCompleteResult, err error)

ApiKeysListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type NginxDeploymentApiKeyRequest 

type NginxDeploymentApiKeyRequest struct {
	Id         *string                                 `json:"id,omitempty"`
	Name       *string                                 `json:"name,omitempty"`
	Properties *NginxDeploymentApiKeyRequestProperties `json:"properties,omitempty"`
	Type       *string                                 `json:"type,omitempty"`
}

type NginxDeploymentApiKeyRequestProperties 

type NginxDeploymentApiKeyRequestProperties struct {
	EndDateTime *string `json:"endDateTime,omitempty"`
	SecretText  *string `json:"secretText,omitempty"`
}

func (*NginxDeploymentApiKeyRequestProperties) GetEndDateTimeAsTime 

func (o *NginxDeploymentApiKeyRequestProperties) GetEndDateTimeAsTime() (*time.Time, error)

func (*NginxDeploymentApiKeyRequestProperties) SetEndDateTimeAsTime 

func (o *NginxDeploymentApiKeyRequestProperties) SetEndDateTimeAsTime(input time.Time)

type NginxDeploymentApiKeyResponse 

type NginxDeploymentApiKeyResponse struct {
	Id         *string                                  `json:"id,omitempty"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *NginxDeploymentApiKeyResponseProperties `json:"properties,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type NginxDeploymentApiKeyResponseOperationPredicate 

type NginxDeploymentApiKeyResponseOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (NginxDeploymentApiKeyResponseOperationPredicate) Matches 

func (p NginxDeploymentApiKeyResponseOperationPredicate) Matches(input NginxDeploymentApiKeyResponse) bool

type NginxDeploymentApiKeyResponseProperties 

type NginxDeploymentApiKeyResponseProperties struct {
	EndDateTime *string `json:"endDateTime,omitempty"`
	Hint        *string `json:"hint,omitempty"`
}

func (*NginxDeploymentApiKeyResponseProperties) GetEndDateTimeAsTime 

func (o *NginxDeploymentApiKeyResponseProperties) GetEndDateTimeAsTime() (*time.Time, error)

func (*NginxDeploymentApiKeyResponseProperties) SetEndDateTimeAsTime 

func (o *NginxDeploymentApiKeyResponseProperties) SetEndDateTimeAsTime(input time.Time)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.