gatewaycertificateauthority

package
v0.20241004.1180715 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2024-05-01/gatewaycertificateauthority Documentation

The gatewaycertificateauthority SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2024-05-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/apimanagement/2024-05-01/gatewaycertificateauthority"

Client Initialization

client := gatewaycertificateauthority.NewGatewayCertificateAuthorityClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GatewayCertificateAuthorityClient.CreateOrUpdate

ctx := context.TODO()
id := gatewaycertificateauthority.NewCertificateAuthorityID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "gatewayId", "certificateId")

payload := gatewaycertificateauthority.GatewayCertificateAuthorityContract{
	// ...
}


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

Example Usage: GatewayCertificateAuthorityClient.Delete

ctx := context.TODO()
id := gatewaycertificateauthority.NewCertificateAuthorityID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "gatewayId", "certificateId")

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

Example Usage: GatewayCertificateAuthorityClient.Get

ctx := context.TODO()
id := gatewaycertificateauthority.NewCertificateAuthorityID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "gatewayId", "certificateId")

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

Example Usage: GatewayCertificateAuthorityClient.GetEntityTag

ctx := context.TODO()
id := gatewaycertificateauthority.NewCertificateAuthorityID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "gatewayId", "certificateId")

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

Example Usage: GatewayCertificateAuthorityClient.ListByService

ctx := context.TODO()
id := gatewaycertificateauthority.NewServiceGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "gatewayId")

// alternatively `client.ListByService(ctx, id, gatewaycertificateauthority.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, gatewaycertificateauthority.DefaultListByServiceOperationOptions())
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 ValidateCertificateAuthorityID 

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

ValidateCertificateAuthorityID checks that 'input' can be parsed as a Certificate Authority ID

func ValidateServiceGatewayID 

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

ValidateServiceGatewayID checks that 'input' can be parsed as a Service Gateway ID

Types

type CertificateAuthorityId 

type CertificateAuthorityId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	GatewayId         string
	CertificateId     string
}

CertificateAuthorityId is a struct representing the Resource ID for a Certificate Authority

func NewCertificateAuthorityID 

func NewCertificateAuthorityID(subscriptionId string, resourceGroupName string, serviceName string, gatewayId string, certificateId string) CertificateAuthorityId

NewCertificateAuthorityID returns a new CertificateAuthorityId struct

func ParseCertificateAuthorityID 

func ParseCertificateAuthorityID(input string) (*CertificateAuthorityId, error)

ParseCertificateAuthorityID parses 'input' into a CertificateAuthorityId

func ParseCertificateAuthorityIDInsensitively 

func ParseCertificateAuthorityIDInsensitively(input string) (*CertificateAuthorityId, error)

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

func (*CertificateAuthorityId) FromParseResult 

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

func (CertificateAuthorityId) ID 

func (id CertificateAuthorityId) ID() string

ID returns the formatted Certificate Authority ID

func (CertificateAuthorityId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Certificate Authority ID

func (CertificateAuthorityId) String 

func (id CertificateAuthorityId) String() string

String returns a human-readable description of this Certificate Authority ID

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders 

func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (CreateOrUpdateOperationOptions) ToOData 

func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query

func (CreateOrUpdateOperationOptions) ToQuery 

func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GatewayCertificateAuthorityContract
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

func (o DeleteOperationOptions) ToHeaders() *client.Headers

func (DeleteOperationOptions) ToOData 

func (o DeleteOperationOptions) ToOData() *odata.Query

func (DeleteOperationOptions) ToQuery 

func (o DeleteOperationOptions) ToQuery() *client.QueryParams

type DeleteOperationResponse 

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

type GatewayCertificateAuthorityClient 

type GatewayCertificateAuthorityClient struct {
	Client *resourcemanager.Client
}

func NewGatewayCertificateAuthorityClientWithBaseURI 

func NewGatewayCertificateAuthorityClientWithBaseURI(sdkApi sdkEnv.Api) (*GatewayCertificateAuthorityClient, error)

func (GatewayCertificateAuthorityClient) CreateOrUpdate 

func (c GatewayCertificateAuthorityClient) CreateOrUpdate(ctx context.Context, id CertificateAuthorityId, input GatewayCertificateAuthorityContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (GatewayCertificateAuthorityClient) Delete 

func (c GatewayCertificateAuthorityClient) Delete(ctx context.Context, id CertificateAuthorityId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (GatewayCertificateAuthorityClient) Get 

func (c GatewayCertificateAuthorityClient) Get(ctx context.Context, id CertificateAuthorityId) (result GetOperationResponse, err error)

Get ...

func (GatewayCertificateAuthorityClient) GetEntityTag 

func (c GatewayCertificateAuthorityClient) GetEntityTag(ctx context.Context, id CertificateAuthorityId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (GatewayCertificateAuthorityClient) ListByService 

func (c GatewayCertificateAuthorityClient) ListByService(ctx context.Context, id ServiceGatewayId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)

ListByService ...

func (GatewayCertificateAuthorityClient) ListByServiceComplete 

func (c GatewayCertificateAuthorityClient) ListByServiceComplete(ctx context.Context, id ServiceGatewayId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (GatewayCertificateAuthorityClient) ListByServiceCompleteMatchingPredicate 

func (c GatewayCertificateAuthorityClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceGatewayId, options ListByServiceOperationOptions, predicate GatewayCertificateAuthorityContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GatewayCertificateAuthorityContract 

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

type GatewayCertificateAuthorityContractOperationPredicate 

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

func (GatewayCertificateAuthorityContractOperationPredicate) Matches 

func (p GatewayCertificateAuthorityContractOperationPredicate) Matches(input GatewayCertificateAuthorityContract) bool

type GatewayCertificateAuthorityContractProperties 

type GatewayCertificateAuthorityContractProperties struct {
	IsTrusted *bool `json:"isTrusted,omitempty"`
}

type GetEntityTagOperationResponse 

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

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GatewayCertificateAuthorityContract
}

type ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []GatewayCertificateAuthorityContract
}

type ListByServiceCustomPager 

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

type ListByServiceOperationOptions 

type ListByServiceOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

func DefaultListByServiceOperationOptions 

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

func (ListByServiceOperationOptions) ToHeaders 

func (o ListByServiceOperationOptions) ToHeaders() *client.Headers

func (ListByServiceOperationOptions) ToOData 

func (o ListByServiceOperationOptions) ToOData() *odata.Query

func (ListByServiceOperationOptions) ToQuery 

func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams

type ListByServiceOperationResponse 

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GatewayCertificateAuthorityContract
}

type ServiceGatewayId 

type ServiceGatewayId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	GatewayId         string
}

ServiceGatewayId is a struct representing the Resource ID for a Service Gateway

func NewServiceGatewayID 

func NewServiceGatewayID(subscriptionId string, resourceGroupName string, serviceName string, gatewayId string) ServiceGatewayId

NewServiceGatewayID returns a new ServiceGatewayId struct

func ParseServiceGatewayID 

func ParseServiceGatewayID(input string) (*ServiceGatewayId, error)

ParseServiceGatewayID parses 'input' into a ServiceGatewayId

func ParseServiceGatewayIDInsensitively 

func ParseServiceGatewayIDInsensitively(input string) (*ServiceGatewayId, error)

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

func (*ServiceGatewayId) FromParseResult 

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

func (ServiceGatewayId) ID 

func (id ServiceGatewayId) ID() string

ID returns the formatted Service Gateway ID

func (ServiceGatewayId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Service Gateway ID

func (ServiceGatewayId) String 

func (id ServiceGatewayId) String() string

String returns a human-readable description of this Service Gateway 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.