api

package
v0.20241025.1143247 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-05-01-preview/api Documentation

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

Client Initialization

client := api.NewApiClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiClient.CreateOrUpdate

ctx := context.TODO()
id := api.NewApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId")

payload := api.ApiCreateOrUpdateParameter{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload, api.DefaultCreateOrUpdateOperationOptions()); err != nil {
	// handle the error
}

Example Usage: ApiClient.Delete

ctx := context.TODO()
id := api.NewApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId")

if err := client.DeleteThenPoll(ctx, id, api.DefaultDeleteOperationOptions()); err != nil {
	// handle the error
}

Example Usage: ApiClient.Get

ctx := context.TODO()
id := api.NewApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId")

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: ApiClient.GetEntityTag

ctx := context.TODO()
id := api.NewApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId")

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: ApiClient.ListByService

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

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

Example Usage: ApiClient.Update

ctx := context.TODO()
id := api.NewApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId")

payload := api.ApiUpdateContract{
	// ...
}


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

Example Usage: ApiClient.WorkspaceApiCreateOrUpdate

ctx := context.TODO()
id := api.NewWorkspaceApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "apiId")

payload := api.ApiCreateOrUpdateParameter{
	// ...
}


if err := client.WorkspaceApiCreateOrUpdateThenPoll(ctx, id, payload, api.DefaultWorkspaceApiCreateOrUpdateOperationOptions()); err != nil {
	// handle the error
}

Example Usage: ApiClient.WorkspaceApiDelete

ctx := context.TODO()
id := api.NewWorkspaceApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "apiId")

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

Example Usage: ApiClient.WorkspaceApiGet

ctx := context.TODO()
id := api.NewWorkspaceApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "apiId")

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

Example Usage: ApiClient.WorkspaceApiGetEntityTag

ctx := context.TODO()
id := api.NewWorkspaceApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "apiId")

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

Example Usage: ApiClient.WorkspaceApiListByService

ctx := context.TODO()
id := api.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId")

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

Example Usage: ApiClient.WorkspaceApiUpdate

ctx := context.TODO()
id := api.NewWorkspaceApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "apiId")

payload := api.ApiUpdateContract{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForApiType 

func PossibleValuesForApiType() []string

func PossibleValuesForBearerTokenSendingMethods 

func PossibleValuesForBearerTokenSendingMethods() []string

func PossibleValuesForContentFormat 

func PossibleValuesForContentFormat() []string

func PossibleValuesForProtocol 

func PossibleValuesForProtocol() []string

func PossibleValuesForSoapApiType 

func PossibleValuesForSoapApiType() []string

func PossibleValuesForTranslateRequiredQueryParametersConduct 

func PossibleValuesForTranslateRequiredQueryParametersConduct() []string

func PossibleValuesForVersioningScheme 

func PossibleValuesForVersioningScheme() []string

func ValidateApiID 

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

ValidateApiID checks that 'input' can be parsed as a Api ID

func ValidateServiceID 

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

func ValidateWorkspaceApiID 

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

ValidateWorkspaceApiID checks that 'input' can be parsed as a Workspace Api ID

func ValidateWorkspaceID 

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type ApiClient 

type ApiClient struct {
	Client *resourcemanager.Client
}

func NewApiClientWithBaseURI 

func NewApiClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiClient, error)

func (ApiClient) CreateOrUpdate 

func (c ApiClient) CreateOrUpdate(ctx context.Context, id ApiId, input ApiCreateOrUpdateParameter, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ApiClient) CreateOrUpdateThenPoll 

func (c ApiClient) CreateOrUpdateThenPoll(ctx context.Context, id ApiId, input ApiCreateOrUpdateParameter, options CreateOrUpdateOperationOptions) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ApiClient) Delete 

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

Delete ...

func (ApiClient) DeleteThenPoll 

func (c ApiClient) DeleteThenPoll(ctx context.Context, id ApiId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (ApiClient) Get 

func (c ApiClient) Get(ctx context.Context, id ApiId) (result GetOperationResponse, err error)

Get ...

func (ApiClient) GetEntityTag 

func (c ApiClient) GetEntityTag(ctx context.Context, id ApiId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (ApiClient) ListByService 

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

ListByService ...

func (ApiClient) ListByServiceComplete 

func (c ApiClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (ApiClient) ListByServiceCompleteMatchingPredicate 

func (c ApiClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, predicate ApiContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApiClient) Update 

func (c ApiClient) Update(ctx context.Context, id ApiId, input ApiUpdateContract, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

func (ApiClient) WorkspaceApiCreateOrUpdate 

func (c ApiClient) WorkspaceApiCreateOrUpdate(ctx context.Context, id WorkspaceApiId, input ApiCreateOrUpdateParameter, options WorkspaceApiCreateOrUpdateOperationOptions) (result WorkspaceApiCreateOrUpdateOperationResponse, err error)

WorkspaceApiCreateOrUpdate ...

func (ApiClient) WorkspaceApiCreateOrUpdateThenPoll 

func (c ApiClient) WorkspaceApiCreateOrUpdateThenPoll(ctx context.Context, id WorkspaceApiId, input ApiCreateOrUpdateParameter, options WorkspaceApiCreateOrUpdateOperationOptions) error

WorkspaceApiCreateOrUpdateThenPoll performs WorkspaceApiCreateOrUpdate then polls until it's completed

func (ApiClient) WorkspaceApiDelete 

func (c ApiClient) WorkspaceApiDelete(ctx context.Context, id WorkspaceApiId, options WorkspaceApiDeleteOperationOptions) (result WorkspaceApiDeleteOperationResponse, err error)

WorkspaceApiDelete ...

func (ApiClient) WorkspaceApiGet 

func (c ApiClient) WorkspaceApiGet(ctx context.Context, id WorkspaceApiId) (result WorkspaceApiGetOperationResponse, err error)

WorkspaceApiGet ...

func (ApiClient) WorkspaceApiGetEntityTag 

func (c ApiClient) WorkspaceApiGetEntityTag(ctx context.Context, id WorkspaceApiId) (result WorkspaceApiGetEntityTagOperationResponse, err error)

WorkspaceApiGetEntityTag ...

func (ApiClient) WorkspaceApiListByService 

func (c ApiClient) WorkspaceApiListByService(ctx context.Context, id WorkspaceId, options WorkspaceApiListByServiceOperationOptions) (result WorkspaceApiListByServiceOperationResponse, err error)

WorkspaceApiListByService ...

func (ApiClient) WorkspaceApiListByServiceComplete 

func (c ApiClient) WorkspaceApiListByServiceComplete(ctx context.Context, id WorkspaceId, options WorkspaceApiListByServiceOperationOptions) (WorkspaceApiListByServiceCompleteResult, error)

WorkspaceApiListByServiceComplete retrieves all the results into a single object

func (ApiClient) WorkspaceApiListByServiceCompleteMatchingPredicate 

func (c ApiClient) WorkspaceApiListByServiceCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options WorkspaceApiListByServiceOperationOptions, predicate ApiContractOperationPredicate) (result WorkspaceApiListByServiceCompleteResult, err error)

WorkspaceApiListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApiClient) WorkspaceApiUpdate 

func (c ApiClient) WorkspaceApiUpdate(ctx context.Context, id WorkspaceApiId, input ApiUpdateContract, options WorkspaceApiUpdateOperationOptions) (result WorkspaceApiUpdateOperationResponse, err error)

WorkspaceApiUpdate ...

type ApiContactInformation 

type ApiContactInformation struct {
	Email *string `json:"email,omitempty"`
	Name  *string `json:"name,omitempty"`
	Url   *string `json:"url,omitempty"`
}

type ApiContract 

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

type ApiContractOperationPredicate 

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

func (ApiContractOperationPredicate) Matches 

func (p ApiContractOperationPredicate) Matches(input ApiContract) bool

type ApiContractProperties 

type ApiContractProperties struct {
	ApiRevision                   *string                                `json:"apiRevision,omitempty"`
	ApiRevisionDescription        *string                                `json:"apiRevisionDescription,omitempty"`
	ApiVersion                    *string                                `json:"apiVersion,omitempty"`
	ApiVersionDescription         *string                                `json:"apiVersionDescription,omitempty"`
	ApiVersionSet                 *ApiVersionSetContractDetails          `json:"apiVersionSet,omitempty"`
	ApiVersionSetId               *string                                `json:"apiVersionSetId,omitempty"`
	AuthenticationSettings        *AuthenticationSettingsContract        `json:"authenticationSettings,omitempty"`
	Contact                       *ApiContactInformation                 `json:"contact,omitempty"`
	Description                   *string                                `json:"description,omitempty"`
	DisplayName                   *string                                `json:"displayName,omitempty"`
	IsCurrent                     *bool                                  `json:"isCurrent,omitempty"`
	IsOnline                      *bool                                  `json:"isOnline,omitempty"`
	License                       *ApiLicenseInformation                 `json:"license,omitempty"`
	Path                          string                                 `json:"path"`
	Protocols                     *[]Protocol                            `json:"protocols,omitempty"`
	ProvisioningState             *string                                `json:"provisioningState,omitempty"`
	ServiceURL                    *string                                `json:"serviceUrl,omitempty"`
	SourceApiId                   *string                                `json:"sourceApiId,omitempty"`
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	SubscriptionRequired          *bool                                  `json:"subscriptionRequired,omitempty"`
	TermsOfServiceURL             *string                                `json:"termsOfServiceUrl,omitempty"`
	Type                          *ApiType                               `json:"type,omitempty"`
}

type ApiContractUpdateProperties 

type ApiContractUpdateProperties struct {
	ApiRevision                   *string                                `json:"apiRevision,omitempty"`
	ApiRevisionDescription        *string                                `json:"apiRevisionDescription,omitempty"`
	ApiVersion                    *string                                `json:"apiVersion,omitempty"`
	ApiVersionDescription         *string                                `json:"apiVersionDescription,omitempty"`
	ApiVersionSetId               *string                                `json:"apiVersionSetId,omitempty"`
	AuthenticationSettings        *AuthenticationSettingsContract        `json:"authenticationSettings,omitempty"`
	Contact                       *ApiContactInformation                 `json:"contact,omitempty"`
	Description                   *string                                `json:"description,omitempty"`
	DisplayName                   *string                                `json:"displayName,omitempty"`
	IsCurrent                     *bool                                  `json:"isCurrent,omitempty"`
	IsOnline                      *bool                                  `json:"isOnline,omitempty"`
	License                       *ApiLicenseInformation                 `json:"license,omitempty"`
	Path                          *string                                `json:"path,omitempty"`
	Protocols                     *[]Protocol                            `json:"protocols,omitempty"`
	ServiceURL                    *string                                `json:"serviceUrl,omitempty"`
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	SubscriptionRequired          *bool                                  `json:"subscriptionRequired,omitempty"`
	TermsOfServiceURL             *string                                `json:"termsOfServiceUrl,omitempty"`
	Type                          *ApiType                               `json:"type,omitempty"`
}

type ApiCreateOrUpdateParameter 

type ApiCreateOrUpdateParameter struct {
	Properties *ApiCreateOrUpdateProperties `json:"properties,omitempty"`
}

type ApiCreateOrUpdateProperties 

type ApiCreateOrUpdateProperties struct {
	ApiRevision                      *string                                  `json:"apiRevision,omitempty"`
	ApiRevisionDescription           *string                                  `json:"apiRevisionDescription,omitempty"`
	ApiType                          *SoapApiType                             `json:"apiType,omitempty"`
	ApiVersion                       *string                                  `json:"apiVersion,omitempty"`
	ApiVersionDescription            *string                                  `json:"apiVersionDescription,omitempty"`
	ApiVersionSet                    *ApiVersionSetContractDetails            `json:"apiVersionSet,omitempty"`
	ApiVersionSetId                  *string                                  `json:"apiVersionSetId,omitempty"`
	AuthenticationSettings           *AuthenticationSettingsContract          `json:"authenticationSettings,omitempty"`
	Contact                          *ApiContactInformation                   `json:"contact,omitempty"`
	Description                      *string                                  `json:"description,omitempty"`
	DisplayName                      *string                                  `json:"displayName,omitempty"`
	Format                           *ContentFormat                           `json:"format,omitempty"`
	IsCurrent                        *bool                                    `json:"isCurrent,omitempty"`
	IsOnline                         *bool                                    `json:"isOnline,omitempty"`
	License                          *ApiLicenseInformation                   `json:"license,omitempty"`
	Path                             string                                   `json:"path"`
	Protocols                        *[]Protocol                              `json:"protocols,omitempty"`
	ProvisioningState                *string                                  `json:"provisioningState,omitempty"`
	ServiceURL                       *string                                  `json:"serviceUrl,omitempty"`
	SourceApiId                      *string                                  `json:"sourceApiId,omitempty"`
	SubscriptionKeyParameterNames    *SubscriptionKeyParameterNamesContract   `json:"subscriptionKeyParameterNames,omitempty"`
	SubscriptionRequired             *bool                                    `json:"subscriptionRequired,omitempty"`
	TermsOfServiceURL                *string                                  `json:"termsOfServiceUrl,omitempty"`
	TranslateRequiredQueryParameters *TranslateRequiredQueryParametersConduct `json:"translateRequiredQueryParameters,omitempty"`
	Type                             *ApiType                                 `json:"type,omitempty"`
	Value                            *string                                  `json:"value,omitempty"`
	WsdlSelector                     *ApiCreateOrUpdatePropertiesWsdlSelector `json:"wsdlSelector,omitempty"`
}

type ApiCreateOrUpdatePropertiesWsdlSelector 

type ApiCreateOrUpdatePropertiesWsdlSelector struct {
	WsdlEndpointName *string `json:"wsdlEndpointName,omitempty"`
	WsdlServiceName  *string `json:"wsdlServiceName,omitempty"`
}

type ApiId 

type ApiId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ApiId             string
}

ApiId is a struct representing the Resource ID for a Api

func NewApiID 

func NewApiID(subscriptionId string, resourceGroupName string, serviceName string, apiId string) ApiId

NewApiID returns a new ApiId struct

func ParseApiID 

func ParseApiID(input string) (*ApiId, error)

ParseApiID parses 'input' into a ApiId

func ParseApiIDInsensitively 

func ParseApiIDInsensitively(input string) (*ApiId, error)

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

func (*ApiId) FromParseResult 

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

func (ApiId) ID 

func (id ApiId) ID() string

ID returns the formatted Api ID

func (ApiId) Segments 

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

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

func (ApiId) String 

func (id ApiId) String() string

String returns a human-readable description of this Api ID

type ApiLicenseInformation 

type ApiLicenseInformation struct {
	Name *string `json:"name,omitempty"`
	Url  *string `json:"url,omitempty"`
}

type ApiType 

type ApiType string
const (
	ApiTypeGraphql   ApiType = "graphql"
	ApiTypeGrpc      ApiType = "grpc"
	ApiTypeHTTP      ApiType = "http"
	ApiTypeOdata     ApiType = "odata"
	ApiTypeSoap      ApiType = "soap"
	ApiTypeWebsocket ApiType = "websocket"
)

func (*ApiType) UnmarshalJSON 

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

type ApiUpdateContract 

type ApiUpdateContract struct {
	Properties *ApiContractUpdateProperties `json:"properties,omitempty"`
}

type ApiVersionSetContractDetails 

type ApiVersionSetContractDetails struct {
	Description       *string           `json:"description,omitempty"`
	Id                *string           `json:"id,omitempty"`
	Name              *string           `json:"name,omitempty"`
	VersionHeaderName *string           `json:"versionHeaderName,omitempty"`
	VersionQueryName  *string           `json:"versionQueryName,omitempty"`
	VersioningScheme  *VersioningScheme `json:"versioningScheme,omitempty"`
}

type AuthenticationSettingsContract 

type AuthenticationSettingsContract struct {
	OAuth2                       *OAuth2AuthenticationSettingsContract   `json:"oAuth2,omitempty"`
	OAuth2AuthenticationSettings *[]OAuth2AuthenticationSettingsContract `json:"oAuth2AuthenticationSettings,omitempty"`
	Openid                       *OpenIdAuthenticationSettingsContract   `json:"openid,omitempty"`
	OpenidAuthenticationSettings *[]OpenIdAuthenticationSettingsContract `json:"openidAuthenticationSettings,omitempty"`
}

type BearerTokenSendingMethods 

type BearerTokenSendingMethods string
const (
	BearerTokenSendingMethodsAuthorizationHeader BearerTokenSendingMethods = "authorizationHeader"
	BearerTokenSendingMethodsQuery               BearerTokenSendingMethods = "query"
)

func (*BearerTokenSendingMethods) UnmarshalJSON 

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

type ContentFormat 

type ContentFormat string
const (
	ContentFormatGraphqlNegativelink             ContentFormat = "graphql-link"
	ContentFormatGrpc                            ContentFormat = "grpc"
	ContentFormatGrpcNegativelink                ContentFormat = "grpc-link"
	ContentFormatOdata                           ContentFormat = "odata"
	ContentFormatOdataNegativelink               ContentFormat = "odata-link"
	ContentFormatOpenapi                         ContentFormat = "openapi"
	ContentFormatOpenapiNegativelink             ContentFormat = "openapi-link"
	ContentFormatOpenapiPositivejson             ContentFormat = "openapi+json"
	ContentFormatOpenapiPositivejsonNegativelink ContentFormat = "openapi+json-link"
	ContentFormatSwaggerNegativejson             ContentFormat = "swagger-json"
	ContentFormatSwaggerNegativelinkNegativejson ContentFormat = "swagger-link-json"
	ContentFormatWadlNegativelinkNegativejson    ContentFormat = "wadl-link-json"
	ContentFormatWadlNegativexml                 ContentFormat = "wadl-xml"
	ContentFormatWsdl                            ContentFormat = "wsdl"
	ContentFormatWsdlNegativelink                ContentFormat = "wsdl-link"
)

func (*ContentFormat) UnmarshalJSON 

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

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 {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiContract
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	DeleteRevisions *bool
	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 {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetEntityTagOperationResponse 

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

type GetOperationResponse 

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

type ListByServiceCompleteResult 

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

type ListByServiceCustomPager added in v0.20240628.1153531 

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

type ListByServiceOperationOptions 

type ListByServiceOperationOptions struct {
	ExpandApiVersionSet *bool
	Filter              *string
	Skip                *int64
	Tags                *string
	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        *[]ApiContract
}

type OAuth2AuthenticationSettingsContract 

type OAuth2AuthenticationSettingsContract struct {
	AuthorizationServerId *string `json:"authorizationServerId,omitempty"`
	Scope                 *string `json:"scope,omitempty"`
}

type OpenIdAuthenticationSettingsContract 

type OpenIdAuthenticationSettingsContract struct {
	BearerTokenSendingMethods *[]BearerTokenSendingMethods `json:"bearerTokenSendingMethods,omitempty"`
	OpenidProviderId          *string                      `json:"openidProviderId,omitempty"`
}

type Protocol 

type Protocol string
const (
	ProtocolHTTP  Protocol = "http"
	ProtocolHTTPS Protocol = "https"
	ProtocolWs    Protocol = "ws"
	ProtocolWss   Protocol = "wss"
)

func (*Protocol) UnmarshalJSON 

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

type ServiceId 

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID 

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID 

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively 

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (*ServiceId) FromParseResult 

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

func (ServiceId) ID 

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments 

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

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

func (ServiceId) String 

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

type SoapApiType 

type SoapApiType string
const (
	SoapApiTypeGraphql   SoapApiType = "graphql"
	SoapApiTypeGrpc      SoapApiType = "grpc"
	SoapApiTypeHTTP      SoapApiType = "http"
	SoapApiTypeOdata     SoapApiType = "odata"
	SoapApiTypeSoap      SoapApiType = "soap"
	SoapApiTypeWebsocket SoapApiType = "websocket"
)

func (*SoapApiType) UnmarshalJSON 

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

type SubscriptionKeyParameterNamesContract 

type SubscriptionKeyParameterNamesContract struct {
	Header *string `json:"header,omitempty"`
	Query  *string `json:"query,omitempty"`
}

type TranslateRequiredQueryParametersConduct 

type TranslateRequiredQueryParametersConduct string
const (
	TranslateRequiredQueryParametersConductQuery    TranslateRequiredQueryParametersConduct = "query"
	TranslateRequiredQueryParametersConductTemplate TranslateRequiredQueryParametersConduct = "template"
)

func (*TranslateRequiredQueryParametersConduct) UnmarshalJSON 

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

type UpdateOperationOptions 

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions 

func DefaultUpdateOperationOptions() UpdateOperationOptions

func (UpdateOperationOptions) ToHeaders 

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

func (UpdateOperationOptions) ToOData 

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

func (UpdateOperationOptions) ToQuery 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiContract
}

type VersioningScheme 

type VersioningScheme string
const (
	VersioningSchemeHeader  VersioningScheme = "Header"
	VersioningSchemeQuery   VersioningScheme = "Query"
	VersioningSchemeSegment VersioningScheme = "Segment"
)

func (*VersioningScheme) UnmarshalJSON 

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

type WorkspaceApiCreateOrUpdateOperationOptions 

type WorkspaceApiCreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultWorkspaceApiCreateOrUpdateOperationOptions 

func DefaultWorkspaceApiCreateOrUpdateOperationOptions() WorkspaceApiCreateOrUpdateOperationOptions

func (WorkspaceApiCreateOrUpdateOperationOptions) ToHeaders 

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

func (WorkspaceApiCreateOrUpdateOperationOptions) ToOData 

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

func (WorkspaceApiCreateOrUpdateOperationOptions) ToQuery 

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

type WorkspaceApiCreateOrUpdateOperationResponse 

type WorkspaceApiCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiContract
}

type WorkspaceApiDeleteOperationOptions 

type WorkspaceApiDeleteOperationOptions struct {
	DeleteRevisions *bool
	IfMatch         *string
}

func DefaultWorkspaceApiDeleteOperationOptions 

func DefaultWorkspaceApiDeleteOperationOptions() WorkspaceApiDeleteOperationOptions

func (WorkspaceApiDeleteOperationOptions) ToHeaders 

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

func (WorkspaceApiDeleteOperationOptions) ToOData 

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

func (WorkspaceApiDeleteOperationOptions) ToQuery 

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

type WorkspaceApiDeleteOperationResponse 

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

type WorkspaceApiGetEntityTagOperationResponse 

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

type WorkspaceApiGetOperationResponse 

type WorkspaceApiGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiContract
}

type WorkspaceApiId 

type WorkspaceApiId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	ApiId             string
}

WorkspaceApiId is a struct representing the Resource ID for a Workspace Api

func NewWorkspaceApiID 

func NewWorkspaceApiID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, apiId string) WorkspaceApiId

NewWorkspaceApiID returns a new WorkspaceApiId struct

func ParseWorkspaceApiID 

func ParseWorkspaceApiID(input string) (*WorkspaceApiId, error)

ParseWorkspaceApiID parses 'input' into a WorkspaceApiId

func ParseWorkspaceApiIDInsensitively 

func ParseWorkspaceApiIDInsensitively(input string) (*WorkspaceApiId, error)

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

func (*WorkspaceApiId) FromParseResult 

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

func (WorkspaceApiId) ID 

func (id WorkspaceApiId) ID() string

ID returns the formatted Workspace Api ID

func (WorkspaceApiId) Segments 

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

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

func (WorkspaceApiId) String 

func (id WorkspaceApiId) String() string

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

type WorkspaceApiListByServiceCompleteResult 

type WorkspaceApiListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiContract
}

type WorkspaceApiListByServiceCustomPager added in v0.20240628.1153531 

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

type WorkspaceApiListByServiceOperationOptions 

type WorkspaceApiListByServiceOperationOptions struct {
	ExpandApiVersionSet *bool
	Filter              *string
	Skip                *int64
	Tags                *string
	Top                 *int64
}

func DefaultWorkspaceApiListByServiceOperationOptions 

func DefaultWorkspaceApiListByServiceOperationOptions() WorkspaceApiListByServiceOperationOptions

func (WorkspaceApiListByServiceOperationOptions) ToHeaders 

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

func (WorkspaceApiListByServiceOperationOptions) ToOData 

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

func (WorkspaceApiListByServiceOperationOptions) ToQuery 

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

type WorkspaceApiListByServiceOperationResponse 

type WorkspaceApiListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiContract
}

type WorkspaceApiUpdateOperationOptions 

type WorkspaceApiUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultWorkspaceApiUpdateOperationOptions 

func DefaultWorkspaceApiUpdateOperationOptions() WorkspaceApiUpdateOperationOptions

func (WorkspaceApiUpdateOperationOptions) ToHeaders 

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

func (WorkspaceApiUpdateOperationOptions) ToOData 

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

func (WorkspaceApiUpdateOperationOptions) ToQuery 

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

type WorkspaceApiUpdateOperationResponse 

type WorkspaceApiUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiContract
}

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult 

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

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Workspace ID

func (WorkspaceId) String 

func (id WorkspaceId) String() string

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