armapimanagement

package module
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Nov 1, 2021 License: MIT Imports: 16 Imported by: 10

README

Azure API Management Module for Go

PkgGoDev

The armapimanagement module provides operations for working with Azure API Management.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure API Management module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure API Management. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure API Management modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armapimanagement.NewTagClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armapimanagement.NewTagClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the API Management label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIBeginCreateOrUpdateOptions 

type APIBeginCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APIBeginCreateOrUpdateOptions contains the optional parameters for the API.BeginCreateOrUpdate method.

type APIClient 

type APIClient struct {
	// contains filtered or unexported fields
}

APIClient contains the methods for the API group. Don't use this type directly, use NewAPIClient() instead.

func NewAPIClient 

func NewAPIClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIClient

NewAPIClient creates a new instance of APIClient with the specified values.

func (*APIClient) BeginCreateOrUpdate 

func (client *APIClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, parameters APICreateOrUpdateParameter, options *APIBeginCreateOrUpdateOptions) (APICreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates new or updates existing specified API of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*APIClient) Delete 

func (client *APIClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, ifMatch string, options *APIDeleteOptions) (APIDeleteResponse, error)

Delete - Deletes the specified API of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*APIClient) Get 

func (client *APIClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, options *APIGetOptions) (APIGetResponse, error)

Get - Gets the details of the API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIClient) GetEntityTag 

func (client *APIClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, options *APIGetEntityTagOptions) (APIGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIClient) ListByService 

func (client *APIClient) ListByService(resourceGroupName string, serviceName string, options *APIListByServiceOptions) *APIListByServicePager

ListByService - Lists all APIs of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*APIClient) ListByTags 

func (client *APIClient) ListByTags(resourceGroupName string, serviceName string, options *APIListByTagsOptions) *APIListByTagsPager

ListByTags - Lists a collection of apis associated with tags. If the operation fails it returns the *ErrorResponse error type.

func (*APIClient) Update 

func (client *APIClient) Update(ctx context.Context, resourceGroupName string, serviceName string, apiID string, ifMatch string, parameters APIUpdateContract, options *APIUpdateOptions) (APIUpdateResponse, error)

Update - Updates the specified API of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

type APICollection 

type APICollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Page values.
	Value []*APIContract `json:"value,omitempty" azure:"ro"`
}

APICollection - Paged API list representation.

func (APICollection) MarshalJSON 

func (a APICollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APICollection.

type APIContactInformation 

type APIContactInformation struct {
	// The email address of the contact person/organization. MUST be in the format of an email address
	Email *string `json:"email,omitempty"`

	// The identifying name of the contact person/organization
	Name *string `json:"name,omitempty"`

	// The URL pointing to the contact information. MUST be in the format of a URL
	URL *string `json:"url,omitempty"`
}

APIContactInformation - API contact information

type APIContract 

type APIContract struct {
	Resource
	// API entity contract properties.
	Properties *APIContractProperties `json:"properties,omitempty"`
}

APIContract - API details.

func (APIContract) MarshalJSON 

func (a APIContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIContract.

type APIContractProperties 

type APIContractProperties struct {
	APIEntityBaseContract
	// REQUIRED; Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the
	// API endpoint base URL specified during the service instance
	// creation to form a public URL for this API.
	Path *string `json:"path,omitempty"`

	// Version set details
	APIVersionSet *APIVersionSetContractDetails `json:"apiVersionSet,omitempty"`

	// API name. Must be 1 to 300 characters long.
	DisplayName *string `json:"displayName,omitempty"`

	// Describes on which protocols the operations in this API can be invoked.
	Protocols []*Protocol `json:"protocols,omitempty"`

	// Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
	ServiceURL *string `json:"serviceUrl,omitempty"`

	// API identifier of the source API.
	SourceAPIID *string `json:"sourceApiId,omitempty"`
}

APIContractProperties - API Entity Properties

func (APIContractProperties) MarshalJSON 

func (a APIContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIContractProperties.

type APIContractUpdateProperties 

type APIContractUpdateProperties struct {
	APIEntityBaseContract
	// API name.
	DisplayName *string `json:"displayName,omitempty"`

	// Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint
	// base URL specified during the service instance
	// creation to form a public URL for this API.
	Path *string `json:"path,omitempty"`

	// Describes on which protocols the operations in this API can be invoked.
	Protocols []*Protocol `json:"protocols,omitempty"`

	// Absolute URL of the backend service implementing this API.
	ServiceURL *string `json:"serviceUrl,omitempty"`
}

APIContractUpdateProperties - API update contract properties.

func (APIContractUpdateProperties) MarshalJSON 

func (a APIContractUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIContractUpdateProperties.

type APICreateOrUpdateParameter 

type APICreateOrUpdateParameter struct {
	// API entity create of update properties.
	Properties *APICreateOrUpdateProperties `json:"properties,omitempty"`
}

APICreateOrUpdateParameter - API Create or Update Parameters.

type APICreateOrUpdatePoller 

type APICreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

APICreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*APICreateOrUpdatePoller) Done 

func (p *APICreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*APICreateOrUpdatePoller) FinalResponse 

func (p *APICreateOrUpdatePoller) FinalResponse(ctx context.Context) (APICreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final APICreateOrUpdateResponse will be returned.

func (*APICreateOrUpdatePoller) Poll 

func (p *APICreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*APICreateOrUpdatePoller) ResumeToken 

func (p *APICreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type APICreateOrUpdatePollerResponse 

type APICreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *APICreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APICreateOrUpdatePollerResponse contains the response from method API.CreateOrUpdate.

func (APICreateOrUpdatePollerResponse) PollUntilDone 

func (l APICreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (APICreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*APICreateOrUpdatePollerResponse) Resume 

func (l *APICreateOrUpdatePollerResponse) Resume(ctx context.Context, client *APIClient, token string) error

Resume rehydrates a APICreateOrUpdatePollerResponse from the provided client and resume token.

type APICreateOrUpdateProperties 

type APICreateOrUpdateProperties struct {
	APIContractProperties
	// Format of the Content in which the API is getting imported.
	Format *ContentFormat `json:"format,omitempty"`

	// Type of API to create.
	// * http creates a REST API
	// * soap creates a SOAP pass-through API
	// * websocket creates websocket API
	// * graphql creates GraphQL API.
	SoapAPIType *SoapAPIType `json:"apiType,omitempty"`

	// Content value when Importing an API.
	Value *string `json:"value,omitempty"`

	// Criteria to limit import of WSDL to a subset of the document.
	WsdlSelector *APICreateOrUpdatePropertiesWsdlSelector `json:"wsdlSelector,omitempty"`
}

APICreateOrUpdateProperties - API Create or Update Properties.

func (APICreateOrUpdateProperties) MarshalJSON 

func (a APICreateOrUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APICreateOrUpdateProperties.

type APICreateOrUpdatePropertiesWsdlSelector 

type APICreateOrUpdatePropertiesWsdlSelector struct {
	// Name of endpoint(port) to import from WSDL
	WsdlEndpointName *string `json:"wsdlEndpointName,omitempty"`

	// Name of service to import from WSDL
	WsdlServiceName *string `json:"wsdlServiceName,omitempty"`
}

APICreateOrUpdatePropertiesWsdlSelector - Criteria to limit import of WSDL to a subset of the document.

type APICreateOrUpdateResponse 

type APICreateOrUpdateResponse struct {
	APICreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APICreateOrUpdateResponse contains the response from method API.CreateOrUpdate.

type APICreateOrUpdateResult 

type APICreateOrUpdateResult struct {
	APIContract
}

APICreateOrUpdateResult contains the result from method API.CreateOrUpdate.

type APIDeleteOptions 

type APIDeleteOptions struct {
	// Delete all revisions of the Api.
	DeleteRevisions *bool
}

APIDeleteOptions contains the optional parameters for the API.Delete method.

type APIDeleteResponse 

type APIDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIDeleteResponse contains the response from method API.Delete.

type APIDiagnosticClient 

type APIDiagnosticClient struct {
	// contains filtered or unexported fields
}

APIDiagnosticClient contains the methods for the APIDiagnostic group. Don't use this type directly, use NewAPIDiagnosticClient() instead.

func NewAPIDiagnosticClient 

func NewAPIDiagnosticClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIDiagnosticClient

NewAPIDiagnosticClient creates a new instance of APIDiagnosticClient with the specified values.

func (*APIDiagnosticClient) CreateOrUpdate 

func (client *APIDiagnosticClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, diagnosticID string, parameters DiagnosticContract, options *APIDiagnosticCreateOrUpdateOptions) (APIDiagnosticCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new Diagnostic for an API or updates an existing one. If the operation fails it returns the *ErrorResponse error type.

func (*APIDiagnosticClient) Delete 

func (client *APIDiagnosticClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, diagnosticID string, ifMatch string, options *APIDiagnosticDeleteOptions) (APIDiagnosticDeleteResponse, error)

Delete - Deletes the specified Diagnostic from an API. If the operation fails it returns the *ErrorResponse error type.

func (*APIDiagnosticClient) Get 

func (client *APIDiagnosticClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, diagnosticID string, options *APIDiagnosticGetOptions) (APIDiagnosticGetResponse, error)

Get - Gets the details of the Diagnostic for an API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIDiagnosticClient) GetEntityTag 

func (client *APIDiagnosticClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, diagnosticID string, options *APIDiagnosticGetEntityTagOptions) (APIDiagnosticGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIDiagnosticClient) ListByService 

func (client *APIDiagnosticClient) ListByService(resourceGroupName string, serviceName string, apiID string, options *APIDiagnosticListByServiceOptions) *APIDiagnosticListByServicePager

ListByService - Lists all diagnostics of an API. If the operation fails it returns the *ErrorResponse error type.

func (*APIDiagnosticClient) Update 

func (client *APIDiagnosticClient) Update(ctx context.Context, resourceGroupName string, serviceName string, apiID string, diagnosticID string, ifMatch string, parameters DiagnosticContract, options *APIDiagnosticUpdateOptions) (APIDiagnosticUpdateResponse, error)

Update - Updates the details of the Diagnostic for an API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type APIDiagnosticCreateOrUpdateOptions 

type APIDiagnosticCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APIDiagnosticCreateOrUpdateOptions contains the optional parameters for the APIDiagnostic.CreateOrUpdate method.

type APIDiagnosticCreateOrUpdateResponse 

type APIDiagnosticCreateOrUpdateResponse struct {
	APIDiagnosticCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIDiagnosticCreateOrUpdateResponse contains the response from method APIDiagnostic.CreateOrUpdate.

type APIDiagnosticCreateOrUpdateResult 

type APIDiagnosticCreateOrUpdateResult struct {
	DiagnosticContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIDiagnosticCreateOrUpdateResult contains the result from method APIDiagnostic.CreateOrUpdate.

type APIDiagnosticDeleteOptions 

type APIDiagnosticDeleteOptions struct {
}

APIDiagnosticDeleteOptions contains the optional parameters for the APIDiagnostic.Delete method.

type APIDiagnosticDeleteResponse 

type APIDiagnosticDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIDiagnosticDeleteResponse contains the response from method APIDiagnostic.Delete.

type APIDiagnosticGetEntityTagOptions 

type APIDiagnosticGetEntityTagOptions struct {
}

APIDiagnosticGetEntityTagOptions contains the optional parameters for the APIDiagnostic.GetEntityTag method.

type APIDiagnosticGetEntityTagResponse 

type APIDiagnosticGetEntityTagResponse struct {
	APIDiagnosticGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIDiagnosticGetEntityTagResponse contains the response from method APIDiagnostic.GetEntityTag.

type APIDiagnosticGetEntityTagResult 

type APIDiagnosticGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APIDiagnosticGetEntityTagResult contains the result from method APIDiagnostic.GetEntityTag.

type APIDiagnosticGetOptions 

type APIDiagnosticGetOptions struct {
}

APIDiagnosticGetOptions contains the optional parameters for the APIDiagnostic.Get method.

type APIDiagnosticGetResponse 

type APIDiagnosticGetResponse struct {
	APIDiagnosticGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIDiagnosticGetResponse contains the response from method APIDiagnostic.Get.

type APIDiagnosticGetResult 

type APIDiagnosticGetResult struct {
	DiagnosticContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIDiagnosticGetResult contains the result from method APIDiagnostic.Get.

type APIDiagnosticListByServiceOptions 

type APIDiagnosticListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APIDiagnosticListByServiceOptions contains the optional parameters for the APIDiagnostic.ListByService method.

type APIDiagnosticListByServicePager 

type APIDiagnosticListByServicePager struct {
	// contains filtered or unexported fields
}

APIDiagnosticListByServicePager provides operations for iterating over paged responses.

func (*APIDiagnosticListByServicePager) Err 

func (p *APIDiagnosticListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*APIDiagnosticListByServicePager) NextPage 

func (p *APIDiagnosticListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIDiagnosticListByServicePager) PageResponse 

func (p *APIDiagnosticListByServicePager) PageResponse() APIDiagnosticListByServiceResponse

PageResponse returns the current APIDiagnosticListByServiceResponse page.

type APIDiagnosticListByServiceResponse 

type APIDiagnosticListByServiceResponse struct {
	APIDiagnosticListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIDiagnosticListByServiceResponse contains the response from method APIDiagnostic.ListByService.

type APIDiagnosticListByServiceResult 

type APIDiagnosticListByServiceResult struct {
	DiagnosticCollection
}

APIDiagnosticListByServiceResult contains the result from method APIDiagnostic.ListByService.

type APIDiagnosticUpdateOptions 

type APIDiagnosticUpdateOptions struct {
}

APIDiagnosticUpdateOptions contains the optional parameters for the APIDiagnostic.Update method.

type APIDiagnosticUpdateResponse 

type APIDiagnosticUpdateResponse struct {
	APIDiagnosticUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIDiagnosticUpdateResponse contains the response from method APIDiagnostic.Update.

type APIDiagnosticUpdateResult 

type APIDiagnosticUpdateResult struct {
	DiagnosticContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIDiagnosticUpdateResult contains the result from method APIDiagnostic.Update.

type APIEntityBaseContract 

type APIEntityBaseContract struct {
	// Describes the revision of the API. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`

	// Description of the API Revision.
	APIRevisionDescription *string `json:"apiRevisionDescription,omitempty"`

	// Type of API.
	APIType *APIType `json:"type,omitempty"`

	// Indicates the version identifier of the API if the API is versioned
	APIVersion *string `json:"apiVersion,omitempty"`

	// Description of the API Version.
	APIVersionDescription *string `json:"apiVersionDescription,omitempty"`

	// A resource identifier for the related ApiVersionSet.
	APIVersionSetID *string `json:"apiVersionSetId,omitempty"`

	// Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`

	// Contact information for the API.
	Contact *APIContactInformation `json:"contact,omitempty"`

	// Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`

	// Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`

	// License information for the API.
	License *APILicenseInformation `json:"license,omitempty"`

	// Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`

	// Specifies whether an API or Product subscription is required for accessing the API.
	SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`

	// A URL to the Terms of Service for the API. MUST be in the format of a URL.
	TermsOfServiceURL *string `json:"termsOfServiceUrl,omitempty"`

	// READ-ONLY; Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty" azure:"ro"`
}

APIEntityBaseContract - API base contract details.

func (APIEntityBaseContract) MarshalJSON 

func (a APIEntityBaseContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIEntityBaseContract.

type APIExportClient 

type APIExportClient struct {
	// contains filtered or unexported fields
}

APIExportClient contains the methods for the APIExport group. Don't use this type directly, use NewAPIExportClient() instead.

func NewAPIExportClient 

func NewAPIExportClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIExportClient

NewAPIExportClient creates a new instance of APIExportClient with the specified values.

func (*APIExportClient) Get 

func (client *APIExportClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, formatParam ExportFormat, export ExportAPI, options *APIExportGetOptions) (APIExportGetResponse, error)

Get - Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes. If the operation fails it returns the *ErrorResponse error type.

type APIExportGetOptions 

type APIExportGetOptions struct {
}

APIExportGetOptions contains the optional parameters for the APIExport.Get method.

type APIExportGetResponse 

type APIExportGetResponse struct {
	APIExportGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIExportGetResponse contains the response from method APIExport.Get.

type APIExportGetResult 

type APIExportGetResult struct {
	APIExportResult
}

APIExportGetResult contains the result from method APIExport.Get.

type APIExportResult 

type APIExportResult struct {
	// Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes.
	ExportResultFormat *ExportResultFormat `json:"format,omitempty"`

	// ResourceId of the API which was exported.
	ID *string `json:"id,omitempty"`

	// The object defining the schema of the exported API Detail
	Value *APIExportResultValue `json:"value,omitempty"`
}

APIExportResult - API Export result.

type APIExportResultValue 

type APIExportResultValue struct {
	// Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes.
	Link *string `json:"link,omitempty"`
}

APIExportResultValue - The object defining the schema of the exported API Detail

type APIGetEntityTagOptions 

type APIGetEntityTagOptions struct {
}

APIGetEntityTagOptions contains the optional parameters for the API.GetEntityTag method.

type APIGetEntityTagResponse 

type APIGetEntityTagResponse struct {
	APIGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIGetEntityTagResponse contains the response from method API.GetEntityTag.

type APIGetEntityTagResult 

type APIGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APIGetEntityTagResult contains the result from method API.GetEntityTag.

type APIGetOptions 

type APIGetOptions struct {
}

APIGetOptions contains the optional parameters for the API.Get method.

type APIGetResponse 

type APIGetResponse struct {
	APIGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIGetResponse contains the response from method API.Get.

type APIGetResult 

type APIGetResult struct {
	APIContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIGetResult contains the result from method API.Get.

type APIIssueAttachmentClient 

type APIIssueAttachmentClient struct {
	// contains filtered or unexported fields
}

APIIssueAttachmentClient contains the methods for the APIIssueAttachment group. Don't use this type directly, use NewAPIIssueAttachmentClient() instead.

func NewAPIIssueAttachmentClient 

func NewAPIIssueAttachmentClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIIssueAttachmentClient

NewAPIIssueAttachmentClient creates a new instance of APIIssueAttachmentClient with the specified values.

func (*APIIssueAttachmentClient) CreateOrUpdate 

func (client *APIIssueAttachmentClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, attachmentID string, parameters IssueAttachmentContract, options *APIIssueAttachmentCreateOrUpdateOptions) (APIIssueAttachmentCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new Attachment for the Issue in an API or updates an existing one. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueAttachmentClient) Delete 

func (client *APIIssueAttachmentClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, attachmentID string, ifMatch string, options *APIIssueAttachmentDeleteOptions) (APIIssueAttachmentDeleteResponse, error)

Delete - Deletes the specified comment from an Issue. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueAttachmentClient) Get 

func (client *APIIssueAttachmentClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, attachmentID string, options *APIIssueAttachmentGetOptions) (APIIssueAttachmentGetResponse, error)

Get - Gets the details of the issue Attachment for an API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueAttachmentClient) GetEntityTag 

func (client *APIIssueAttachmentClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, attachmentID string, options *APIIssueAttachmentGetEntityTagOptions) (APIIssueAttachmentGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueAttachmentClient) ListByService 

func (client *APIIssueAttachmentClient) ListByService(resourceGroupName string, serviceName string, apiID string, issueID string, options *APIIssueAttachmentListByServiceOptions) *APIIssueAttachmentListByServicePager

ListByService - Lists all attachments for the Issue associated with the specified API. If the operation fails it returns the *ErrorResponse error type.

type APIIssueAttachmentCreateOrUpdateOptions 

type APIIssueAttachmentCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APIIssueAttachmentCreateOrUpdateOptions contains the optional parameters for the APIIssueAttachment.CreateOrUpdate method.

type APIIssueAttachmentCreateOrUpdateResponse 

type APIIssueAttachmentCreateOrUpdateResponse struct {
	APIIssueAttachmentCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueAttachmentCreateOrUpdateResponse contains the response from method APIIssueAttachment.CreateOrUpdate.

type APIIssueAttachmentCreateOrUpdateResult 

type APIIssueAttachmentCreateOrUpdateResult struct {
	IssueAttachmentContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIIssueAttachmentCreateOrUpdateResult contains the result from method APIIssueAttachment.CreateOrUpdate.

type APIIssueAttachmentDeleteOptions 

type APIIssueAttachmentDeleteOptions struct {
}

APIIssueAttachmentDeleteOptions contains the optional parameters for the APIIssueAttachment.Delete method.

type APIIssueAttachmentDeleteResponse 

type APIIssueAttachmentDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueAttachmentDeleteResponse contains the response from method APIIssueAttachment.Delete.

type APIIssueAttachmentGetEntityTagOptions 

type APIIssueAttachmentGetEntityTagOptions struct {
}

APIIssueAttachmentGetEntityTagOptions contains the optional parameters for the APIIssueAttachment.GetEntityTag method.

type APIIssueAttachmentGetEntityTagResponse 

type APIIssueAttachmentGetEntityTagResponse struct {
	APIIssueAttachmentGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueAttachmentGetEntityTagResponse contains the response from method APIIssueAttachment.GetEntityTag.

type APIIssueAttachmentGetEntityTagResult 

type APIIssueAttachmentGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APIIssueAttachmentGetEntityTagResult contains the result from method APIIssueAttachment.GetEntityTag.

type APIIssueAttachmentGetOptions 

type APIIssueAttachmentGetOptions struct {
}

APIIssueAttachmentGetOptions contains the optional parameters for the APIIssueAttachment.Get method.

type APIIssueAttachmentGetResponse 

type APIIssueAttachmentGetResponse struct {
	APIIssueAttachmentGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueAttachmentGetResponse contains the response from method APIIssueAttachment.Get.

type APIIssueAttachmentGetResult 

type APIIssueAttachmentGetResult struct {
	IssueAttachmentContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIIssueAttachmentGetResult contains the result from method APIIssueAttachment.Get.

type APIIssueAttachmentListByServiceOptions 

type APIIssueAttachmentListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APIIssueAttachmentListByServiceOptions contains the optional parameters for the APIIssueAttachment.ListByService method.

type APIIssueAttachmentListByServicePager 

type APIIssueAttachmentListByServicePager struct {
	// contains filtered or unexported fields
}

APIIssueAttachmentListByServicePager provides operations for iterating over paged responses.

func (*APIIssueAttachmentListByServicePager) Err 

func (p *APIIssueAttachmentListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*APIIssueAttachmentListByServicePager) NextPage 

func (p *APIIssueAttachmentListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIIssueAttachmentListByServicePager) PageResponse 

func (p *APIIssueAttachmentListByServicePager) PageResponse() APIIssueAttachmentListByServiceResponse

PageResponse returns the current APIIssueAttachmentListByServiceResponse page.

type APIIssueAttachmentListByServiceResponse 

type APIIssueAttachmentListByServiceResponse struct {
	APIIssueAttachmentListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueAttachmentListByServiceResponse contains the response from method APIIssueAttachment.ListByService.

type APIIssueAttachmentListByServiceResult 

type APIIssueAttachmentListByServiceResult struct {
	IssueAttachmentCollection
}

APIIssueAttachmentListByServiceResult contains the result from method APIIssueAttachment.ListByService.

type APIIssueClient 

type APIIssueClient struct {
	// contains filtered or unexported fields
}

APIIssueClient contains the methods for the APIIssue group. Don't use this type directly, use NewAPIIssueClient() instead.

func NewAPIIssueClient 

func NewAPIIssueClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIIssueClient

NewAPIIssueClient creates a new instance of APIIssueClient with the specified values.

func (*APIIssueClient) CreateOrUpdate 

func (client *APIIssueClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, parameters IssueContract, options *APIIssueCreateOrUpdateOptions) (APIIssueCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new Issue for an API or updates an existing one. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueClient) Delete 

func (client *APIIssueClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, ifMatch string, options *APIIssueDeleteOptions) (APIIssueDeleteResponse, error)

Delete - Deletes the specified Issue from an API. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueClient) Get 

func (client *APIIssueClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, options *APIIssueGetOptions) (APIIssueGetResponse, error)

Get - Gets the details of the Issue for an API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueClient) GetEntityTag 

func (client *APIIssueClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, options *APIIssueGetEntityTagOptions) (APIIssueGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the Issue for an API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueClient) ListByService 

func (client *APIIssueClient) ListByService(resourceGroupName string, serviceName string, apiID string, options *APIIssueListByServiceOptions) *APIIssueListByServicePager

ListByService - Lists all issues associated with the specified API. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueClient) Update 

func (client *APIIssueClient) Update(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, ifMatch string, parameters IssueUpdateContract, options *APIIssueUpdateOptions) (APIIssueUpdateResponse, error)

Update - Updates an existing issue for an API. If the operation fails it returns the *ErrorResponse error type.

type APIIssueCommentClient 

type APIIssueCommentClient struct {
	// contains filtered or unexported fields
}

APIIssueCommentClient contains the methods for the APIIssueComment group. Don't use this type directly, use NewAPIIssueCommentClient() instead.

func NewAPIIssueCommentClient 

func NewAPIIssueCommentClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIIssueCommentClient

NewAPIIssueCommentClient creates a new instance of APIIssueCommentClient with the specified values.

func (*APIIssueCommentClient) CreateOrUpdate 

func (client *APIIssueCommentClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, commentID string, parameters IssueCommentContract, options *APIIssueCommentCreateOrUpdateOptions) (APIIssueCommentCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new Comment for the Issue in an API or updates an existing one. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueCommentClient) Delete 

func (client *APIIssueCommentClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, commentID string, ifMatch string, options *APIIssueCommentDeleteOptions) (APIIssueCommentDeleteResponse, error)

Delete - Deletes the specified comment from an Issue. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueCommentClient) Get 

func (client *APIIssueCommentClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, commentID string, options *APIIssueCommentGetOptions) (APIIssueCommentGetResponse, error)

Get - Gets the details of the issue Comment for an API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueCommentClient) GetEntityTag 

func (client *APIIssueCommentClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, issueID string, commentID string, options *APIIssueCommentGetEntityTagOptions) (APIIssueCommentGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIIssueCommentClient) ListByService 

func (client *APIIssueCommentClient) ListByService(resourceGroupName string, serviceName string, apiID string, issueID string, options *APIIssueCommentListByServiceOptions) *APIIssueCommentListByServicePager

ListByService - Lists all comments for the Issue associated with the specified API. If the operation fails it returns the *ErrorResponse error type.

type APIIssueCommentCreateOrUpdateOptions 

type APIIssueCommentCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APIIssueCommentCreateOrUpdateOptions contains the optional parameters for the APIIssueComment.CreateOrUpdate method.

type APIIssueCommentCreateOrUpdateResponse 

type APIIssueCommentCreateOrUpdateResponse struct {
	APIIssueCommentCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueCommentCreateOrUpdateResponse contains the response from method APIIssueComment.CreateOrUpdate.

type APIIssueCommentCreateOrUpdateResult 

type APIIssueCommentCreateOrUpdateResult struct {
	IssueCommentContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIIssueCommentCreateOrUpdateResult contains the result from method APIIssueComment.CreateOrUpdate.

type APIIssueCommentDeleteOptions 

type APIIssueCommentDeleteOptions struct {
}

APIIssueCommentDeleteOptions contains the optional parameters for the APIIssueComment.Delete method.

type APIIssueCommentDeleteResponse 

type APIIssueCommentDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueCommentDeleteResponse contains the response from method APIIssueComment.Delete.

type APIIssueCommentGetEntityTagOptions 

type APIIssueCommentGetEntityTagOptions struct {
}

APIIssueCommentGetEntityTagOptions contains the optional parameters for the APIIssueComment.GetEntityTag method.

type APIIssueCommentGetEntityTagResponse 

type APIIssueCommentGetEntityTagResponse struct {
	APIIssueCommentGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueCommentGetEntityTagResponse contains the response from method APIIssueComment.GetEntityTag.

type APIIssueCommentGetEntityTagResult 

type APIIssueCommentGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APIIssueCommentGetEntityTagResult contains the result from method APIIssueComment.GetEntityTag.

type APIIssueCommentGetOptions 

type APIIssueCommentGetOptions struct {
}

APIIssueCommentGetOptions contains the optional parameters for the APIIssueComment.Get method.

type APIIssueCommentGetResponse 

type APIIssueCommentGetResponse struct {
	APIIssueCommentGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueCommentGetResponse contains the response from method APIIssueComment.Get.

type APIIssueCommentGetResult 

type APIIssueCommentGetResult struct {
	IssueCommentContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIIssueCommentGetResult contains the result from method APIIssueComment.Get.

type APIIssueCommentListByServiceOptions 

type APIIssueCommentListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APIIssueCommentListByServiceOptions contains the optional parameters for the APIIssueComment.ListByService method.

type APIIssueCommentListByServicePager 

type APIIssueCommentListByServicePager struct {
	// contains filtered or unexported fields
}

APIIssueCommentListByServicePager provides operations for iterating over paged responses.

func (*APIIssueCommentListByServicePager) Err 

func (p *APIIssueCommentListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*APIIssueCommentListByServicePager) NextPage 

func (p *APIIssueCommentListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIIssueCommentListByServicePager) PageResponse 

func (p *APIIssueCommentListByServicePager) PageResponse() APIIssueCommentListByServiceResponse

PageResponse returns the current APIIssueCommentListByServiceResponse page.

type APIIssueCommentListByServiceResponse 

type APIIssueCommentListByServiceResponse struct {
	APIIssueCommentListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueCommentListByServiceResponse contains the response from method APIIssueComment.ListByService.

type APIIssueCommentListByServiceResult 

type APIIssueCommentListByServiceResult struct {
	IssueCommentCollection
}

APIIssueCommentListByServiceResult contains the result from method APIIssueComment.ListByService.

type APIIssueCreateOrUpdateOptions 

type APIIssueCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APIIssueCreateOrUpdateOptions contains the optional parameters for the APIIssue.CreateOrUpdate method.

type APIIssueCreateOrUpdateResponse 

type APIIssueCreateOrUpdateResponse struct {
	APIIssueCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueCreateOrUpdateResponse contains the response from method APIIssue.CreateOrUpdate.

type APIIssueCreateOrUpdateResult 

type APIIssueCreateOrUpdateResult struct {
	IssueContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIIssueCreateOrUpdateResult contains the result from method APIIssue.CreateOrUpdate.

type APIIssueDeleteOptions 

type APIIssueDeleteOptions struct {
}

APIIssueDeleteOptions contains the optional parameters for the APIIssue.Delete method.

type APIIssueDeleteResponse 

type APIIssueDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueDeleteResponse contains the response from method APIIssue.Delete.

type APIIssueGetEntityTagOptions 

type APIIssueGetEntityTagOptions struct {
}

APIIssueGetEntityTagOptions contains the optional parameters for the APIIssue.GetEntityTag method.

type APIIssueGetEntityTagResponse 

type APIIssueGetEntityTagResponse struct {
	APIIssueGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueGetEntityTagResponse contains the response from method APIIssue.GetEntityTag.

type APIIssueGetEntityTagResult 

type APIIssueGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APIIssueGetEntityTagResult contains the result from method APIIssue.GetEntityTag.

type APIIssueGetOptions 

type APIIssueGetOptions struct {
	// Expand the comment attachments.
	ExpandCommentsAttachments *bool
}

APIIssueGetOptions contains the optional parameters for the APIIssue.Get method.

type APIIssueGetResponse 

type APIIssueGetResponse struct {
	APIIssueGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueGetResponse contains the response from method APIIssue.Get.

type APIIssueGetResult 

type APIIssueGetResult struct {
	IssueContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIIssueGetResult contains the result from method APIIssue.Get.

type APIIssueListByServiceOptions 

type APIIssueListByServiceOptions struct {
	// Expand the comment attachments.
	ExpandCommentsAttachments *bool
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| state | filter | eq | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APIIssueListByServiceOptions contains the optional parameters for the APIIssue.ListByService method.

type APIIssueListByServicePager 

type APIIssueListByServicePager struct {
	// contains filtered or unexported fields
}

APIIssueListByServicePager provides operations for iterating over paged responses.

func (*APIIssueListByServicePager) Err 

func (p *APIIssueListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*APIIssueListByServicePager) NextPage 

func (p *APIIssueListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIIssueListByServicePager) PageResponse 

func (p *APIIssueListByServicePager) PageResponse() APIIssueListByServiceResponse

PageResponse returns the current APIIssueListByServiceResponse page.

type APIIssueListByServiceResponse 

type APIIssueListByServiceResponse struct {
	APIIssueListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueListByServiceResponse contains the response from method APIIssue.ListByService.

type APIIssueListByServiceResult 

type APIIssueListByServiceResult struct {
	IssueCollection
}

APIIssueListByServiceResult contains the result from method APIIssue.ListByService.

type APIIssueUpdateOptions 

type APIIssueUpdateOptions struct {
}

APIIssueUpdateOptions contains the optional parameters for the APIIssue.Update method.

type APIIssueUpdateResponse 

type APIIssueUpdateResponse struct {
	APIIssueUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIIssueUpdateResponse contains the response from method APIIssue.Update.

type APIIssueUpdateResult 

type APIIssueUpdateResult struct {
	IssueContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIIssueUpdateResult contains the result from method APIIssue.Update.

type APILicenseInformation 

type APILicenseInformation struct {
	// The license name used for the API
	Name *string `json:"name,omitempty"`

	// A URL to the license used for the API. MUST be in the format of a URL
	URL *string `json:"url,omitempty"`
}

APILicenseInformation - API license information

type APIListByServiceOptions 

type APIListByServiceOptions struct {
	// Include full ApiVersionSet resource in response
	ExpandAPIVersionSet *bool
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| serviceUrl | filter | ge, le, eq,
	// ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith
	// |</br>| isCurrent | filter | eq, ne | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Include tags in the response.
	Tags *string
	// Number of records to return.
	Top *int32
}

APIListByServiceOptions contains the optional parameters for the API.ListByService method.

type APIListByServicePager 

type APIListByServicePager struct {
	// contains filtered or unexported fields
}

APIListByServicePager provides operations for iterating over paged responses.

func (*APIListByServicePager) Err 

func (p *APIListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*APIListByServicePager) NextPage 

func (p *APIListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIListByServicePager) PageResponse 

func (p *APIListByServicePager) PageResponse() APIListByServiceResponse

PageResponse returns the current APIListByServiceResponse page.

type APIListByServiceResponse 

type APIListByServiceResponse struct {
	APIListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIListByServiceResponse contains the response from method API.ListByService.

type APIListByServiceResult 

type APIListByServiceResult struct {
	APICollection
}

APIListByServiceResult contains the result from method API.ListByService.

type APIListByTagsOptions 

type APIListByTagsOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | filter | ge, le, eq, ne,
	// gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith
	// |</br>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| isCurrent | filter | eq | |</br>
	Filter *string
	// Include not tagged APIs.
	IncludeNotTaggedApis *bool
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APIListByTagsOptions contains the optional parameters for the API.ListByTags method.

type APIListByTagsPager 

type APIListByTagsPager struct {
	// contains filtered or unexported fields
}

APIListByTagsPager provides operations for iterating over paged responses.

func (*APIListByTagsPager) Err 

func (p *APIListByTagsPager) Err() error

Err returns the last error encountered while paging.

func (*APIListByTagsPager) NextPage 

func (p *APIListByTagsPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIListByTagsPager) PageResponse 

func (p *APIListByTagsPager) PageResponse() APIListByTagsResponse

PageResponse returns the current APIListByTagsResponse page.

type APIListByTagsResponse 

type APIListByTagsResponse struct {
	APIListByTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIListByTagsResponse contains the response from method API.ListByTags.

type APIListByTagsResult 

type APIListByTagsResult struct {
	TagResourceCollection
}

APIListByTagsResult contains the result from method API.ListByTags.

type APIManagementClient 

type APIManagementClient struct {
	// contains filtered or unexported fields
}

APIManagementClient contains the methods for the APIManagementClient group. Don't use this type directly, use NewAPIManagementClient() instead.

func NewAPIManagementClient 

func NewAPIManagementClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIManagementClient

NewAPIManagementClient creates a new instance of APIManagementClient with the specified values.

func (*APIManagementClient) BeginPerformConnectivityCheckAsync 

func (client *APIManagementClient) BeginPerformConnectivityCheckAsync(ctx context.Context, resourceGroupName string, serviceName string, connectivityCheckRequestParams ConnectivityCheckRequest, options *APIManagementClientBeginPerformConnectivityCheckAsyncOptions) (APIManagementClientPerformConnectivityCheckAsyncPollerResponse, error)

BeginPerformConnectivityCheckAsync - Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it. If the operation fails it returns the *ErrorResponse error type.

type APIManagementClientBeginPerformConnectivityCheckAsyncOptions 

type APIManagementClientBeginPerformConnectivityCheckAsyncOptions struct {
}

APIManagementClientBeginPerformConnectivityCheckAsyncOptions contains the optional parameters for the APIManagementClient.BeginPerformConnectivityCheckAsync method.

type APIManagementClientPerformConnectivityCheckAsyncPoller 

type APIManagementClientPerformConnectivityCheckAsyncPoller struct {
	// contains filtered or unexported fields
}

APIManagementClientPerformConnectivityCheckAsyncPoller provides polling facilities until the operation reaches a terminal state.

func (*APIManagementClientPerformConnectivityCheckAsyncPoller) Done 

func (p *APIManagementClientPerformConnectivityCheckAsyncPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*APIManagementClientPerformConnectivityCheckAsyncPoller) FinalResponse 

func (p *APIManagementClientPerformConnectivityCheckAsyncPoller) FinalResponse(ctx context.Context) (APIManagementClientPerformConnectivityCheckAsyncResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final APIManagementClientPerformConnectivityCheckAsyncResponse will be returned.

func (*APIManagementClientPerformConnectivityCheckAsyncPoller) Poll 

func (p *APIManagementClientPerformConnectivityCheckAsyncPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*APIManagementClientPerformConnectivityCheckAsyncPoller) ResumeToken 

func (p *APIManagementClientPerformConnectivityCheckAsyncPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type APIManagementClientPerformConnectivityCheckAsyncPollerResponse 

type APIManagementClientPerformConnectivityCheckAsyncPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *APIManagementClientPerformConnectivityCheckAsyncPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementClientPerformConnectivityCheckAsyncPollerResponse contains the response from method APIManagementClient.PerformConnectivityCheckAsync.

func (APIManagementClientPerformConnectivityCheckAsyncPollerResponse) PollUntilDone 

func (l APIManagementClientPerformConnectivityCheckAsyncPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (APIManagementClientPerformConnectivityCheckAsyncResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*APIManagementClientPerformConnectivityCheckAsyncPollerResponse) Resume 

func (l *APIManagementClientPerformConnectivityCheckAsyncPollerResponse) Resume(ctx context.Context, client *APIManagementClient, token string) error

Resume rehydrates a APIManagementClientPerformConnectivityCheckAsyncPollerResponse from the provided client and resume token.

type APIManagementClientPerformConnectivityCheckAsyncResponse 

type APIManagementClientPerformConnectivityCheckAsyncResponse struct {
	APIManagementClientPerformConnectivityCheckAsyncResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementClientPerformConnectivityCheckAsyncResponse contains the response from method APIManagementClient.PerformConnectivityCheckAsync.

type APIManagementClientPerformConnectivityCheckAsyncResult 

type APIManagementClientPerformConnectivityCheckAsyncResult struct {
	ConnectivityCheckResponse
}

APIManagementClientPerformConnectivityCheckAsyncResult contains the result from method APIManagementClient.PerformConnectivityCheckAsync.

type APIManagementOperationsClient 

type APIManagementOperationsClient struct {
	// contains filtered or unexported fields
}

APIManagementOperationsClient contains the methods for the APIManagementOperations group. Don't use this type directly, use NewAPIManagementOperationsClient() instead.

func NewAPIManagementOperationsClient 

func NewAPIManagementOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *APIManagementOperationsClient

NewAPIManagementOperationsClient creates a new instance of APIManagementOperationsClient with the specified values.

func (*APIManagementOperationsClient) List 

func (client *APIManagementOperationsClient) List(options *APIManagementOperationsListOptions) *APIManagementOperationsListPager

List - Lists all of the available REST API operations of the Microsoft.ApiManagement provider. If the operation fails it returns the *ErrorResponse error type.

type APIManagementOperationsListOptions 

type APIManagementOperationsListOptions struct {
}

APIManagementOperationsListOptions contains the optional parameters for the APIManagementOperations.List method.

type APIManagementOperationsListPager 

type APIManagementOperationsListPager struct {
	// contains filtered or unexported fields
}

APIManagementOperationsListPager provides operations for iterating over paged responses.

func (*APIManagementOperationsListPager) Err 

func (p *APIManagementOperationsListPager) Err() error

Err returns the last error encountered while paging.

func (*APIManagementOperationsListPager) NextPage 

func (p *APIManagementOperationsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIManagementOperationsListPager) PageResponse 

func (p *APIManagementOperationsListPager) PageResponse() APIManagementOperationsListResponse

PageResponse returns the current APIManagementOperationsListResponse page.

type APIManagementOperationsListResponse 

type APIManagementOperationsListResponse struct {
	APIManagementOperationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementOperationsListResponse contains the response from method APIManagementOperations.List.

type APIManagementOperationsListResult 

type APIManagementOperationsListResult struct {
	OperationListResult
}

APIManagementOperationsListResult contains the result from method APIManagementOperations.List.

type APIManagementSKU 

type APIManagementSKU struct {
	// READ-ONLY; The api versions that support this SKU.
	APIVersions []*string `json:"apiVersions,omitempty" azure:"ro"`

	// READ-ONLY; A name value pair to describe the capability.
	Capabilities []*APIManagementSKUCapabilities `json:"capabilities,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the number of virtual machines in the scale set.
	Capacity *APIManagementSKUCapacity `json:"capacity,omitempty" azure:"ro"`

	// READ-ONLY; Metadata for retrieving price info.
	Costs []*APIManagementSKUCosts `json:"costs,omitempty" azure:"ro"`

	// READ-ONLY; The Family of this particular SKU.
	Family *string `json:"family,omitempty" azure:"ro"`

	// READ-ONLY; The Kind of resources that are supported in this SKU.
	Kind *string `json:"kind,omitempty" azure:"ro"`

	// READ-ONLY; A list of locations and availability zones in those locations where the SKU is available.
	LocationInfo []*APIManagementSKULocationInfo `json:"locationInfo,omitempty" azure:"ro"`

	// READ-ONLY; The set of locations that the SKU is available.
	Locations []*string `json:"locations,omitempty" azure:"ro"`

	// READ-ONLY; The name of SKU.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of resource the SKU applies to.
	ResourceType *string `json:"resourceType,omitempty" azure:"ro"`

	// READ-ONLY; The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
	Restrictions []*APIManagementSKURestrictions `json:"restrictions,omitempty" azure:"ro"`

	// READ-ONLY; The Size of the SKU.
	Size *string `json:"size,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the tier of virtual machines in a scale set.
	// Possible Values:
	// Standard
	// Basic
	Tier *string `json:"tier,omitempty" azure:"ro"`
}

APIManagementSKU - Describes an available ApiManagement SKU.

func (APIManagementSKU) MarshalJSON 

func (a APIManagementSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementSKU.

type APIManagementSKUCapabilities 

type APIManagementSKUCapabilities struct {
	// READ-ONLY; An invariant to describe the feature.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; An invariant if the feature is measured by quantity.
	Value *string `json:"value,omitempty" azure:"ro"`
}

APIManagementSKUCapabilities - Describes The SKU capabilities object.

type APIManagementSKUCapacity 

type APIManagementSKUCapacity struct {
	// READ-ONLY; The default capacity.
	Default *int32 `json:"default,omitempty" azure:"ro"`

	// READ-ONLY; The maximum capacity that can be set.
	Maximum *int32 `json:"maximum,omitempty" azure:"ro"`

	// READ-ONLY; The minimum capacity.
	Minimum *int32 `json:"minimum,omitempty" azure:"ro"`

	// READ-ONLY; The scale type applicable to the sku.
	ScaleType *APIManagementSKUCapacityScaleType `json:"scaleType,omitempty" azure:"ro"`
}

APIManagementSKUCapacity - Describes scaling information of a SKU.

type APIManagementSKUCapacityScaleType 

type APIManagementSKUCapacityScaleType string

APIManagementSKUCapacityScaleType - The scale type applicable to the sku. 

const (
	APIManagementSKUCapacityScaleTypeAutomatic APIManagementSKUCapacityScaleType = "Automatic"
	APIManagementSKUCapacityScaleTypeManual    APIManagementSKUCapacityScaleType = "Manual"
	APIManagementSKUCapacityScaleTypeNone      APIManagementSKUCapacityScaleType = "None"
)

func PossibleAPIManagementSKUCapacityScaleTypeValues 

func PossibleAPIManagementSKUCapacityScaleTypeValues() []APIManagementSKUCapacityScaleType

PossibleAPIManagementSKUCapacityScaleTypeValues returns the possible values for the APIManagementSKUCapacityScaleType const type.

func (APIManagementSKUCapacityScaleType) ToPtr 

func (c APIManagementSKUCapacityScaleType) ToPtr() *APIManagementSKUCapacityScaleType

ToPtr returns a *APIManagementSKUCapacityScaleType pointing to the current value.

type APIManagementSKUCosts 

type APIManagementSKUCosts struct {
	// READ-ONLY; An invariant to show the extended unit.
	ExtendedUnit *string `json:"extendedUnit,omitempty" azure:"ro"`

	// READ-ONLY; Used for querying price from commerce.
	MeterID *string `json:"meterID,omitempty" azure:"ro"`

	// READ-ONLY; The multiplier is needed to extend the base metered cost.
	Quantity *int64 `json:"quantity,omitempty" azure:"ro"`
}

APIManagementSKUCosts - Describes metadata for retrieving price info.

type APIManagementSKULocationInfo 

type APIManagementSKULocationInfo struct {
	// READ-ONLY; Location of the SKU
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; Details of capabilities available to a SKU in specific zones.
	ZoneDetails []*APIManagementSKUZoneDetails `json:"zoneDetails,omitempty" azure:"ro"`

	// READ-ONLY; List of availability zones where the SKU is supported.
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

func (APIManagementSKULocationInfo) MarshalJSON 

func (a APIManagementSKULocationInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementSKULocationInfo.

type APIManagementSKURestrictionInfo 

type APIManagementSKURestrictionInfo struct {
	// READ-ONLY; Locations where the SKU is restricted
	Locations []*string `json:"locations,omitempty" azure:"ro"`

	// READ-ONLY; List of availability zones where the SKU is restricted.
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

func (APIManagementSKURestrictionInfo) MarshalJSON 

func (a APIManagementSKURestrictionInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementSKURestrictionInfo.

type APIManagementSKURestrictions 

type APIManagementSKURestrictions struct {
	// READ-ONLY; The reason for restriction.
	ReasonCode *APIManagementSKURestrictionsReasonCode `json:"reasonCode,omitempty" azure:"ro"`

	// READ-ONLY; The information about the restriction where the SKU cannot be used.
	RestrictionInfo *APIManagementSKURestrictionInfo `json:"restrictionInfo,omitempty" azure:"ro"`

	// READ-ONLY; The type of restrictions.
	Type *APIManagementSKURestrictionsType `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
	Values []*string `json:"values,omitempty" azure:"ro"`
}

APIManagementSKURestrictions - Describes scaling information of a SKU.

func (APIManagementSKURestrictions) MarshalJSON 

func (a APIManagementSKURestrictions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementSKURestrictions.

type APIManagementSKURestrictionsReasonCode 

type APIManagementSKURestrictionsReasonCode string

APIManagementSKURestrictionsReasonCode - The reason for restriction. 

const (
	APIManagementSKURestrictionsReasonCodeQuotaID                     APIManagementSKURestrictionsReasonCode = "QuotaId"
	APIManagementSKURestrictionsReasonCodeNotAvailableForSubscription APIManagementSKURestrictionsReasonCode = "NotAvailableForSubscription"
)

func PossibleAPIManagementSKURestrictionsReasonCodeValues 

func PossibleAPIManagementSKURestrictionsReasonCodeValues() []APIManagementSKURestrictionsReasonCode

PossibleAPIManagementSKURestrictionsReasonCodeValues returns the possible values for the APIManagementSKURestrictionsReasonCode const type.

func (APIManagementSKURestrictionsReasonCode) ToPtr 

func (c APIManagementSKURestrictionsReasonCode) ToPtr() *APIManagementSKURestrictionsReasonCode

ToPtr returns a *APIManagementSKURestrictionsReasonCode pointing to the current value.

type APIManagementSKURestrictionsType 

type APIManagementSKURestrictionsType string

APIManagementSKURestrictionsType - The type of restrictions. 

const (
	APIManagementSKURestrictionsTypeLocation APIManagementSKURestrictionsType = "Location"
	APIManagementSKURestrictionsTypeZone     APIManagementSKURestrictionsType = "Zone"
)

func PossibleAPIManagementSKURestrictionsTypeValues 

func PossibleAPIManagementSKURestrictionsTypeValues() []APIManagementSKURestrictionsType

PossibleAPIManagementSKURestrictionsTypeValues returns the possible values for the APIManagementSKURestrictionsType const type.

func (APIManagementSKURestrictionsType) ToPtr 

func (c APIManagementSKURestrictionsType) ToPtr() *APIManagementSKURestrictionsType

ToPtr returns a *APIManagementSKURestrictionsType pointing to the current value.

type APIManagementSKUZoneDetails 

type APIManagementSKUZoneDetails struct {
	// READ-ONLY; A list of capabilities that are available for the SKU in the specified list of zones.
	Capabilities []*APIManagementSKUCapabilities `json:"capabilities,omitempty" azure:"ro"`

	// READ-ONLY; The set of zones that the SKU is available in with the specified capabilities.
	Name []*string `json:"name,omitempty" azure:"ro"`
}

APIManagementSKUZoneDetails - Describes The zonal capabilities of a SKU.

func (APIManagementSKUZoneDetails) MarshalJSON 

func (a APIManagementSKUZoneDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementSKUZoneDetails.

type APIManagementSKUsClient 

type APIManagementSKUsClient struct {
	// contains filtered or unexported fields
}

APIManagementSKUsClient contains the methods for the APIManagementSKUs group. Don't use this type directly, use NewAPIManagementSKUsClient() instead.

func NewAPIManagementSKUsClient 

func NewAPIManagementSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIManagementSKUsClient

NewAPIManagementSKUsClient creates a new instance of APIManagementSKUsClient with the specified values.

func (*APIManagementSKUsClient) List 

func (client *APIManagementSKUsClient) List(options *APIManagementSKUsListOptions) *APIManagementSKUsListPager

List - Gets the list of Microsoft.ApiManagement SKUs available for your Subscription. If the operation fails it returns the *ErrorResponse error type.

type APIManagementSKUsListOptions 

type APIManagementSKUsListOptions struct {
}

APIManagementSKUsListOptions contains the optional parameters for the APIManagementSKUs.List method.

type APIManagementSKUsListPager 

type APIManagementSKUsListPager struct {
	// contains filtered or unexported fields
}

APIManagementSKUsListPager provides operations for iterating over paged responses.

func (*APIManagementSKUsListPager) Err 

func (p *APIManagementSKUsListPager) Err() error

Err returns the last error encountered while paging.

func (*APIManagementSKUsListPager) NextPage 

func (p *APIManagementSKUsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIManagementSKUsListPager) PageResponse 

func (p *APIManagementSKUsListPager) PageResponse() APIManagementSKUsListResponse

PageResponse returns the current APIManagementSKUsListResponse page.

type APIManagementSKUsListResponse 

type APIManagementSKUsListResponse struct {
	APIManagementSKUsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementSKUsListResponse contains the response from method APIManagementSKUs.List.

type APIManagementSKUsListResult 

type APIManagementSKUsListResult struct {
	APIManagementSKUsResult
}

APIManagementSKUsListResult contains the result from method APIManagementSKUs.List.

type APIManagementSKUsResult 

type APIManagementSKUsResult struct {
	// REQUIRED; The list of skus available for the subscription.
	Value []*APIManagementSKU `json:"value,omitempty"`

	// READ-ONLY; The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

APIManagementSKUsResult - The List Resource Skus operation response.

func (APIManagementSKUsResult) MarshalJSON 

func (a APIManagementSKUsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementSKUsResult.

type APIManagementServiceApplyNetworkConfigurationParameters 

type APIManagementServiceApplyNetworkConfigurationParameters struct {
	// Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required.
	Location *string `json:"location,omitempty"`
}

APIManagementServiceApplyNetworkConfigurationParameters - Parameter supplied to the Apply Network configuration operation.

type APIManagementServiceApplyNetworkConfigurationUpdatesPoller 

type APIManagementServiceApplyNetworkConfigurationUpdatesPoller struct {
	// contains filtered or unexported fields
}

APIManagementServiceApplyNetworkConfigurationUpdatesPoller provides polling facilities until the operation reaches a terminal state.

func (*APIManagementServiceApplyNetworkConfigurationUpdatesPoller) Done 

func (p *APIManagementServiceApplyNetworkConfigurationUpdatesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*APIManagementServiceApplyNetworkConfigurationUpdatesPoller) FinalResponse 

func (p *APIManagementServiceApplyNetworkConfigurationUpdatesPoller) FinalResponse(ctx context.Context) (APIManagementServiceApplyNetworkConfigurationUpdatesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final APIManagementServiceApplyNetworkConfigurationUpdatesResponse will be returned.

func (*APIManagementServiceApplyNetworkConfigurationUpdatesPoller) Poll 

func (p *APIManagementServiceApplyNetworkConfigurationUpdatesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*APIManagementServiceApplyNetworkConfigurationUpdatesPoller) ResumeToken 

func (p *APIManagementServiceApplyNetworkConfigurationUpdatesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type APIManagementServiceApplyNetworkConfigurationUpdatesPollerResponse 

type APIManagementServiceApplyNetworkConfigurationUpdatesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *APIManagementServiceApplyNetworkConfigurationUpdatesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceApplyNetworkConfigurationUpdatesPollerResponse contains the response from method APIManagementService.ApplyNetworkConfigurationUpdates.

func (APIManagementServiceApplyNetworkConfigurationUpdatesPollerResponse) PollUntilDone 

func (l APIManagementServiceApplyNetworkConfigurationUpdatesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (APIManagementServiceApplyNetworkConfigurationUpdatesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*APIManagementServiceApplyNetworkConfigurationUpdatesPollerResponse) Resume 

func (l *APIManagementServiceApplyNetworkConfigurationUpdatesPollerResponse) Resume(ctx context.Context, client *APIManagementServiceClient, token string) error

Resume rehydrates a APIManagementServiceApplyNetworkConfigurationUpdatesPollerResponse from the provided client and resume token.

type APIManagementServiceApplyNetworkConfigurationUpdatesResponse 

type APIManagementServiceApplyNetworkConfigurationUpdatesResponse struct {
	APIManagementServiceApplyNetworkConfigurationUpdatesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceApplyNetworkConfigurationUpdatesResponse contains the response from method APIManagementService.ApplyNetworkConfigurationUpdates.

type APIManagementServiceApplyNetworkConfigurationUpdatesResult 

type APIManagementServiceApplyNetworkConfigurationUpdatesResult struct {
	APIManagementServiceResource
}

APIManagementServiceApplyNetworkConfigurationUpdatesResult contains the result from method APIManagementService.ApplyNetworkConfigurationUpdates.

type APIManagementServiceBackupPoller 

type APIManagementServiceBackupPoller struct {
	// contains filtered or unexported fields
}

APIManagementServiceBackupPoller provides polling facilities until the operation reaches a terminal state.

func (*APIManagementServiceBackupPoller) Done 

func (p *APIManagementServiceBackupPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*APIManagementServiceBackupPoller) FinalResponse 

func (p *APIManagementServiceBackupPoller) FinalResponse(ctx context.Context) (APIManagementServiceBackupResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final APIManagementServiceBackupResponse will be returned.

func (*APIManagementServiceBackupPoller) Poll 

func (p *APIManagementServiceBackupPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*APIManagementServiceBackupPoller) ResumeToken 

func (p *APIManagementServiceBackupPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type APIManagementServiceBackupPollerResponse 

type APIManagementServiceBackupPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *APIManagementServiceBackupPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceBackupPollerResponse contains the response from method APIManagementService.Backup.

func (APIManagementServiceBackupPollerResponse) PollUntilDone 

func (l APIManagementServiceBackupPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (APIManagementServiceBackupResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*APIManagementServiceBackupPollerResponse) Resume 

func (l *APIManagementServiceBackupPollerResponse) Resume(ctx context.Context, client *APIManagementServiceClient, token string) error

Resume rehydrates a APIManagementServiceBackupPollerResponse from the provided client and resume token.

type APIManagementServiceBackupResponse 

type APIManagementServiceBackupResponse struct {
	APIManagementServiceBackupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceBackupResponse contains the response from method APIManagementService.Backup.

type APIManagementServiceBackupRestoreParameters 

type APIManagementServiceBackupRestoreParameters struct {
	// REQUIRED; The name of the backup file to create/retrieve.
	BackupName *string `json:"backupName,omitempty"`

	// REQUIRED; The name of the blob container (used to place/retrieve the backup).
	ContainerName *string `json:"containerName,omitempty"`

	// REQUIRED; The name of the Azure storage account (used to place/retrieve the backup).
	StorageAccount *string `json:"storageAccount,omitempty"`

	// Storage account access key. Required only if accessType is set to AccessKey.
	AccessKey *string `json:"accessKey,omitempty"`

	// The type of access to be used for the storage account.
	AccessType *AccessType `json:"accessType,omitempty"`

	// The Client ID of user assigned managed identity. Required only if accessType is set to UserAssignedManagedIdentity.
	ClientID *string `json:"clientId,omitempty"`
}

APIManagementServiceBackupRestoreParameters - Parameters supplied to the Backup/Restore of an API Management service operation.

type APIManagementServiceBackupResult 

type APIManagementServiceBackupResult struct {
	APIManagementServiceResource
}

APIManagementServiceBackupResult contains the result from method APIManagementService.Backup.

type APIManagementServiceBaseProperties 

type APIManagementServiceBaseProperties struct {
	// Control Plane Apis version constraint for the API Management service.
	APIVersionConstraint *APIVersionConstraint `json:"apiVersionConstraint,omitempty"`

	// Additional datacenter locations of the API Management service.
	AdditionalLocations []*AdditionalLocation `json:"additionalLocations,omitempty"`

	// List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
	Certificates []*CertificateConfiguration `json:"certificates,omitempty"`

	// Custom properties of the API Management service.
	// Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLSRSAWITH3DESEDECBCSHA for all TLS(1.0, 1.1
	// and 1.2).
	// Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.
	// Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.
	// Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.
	// Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.
	// Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.
	// Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2
	// the default value is True if the service was
	// created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.
	// You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLSECDHEECDSAWITHAES256CBCSHA,
	// TLSECDHEECDSAWITHAES128CBCSHA, TLS
	// ECDHERSAWITHAES256CBCSHA, TLSECDHERSAWITHAES128CBCSHA, TLSRSAWITHAES128GCMSHA256, TLSRSAWITHAES256CBCSHA256, TLSRSAWITHAES128CBCSHA256, TLSRSAWITHAES256CBCSHA,
	// TLSRSAWITHAES128CBCSHA. For example,
	// Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them. Note: next ciphers
	// can't be disabled since they are required by
	// Azure CloudService internal components: TLSECDHEECDSAWITHAES256GCMSHA384,TLSECDHEECDSAWITHAES128GCMSHA256,TLSECDHERSAWITHAES256GCMSHA384,TLSECDHERSAWITHAES128GCMSHA256,TLSECDHEECDSAWITHAES256CBC
	// SHA384,TLSECDHEECDSAWITHAES128CBCSHA256,TLSECDHERSAWITHAES256CBCSHA384,TLSECDHERSAWITHAES128CBCSHA256,TLSRSAWITHAES256GCMSHA384
	CustomProperties map[string]*string `json:"customProperties,omitempty"`

	// Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
	DisableGateway *bool `json:"disableGateway,omitempty"`

	// Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also
	// enables the ability to authenticate the
	// certificate in the policy on the gateway.
	EnableClientCertificate *bool `json:"enableClientCertificate,omitempty"`

	// Custom hostname configuration of the API Management service.
	HostnameConfigurations []*HostnameConfiguration `json:"hostnameConfigurations,omitempty"`

	// Email address from which the notification will be sent.
	NotificationSenderEmail *string `json:"notificationSenderEmail,omitempty"`

	// List of Private Endpoint Connections of this service.
	PrivateEndpointConnections []*RemotePrivateEndpointConnectionWrapper `json:"privateEndpointConnections,omitempty"`

	// Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium
	// SKU being deployed in Virtual Network.
	PublicIPAddressID *string `json:"publicIpAddressId,omitempty"`

	// Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.
	// If 'Disabled', private endpoints are the
	// exclusive access method. Default value is 'Enabled'
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.
	Restore *bool `json:"restore,omitempty"`

	// Virtual network configuration of the API Management service.
	VirtualNetworkConfiguration *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`

	// The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual
	// Network, External means the API Management
	// deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a
	// Virtual Network having an Intranet Facing Endpoint
	// only.
	VirtualNetworkType *VirtualNetworkType `json:"virtualNetworkType,omitempty"`

	// READ-ONLY; Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601
	// standard.
	CreatedAtUTC *time.Time `json:"createdAtUtc,omitempty" azure:"ro"`

	// READ-ONLY; DEveloper Portal endpoint URL of the API Management service.
	DeveloperPortalURL *string `json:"developerPortalUrl,omitempty" azure:"ro"`

	// READ-ONLY; Gateway URL of the API Management service in the Default Region.
	GatewayRegionalURL *string `json:"gatewayRegionalUrl,omitempty" azure:"ro"`

	// READ-ONLY; Gateway URL of the API Management service.
	GatewayURL *string `json:"gatewayUrl,omitempty" azure:"ro"`

	// READ-ONLY; Management API endpoint URL of the API Management service.
	ManagementAPIURL *string `json:"managementApiUrl,omitempty" azure:"ro"`

	// READ-ONLY; Compute Platform Version running the service in this location.
	PlatformVersion *PlatformVersion `json:"platformVersion,omitempty" azure:"ro"`

	// READ-ONLY; Publisher portal endpoint Url of the API Management service.
	PortalURL *string `json:"portalUrl,omitempty" azure:"ro"`

	// READ-ONLY; Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network.
	// Available only for Basic, Standard, Premium and Isolated
	// SKU.
	PrivateIPAddresses []*string `json:"privateIPAddresses,omitempty" azure:"ro"`

	// READ-ONLY; The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and
	// Isolated SKU.
	PublicIPAddresses []*string `json:"publicIPAddresses,omitempty" azure:"ro"`

	// READ-ONLY; SCM endpoint URL of the API Management service.
	ScmURL *string `json:"scmUrl,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
	TargetProvisioningState *string `json:"targetProvisioningState,omitempty" azure:"ro"`
}

APIManagementServiceBaseProperties - Base Properties of an API Management service resource description.

func (APIManagementServiceBaseProperties) MarshalJSON 

func (a APIManagementServiceBaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementServiceBaseProperties.

func (*APIManagementServiceBaseProperties) UnmarshalJSON 

func (a *APIManagementServiceBaseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type APIManagementServiceBaseProperties.

type APIManagementServiceBeginApplyNetworkConfigurationUpdatesOptions 

type APIManagementServiceBeginApplyNetworkConfigurationUpdatesOptions struct {
	// Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is
	// deployed will be updated sequentially without incurring downtime in the region.
	Parameters *APIManagementServiceApplyNetworkConfigurationParameters
}

APIManagementServiceBeginApplyNetworkConfigurationUpdatesOptions contains the optional parameters for the APIManagementService.BeginApplyNetworkConfigurationUpdates method.

type APIManagementServiceBeginBackupOptions 

type APIManagementServiceBeginBackupOptions struct {
}

APIManagementServiceBeginBackupOptions contains the optional parameters for the APIManagementService.BeginBackup method.

type APIManagementServiceBeginCreateOrUpdateOptions 

type APIManagementServiceBeginCreateOrUpdateOptions struct {
}

APIManagementServiceBeginCreateOrUpdateOptions contains the optional parameters for the APIManagementService.BeginCreateOrUpdate method.

type APIManagementServiceBeginDeleteOptions 

type APIManagementServiceBeginDeleteOptions struct {
}

APIManagementServiceBeginDeleteOptions contains the optional parameters for the APIManagementService.BeginDelete method.

type APIManagementServiceBeginRestoreOptions 

type APIManagementServiceBeginRestoreOptions struct {
}

APIManagementServiceBeginRestoreOptions contains the optional parameters for the APIManagementService.BeginRestore method.

type APIManagementServiceBeginUpdateOptions 

type APIManagementServiceBeginUpdateOptions struct {
}

APIManagementServiceBeginUpdateOptions contains the optional parameters for the APIManagementService.BeginUpdate method.

type APIManagementServiceCheckNameAvailabilityOptions 

type APIManagementServiceCheckNameAvailabilityOptions struct {
}

APIManagementServiceCheckNameAvailabilityOptions contains the optional parameters for the APIManagementService.CheckNameAvailability method.

type APIManagementServiceCheckNameAvailabilityParameters 

type APIManagementServiceCheckNameAvailabilityParameters struct {
	// REQUIRED; The name to check for availability.
	Name *string `json:"name,omitempty"`
}

APIManagementServiceCheckNameAvailabilityParameters - Parameters supplied to the CheckNameAvailability operation.

type APIManagementServiceCheckNameAvailabilityResponse 

type APIManagementServiceCheckNameAvailabilityResponse struct {
	APIManagementServiceCheckNameAvailabilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceCheckNameAvailabilityResponse contains the response from method APIManagementService.CheckNameAvailability.

type APIManagementServiceCheckNameAvailabilityResult 

type APIManagementServiceCheckNameAvailabilityResult struct {
	APIManagementServiceNameAvailabilityResult
}

APIManagementServiceCheckNameAvailabilityResult contains the result from method APIManagementService.CheckNameAvailability.

type APIManagementServiceClient 

type APIManagementServiceClient struct {
	// contains filtered or unexported fields
}

APIManagementServiceClient contains the methods for the APIManagementService group. Don't use this type directly, use NewAPIManagementServiceClient() instead.

func NewAPIManagementServiceClient 

func NewAPIManagementServiceClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIManagementServiceClient

NewAPIManagementServiceClient creates a new instance of APIManagementServiceClient with the specified values.

func (*APIManagementServiceClient) BeginApplyNetworkConfigurationUpdates 

func (client *APIManagementServiceClient) BeginApplyNetworkConfigurationUpdates(ctx context.Context, resourceGroupName string, serviceName string, options *APIManagementServiceBeginApplyNetworkConfigurationUpdatesOptions) (APIManagementServiceApplyNetworkConfigurationUpdatesPollerResponse, error)

BeginApplyNetworkConfigurationUpdates - Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) BeginBackup 

func (client *APIManagementServiceClient) BeginBackup(ctx context.Context, resourceGroupName string, serviceName string, parameters APIManagementServiceBackupRestoreParameters, options *APIManagementServiceBeginBackupOptions) (APIManagementServiceBackupPollerResponse, error)

BeginBackup - Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) BeginCreateOrUpdate 

func (client *APIManagementServiceClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters APIManagementServiceResource, options *APIManagementServiceBeginCreateOrUpdateOptions) (APIManagementServiceCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates an API Management service. This is long running operation and could take several minutes to complete. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) BeginDelete 

func (client *APIManagementServiceClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, options *APIManagementServiceBeginDeleteOptions) (APIManagementServiceDeletePollerResponse, error)

BeginDelete - Deletes an existing API Management service. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) BeginRestore 

func (client *APIManagementServiceClient) BeginRestore(ctx context.Context, resourceGroupName string, serviceName string, parameters APIManagementServiceBackupRestoreParameters, options *APIManagementServiceBeginRestoreOptions) (APIManagementServiceRestorePollerResponse, error)

BeginRestore - Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) BeginUpdate 

func (client *APIManagementServiceClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters APIManagementServiceUpdateParameters, options *APIManagementServiceBeginUpdateOptions) (APIManagementServiceUpdatePollerResponse, error)

BeginUpdate - Updates an existing API Management service. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) CheckNameAvailability 

func (client *APIManagementServiceClient) CheckNameAvailability(ctx context.Context, parameters APIManagementServiceCheckNameAvailabilityParameters, options *APIManagementServiceCheckNameAvailabilityOptions) (APIManagementServiceCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks availability and correctness of a name for an API Management service. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) Get 

func (client *APIManagementServiceClient) Get(ctx context.Context, resourceGroupName string, serviceName string, options *APIManagementServiceGetOptions) (APIManagementServiceGetResponse, error)

Get - Gets an API Management service resource description. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) GetDomainOwnershipIdentifier 

func (client *APIManagementServiceClient) GetDomainOwnershipIdentifier(ctx context.Context, options *APIManagementServiceGetDomainOwnershipIdentifierOptions) (APIManagementServiceGetDomainOwnershipIdentifierResponse, error)

GetDomainOwnershipIdentifier - Get the custom domain ownership identifier for an API Management service. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) GetSsoToken 

func (client *APIManagementServiceClient) GetSsoToken(ctx context.Context, resourceGroupName string, serviceName string, options *APIManagementServiceGetSsoTokenOptions) (APIManagementServiceGetSsoTokenResponse, error)

GetSsoToken - Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) List 

func (client *APIManagementServiceClient) List(options *APIManagementServiceListOptions) *APIManagementServiceListPager

List - Lists all API Management services within an Azure subscription. If the operation fails it returns the *ErrorResponse error type.

func (*APIManagementServiceClient) ListByResourceGroup 

func (client *APIManagementServiceClient) ListByResourceGroup(resourceGroupName string, options *APIManagementServiceListByResourceGroupOptions) *APIManagementServiceListByResourceGroupPager

ListByResourceGroup - List all API Management services within a resource group. If the operation fails it returns the *ErrorResponse error type.

type APIManagementServiceCreateOrUpdatePoller 

type APIManagementServiceCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

APIManagementServiceCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*APIManagementServiceCreateOrUpdatePoller) Done 

func (p *APIManagementServiceCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*APIManagementServiceCreateOrUpdatePoller) FinalResponse 

func (p *APIManagementServiceCreateOrUpdatePoller) FinalResponse(ctx context.Context) (APIManagementServiceCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final APIManagementServiceCreateOrUpdateResponse will be returned.

func (*APIManagementServiceCreateOrUpdatePoller) Poll 

func (p *APIManagementServiceCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*APIManagementServiceCreateOrUpdatePoller) ResumeToken 

func (p *APIManagementServiceCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type APIManagementServiceCreateOrUpdatePollerResponse 

type APIManagementServiceCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *APIManagementServiceCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceCreateOrUpdatePollerResponse contains the response from method APIManagementService.CreateOrUpdate.

func (APIManagementServiceCreateOrUpdatePollerResponse) PollUntilDone 

func (l APIManagementServiceCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (APIManagementServiceCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*APIManagementServiceCreateOrUpdatePollerResponse) Resume 

func (l *APIManagementServiceCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *APIManagementServiceClient, token string) error

Resume rehydrates a APIManagementServiceCreateOrUpdatePollerResponse from the provided client and resume token.

type APIManagementServiceCreateOrUpdateResponse 

type APIManagementServiceCreateOrUpdateResponse struct {
	APIManagementServiceCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceCreateOrUpdateResponse contains the response from method APIManagementService.CreateOrUpdate.

type APIManagementServiceCreateOrUpdateResult 

type APIManagementServiceCreateOrUpdateResult struct {
	APIManagementServiceResource
}

APIManagementServiceCreateOrUpdateResult contains the result from method APIManagementService.CreateOrUpdate.

type APIManagementServiceDeletePoller 

type APIManagementServiceDeletePoller struct {
	// contains filtered or unexported fields
}

APIManagementServiceDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*APIManagementServiceDeletePoller) Done 

func (p *APIManagementServiceDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*APIManagementServiceDeletePoller) FinalResponse 

func (p *APIManagementServiceDeletePoller) FinalResponse(ctx context.Context) (APIManagementServiceDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final APIManagementServiceDeleteResponse will be returned.

func (*APIManagementServiceDeletePoller) Poll 

func (p *APIManagementServiceDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*APIManagementServiceDeletePoller) ResumeToken 

func (p *APIManagementServiceDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type APIManagementServiceDeletePollerResponse 

type APIManagementServiceDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *APIManagementServiceDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceDeletePollerResponse contains the response from method APIManagementService.Delete.

func (APIManagementServiceDeletePollerResponse) PollUntilDone 

func (l APIManagementServiceDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (APIManagementServiceDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*APIManagementServiceDeletePollerResponse) Resume 

func (l *APIManagementServiceDeletePollerResponse) Resume(ctx context.Context, client *APIManagementServiceClient, token string) error

Resume rehydrates a APIManagementServiceDeletePollerResponse from the provided client and resume token.

type APIManagementServiceDeleteResponse 

type APIManagementServiceDeleteResponse struct {
	APIManagementServiceDeleteResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceDeleteResponse contains the response from method APIManagementService.Delete.

type APIManagementServiceDeleteResult 

type APIManagementServiceDeleteResult struct {
	APIManagementServiceResource
}

APIManagementServiceDeleteResult contains the result from method APIManagementService.Delete.

type APIManagementServiceGetDomainOwnershipIdentifierOptions 

type APIManagementServiceGetDomainOwnershipIdentifierOptions struct {
}

APIManagementServiceGetDomainOwnershipIdentifierOptions contains the optional parameters for the APIManagementService.GetDomainOwnershipIdentifier method.

type APIManagementServiceGetDomainOwnershipIdentifierResponse 

type APIManagementServiceGetDomainOwnershipIdentifierResponse struct {
	APIManagementServiceGetDomainOwnershipIdentifierResultEnvelope
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceGetDomainOwnershipIdentifierResponse contains the response from method APIManagementService.GetDomainOwnershipIdentifier.

type APIManagementServiceGetDomainOwnershipIdentifierResult 

type APIManagementServiceGetDomainOwnershipIdentifierResult struct {
	// READ-ONLY; The domain ownership identifier value.
	DomainOwnershipIdentifier *string `json:"domainOwnershipIdentifier,omitempty" azure:"ro"`
}

APIManagementServiceGetDomainOwnershipIdentifierResult - Response of the GetDomainOwnershipIdentifier operation.

type APIManagementServiceGetDomainOwnershipIdentifierResultEnvelope 

type APIManagementServiceGetDomainOwnershipIdentifierResultEnvelope struct {
	APIManagementServiceGetDomainOwnershipIdentifierResult
}

APIManagementServiceGetDomainOwnershipIdentifierResultEnvelope contains the result from method APIManagementService.GetDomainOwnershipIdentifier.

type APIManagementServiceGetOptions 

type APIManagementServiceGetOptions struct {
}

APIManagementServiceGetOptions contains the optional parameters for the APIManagementService.Get method.

type APIManagementServiceGetResponse 

type APIManagementServiceGetResponse struct {
	APIManagementServiceGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceGetResponse contains the response from method APIManagementService.Get.

type APIManagementServiceGetResult 

type APIManagementServiceGetResult struct {
	APIManagementServiceResource
}

APIManagementServiceGetResult contains the result from method APIManagementService.Get.

type APIManagementServiceGetSsoTokenOptions 

type APIManagementServiceGetSsoTokenOptions struct {
}

APIManagementServiceGetSsoTokenOptions contains the optional parameters for the APIManagementService.GetSsoToken method.

type APIManagementServiceGetSsoTokenResponse 

type APIManagementServiceGetSsoTokenResponse struct {
	APIManagementServiceGetSsoTokenResultEnvelope
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceGetSsoTokenResponse contains the response from method APIManagementService.GetSsoToken.

type APIManagementServiceGetSsoTokenResult 

type APIManagementServiceGetSsoTokenResult struct {
	// Redirect URL to the Publisher Portal containing the SSO token.
	RedirectURI *string `json:"redirectUri,omitempty"`
}

APIManagementServiceGetSsoTokenResult - The response of the GetSsoToken operation.

type APIManagementServiceGetSsoTokenResultEnvelope 

type APIManagementServiceGetSsoTokenResultEnvelope struct {
	APIManagementServiceGetSsoTokenResult
}

APIManagementServiceGetSsoTokenResultEnvelope contains the result from method APIManagementService.GetSsoToken.

type APIManagementServiceIdentity 

type APIManagementServiceIdentity struct {
	// REQUIRED; The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set
	// of user assigned identities. The type 'None' will remove any
	// identities from the service.
	Type *ApimIdentityType `json:"type,omitempty"`

	// The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentities map[string]*UserIdentityProperties `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The principal id of the identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The client tenant id of the identity.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

APIManagementServiceIdentity - Identity properties of the Api Management service resource.

func (APIManagementServiceIdentity) MarshalJSON 

func (a APIManagementServiceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementServiceIdentity.

type APIManagementServiceListByResourceGroupOptions 

type APIManagementServiceListByResourceGroupOptions struct {
}

APIManagementServiceListByResourceGroupOptions contains the optional parameters for the APIManagementService.ListByResourceGroup method.

type APIManagementServiceListByResourceGroupPager 

type APIManagementServiceListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

APIManagementServiceListByResourceGroupPager provides operations for iterating over paged responses.

func (*APIManagementServiceListByResourceGroupPager) Err 

func (p *APIManagementServiceListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*APIManagementServiceListByResourceGroupPager) NextPage 

func (p *APIManagementServiceListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIManagementServiceListByResourceGroupPager) PageResponse 

func (p *APIManagementServiceListByResourceGroupPager) PageResponse() APIManagementServiceListByResourceGroupResponse

PageResponse returns the current APIManagementServiceListByResourceGroupResponse page.

type APIManagementServiceListByResourceGroupResponse 

type APIManagementServiceListByResourceGroupResponse struct {
	APIManagementServiceListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceListByResourceGroupResponse contains the response from method APIManagementService.ListByResourceGroup.

type APIManagementServiceListByResourceGroupResult 

type APIManagementServiceListByResourceGroupResult struct {
	APIManagementServiceListResult
}

APIManagementServiceListByResourceGroupResult contains the result from method APIManagementService.ListByResourceGroup.

type APIManagementServiceListOptions 

type APIManagementServiceListOptions struct {
}

APIManagementServiceListOptions contains the optional parameters for the APIManagementService.List method.

type APIManagementServiceListPager 

type APIManagementServiceListPager struct {
	// contains filtered or unexported fields
}

APIManagementServiceListPager provides operations for iterating over paged responses.

func (*APIManagementServiceListPager) Err 

func (p *APIManagementServiceListPager) Err() error

Err returns the last error encountered while paging.

func (*APIManagementServiceListPager) NextPage 

func (p *APIManagementServiceListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIManagementServiceListPager) PageResponse 

func (p *APIManagementServiceListPager) PageResponse() APIManagementServiceListResponse

PageResponse returns the current APIManagementServiceListResponse page.

type APIManagementServiceListResponse 

type APIManagementServiceListResponse struct {
	APIManagementServiceListResultEnvelope
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceListResponse contains the response from method APIManagementService.List.

type APIManagementServiceListResult 

type APIManagementServiceListResult struct {
	// REQUIRED; Result of the List API Management services operation.
	Value []*APIManagementServiceResource `json:"value,omitempty"`

	// Link to the next set of results. Not empty if Value contains incomplete list of API Management services.
	NextLink *string `json:"nextLink,omitempty"`
}

APIManagementServiceListResult - The response of the List API Management services operation.

func (APIManagementServiceListResult) MarshalJSON 

func (a APIManagementServiceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementServiceListResult.

type APIManagementServiceListResultEnvelope 

type APIManagementServiceListResultEnvelope struct {
	APIManagementServiceListResult
}

APIManagementServiceListResultEnvelope contains the result from method APIManagementService.List.

type APIManagementServiceNameAvailabilityResult 

type APIManagementServiceNameAvailabilityResult struct {
	// Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists
	// indicates that the name is already in use
	// and is therefore unavailable.
	Reason *NameAvailabilityReason `json:"reason,omitempty"`

	// READ-ONLY; If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that
	// the user can select a valid name. If reason == AlreadyExists,
	// explain that is already in use, and direct them to select a different name.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; True if the name is available and can be used to create a new API Management service; otherwise false.
	NameAvailable *bool `json:"nameAvailable,omitempty" azure:"ro"`
}

APIManagementServiceNameAvailabilityResult - Response of the CheckNameAvailability operation.

type APIManagementServiceProperties 

type APIManagementServiceProperties struct {
	APIManagementServiceBaseProperties
	// REQUIRED; Publisher email.
	PublisherEmail *string `json:"publisherEmail,omitempty"`

	// REQUIRED; Publisher name.
	PublisherName *string `json:"publisherName,omitempty"`
}

APIManagementServiceProperties - Properties of an API Management service resource description.

func (APIManagementServiceProperties) MarshalJSON 

func (a APIManagementServiceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementServiceProperties.

func (*APIManagementServiceProperties) UnmarshalJSON 

func (a *APIManagementServiceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type APIManagementServiceProperties.

type APIManagementServiceResource 

type APIManagementServiceResource struct {
	ApimResource
	// REQUIRED; Resource location.
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties of the API Management service.
	Properties *APIManagementServiceProperties `json:"properties,omitempty"`

	// REQUIRED; SKU properties of the API Management service.
	SKU *APIManagementServiceSKUProperties `json:"sku,omitempty"`

	// Managed service identity of the Api Management service.
	Identity *APIManagementServiceIdentity `json:"identity,omitempty"`

	// A list of availability zones denoting where the resource needs to come from.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; ETag of the resource.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`
}

APIManagementServiceResource - A single API Management service resource in List or Get response.

func (APIManagementServiceResource) MarshalJSON 

func (a APIManagementServiceResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementServiceResource.

type APIManagementServiceRestorePoller 

type APIManagementServiceRestorePoller struct {
	// contains filtered or unexported fields
}

APIManagementServiceRestorePoller provides polling facilities until the operation reaches a terminal state.

func (*APIManagementServiceRestorePoller) Done 

func (p *APIManagementServiceRestorePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*APIManagementServiceRestorePoller) FinalResponse 

func (p *APIManagementServiceRestorePoller) FinalResponse(ctx context.Context) (APIManagementServiceRestoreResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final APIManagementServiceRestoreResponse will be returned.

func (*APIManagementServiceRestorePoller) Poll 

func (p *APIManagementServiceRestorePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*APIManagementServiceRestorePoller) ResumeToken 

func (p *APIManagementServiceRestorePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type APIManagementServiceRestorePollerResponse 

type APIManagementServiceRestorePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *APIManagementServiceRestorePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceRestorePollerResponse contains the response from method APIManagementService.Restore.

func (APIManagementServiceRestorePollerResponse) PollUntilDone 

func (l APIManagementServiceRestorePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (APIManagementServiceRestoreResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*APIManagementServiceRestorePollerResponse) Resume 

func (l *APIManagementServiceRestorePollerResponse) Resume(ctx context.Context, client *APIManagementServiceClient, token string) error

Resume rehydrates a APIManagementServiceRestorePollerResponse from the provided client and resume token.

type APIManagementServiceRestoreResponse 

type APIManagementServiceRestoreResponse struct {
	APIManagementServiceRestoreResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceRestoreResponse contains the response from method APIManagementService.Restore.

type APIManagementServiceRestoreResult 

type APIManagementServiceRestoreResult struct {
	APIManagementServiceResource
}

APIManagementServiceRestoreResult contains the result from method APIManagementService.Restore.

type APIManagementServiceSKUProperties 

type APIManagementServiceSKUProperties struct {
	// REQUIRED; Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.
	Capacity *int32 `json:"capacity,omitempty"`

	// REQUIRED; Name of the Sku.
	Name *SKUType `json:"name,omitempty"`
}

APIManagementServiceSKUProperties - API Management service resource SKU properties.

type APIManagementServiceSKUsClient 

type APIManagementServiceSKUsClient struct {
	// contains filtered or unexported fields
}

APIManagementServiceSKUsClient contains the methods for the APIManagementServiceSKUs group. Don't use this type directly, use NewAPIManagementServiceSKUsClient() instead.

func NewAPIManagementServiceSKUsClient 

func NewAPIManagementServiceSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIManagementServiceSKUsClient

NewAPIManagementServiceSKUsClient creates a new instance of APIManagementServiceSKUsClient with the specified values.

func (*APIManagementServiceSKUsClient) ListAvailableServiceSKUs 

func (client *APIManagementServiceSKUsClient) ListAvailableServiceSKUs(resourceGroupName string, serviceName string, options *APIManagementServiceSKUsListAvailableServiceSKUsOptions) *APIManagementServiceSKUsListAvailableServiceSKUsPager

ListAvailableServiceSKUs - Gets all available SKU for a given API Management service If the operation fails it returns the *ErrorResponse error type.

type APIManagementServiceSKUsListAvailableServiceSKUsOptions 

type APIManagementServiceSKUsListAvailableServiceSKUsOptions struct {
}

APIManagementServiceSKUsListAvailableServiceSKUsOptions contains the optional parameters for the APIManagementServiceSKUs.ListAvailableServiceSKUs method.

type APIManagementServiceSKUsListAvailableServiceSKUsPager 

type APIManagementServiceSKUsListAvailableServiceSKUsPager struct {
	// contains filtered or unexported fields
}

APIManagementServiceSKUsListAvailableServiceSKUsPager provides operations for iterating over paged responses.

func (*APIManagementServiceSKUsListAvailableServiceSKUsPager) Err 

func (p *APIManagementServiceSKUsListAvailableServiceSKUsPager) Err() error

Err returns the last error encountered while paging.

func (*APIManagementServiceSKUsListAvailableServiceSKUsPager) NextPage 

func (p *APIManagementServiceSKUsListAvailableServiceSKUsPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIManagementServiceSKUsListAvailableServiceSKUsPager) PageResponse 

func (p *APIManagementServiceSKUsListAvailableServiceSKUsPager) PageResponse() APIManagementServiceSKUsListAvailableServiceSKUsResponse

PageResponse returns the current APIManagementServiceSKUsListAvailableServiceSKUsResponse page.

type APIManagementServiceSKUsListAvailableServiceSKUsResponse 

type APIManagementServiceSKUsListAvailableServiceSKUsResponse struct {
	APIManagementServiceSKUsListAvailableServiceSKUsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceSKUsListAvailableServiceSKUsResponse contains the response from method APIManagementServiceSKUs.ListAvailableServiceSKUs.

type APIManagementServiceSKUsListAvailableServiceSKUsResult 

type APIManagementServiceSKUsListAvailableServiceSKUsResult struct {
	ResourceSKUResults
}

APIManagementServiceSKUsListAvailableServiceSKUsResult contains the result from method APIManagementServiceSKUs.ListAvailableServiceSKUs.

type APIManagementServiceUpdateParameters 

type APIManagementServiceUpdateParameters struct {
	ApimResource
	// Managed service identity of the Api Management service.
	Identity *APIManagementServiceIdentity `json:"identity,omitempty"`

	// Properties of the API Management service.
	Properties *APIManagementServiceUpdateProperties `json:"properties,omitempty"`

	// SKU properties of the API Management service.
	SKU *APIManagementServiceSKUProperties `json:"sku,omitempty"`

	// A list of availability zones denoting where the resource needs to come from.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; ETag of the resource.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

APIManagementServiceUpdateParameters - Parameter supplied to Update Api Management Service.

func (APIManagementServiceUpdateParameters) MarshalJSON 

func (a APIManagementServiceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementServiceUpdateParameters.

type APIManagementServiceUpdatePoller 

type APIManagementServiceUpdatePoller struct {
	// contains filtered or unexported fields
}

APIManagementServiceUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*APIManagementServiceUpdatePoller) Done 

func (p *APIManagementServiceUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*APIManagementServiceUpdatePoller) FinalResponse 

func (p *APIManagementServiceUpdatePoller) FinalResponse(ctx context.Context) (APIManagementServiceUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final APIManagementServiceUpdateResponse will be returned.

func (*APIManagementServiceUpdatePoller) Poll 

func (p *APIManagementServiceUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*APIManagementServiceUpdatePoller) ResumeToken 

func (p *APIManagementServiceUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type APIManagementServiceUpdatePollerResponse 

type APIManagementServiceUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *APIManagementServiceUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceUpdatePollerResponse contains the response from method APIManagementService.Update.

func (APIManagementServiceUpdatePollerResponse) PollUntilDone 

func (l APIManagementServiceUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (APIManagementServiceUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*APIManagementServiceUpdatePollerResponse) Resume 

func (l *APIManagementServiceUpdatePollerResponse) Resume(ctx context.Context, client *APIManagementServiceClient, token string) error

Resume rehydrates a APIManagementServiceUpdatePollerResponse from the provided client and resume token.

type APIManagementServiceUpdateProperties 

type APIManagementServiceUpdateProperties struct {
	APIManagementServiceBaseProperties
	// Publisher email.
	PublisherEmail *string `json:"publisherEmail,omitempty"`

	// Publisher name.
	PublisherName *string `json:"publisherName,omitempty"`
}

APIManagementServiceUpdateProperties - Properties of an API Management service resource description.

func (APIManagementServiceUpdateProperties) MarshalJSON 

func (a APIManagementServiceUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIManagementServiceUpdateProperties.

func (*APIManagementServiceUpdateProperties) UnmarshalJSON 

func (a *APIManagementServiceUpdateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type APIManagementServiceUpdateProperties.

type APIManagementServiceUpdateResponse 

type APIManagementServiceUpdateResponse struct {
	APIManagementServiceUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIManagementServiceUpdateResponse contains the response from method APIManagementService.Update.

type APIManagementServiceUpdateResult 

type APIManagementServiceUpdateResult struct {
	APIManagementServiceResource
}

APIManagementServiceUpdateResult contains the result from method APIManagementService.Update.

type APIOperationClient 

type APIOperationClient struct {
	// contains filtered or unexported fields
}

APIOperationClient contains the methods for the APIOperation group. Don't use this type directly, use NewAPIOperationClient() instead.

func NewAPIOperationClient 

func NewAPIOperationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIOperationClient

NewAPIOperationClient creates a new instance of APIOperationClient with the specified values.

func (*APIOperationClient) CreateOrUpdate 

func (client *APIOperationClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, parameters OperationContract, options *APIOperationCreateOrUpdateOptions) (APIOperationCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new operation in the API or updates an existing one. If the operation fails it returns the *ErrorResponse error type.

func (*APIOperationClient) Delete 

func (client *APIOperationClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, ifMatch string, options *APIOperationDeleteOptions) (APIOperationDeleteResponse, error)

Delete - Deletes the specified operation in the API. If the operation fails it returns the *ErrorResponse error type.

func (*APIOperationClient) Get 

func (client *APIOperationClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, options *APIOperationGetOptions) (APIOperationGetResponse, error)

Get - Gets the details of the API Operation specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIOperationClient) GetEntityTag 

func (client *APIOperationClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, options *APIOperationGetEntityTagOptions) (APIOperationGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the API operation specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIOperationClient) ListByAPI 

func (client *APIOperationClient) ListByAPI(resourceGroupName string, serviceName string, apiID string, options *APIOperationListByAPIOptions) *APIOperationListByAPIPager

ListByAPI - Lists a collection of the operations for the specified API. If the operation fails it returns the *ErrorResponse error type.

func (*APIOperationClient) Update 

func (client *APIOperationClient) Update(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, ifMatch string, parameters OperationUpdateContract, options *APIOperationUpdateOptions) (APIOperationUpdateResponse, error)

Update - Updates the details of the operation in the API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type APIOperationCreateOrUpdateOptions 

type APIOperationCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APIOperationCreateOrUpdateOptions contains the optional parameters for the APIOperation.CreateOrUpdate method.

type APIOperationCreateOrUpdateResponse 

type APIOperationCreateOrUpdateResponse struct {
	APIOperationCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationCreateOrUpdateResponse contains the response from method APIOperation.CreateOrUpdate.

type APIOperationCreateOrUpdateResult 

type APIOperationCreateOrUpdateResult struct {
	OperationContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIOperationCreateOrUpdateResult contains the result from method APIOperation.CreateOrUpdate.

type APIOperationDeleteOptions 

type APIOperationDeleteOptions struct {
}

APIOperationDeleteOptions contains the optional parameters for the APIOperation.Delete method.

type APIOperationDeleteResponse 

type APIOperationDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationDeleteResponse contains the response from method APIOperation.Delete.

type APIOperationGetEntityTagOptions 

type APIOperationGetEntityTagOptions struct {
}

APIOperationGetEntityTagOptions contains the optional parameters for the APIOperation.GetEntityTag method.

type APIOperationGetEntityTagResponse 

type APIOperationGetEntityTagResponse struct {
	APIOperationGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationGetEntityTagResponse contains the response from method APIOperation.GetEntityTag.

type APIOperationGetEntityTagResult 

type APIOperationGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APIOperationGetEntityTagResult contains the result from method APIOperation.GetEntityTag.

type APIOperationGetOptions 

type APIOperationGetOptions struct {
}

APIOperationGetOptions contains the optional parameters for the APIOperation.Get method.

type APIOperationGetResponse 

type APIOperationGetResponse struct {
	APIOperationGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationGetResponse contains the response from method APIOperation.Get.

type APIOperationGetResult 

type APIOperationGetResult struct {
	OperationContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIOperationGetResult contains the result from method APIOperation.Get.

type APIOperationListByAPIOptions 

type APIOperationListByAPIOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne,
	// gt, lt | substringof, contains, startswith, endswith |</br>| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith
	// |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Include tags in the response.
	Tags *string
	// Number of records to return.
	Top *int32
}

APIOperationListByAPIOptions contains the optional parameters for the APIOperation.ListByAPI method.

type APIOperationListByAPIPager 

type APIOperationListByAPIPager struct {
	// contains filtered or unexported fields
}

APIOperationListByAPIPager provides operations for iterating over paged responses.

func (*APIOperationListByAPIPager) Err 

func (p *APIOperationListByAPIPager) Err() error

Err returns the last error encountered while paging.

func (*APIOperationListByAPIPager) NextPage 

func (p *APIOperationListByAPIPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIOperationListByAPIPager) PageResponse 

func (p *APIOperationListByAPIPager) PageResponse() APIOperationListByAPIResponse

PageResponse returns the current APIOperationListByAPIResponse page.

type APIOperationListByAPIResponse 

type APIOperationListByAPIResponse struct {
	APIOperationListByAPIResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationListByAPIResponse contains the response from method APIOperation.ListByAPI.

type APIOperationListByAPIResult 

type APIOperationListByAPIResult struct {
	OperationCollection
}

APIOperationListByAPIResult contains the result from method APIOperation.ListByAPI.

type APIOperationPolicyClient 

type APIOperationPolicyClient struct {
	// contains filtered or unexported fields
}

APIOperationPolicyClient contains the methods for the APIOperationPolicy group. Don't use this type directly, use NewAPIOperationPolicyClient() instead.

func NewAPIOperationPolicyClient 

func NewAPIOperationPolicyClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIOperationPolicyClient

NewAPIOperationPolicyClient creates a new instance of APIOperationPolicyClient with the specified values.

func (*APIOperationPolicyClient) CreateOrUpdate 

func (client *APIOperationPolicyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, policyID PolicyIDName, parameters PolicyContract, options *APIOperationPolicyCreateOrUpdateOptions) (APIOperationPolicyCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates policy configuration for the API Operation level. If the operation fails it returns the *ErrorResponse error type.

func (*APIOperationPolicyClient) Delete 

func (client *APIOperationPolicyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, policyID PolicyIDName, ifMatch string, options *APIOperationPolicyDeleteOptions) (APIOperationPolicyDeleteResponse, error)

Delete - Deletes the policy configuration at the Api Operation. If the operation fails it returns the *ErrorResponse error type.

func (*APIOperationPolicyClient) Get 

func (client *APIOperationPolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, policyID PolicyIDName, options *APIOperationPolicyGetOptions) (APIOperationPolicyGetResponse, error)

Get - Get the policy configuration at the API Operation level. If the operation fails it returns the *ErrorResponse error type.

func (*APIOperationPolicyClient) GetEntityTag 

func (client *APIOperationPolicyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, policyID PolicyIDName, options *APIOperationPolicyGetEntityTagOptions) (APIOperationPolicyGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the API operation policy specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIOperationPolicyClient) ListByOperation 

func (client *APIOperationPolicyClient) ListByOperation(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, options *APIOperationPolicyListByOperationOptions) (APIOperationPolicyListByOperationResponse, error)

ListByOperation - Get the list of policy configuration at the API Operation level. If the operation fails it returns the *ErrorResponse error type.

type APIOperationPolicyCreateOrUpdateOptions 

type APIOperationPolicyCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APIOperationPolicyCreateOrUpdateOptions contains the optional parameters for the APIOperationPolicy.CreateOrUpdate method.

type APIOperationPolicyCreateOrUpdateResponse 

type APIOperationPolicyCreateOrUpdateResponse struct {
	APIOperationPolicyCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationPolicyCreateOrUpdateResponse contains the response from method APIOperationPolicy.CreateOrUpdate.

type APIOperationPolicyCreateOrUpdateResult 

type APIOperationPolicyCreateOrUpdateResult struct {
	PolicyContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIOperationPolicyCreateOrUpdateResult contains the result from method APIOperationPolicy.CreateOrUpdate.

type APIOperationPolicyDeleteOptions 

type APIOperationPolicyDeleteOptions struct {
}

APIOperationPolicyDeleteOptions contains the optional parameters for the APIOperationPolicy.Delete method.

type APIOperationPolicyDeleteResponse 

type APIOperationPolicyDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationPolicyDeleteResponse contains the response from method APIOperationPolicy.Delete.

type APIOperationPolicyGetEntityTagOptions 

type APIOperationPolicyGetEntityTagOptions struct {
}

APIOperationPolicyGetEntityTagOptions contains the optional parameters for the APIOperationPolicy.GetEntityTag method.

type APIOperationPolicyGetEntityTagResponse 

type APIOperationPolicyGetEntityTagResponse struct {
	APIOperationPolicyGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationPolicyGetEntityTagResponse contains the response from method APIOperationPolicy.GetEntityTag.

type APIOperationPolicyGetEntityTagResult 

type APIOperationPolicyGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APIOperationPolicyGetEntityTagResult contains the result from method APIOperationPolicy.GetEntityTag.

type APIOperationPolicyGetOptions 

type APIOperationPolicyGetOptions struct {
	// Policy Export Format.
	Format *PolicyExportFormat
}

APIOperationPolicyGetOptions contains the optional parameters for the APIOperationPolicy.Get method.

type APIOperationPolicyGetResponse 

type APIOperationPolicyGetResponse struct {
	APIOperationPolicyGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationPolicyGetResponse contains the response from method APIOperationPolicy.Get.

type APIOperationPolicyGetResult 

type APIOperationPolicyGetResult struct {
	PolicyContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIOperationPolicyGetResult contains the result from method APIOperationPolicy.Get.

type APIOperationPolicyListByOperationOptions 

type APIOperationPolicyListByOperationOptions struct {
}

APIOperationPolicyListByOperationOptions contains the optional parameters for the APIOperationPolicy.ListByOperation method.

type APIOperationPolicyListByOperationResponse 

type APIOperationPolicyListByOperationResponse struct {
	APIOperationPolicyListByOperationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationPolicyListByOperationResponse contains the response from method APIOperationPolicy.ListByOperation.

type APIOperationPolicyListByOperationResult 

type APIOperationPolicyListByOperationResult struct {
	PolicyCollection
}

APIOperationPolicyListByOperationResult contains the result from method APIOperationPolicy.ListByOperation.

type APIOperationUpdateOptions 

type APIOperationUpdateOptions struct {
}

APIOperationUpdateOptions contains the optional parameters for the APIOperation.Update method.

type APIOperationUpdateResponse 

type APIOperationUpdateResponse struct {
	APIOperationUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIOperationUpdateResponse contains the response from method APIOperation.Update.

type APIOperationUpdateResult 

type APIOperationUpdateResult struct {
	OperationContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIOperationUpdateResult contains the result from method APIOperation.Update.

type APIPolicyClient 

type APIPolicyClient struct {
	// contains filtered or unexported fields
}

APIPolicyClient contains the methods for the APIPolicy group. Don't use this type directly, use NewAPIPolicyClient() instead.

func NewAPIPolicyClient 

func NewAPIPolicyClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIPolicyClient

NewAPIPolicyClient creates a new instance of APIPolicyClient with the specified values.

func (*APIPolicyClient) CreateOrUpdate 

func (client *APIPolicyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, policyID PolicyIDName, parameters PolicyContract, options *APIPolicyCreateOrUpdateOptions) (APIPolicyCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates policy configuration for the API. If the operation fails it returns the *ErrorResponse error type.

func (*APIPolicyClient) Delete 

func (client *APIPolicyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, policyID PolicyIDName, ifMatch string, options *APIPolicyDeleteOptions) (APIPolicyDeleteResponse, error)

Delete - Deletes the policy configuration at the Api. If the operation fails it returns the *ErrorResponse error type.

func (*APIPolicyClient) Get 

func (client *APIPolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, policyID PolicyIDName, options *APIPolicyGetOptions) (APIPolicyGetResponse, error)

Get - Get the policy configuration at the API level. If the operation fails it returns one of the following error types. - *ErrorResponse, *ErrorResponse

func (*APIPolicyClient) GetEntityTag 

func (client *APIPolicyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, policyID PolicyIDName, options *APIPolicyGetEntityTagOptions) (APIPolicyGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the API policy specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIPolicyClient) ListByAPI 

func (client *APIPolicyClient) ListByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiID string, options *APIPolicyListByAPIOptions) (APIPolicyListByAPIResponse, error)

ListByAPI - Get the policy configuration at the API level. If the operation fails it returns the *ErrorResponse error type.

type APIPolicyCreateOrUpdateOptions 

type APIPolicyCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APIPolicyCreateOrUpdateOptions contains the optional parameters for the APIPolicy.CreateOrUpdate method.

type APIPolicyCreateOrUpdateResponse 

type APIPolicyCreateOrUpdateResponse struct {
	APIPolicyCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIPolicyCreateOrUpdateResponse contains the response from method APIPolicy.CreateOrUpdate.

type APIPolicyCreateOrUpdateResult 

type APIPolicyCreateOrUpdateResult struct {
	PolicyContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIPolicyCreateOrUpdateResult contains the result from method APIPolicy.CreateOrUpdate.

type APIPolicyDeleteOptions 

type APIPolicyDeleteOptions struct {
}

APIPolicyDeleteOptions contains the optional parameters for the APIPolicy.Delete method.

type APIPolicyDeleteResponse 

type APIPolicyDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIPolicyDeleteResponse contains the response from method APIPolicy.Delete.

type APIPolicyGetEntityTagOptions 

type APIPolicyGetEntityTagOptions struct {
}

APIPolicyGetEntityTagOptions contains the optional parameters for the APIPolicy.GetEntityTag method.

type APIPolicyGetEntityTagResponse 

type APIPolicyGetEntityTagResponse struct {
	APIPolicyGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIPolicyGetEntityTagResponse contains the response from method APIPolicy.GetEntityTag.

type APIPolicyGetEntityTagResult 

type APIPolicyGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APIPolicyGetEntityTagResult contains the result from method APIPolicy.GetEntityTag.

type APIPolicyGetOptions 

type APIPolicyGetOptions struct {
	// Policy Export Format.
	Format *PolicyExportFormat
}

APIPolicyGetOptions contains the optional parameters for the APIPolicy.Get method.

type APIPolicyGetResponse 

type APIPolicyGetResponse struct {
	APIPolicyGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIPolicyGetResponse contains the response from method APIPolicy.Get.

type APIPolicyGetResult 

type APIPolicyGetResult struct {
	PolicyContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIPolicyGetResult contains the result from method APIPolicy.Get.

type APIPolicyListByAPIOptions 

type APIPolicyListByAPIOptions struct {
}

APIPolicyListByAPIOptions contains the optional parameters for the APIPolicy.ListByAPI method.

type APIPolicyListByAPIResponse 

type APIPolicyListByAPIResponse struct {
	APIPolicyListByAPIResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIPolicyListByAPIResponse contains the response from method APIPolicy.ListByAPI.

type APIPolicyListByAPIResult 

type APIPolicyListByAPIResult struct {
	PolicyCollection
}

APIPolicyListByAPIResult contains the result from method APIPolicy.ListByAPI.

type APIProductClient 

type APIProductClient struct {
	// contains filtered or unexported fields
}

APIProductClient contains the methods for the APIProduct group. Don't use this type directly, use NewAPIProductClient() instead.

func NewAPIProductClient 

func NewAPIProductClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIProductClient

NewAPIProductClient creates a new instance of APIProductClient with the specified values.

func (*APIProductClient) ListByApis 

func (client *APIProductClient) ListByApis(resourceGroupName string, serviceName string, apiID string, options *APIProductListByApisOptions) *APIProductListByApisPager

ListByApis - Lists all Products, which the API is part of. If the operation fails it returns the *ErrorResponse error type.

type APIProductListByApisOptions 

type APIProductListByApisOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter
	// | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APIProductListByApisOptions contains the optional parameters for the APIProduct.ListByApis method.

type APIProductListByApisPager 

type APIProductListByApisPager struct {
	// contains filtered or unexported fields
}

APIProductListByApisPager provides operations for iterating over paged responses.

func (*APIProductListByApisPager) Err 

func (p *APIProductListByApisPager) Err() error

Err returns the last error encountered while paging.

func (*APIProductListByApisPager) NextPage 

func (p *APIProductListByApisPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIProductListByApisPager) PageResponse 

func (p *APIProductListByApisPager) PageResponse() APIProductListByApisResponse

PageResponse returns the current APIProductListByApisResponse page.

type APIProductListByApisResponse 

type APIProductListByApisResponse struct {
	APIProductListByApisResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIProductListByApisResponse contains the response from method APIProduct.ListByApis.

type APIProductListByApisResult 

type APIProductListByApisResult struct {
	ProductCollection
}

APIProductListByApisResult contains the result from method APIProduct.ListByApis.

type APIReleaseClient 

type APIReleaseClient struct {
	// contains filtered or unexported fields
}

APIReleaseClient contains the methods for the APIRelease group. Don't use this type directly, use NewAPIReleaseClient() instead.

func NewAPIReleaseClient 

func NewAPIReleaseClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIReleaseClient

NewAPIReleaseClient creates a new instance of APIReleaseClient with the specified values.

func (*APIReleaseClient) CreateOrUpdate 

func (client *APIReleaseClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, releaseID string, parameters APIReleaseContract, options *APIReleaseCreateOrUpdateOptions) (APIReleaseCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new Release for the API. If the operation fails it returns the *ErrorResponse error type.

func (*APIReleaseClient) Delete 

func (client *APIReleaseClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, releaseID string, ifMatch string, options *APIReleaseDeleteOptions) (APIReleaseDeleteResponse, error)

Delete - Deletes the specified release in the API. If the operation fails it returns the *ErrorResponse error type.

func (*APIReleaseClient) Get 

func (client *APIReleaseClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, releaseID string, options *APIReleaseGetOptions) (APIReleaseGetResponse, error)

Get - Returns the details of an API release. If the operation fails it returns the *ErrorResponse error type.

func (*APIReleaseClient) GetEntityTag 

func (client *APIReleaseClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, releaseID string, options *APIReleaseGetEntityTagOptions) (APIReleaseGetEntityTagResponse, error)

GetEntityTag - Returns the etag of an API release. If the operation fails it returns the *ErrorResponse error type.

func (*APIReleaseClient) ListByService 

func (client *APIReleaseClient) ListByService(resourceGroupName string, serviceName string, apiID string, options *APIReleaseListByServiceOptions) *APIReleaseListByServicePager

ListByService - Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters. If the operation fails it returns the *ErrorResponse error type.

func (*APIReleaseClient) Update 

func (client *APIReleaseClient) Update(ctx context.Context, resourceGroupName string, serviceName string, apiID string, releaseID string, ifMatch string, parameters APIReleaseContract, options *APIReleaseUpdateOptions) (APIReleaseUpdateResponse, error)

Update - Updates the details of the release of the API specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type APIReleaseCollection 

type APIReleaseCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Page values.
	Value []*APIReleaseContract `json:"value,omitempty" azure:"ro"`
}

APIReleaseCollection - Paged ApiRelease list representation.

func (APIReleaseCollection) MarshalJSON 

func (a APIReleaseCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIReleaseCollection.

type APIReleaseContract 

type APIReleaseContract struct {
	Resource
	// ApiRelease entity contract properties.
	Properties *APIReleaseContractProperties `json:"properties,omitempty"`
}

APIReleaseContract - ApiRelease details.

func (APIReleaseContract) MarshalJSON 

func (a APIReleaseContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIReleaseContract.

type APIReleaseContractProperties 

type APIReleaseContractProperties struct {
	// Identifier of the API the release belongs to.
	APIID *string `json:"apiId,omitempty"`

	// Release Notes
	Notes *string `json:"notes,omitempty"`

	// READ-ONLY; The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	CreatedDateTime *time.Time `json:"createdDateTime,omitempty" azure:"ro"`

	// READ-ONLY; The time the API release was updated.
	UpdatedDateTime *time.Time `json:"updatedDateTime,omitempty" azure:"ro"`
}

APIReleaseContractProperties - API Release details

func (APIReleaseContractProperties) MarshalJSON 

func (a APIReleaseContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIReleaseContractProperties.

func (*APIReleaseContractProperties) UnmarshalJSON 

func (a *APIReleaseContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type APIReleaseContractProperties.

type APIReleaseCreateOrUpdateOptions 

type APIReleaseCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APIReleaseCreateOrUpdateOptions contains the optional parameters for the APIRelease.CreateOrUpdate method.

type APIReleaseCreateOrUpdateResponse 

type APIReleaseCreateOrUpdateResponse struct {
	APIReleaseCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIReleaseCreateOrUpdateResponse contains the response from method APIRelease.CreateOrUpdate.

type APIReleaseCreateOrUpdateResult 

type APIReleaseCreateOrUpdateResult struct {
	APIReleaseContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIReleaseCreateOrUpdateResult contains the result from method APIRelease.CreateOrUpdate.

type APIReleaseDeleteOptions 

type APIReleaseDeleteOptions struct {
}

APIReleaseDeleteOptions contains the optional parameters for the APIRelease.Delete method.

type APIReleaseDeleteResponse 

type APIReleaseDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIReleaseDeleteResponse contains the response from method APIRelease.Delete.

type APIReleaseGetEntityTagOptions 

type APIReleaseGetEntityTagOptions struct {
}

APIReleaseGetEntityTagOptions contains the optional parameters for the APIRelease.GetEntityTag method.

type APIReleaseGetEntityTagResponse 

type APIReleaseGetEntityTagResponse struct {
	APIReleaseGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIReleaseGetEntityTagResponse contains the response from method APIRelease.GetEntityTag.

type APIReleaseGetEntityTagResult 

type APIReleaseGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APIReleaseGetEntityTagResult contains the result from method APIRelease.GetEntityTag.

type APIReleaseGetOptions 

type APIReleaseGetOptions struct {
}

APIReleaseGetOptions contains the optional parameters for the APIRelease.Get method.

type APIReleaseGetResponse 

type APIReleaseGetResponse struct {
	APIReleaseGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIReleaseGetResponse contains the response from method APIRelease.Get.

type APIReleaseGetResult 

type APIReleaseGetResult struct {
	APIReleaseContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIReleaseGetResult contains the result from method APIRelease.Get.

type APIReleaseListByServiceOptions 

type APIReleaseListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| notes | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APIReleaseListByServiceOptions contains the optional parameters for the APIRelease.ListByService method.

type APIReleaseListByServicePager 

type APIReleaseListByServicePager struct {
	// contains filtered or unexported fields
}

APIReleaseListByServicePager provides operations for iterating over paged responses.

func (*APIReleaseListByServicePager) Err 

func (p *APIReleaseListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*APIReleaseListByServicePager) NextPage 

func (p *APIReleaseListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIReleaseListByServicePager) PageResponse 

func (p *APIReleaseListByServicePager) PageResponse() APIReleaseListByServiceResponse

PageResponse returns the current APIReleaseListByServiceResponse page.

type APIReleaseListByServiceResponse 

type APIReleaseListByServiceResponse struct {
	APIReleaseListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIReleaseListByServiceResponse contains the response from method APIRelease.ListByService.

type APIReleaseListByServiceResult 

type APIReleaseListByServiceResult struct {
	APIReleaseCollection
}

APIReleaseListByServiceResult contains the result from method APIRelease.ListByService.

type APIReleaseUpdateOptions 

type APIReleaseUpdateOptions struct {
}

APIReleaseUpdateOptions contains the optional parameters for the APIRelease.Update method.

type APIReleaseUpdateResponse 

type APIReleaseUpdateResponse struct {
	APIReleaseUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIReleaseUpdateResponse contains the response from method APIRelease.Update.

type APIReleaseUpdateResult 

type APIReleaseUpdateResult struct {
	APIReleaseContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIReleaseUpdateResult contains the result from method APIRelease.Update.

type APIRevisionClient 

type APIRevisionClient struct {
	// contains filtered or unexported fields
}

APIRevisionClient contains the methods for the APIRevision group. Don't use this type directly, use NewAPIRevisionClient() instead.

func NewAPIRevisionClient 

func NewAPIRevisionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIRevisionClient

NewAPIRevisionClient creates a new instance of APIRevisionClient with the specified values.

func (*APIRevisionClient) ListByService 

func (client *APIRevisionClient) ListByService(resourceGroupName string, serviceName string, apiID string, options *APIRevisionListByServiceOptions) *APIRevisionListByServicePager

ListByService - Lists all revisions of an API. If the operation fails it returns the *ErrorResponse error type.

type APIRevisionCollection 

type APIRevisionCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Page values.
	Value []*APIRevisionContract `json:"value,omitempty" azure:"ro"`
}

APIRevisionCollection - Paged API Revision list representation.

func (APIRevisionCollection) MarshalJSON 

func (a APIRevisionCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIRevisionCollection.

type APIRevisionContract 

type APIRevisionContract struct {
	// READ-ONLY; Identifier of the API Revision.
	APIID *string `json:"apiId,omitempty" azure:"ro"`

	// READ-ONLY; Revision number of API.
	APIRevision *string `json:"apiRevision,omitempty" azure:"ro"`

	// READ-ONLY; The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	CreatedDateTime *time.Time `json:"createdDateTime,omitempty" azure:"ro"`

	// READ-ONLY; Description of the API Revision.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; Indicates if API revision is accessible via the gateway.
	IsCurrent *bool `json:"isCurrent,omitempty" azure:"ro"`

	// READ-ONLY; Indicates if API revision is the current api revision.
	IsOnline *bool `json:"isOnline,omitempty" azure:"ro"`

	// READ-ONLY; Gateway URL for accessing the non-current API Revision.
	PrivateURL *string `json:"privateUrl,omitempty" azure:"ro"`

	// READ-ONLY; The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	UpdatedDateTime *time.Time `json:"updatedDateTime,omitempty" azure:"ro"`
}

APIRevisionContract - Summary of revision metadata.

func (APIRevisionContract) MarshalJSON 

func (a APIRevisionContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIRevisionContract.

func (*APIRevisionContract) UnmarshalJSON 

func (a *APIRevisionContract) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type APIRevisionContract.

type APIRevisionInfoContract 

type APIRevisionInfoContract struct {
	// Description of new API Revision.
	APIRevisionDescription *string `json:"apiRevisionDescription,omitempty"`

	// Version identifier for the new API Version.
	APIVersionName *string `json:"apiVersionName,omitempty"`

	// Version set details
	APIVersionSet *APIVersionSetContractDetails `json:"apiVersionSet,omitempty"`

	// Resource identifier of API to be used to create the revision from.
	SourceAPIID *string `json:"sourceApiId,omitempty"`
}

APIRevisionInfoContract - Object used to create an API Revision or Version based on an existing API Revision

type APIRevisionListByServiceOptions 

type APIRevisionListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| apiRevision | filter
	// | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APIRevisionListByServiceOptions contains the optional parameters for the APIRevision.ListByService method.

type APIRevisionListByServicePager 

type APIRevisionListByServicePager struct {
	// contains filtered or unexported fields
}

APIRevisionListByServicePager provides operations for iterating over paged responses.

func (*APIRevisionListByServicePager) Err 

func (p *APIRevisionListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*APIRevisionListByServicePager) NextPage 

func (p *APIRevisionListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIRevisionListByServicePager) PageResponse 

func (p *APIRevisionListByServicePager) PageResponse() APIRevisionListByServiceResponse

PageResponse returns the current APIRevisionListByServiceResponse page.

type APIRevisionListByServiceResponse 

type APIRevisionListByServiceResponse struct {
	APIRevisionListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIRevisionListByServiceResponse contains the response from method APIRevision.ListByService.

type APIRevisionListByServiceResult 

type APIRevisionListByServiceResult struct {
	APIRevisionCollection
}

APIRevisionListByServiceResult contains the result from method APIRevision.ListByService.

type APISchemaBeginCreateOrUpdateOptions 

type APISchemaBeginCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APISchemaBeginCreateOrUpdateOptions contains the optional parameters for the APISchema.BeginCreateOrUpdate method.

type APISchemaClient 

type APISchemaClient struct {
	// contains filtered or unexported fields
}

APISchemaClient contains the methods for the APISchema group. Don't use this type directly, use NewAPISchemaClient() instead.

func NewAPISchemaClient 

func NewAPISchemaClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APISchemaClient

NewAPISchemaClient creates a new instance of APISchemaClient with the specified values.

func (*APISchemaClient) BeginCreateOrUpdate 

func (client *APISchemaClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, schemaID string, parameters SchemaContract, options *APISchemaBeginCreateOrUpdateOptions) (APISchemaCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates schema configuration for the API. If the operation fails it returns the *ErrorResponse error type.

func (*APISchemaClient) Delete 

func (client *APISchemaClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, schemaID string, ifMatch string, options *APISchemaDeleteOptions) (APISchemaDeleteResponse, error)

Delete - Deletes the schema configuration at the Api. If the operation fails it returns the *ErrorResponse error type.

func (*APISchemaClient) Get 

func (client *APISchemaClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, schemaID string, options *APISchemaGetOptions) (APISchemaGetResponse, error)

Get - Get the schema configuration at the API level. If the operation fails it returns the *ErrorResponse error type.

func (*APISchemaClient) GetEntityTag 

func (client *APISchemaClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, schemaID string, options *APISchemaGetEntityTagOptions) (APISchemaGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the schema specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APISchemaClient) ListByAPI 

func (client *APISchemaClient) ListByAPI(resourceGroupName string, serviceName string, apiID string, options *APISchemaListByAPIOptions) *APISchemaListByAPIPager

ListByAPI - Get the schema configuration at the API level. If the operation fails it returns the *ErrorResponse error type.

type APISchemaCreateOrUpdatePoller 

type APISchemaCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

APISchemaCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*APISchemaCreateOrUpdatePoller) Done 

func (p *APISchemaCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*APISchemaCreateOrUpdatePoller) FinalResponse 

func (p *APISchemaCreateOrUpdatePoller) FinalResponse(ctx context.Context) (APISchemaCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final APISchemaCreateOrUpdateResponse will be returned.

func (*APISchemaCreateOrUpdatePoller) Poll 

func (p *APISchemaCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*APISchemaCreateOrUpdatePoller) ResumeToken 

func (p *APISchemaCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type APISchemaCreateOrUpdatePollerResponse 

type APISchemaCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *APISchemaCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APISchemaCreateOrUpdatePollerResponse contains the response from method APISchema.CreateOrUpdate.

func (APISchemaCreateOrUpdatePollerResponse) PollUntilDone 

func (l APISchemaCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (APISchemaCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*APISchemaCreateOrUpdatePollerResponse) Resume 

func (l *APISchemaCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *APISchemaClient, token string) error

Resume rehydrates a APISchemaCreateOrUpdatePollerResponse from the provided client and resume token.

type APISchemaCreateOrUpdateResponse 

type APISchemaCreateOrUpdateResponse struct {
	APISchemaCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APISchemaCreateOrUpdateResponse contains the response from method APISchema.CreateOrUpdate.

type APISchemaCreateOrUpdateResult 

type APISchemaCreateOrUpdateResult struct {
	SchemaContract
}

APISchemaCreateOrUpdateResult contains the result from method APISchema.CreateOrUpdate.

type APISchemaDeleteOptions 

type APISchemaDeleteOptions struct {
	// If true removes all references to the schema before deleting it.
	Force *bool
}

APISchemaDeleteOptions contains the optional parameters for the APISchema.Delete method.

type APISchemaDeleteResponse 

type APISchemaDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APISchemaDeleteResponse contains the response from method APISchema.Delete.

type APISchemaGetEntityTagOptions 

type APISchemaGetEntityTagOptions struct {
}

APISchemaGetEntityTagOptions contains the optional parameters for the APISchema.GetEntityTag method.

type APISchemaGetEntityTagResponse 

type APISchemaGetEntityTagResponse struct {
	APISchemaGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APISchemaGetEntityTagResponse contains the response from method APISchema.GetEntityTag.

type APISchemaGetEntityTagResult 

type APISchemaGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APISchemaGetEntityTagResult contains the result from method APISchema.GetEntityTag.

type APISchemaGetOptions 

type APISchemaGetOptions struct {
}

APISchemaGetOptions contains the optional parameters for the APISchema.Get method.

type APISchemaGetResponse 

type APISchemaGetResponse struct {
	APISchemaGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APISchemaGetResponse contains the response from method APISchema.Get.

type APISchemaGetResult 

type APISchemaGetResult struct {
	SchemaContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APISchemaGetResult contains the result from method APISchema.Get.

type APISchemaListByAPIOptions 

type APISchemaListByAPIOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| contentType | filter
	// | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APISchemaListByAPIOptions contains the optional parameters for the APISchema.ListByAPI method.

type APISchemaListByAPIPager 

type APISchemaListByAPIPager struct {
	// contains filtered or unexported fields
}

APISchemaListByAPIPager provides operations for iterating over paged responses.

func (*APISchemaListByAPIPager) Err 

func (p *APISchemaListByAPIPager) Err() error

Err returns the last error encountered while paging.

func (*APISchemaListByAPIPager) NextPage 

func (p *APISchemaListByAPIPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APISchemaListByAPIPager) PageResponse 

func (p *APISchemaListByAPIPager) PageResponse() APISchemaListByAPIResponse

PageResponse returns the current APISchemaListByAPIResponse page.

type APISchemaListByAPIResponse 

type APISchemaListByAPIResponse struct {
	APISchemaListByAPIResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APISchemaListByAPIResponse contains the response from method APISchema.ListByAPI.

type APISchemaListByAPIResult 

type APISchemaListByAPIResult struct {
	SchemaCollection
}

APISchemaListByAPIResult contains the result from method APISchema.ListByAPI.

type APITagDescriptionClient 

type APITagDescriptionClient struct {
	// contains filtered or unexported fields
}

APITagDescriptionClient contains the methods for the APITagDescription group. Don't use this type directly, use NewAPITagDescriptionClient() instead.

func NewAPITagDescriptionClient 

func NewAPITagDescriptionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APITagDescriptionClient

NewAPITagDescriptionClient creates a new instance of APITagDescriptionClient with the specified values.

func (*APITagDescriptionClient) CreateOrUpdate 

func (client *APITagDescriptionClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiID string, tagDescriptionID string, parameters TagDescriptionCreateParameters, options *APITagDescriptionCreateOrUpdateOptions) (APITagDescriptionCreateOrUpdateResponse, error)

CreateOrUpdate - Create/Update tag description in scope of the Api. If the operation fails it returns the *ErrorResponse error type.

func (*APITagDescriptionClient) Delete 

func (client *APITagDescriptionClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiID string, tagDescriptionID string, ifMatch string, options *APITagDescriptionDeleteOptions) (APITagDescriptionDeleteResponse, error)

Delete - Delete tag description for the Api. If the operation fails it returns the *ErrorResponse error type.

func (*APITagDescriptionClient) Get 

func (client *APITagDescriptionClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiID string, tagDescriptionID string, options *APITagDescriptionGetOptions) (APITagDescriptionGetResponse, error)

Get - Get Tag description in scope of API If the operation fails it returns the *ErrorResponse error type.

func (*APITagDescriptionClient) GetEntityTag 

func (client *APITagDescriptionClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiID string, tagDescriptionID string, options *APITagDescriptionGetEntityTagOptions) (APITagDescriptionGetEntityTagResponse, error)

GetEntityTag - Gets the entity state version of the tag specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APITagDescriptionClient) ListByService 

func (client *APITagDescriptionClient) ListByService(resourceGroupName string, serviceName string, apiID string, options *APITagDescriptionListByServiceOptions) *APITagDescriptionListByServicePager

ListByService - Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations If the operation fails it returns the *ErrorResponse error type.

type APITagDescriptionCreateOrUpdateOptions 

type APITagDescriptionCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APITagDescriptionCreateOrUpdateOptions contains the optional parameters for the APITagDescription.CreateOrUpdate method.

type APITagDescriptionCreateOrUpdateResponse 

type APITagDescriptionCreateOrUpdateResponse struct {
	APITagDescriptionCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APITagDescriptionCreateOrUpdateResponse contains the response from method APITagDescription.CreateOrUpdate.

type APITagDescriptionCreateOrUpdateResult 

type APITagDescriptionCreateOrUpdateResult struct {
	TagDescriptionContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APITagDescriptionCreateOrUpdateResult contains the result from method APITagDescription.CreateOrUpdate.

type APITagDescriptionDeleteOptions 

type APITagDescriptionDeleteOptions struct {
}

APITagDescriptionDeleteOptions contains the optional parameters for the APITagDescription.Delete method.

type APITagDescriptionDeleteResponse 

type APITagDescriptionDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APITagDescriptionDeleteResponse contains the response from method APITagDescription.Delete.

type APITagDescriptionGetEntityTagOptions 

type APITagDescriptionGetEntityTagOptions struct {
}

APITagDescriptionGetEntityTagOptions contains the optional parameters for the APITagDescription.GetEntityTag method.

type APITagDescriptionGetEntityTagResponse 

type APITagDescriptionGetEntityTagResponse struct {
	APITagDescriptionGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APITagDescriptionGetEntityTagResponse contains the response from method APITagDescription.GetEntityTag.

type APITagDescriptionGetEntityTagResult 

type APITagDescriptionGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APITagDescriptionGetEntityTagResult contains the result from method APITagDescription.GetEntityTag.

type APITagDescriptionGetOptions 

type APITagDescriptionGetOptions struct {
}

APITagDescriptionGetOptions contains the optional parameters for the APITagDescription.Get method.

type APITagDescriptionGetResponse 

type APITagDescriptionGetResponse struct {
	APITagDescriptionGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APITagDescriptionGetResponse contains the response from method APITagDescription.Get.

type APITagDescriptionGetResult 

type APITagDescriptionGetResult struct {
	TagDescriptionContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APITagDescriptionGetResult contains the result from method APITagDescription.Get.

type APITagDescriptionListByServiceOptions 

type APITagDescriptionListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter
	// | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APITagDescriptionListByServiceOptions contains the optional parameters for the APITagDescription.ListByService method.

type APITagDescriptionListByServicePager 

type APITagDescriptionListByServicePager struct {
	// contains filtered or unexported fields
}

APITagDescriptionListByServicePager provides operations for iterating over paged responses.

func (*APITagDescriptionListByServicePager) Err 

func (p *APITagDescriptionListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*APITagDescriptionListByServicePager) NextPage 

func (p *APITagDescriptionListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APITagDescriptionListByServicePager) PageResponse 

func (p *APITagDescriptionListByServicePager) PageResponse() APITagDescriptionListByServiceResponse

PageResponse returns the current APITagDescriptionListByServiceResponse page.

type APITagDescriptionListByServiceResponse 

type APITagDescriptionListByServiceResponse struct {
	APITagDescriptionListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APITagDescriptionListByServiceResponse contains the response from method APITagDescription.ListByService.

type APITagDescriptionListByServiceResult 

type APITagDescriptionListByServiceResult struct {
	TagDescriptionCollection
}

APITagDescriptionListByServiceResult contains the result from method APITagDescription.ListByService.

type APITagResourceContractProperties 

type APITagResourceContractProperties struct {
	APIEntityBaseContract
	// API identifier in the form /apis/{apiId}.
	ID *string `json:"id,omitempty"`

	// API name.
	Name *string `json:"name,omitempty"`

	// Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint
	// base URL specified during the service instance
	// creation to form a public URL for this API.
	Path *string `json:"path,omitempty"`

	// Describes on which protocols the operations in this API can be invoked.
	Protocols []*Protocol `json:"protocols,omitempty"`

	// Absolute URL of the backend service implementing this API.
	ServiceURL *string `json:"serviceUrl,omitempty"`
}

APITagResourceContractProperties - API contract properties for the Tag Resources.

func (APITagResourceContractProperties) MarshalJSON 

func (a APITagResourceContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APITagResourceContractProperties.

type APIType 

type APIType string

APIType - Type of API. 

const (
	APITypeGraphql   APIType = "graphql"
	APITypeHTTP      APIType = "http"
	APITypeSoap      APIType = "soap"
	APITypeWebsocket APIType = "websocket"
)

func PossibleAPITypeValues 

func PossibleAPITypeValues() []APIType

PossibleAPITypeValues returns the possible values for the APIType const type.

func (APIType) ToPtr 

func (c APIType) ToPtr() *APIType

ToPtr returns a *APIType pointing to the current value.

type APIUpdateContract 

type APIUpdateContract struct {
	// Properties of the API entity that can be updated.
	Properties *APIContractUpdateProperties `json:"properties,omitempty"`
}

APIUpdateContract - API update contract details.

func (APIUpdateContract) MarshalJSON 

func (a APIUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIUpdateContract.

type APIUpdateOptions 

type APIUpdateOptions struct {
}

APIUpdateOptions contains the optional parameters for the API.Update method.

type APIUpdateResponse 

type APIUpdateResponse struct {
	APIUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIUpdateResponse contains the response from method API.Update.

type APIUpdateResult 

type APIUpdateResult struct {
	APIContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIUpdateResult contains the result from method API.Update.

type APIVersionConstraint 

type APIVersionConstraint struct {
	// Limit control plane API calls to API Management service with version equal to or newer than this value.
	MinAPIVersion *string `json:"minApiVersion,omitempty"`
}

APIVersionConstraint - Control Plane Apis version constraint for the API Management service.

type APIVersionSetClient 

type APIVersionSetClient struct {
	// contains filtered or unexported fields
}

APIVersionSetClient contains the methods for the APIVersionSet group. Don't use this type directly, use NewAPIVersionSetClient() instead.

func NewAPIVersionSetClient 

func NewAPIVersionSetClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *APIVersionSetClient

NewAPIVersionSetClient creates a new instance of APIVersionSetClient with the specified values.

func (*APIVersionSetClient) CreateOrUpdate 

func (client *APIVersionSetClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, parameters APIVersionSetContract, options *APIVersionSetCreateOrUpdateOptions) (APIVersionSetCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or Updates a Api Version Set. If the operation fails it returns the *ErrorResponse error type.

func (*APIVersionSetClient) Delete 

func (client *APIVersionSetClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, ifMatch string, options *APIVersionSetDeleteOptions) (APIVersionSetDeleteResponse, error)

Delete - Deletes specific Api Version Set. If the operation fails it returns the *ErrorResponse error type.

func (*APIVersionSetClient) Get 

func (client *APIVersionSetClient) Get(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, options *APIVersionSetGetOptions) (APIVersionSetGetResponse, error)

Get - Gets the details of the Api Version Set specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIVersionSetClient) GetEntityTag 

func (client *APIVersionSetClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, options *APIVersionSetGetEntityTagOptions) (APIVersionSetGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the Api Version Set specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*APIVersionSetClient) ListByService 

func (client *APIVersionSetClient) ListByService(resourceGroupName string, serviceName string, options *APIVersionSetListByServiceOptions) *APIVersionSetListByServicePager

ListByService - Lists a collection of API Version Sets in the specified service instance. If the operation fails it returns the *ErrorResponse error type.

func (*APIVersionSetClient) Update 

func (client *APIVersionSetClient) Update(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, ifMatch string, parameters APIVersionSetUpdateParameters, options *APIVersionSetUpdateOptions) (APIVersionSetUpdateResponse, error)

Update - Updates the details of the Api VersionSet specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type APIVersionSetCollection 

type APIVersionSetCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*APIVersionSetContract `json:"value,omitempty"`
}

APIVersionSetCollection - Paged API Version Set list representation.

func (APIVersionSetCollection) MarshalJSON 

func (a APIVersionSetCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIVersionSetCollection.

type APIVersionSetContract 

type APIVersionSetContract struct {
	Resource
	// API VersionSet contract properties.
	Properties *APIVersionSetContractProperties `json:"properties,omitempty"`
}

APIVersionSetContract - API Version Set Contract details.

func (APIVersionSetContract) MarshalJSON 

func (a APIVersionSetContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIVersionSetContract.

type APIVersionSetContractDetails 

type APIVersionSetContractDetails struct {
	// Description of API Version Set.
	Description *string `json:"description,omitempty"`

	// Identifier for existing API Version Set. Omit this value to create a new Version Set.
	ID *string `json:"id,omitempty"`

	// The display Name of the API Version Set.
	Name *string `json:"name,omitempty"`

	// Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
	VersionHeaderName *string `json:"versionHeaderName,omitempty"`

	// Name of query parameter that indicates the API Version if versioningScheme is set to query.
	VersionQueryName *string `json:"versionQueryName,omitempty"`

	// An value that determines where the API Version identifier will be located in a HTTP request.
	VersioningScheme *APIVersionSetContractDetailsVersioningScheme `json:"versioningScheme,omitempty"`
}

APIVersionSetContractDetails - An API Version Set contains the common configuration for a set of API Versions relating

type APIVersionSetContractDetailsVersioningScheme 

type APIVersionSetContractDetailsVersioningScheme string

APIVersionSetContractDetailsVersioningScheme - An value that determines where the API Version identifier will be located in a HTTP request. 

const (
	APIVersionSetContractDetailsVersioningSchemeHeader  APIVersionSetContractDetailsVersioningScheme = "Header"
	APIVersionSetContractDetailsVersioningSchemeQuery   APIVersionSetContractDetailsVersioningScheme = "Query"
	APIVersionSetContractDetailsVersioningSchemeSegment APIVersionSetContractDetailsVersioningScheme = "Segment"
)

func PossibleAPIVersionSetContractDetailsVersioningSchemeValues 

func PossibleAPIVersionSetContractDetailsVersioningSchemeValues() []APIVersionSetContractDetailsVersioningScheme

PossibleAPIVersionSetContractDetailsVersioningSchemeValues returns the possible values for the APIVersionSetContractDetailsVersioningScheme const type.

func (APIVersionSetContractDetailsVersioningScheme) ToPtr 

func (c APIVersionSetContractDetailsVersioningScheme) ToPtr() *APIVersionSetContractDetailsVersioningScheme

ToPtr returns a *APIVersionSetContractDetailsVersioningScheme pointing to the current value.

type APIVersionSetContractProperties 

type APIVersionSetContractProperties struct {
	APIVersionSetEntityBase
	// REQUIRED; Name of API Version Set
	DisplayName *string `json:"displayName,omitempty"`

	// REQUIRED; An value that determines where the API Version identifier will be located in a HTTP request.
	VersioningScheme *VersioningScheme `json:"versioningScheme,omitempty"`
}

APIVersionSetContractProperties - Properties of an API Version Set.

type APIVersionSetCreateOrUpdateOptions 

type APIVersionSetCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

APIVersionSetCreateOrUpdateOptions contains the optional parameters for the APIVersionSet.CreateOrUpdate method.

type APIVersionSetCreateOrUpdateResponse 

type APIVersionSetCreateOrUpdateResponse struct {
	APIVersionSetCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIVersionSetCreateOrUpdateResponse contains the response from method APIVersionSet.CreateOrUpdate.

type APIVersionSetCreateOrUpdateResult 

type APIVersionSetCreateOrUpdateResult struct {
	APIVersionSetContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIVersionSetCreateOrUpdateResult contains the result from method APIVersionSet.CreateOrUpdate.

type APIVersionSetDeleteOptions 

type APIVersionSetDeleteOptions struct {
}

APIVersionSetDeleteOptions contains the optional parameters for the APIVersionSet.Delete method.

type APIVersionSetDeleteResponse 

type APIVersionSetDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIVersionSetDeleteResponse contains the response from method APIVersionSet.Delete.

type APIVersionSetEntityBase 

type APIVersionSetEntityBase struct {
	// Description of API Version Set.
	Description *string `json:"description,omitempty"`

	// Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
	VersionHeaderName *string `json:"versionHeaderName,omitempty"`

	// Name of query parameter that indicates the API Version if versioningScheme is set to query.
	VersionQueryName *string `json:"versionQueryName,omitempty"`
}

APIVersionSetEntityBase - API Version set base parameters

type APIVersionSetGetEntityTagOptions 

type APIVersionSetGetEntityTagOptions struct {
}

APIVersionSetGetEntityTagOptions contains the optional parameters for the APIVersionSet.GetEntityTag method.

type APIVersionSetGetEntityTagResponse 

type APIVersionSetGetEntityTagResponse struct {
	APIVersionSetGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIVersionSetGetEntityTagResponse contains the response from method APIVersionSet.GetEntityTag.

type APIVersionSetGetEntityTagResult 

type APIVersionSetGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

APIVersionSetGetEntityTagResult contains the result from method APIVersionSet.GetEntityTag.

type APIVersionSetGetOptions 

type APIVersionSetGetOptions struct {
}

APIVersionSetGetOptions contains the optional parameters for the APIVersionSet.Get method.

type APIVersionSetGetResponse 

type APIVersionSetGetResponse struct {
	APIVersionSetGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIVersionSetGetResponse contains the response from method APIVersionSet.Get.

type APIVersionSetGetResult 

type APIVersionSetGetResult struct {
	APIVersionSetContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIVersionSetGetResult contains the result from method APIVersionSet.Get.

type APIVersionSetListByServiceOptions 

type APIVersionSetListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

APIVersionSetListByServiceOptions contains the optional parameters for the APIVersionSet.ListByService method.

type APIVersionSetListByServicePager 

type APIVersionSetListByServicePager struct {
	// contains filtered or unexported fields
}

APIVersionSetListByServicePager provides operations for iterating over paged responses.

func (*APIVersionSetListByServicePager) Err 

func (p *APIVersionSetListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*APIVersionSetListByServicePager) NextPage 

func (p *APIVersionSetListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*APIVersionSetListByServicePager) PageResponse 

func (p *APIVersionSetListByServicePager) PageResponse() APIVersionSetListByServiceResponse

PageResponse returns the current APIVersionSetListByServiceResponse page.

type APIVersionSetListByServiceResponse 

type APIVersionSetListByServiceResponse struct {
	APIVersionSetListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIVersionSetListByServiceResponse contains the response from method APIVersionSet.ListByService.

type APIVersionSetListByServiceResult 

type APIVersionSetListByServiceResult struct {
	APIVersionSetCollection
}

APIVersionSetListByServiceResult contains the result from method APIVersionSet.ListByService.

type APIVersionSetUpdateOptions 

type APIVersionSetUpdateOptions struct {
}

APIVersionSetUpdateOptions contains the optional parameters for the APIVersionSet.Update method.

type APIVersionSetUpdateParameters 

type APIVersionSetUpdateParameters struct {
	// Parameters to update or create an API Version Set Contract.
	Properties *APIVersionSetUpdateParametersProperties `json:"properties,omitempty"`
}

APIVersionSetUpdateParameters - Parameters to update or create an API Version Set Contract.

func (APIVersionSetUpdateParameters) MarshalJSON 

func (a APIVersionSetUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIVersionSetUpdateParameters.

type APIVersionSetUpdateParametersProperties 

type APIVersionSetUpdateParametersProperties struct {
	APIVersionSetEntityBase
	// Name of API Version Set
	DisplayName *string `json:"displayName,omitempty"`

	// An value that determines where the API Version identifier will be located in a HTTP request.
	VersioningScheme *VersioningScheme `json:"versioningScheme,omitempty"`
}

APIVersionSetUpdateParametersProperties - Properties used to create or update an API Version Set.

type APIVersionSetUpdateResponse 

type APIVersionSetUpdateResponse struct {
	APIVersionSetUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

APIVersionSetUpdateResponse contains the response from method APIVersionSet.Update.

type APIVersionSetUpdateResult 

type APIVersionSetUpdateResult struct {
	APIVersionSetContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

APIVersionSetUpdateResult contains the result from method APIVersionSet.Update.

type AccessIDName 

type AccessIDName string
const (
	AccessIDNameAccess    AccessIDName = "access"
	AccessIDNameGitAccess AccessIDName = "gitAccess"
)

func PossibleAccessIDNameValues 

func PossibleAccessIDNameValues() []AccessIDName

PossibleAccessIDNameValues returns the possible values for the AccessIDName const type.

func (AccessIDName) ToPtr 

func (c AccessIDName) ToPtr() *AccessIDName

ToPtr returns a *AccessIDName pointing to the current value.

type AccessInformationCollection 

type AccessInformationCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Page values.
	Value []*AccessInformationContract `json:"value,omitempty" azure:"ro"`
}

AccessInformationCollection - Paged AccessInformation list representation.

func (AccessInformationCollection) MarshalJSON 

func (a AccessInformationCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessInformationCollection.

type AccessInformationContract 

type AccessInformationContract struct {
	Resource
	// AccessInformation entity contract properties.
	Properties *AccessInformationContractProperties `json:"properties,omitempty"`
}

AccessInformationContract - Tenant Settings.

func (AccessInformationContract) MarshalJSON 

func (a AccessInformationContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessInformationContract.

type AccessInformationContractProperties 

type AccessInformationContractProperties struct {
	// Determines whether direct access is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Access Information type ('access' or 'gitAccess')
	ID *string `json:"id,omitempty"`

	// Principal (User) Identifier.
	PrincipalID *string `json:"principalId,omitempty"`
}

AccessInformationContractProperties - Tenant access information contract of the API Management service.

type AccessInformationCreateParameterProperties 

type AccessInformationCreateParameterProperties struct {
	// Determines whether direct access is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// Principal (User) Identifier.
	PrincipalID *string `json:"principalId,omitempty"`

	// Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

AccessInformationCreateParameterProperties - Tenant access information update parameters of the API Management service

type AccessInformationCreateParameters 

type AccessInformationCreateParameters struct {
	// Tenant access information update parameter properties.
	Properties *AccessInformationCreateParameterProperties `json:"properties,omitempty"`
}

AccessInformationCreateParameters - Tenant access information update parameters.

type AccessInformationSecretsContract 

type AccessInformationSecretsContract struct {
	// Determines whether direct access is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Access Information type ('access' or 'gitAccess')
	ID *string `json:"id,omitempty"`

	// Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// Principal (User) Identifier.
	PrincipalID *string `json:"principalId,omitempty"`

	// Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

AccessInformationSecretsContract - Tenant access information contract of the API Management service.

type AccessInformationUpdateParameterProperties 

type AccessInformationUpdateParameterProperties struct {
	// Determines whether direct access is enabled.
	Enabled *bool `json:"enabled,omitempty"`
}

AccessInformationUpdateParameterProperties - Tenant access information update parameters of the API Management service

type AccessInformationUpdateParameters 

type AccessInformationUpdateParameters struct {
	// Tenant access information update parameter properties.
	Properties *AccessInformationUpdateParameterProperties `json:"properties,omitempty"`
}

AccessInformationUpdateParameters - Tenant access information update parameters.

func (AccessInformationUpdateParameters) MarshalJSON 

func (a AccessInformationUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessInformationUpdateParameters.

type AccessType 

type AccessType string

AccessType - The type of access to be used for the storage account. 

const (
	// AccessTypeAccessKey - Use access key.
	AccessTypeAccessKey AccessType = "AccessKey"
	// AccessTypeSystemAssignedManagedIdentity - Use system assigned managed identity.
	AccessTypeSystemAssignedManagedIdentity AccessType = "SystemAssignedManagedIdentity"
	// AccessTypeUserAssignedManagedIdentity - Use user assigned managed identity.
	AccessTypeUserAssignedManagedIdentity AccessType = "UserAssignedManagedIdentity"
)

func PossibleAccessTypeValues 

func PossibleAccessTypeValues() []AccessType

PossibleAccessTypeValues returns the possible values for the AccessType const type.

func (AccessType) ToPtr 

func (c AccessType) ToPtr() *AccessType

ToPtr returns a *AccessType pointing to the current value.

type AdditionalLocation 

type AdditionalLocation struct {
	// REQUIRED; The location name of the additional region among Azure Data center regions.
	Location *string `json:"location,omitempty"`

	// REQUIRED; SKU properties of the API Management service.
	SKU *APIManagementServiceSKUProperties `json:"sku,omitempty"`

	// Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
	DisableGateway *bool `json:"disableGateway,omitempty"`

	// Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being
	// deployed in Virtual Network.
	PublicIPAddressID *string `json:"publicIpAddressId,omitempty"`

	// Virtual network configuration for the location.
	VirtualNetworkConfiguration *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`

	// A list of availability zones denoting where the resource needs to come from.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; Gateway URL of the API Management service in the Region.
	GatewayRegionalURL *string `json:"gatewayRegionalUrl,omitempty" azure:"ro"`

	// READ-ONLY; Compute Platform Version running the service.
	PlatformVersion *PlatformVersion `json:"platformVersion,omitempty" azure:"ro"`

	// READ-ONLY; Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional
	// location. Available only for Basic, Standard,
	// Premium and Isolated SKU.
	PrivateIPAddresses []*string `json:"privateIPAddresses,omitempty" azure:"ro"`

	// READ-ONLY; Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium
	// and Isolated SKU.
	PublicIPAddresses []*string `json:"publicIPAddresses,omitempty" azure:"ro"`
}

AdditionalLocation - Description of an additional API Management resource location.

func (AdditionalLocation) MarshalJSON 

func (a AdditionalLocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AdditionalLocation.

type AlwaysLog 

type AlwaysLog string

AlwaysLog - Specifies for what type of messages sampling settings should not apply. 

const (
	// AlwaysLogAllErrors - Always log all erroneous request regardless of sampling settings.
	AlwaysLogAllErrors AlwaysLog = "allErrors"
)

func PossibleAlwaysLogValues 

func PossibleAlwaysLogValues() []AlwaysLog

PossibleAlwaysLogValues returns the possible values for the AlwaysLog const type.

func (AlwaysLog) ToPtr 

func (c AlwaysLog) ToPtr() *AlwaysLog

ToPtr returns a *AlwaysLog pointing to the current value.

type ApimIdentityType 

type ApimIdentityType string

ApimIdentityType - The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. 

const (
	ApimIdentityTypeNone                       ApimIdentityType = "None"
	ApimIdentityTypeSystemAssigned             ApimIdentityType = "SystemAssigned"
	ApimIdentityTypeSystemAssignedUserAssigned ApimIdentityType = "SystemAssigned, UserAssigned"
	ApimIdentityTypeUserAssigned               ApimIdentityType = "UserAssigned"
)

func PossibleApimIdentityTypeValues 

func PossibleApimIdentityTypeValues() []ApimIdentityType

PossibleApimIdentityTypeValues returns the possible values for the ApimIdentityType const type.

func (ApimIdentityType) ToPtr 

func (c ApimIdentityType) ToPtr() *ApimIdentityType

ToPtr returns a *ApimIdentityType pointing to the current value.

type ApimResource 

type ApimResource struct {
	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type for API Management resource is set to Microsoft.ApiManagement.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApimResource - The Resource definition.

func (ApimResource) MarshalJSON 

func (a ApimResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApimResource.

type AppType 

type AppType string
const (
	// AppTypeDeveloperPortal - User create request was sent by new developer portal.
	AppTypeDeveloperPortal AppType = "developerPortal"
	// AppTypePortal - User create request was sent by legacy developer portal.
	AppTypePortal AppType = "portal"
)

func PossibleAppTypeValues 

func PossibleAppTypeValues() []AppType

PossibleAppTypeValues returns the possible values for the AppType const type.

func (AppType) ToPtr 

func (c AppType) ToPtr() *AppType

ToPtr returns a *AppType pointing to the current value.

type ArmIDWrapper 

type ArmIDWrapper struct {
	// READ-ONLY
	ID *string `json:"id,omitempty" azure:"ro"`
}

ArmIDWrapper - A wrapper for an ARM resource id

type AssociationContract 

type AssociationContract struct {
	Resource
	// Association entity contract properties.
	Properties *AssociationContractProperties `json:"properties,omitempty"`
}

AssociationContract - Association entity details.

func (AssociationContract) MarshalJSON 

func (a AssociationContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AssociationContract.

type AssociationContractProperties 

type AssociationContractProperties struct {
	// Provisioning state.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

AssociationContractProperties - Association entity contract properties.

type AsyncOperationStatus 

type AsyncOperationStatus string

AsyncOperationStatus - Status of an async operation. 

const (
	AsyncOperationStatusStarted    AsyncOperationStatus = "Started"
	AsyncOperationStatusInProgress AsyncOperationStatus = "InProgress"
	AsyncOperationStatusSucceeded  AsyncOperationStatus = "Succeeded"
	AsyncOperationStatusFailed     AsyncOperationStatus = "Failed"
)

func PossibleAsyncOperationStatusValues 

func PossibleAsyncOperationStatusValues() []AsyncOperationStatus

PossibleAsyncOperationStatusValues returns the possible values for the AsyncOperationStatus const type.

func (AsyncOperationStatus) ToPtr 

func (c AsyncOperationStatus) ToPtr() *AsyncOperationStatus

ToPtr returns a *AsyncOperationStatus pointing to the current value.

type AuthenticationSettingsContract 

type AuthenticationSettingsContract struct {
	// OAuth2 Authentication settings
	OAuth2 *OAuth2AuthenticationSettingsContract `json:"oAuth2,omitempty"`

	// OpenID Connect Authentication Settings
	Openid *OpenIDAuthenticationSettingsContract `json:"openid,omitempty"`
}

AuthenticationSettingsContract - API Authentication Settings.

type AuthorizationMethod 

type AuthorizationMethod string
const (
	AuthorizationMethodHEAD    AuthorizationMethod = "HEAD"
	AuthorizationMethodOPTIONS AuthorizationMethod = "OPTIONS"
	AuthorizationMethodTRACE   AuthorizationMethod = "TRACE"
	AuthorizationMethodGET     AuthorizationMethod = "GET"
	AuthorizationMethodPOST    AuthorizationMethod = "POST"
	AuthorizationMethodPUT     AuthorizationMethod = "PUT"
	AuthorizationMethodPATCH   AuthorizationMethod = "PATCH"
	AuthorizationMethodDELETE  AuthorizationMethod = "DELETE"
)

func PossibleAuthorizationMethodValues 

func PossibleAuthorizationMethodValues() []AuthorizationMethod

PossibleAuthorizationMethodValues returns the possible values for the AuthorizationMethod const type.

func (AuthorizationMethod) ToPtr 

func (c AuthorizationMethod) ToPtr() *AuthorizationMethod

ToPtr returns a *AuthorizationMethod pointing to the current value.

type AuthorizationServerClient 

type AuthorizationServerClient struct {
	// contains filtered or unexported fields
}

AuthorizationServerClient contains the methods for the AuthorizationServer group. Don't use this type directly, use NewAuthorizationServerClient() instead.

func NewAuthorizationServerClient 

func NewAuthorizationServerClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AuthorizationServerClient

NewAuthorizationServerClient creates a new instance of AuthorizationServerClient with the specified values.

func (*AuthorizationServerClient) CreateOrUpdate 

func (client *AuthorizationServerClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, authsid string, parameters AuthorizationServerContract, options *AuthorizationServerCreateOrUpdateOptions) (AuthorizationServerCreateOrUpdateResponse, error)

CreateOrUpdate - Creates new authorization server or updates an existing authorization server. If the operation fails it returns the *ErrorResponse error type.

func (*AuthorizationServerClient) Delete 

func (client *AuthorizationServerClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, authsid string, ifMatch string, options *AuthorizationServerDeleteOptions) (AuthorizationServerDeleteResponse, error)

Delete - Deletes specific authorization server instance. If the operation fails it returns the *ErrorResponse error type.

func (*AuthorizationServerClient) Get 

func (client *AuthorizationServerClient) Get(ctx context.Context, resourceGroupName string, serviceName string, authsid string, options *AuthorizationServerGetOptions) (AuthorizationServerGetResponse, error)

Get - Gets the details of the authorization server specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*AuthorizationServerClient) GetEntityTag 

func (client *AuthorizationServerClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, authsid string, options *AuthorizationServerGetEntityTagOptions) (AuthorizationServerGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the authorizationServer specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*AuthorizationServerClient) ListByService 

func (client *AuthorizationServerClient) ListByService(resourceGroupName string, serviceName string, options *AuthorizationServerListByServiceOptions) *AuthorizationServerListByServicePager

ListByService - Lists a collection of authorization servers defined within a service instance. If the operation fails it returns the *ErrorResponse error type.

func (*AuthorizationServerClient) ListSecrets 

func (client *AuthorizationServerClient) ListSecrets(ctx context.Context, resourceGroupName string, serviceName string, authsid string, options *AuthorizationServerListSecretsOptions) (AuthorizationServerListSecretsResponse, error)

ListSecrets - Gets the client secret details of the authorization server. If the operation fails it returns the *ErrorResponse error type.

func (*AuthorizationServerClient) Update 

func (client *AuthorizationServerClient) Update(ctx context.Context, resourceGroupName string, serviceName string, authsid string, ifMatch string, parameters AuthorizationServerUpdateContract, options *AuthorizationServerUpdateOptions) (AuthorizationServerUpdateResponse, error)

Update - Updates the details of the authorization server specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type AuthorizationServerCollection 

type AuthorizationServerCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*AuthorizationServerContract `json:"value,omitempty"`
}

AuthorizationServerCollection - Paged OAuth2 Authorization Servers list representation.

func (AuthorizationServerCollection) MarshalJSON 

func (a AuthorizationServerCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizationServerCollection.

type AuthorizationServerContract 

type AuthorizationServerContract struct {
	Resource
	// Properties of the External OAuth authorization server Contract.
	Properties *AuthorizationServerContractProperties `json:"properties,omitempty"`
}

AuthorizationServerContract - External OAuth authorization server settings.

func (AuthorizationServerContract) MarshalJSON 

func (a AuthorizationServerContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizationServerContract.

type AuthorizationServerContractBaseProperties 

type AuthorizationServerContractBaseProperties struct {
	// HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
	AuthorizationMethods []*AuthorizationMethod `json:"authorizationMethods,omitempty"`

	// Specifies the mechanism by which access token is passed to the API.
	BearerTokenSendingMethods []*BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`

	// Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified,
	// client credentials and other parameters are passed
	// within the request body in the application/x-www-form-urlencoded format.
	ClientAuthenticationMethod []*ClientAuthenticationMethod `json:"clientAuthenticationMethod,omitempty"`

	// Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing
	// space-delimited values.
	DefaultScope *string `json:"defaultScope,omitempty"`

	// Description of the authorization server. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`

	// Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
	ResourceOwnerPassword *string `json:"resourceOwnerPassword,omitempty"`

	// Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
	ResourceOwnerUsername *string `json:"resourceOwnerUsername,omitempty"`

	// If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol
	// security.
	SupportState *bool `json:"supportState,omitempty"`

	// Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string
	// properties, i.e. {"name" : "name value", "value":
	// "a value"}.
	TokenBodyParameters []*TokenBodyParameterContract `json:"tokenBodyParameters,omitempty"`

	// OAuth token endpoint. Contains absolute URI to entity being referenced.
	TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
}

AuthorizationServerContractBaseProperties - External OAuth authorization server Update settings contract.

func (AuthorizationServerContractBaseProperties) MarshalJSON 

func (a AuthorizationServerContractBaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizationServerContractBaseProperties.

type AuthorizationServerContractProperties 

type AuthorizationServerContractProperties struct {
	AuthorizationServerContractBaseProperties
	// REQUIRED; OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
	AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`

	// REQUIRED; Client or app id registered with this authorization server.
	ClientID *string `json:"clientId,omitempty"`

	// REQUIRED; Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being
	// referenced.
	ClientRegistrationEndpoint *string `json:"clientRegistrationEndpoint,omitempty"`

	// REQUIRED; User-friendly authorization server name.
	DisplayName *string `json:"displayName,omitempty"`

	// REQUIRED; Form of an authorization grant, which the client uses to request the access token.
	GrantTypes []*GrantType `json:"grantTypes,omitempty"`

	// Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request
	// to get the value.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

AuthorizationServerContractProperties - External OAuth authorization server settings Properties.

func (AuthorizationServerContractProperties) MarshalJSON 

func (a AuthorizationServerContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizationServerContractProperties.

type AuthorizationServerCreateOrUpdateOptions 

type AuthorizationServerCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

AuthorizationServerCreateOrUpdateOptions contains the optional parameters for the AuthorizationServer.CreateOrUpdate method.

type AuthorizationServerCreateOrUpdateResponse 

type AuthorizationServerCreateOrUpdateResponse struct {
	AuthorizationServerCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AuthorizationServerCreateOrUpdateResponse contains the response from method AuthorizationServer.CreateOrUpdate.

type AuthorizationServerCreateOrUpdateResult 

type AuthorizationServerCreateOrUpdateResult struct {
	AuthorizationServerContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

AuthorizationServerCreateOrUpdateResult contains the result from method AuthorizationServer.CreateOrUpdate.

type AuthorizationServerDeleteOptions 

type AuthorizationServerDeleteOptions struct {
}

AuthorizationServerDeleteOptions contains the optional parameters for the AuthorizationServer.Delete method.

type AuthorizationServerDeleteResponse 

type AuthorizationServerDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AuthorizationServerDeleteResponse contains the response from method AuthorizationServer.Delete.

type AuthorizationServerGetEntityTagOptions 

type AuthorizationServerGetEntityTagOptions struct {
}

AuthorizationServerGetEntityTagOptions contains the optional parameters for the AuthorizationServer.GetEntityTag method.

type AuthorizationServerGetEntityTagResponse 

type AuthorizationServerGetEntityTagResponse struct {
	AuthorizationServerGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AuthorizationServerGetEntityTagResponse contains the response from method AuthorizationServer.GetEntityTag.

type AuthorizationServerGetEntityTagResult 

type AuthorizationServerGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

AuthorizationServerGetEntityTagResult contains the result from method AuthorizationServer.GetEntityTag.

type AuthorizationServerGetOptions 

type AuthorizationServerGetOptions struct {
}

AuthorizationServerGetOptions contains the optional parameters for the AuthorizationServer.Get method.

type AuthorizationServerGetResponse 

type AuthorizationServerGetResponse struct {
	AuthorizationServerGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AuthorizationServerGetResponse contains the response from method AuthorizationServer.Get.

type AuthorizationServerGetResult 

type AuthorizationServerGetResult struct {
	AuthorizationServerContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

AuthorizationServerGetResult contains the result from method AuthorizationServer.Get.

type AuthorizationServerListByServiceOptions 

type AuthorizationServerListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

AuthorizationServerListByServiceOptions contains the optional parameters for the AuthorizationServer.ListByService method.

type AuthorizationServerListByServicePager 

type AuthorizationServerListByServicePager struct {
	// contains filtered or unexported fields
}

AuthorizationServerListByServicePager provides operations for iterating over paged responses.

func (*AuthorizationServerListByServicePager) Err 

func (p *AuthorizationServerListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*AuthorizationServerListByServicePager) NextPage 

func (p *AuthorizationServerListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AuthorizationServerListByServicePager) PageResponse 

func (p *AuthorizationServerListByServicePager) PageResponse() AuthorizationServerListByServiceResponse

PageResponse returns the current AuthorizationServerListByServiceResponse page.

type AuthorizationServerListByServiceResponse 

type AuthorizationServerListByServiceResponse struct {
	AuthorizationServerListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AuthorizationServerListByServiceResponse contains the response from method AuthorizationServer.ListByService.

type AuthorizationServerListByServiceResult 

type AuthorizationServerListByServiceResult struct {
	AuthorizationServerCollection
}

AuthorizationServerListByServiceResult contains the result from method AuthorizationServer.ListByService.

type AuthorizationServerListSecretsOptions 

type AuthorizationServerListSecretsOptions struct {
}

AuthorizationServerListSecretsOptions contains the optional parameters for the AuthorizationServer.ListSecrets method.

type AuthorizationServerListSecretsResponse 

type AuthorizationServerListSecretsResponse struct {
	AuthorizationServerListSecretsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AuthorizationServerListSecretsResponse contains the response from method AuthorizationServer.ListSecrets.

type AuthorizationServerListSecretsResult 

type AuthorizationServerListSecretsResult struct {
	AuthorizationServerSecretsContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

AuthorizationServerListSecretsResult contains the result from method AuthorizationServer.ListSecrets.

type AuthorizationServerSecretsContract 

type AuthorizationServerSecretsContract struct {
	// oAuth Authorization Server Secrets.
	ClientSecret *string `json:"clientSecret,omitempty"`

	// Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
	ResourceOwnerPassword *string `json:"resourceOwnerPassword,omitempty"`

	// Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
	ResourceOwnerUsername *string `json:"resourceOwnerUsername,omitempty"`
}

AuthorizationServerSecretsContract - OAuth Server Secrets Contract.

type AuthorizationServerUpdateContract 

type AuthorizationServerUpdateContract struct {
	Resource
	// Properties of the External OAuth authorization server update Contract.
	Properties *AuthorizationServerUpdateContractProperties `json:"properties,omitempty"`
}

AuthorizationServerUpdateContract - External OAuth authorization server settings.

func (AuthorizationServerUpdateContract) MarshalJSON 

func (a AuthorizationServerUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizationServerUpdateContract.

type AuthorizationServerUpdateContractProperties 

type AuthorizationServerUpdateContractProperties struct {
	AuthorizationServerContractBaseProperties
	// OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
	AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`

	// Client or app id registered with this authorization server.
	ClientID *string `json:"clientId,omitempty"`

	// Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
	ClientRegistrationEndpoint *string `json:"clientRegistrationEndpoint,omitempty"`

	// Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request
	// to get the value.
	ClientSecret *string `json:"clientSecret,omitempty"`

	// User-friendly authorization server name.
	DisplayName *string `json:"displayName,omitempty"`

	// Form of an authorization grant, which the client uses to request the access token.
	GrantTypes []*GrantType `json:"grantTypes,omitempty"`
}

AuthorizationServerUpdateContractProperties - External OAuth authorization server Update settings contract.

func (AuthorizationServerUpdateContractProperties) MarshalJSON 

func (a AuthorizationServerUpdateContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizationServerUpdateContractProperties.

type AuthorizationServerUpdateOptions 

type AuthorizationServerUpdateOptions struct {
}

AuthorizationServerUpdateOptions contains the optional parameters for the AuthorizationServer.Update method.

type AuthorizationServerUpdateResponse 

type AuthorizationServerUpdateResponse struct {
	AuthorizationServerUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AuthorizationServerUpdateResponse contains the response from method AuthorizationServer.Update.

type AuthorizationServerUpdateResult 

type AuthorizationServerUpdateResult struct {
	AuthorizationServerContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

AuthorizationServerUpdateResult contains the result from method AuthorizationServer.Update.

type BackendAuthorizationHeaderCredentials 

type BackendAuthorizationHeaderCredentials struct {
	// REQUIRED; Authentication Parameter value.
	Parameter *string `json:"parameter,omitempty"`

	// REQUIRED; Authentication Scheme name.
	Scheme *string `json:"scheme,omitempty"`
}

BackendAuthorizationHeaderCredentials - Authorization header information.

type BackendBaseParameters 

type BackendBaseParameters struct {
	// Backend Credentials Contract Properties
	Credentials *BackendCredentialsContract `json:"credentials,omitempty"`

	// Backend Description.
	Description *string `json:"description,omitempty"`

	// Backend Properties contract
	Properties *BackendProperties `json:"properties,omitempty"`

	// Backend Proxy Contract Properties
	Proxy *BackendProxyContract `json:"proxy,omitempty"`

	// Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
	ResourceID *string `json:"resourceId,omitempty"`

	// Backend TLS Properties
	TLS *BackendTLSProperties `json:"tls,omitempty"`

	// Backend Title.
	Title *string `json:"title,omitempty"`
}

BackendBaseParameters - Backend entity base Parameter set.

type BackendClient 

type BackendClient struct {
	// contains filtered or unexported fields
}

BackendClient contains the methods for the Backend group. Don't use this type directly, use NewBackendClient() instead.

func NewBackendClient 

func NewBackendClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *BackendClient

NewBackendClient creates a new instance of BackendClient with the specified values.

func (*BackendClient) CreateOrUpdate 

func (client *BackendClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, backendID string, parameters BackendContract, options *BackendCreateOrUpdateOptions) (BackendCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or Updates a backend. If the operation fails it returns the *ErrorResponse error type.

func (*BackendClient) Delete 

func (client *BackendClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, backendID string, ifMatch string, options *BackendDeleteOptions) (BackendDeleteResponse, error)

Delete - Deletes the specified backend. If the operation fails it returns the *ErrorResponse error type.

func (*BackendClient) Get 

func (client *BackendClient) Get(ctx context.Context, resourceGroupName string, serviceName string, backendID string, options *BackendGetOptions) (BackendGetResponse, error)

Get - Gets the details of the backend specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*BackendClient) GetEntityTag 

func (client *BackendClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, backendID string, options *BackendGetEntityTagOptions) (BackendGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the backend specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*BackendClient) ListByService 

func (client *BackendClient) ListByService(resourceGroupName string, serviceName string, options *BackendListByServiceOptions) *BackendListByServicePager

ListByService - Lists a collection of backends in the specified service instance. If the operation fails it returns the *ErrorResponse error type.

func (*BackendClient) Reconnect 

func (client *BackendClient) Reconnect(ctx context.Context, resourceGroupName string, serviceName string, backendID string, options *BackendReconnectOptions) (BackendReconnectResponse, error)

Reconnect - Notifies the APIM proxy to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used. If the operation fails it returns the *ErrorResponse error type.

func (*BackendClient) Update 

func (client *BackendClient) Update(ctx context.Context, resourceGroupName string, serviceName string, backendID string, ifMatch string, parameters BackendUpdateParameters, options *BackendUpdateOptions) (BackendUpdateResponse, error)

Update - Updates an existing backend. If the operation fails it returns the *ErrorResponse error type.

type BackendCollection 

type BackendCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Backend values.
	Value []*BackendContract `json:"value,omitempty"`
}

BackendCollection - Paged Backend list representation.

func (BackendCollection) MarshalJSON 

func (b BackendCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackendCollection.

type BackendContract 

type BackendContract struct {
	Resource
	// Backend entity contract properties.
	Properties *BackendContractProperties `json:"properties,omitempty"`
}

BackendContract - Backend details.

func (BackendContract) MarshalJSON 

func (b BackendContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackendContract.

type BackendContractProperties 

type BackendContractProperties struct {
	BackendBaseParameters
	// REQUIRED; Backend communication protocol.
	Protocol *BackendProtocol `json:"protocol,omitempty"`

	// REQUIRED; Runtime Url of the Backend.
	URL *string `json:"url,omitempty"`
}

BackendContractProperties - Parameters supplied to the Create Backend operation.

type BackendCreateOrUpdateOptions 

type BackendCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

BackendCreateOrUpdateOptions contains the optional parameters for the Backend.CreateOrUpdate method.

type BackendCreateOrUpdateResponse 

type BackendCreateOrUpdateResponse struct {
	BackendCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BackendCreateOrUpdateResponse contains the response from method Backend.CreateOrUpdate.

type BackendCreateOrUpdateResult 

type BackendCreateOrUpdateResult struct {
	BackendContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

BackendCreateOrUpdateResult contains the result from method Backend.CreateOrUpdate.

type BackendCredentialsContract 

type BackendCredentialsContract struct {
	// Authorization header authentication
	Authorization *BackendAuthorizationHeaderCredentials `json:"authorization,omitempty"`

	// List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
	Certificate []*string `json:"certificate,omitempty"`

	// List of Client Certificate Ids.
	CertificateIDs []*string `json:"certificateIds,omitempty"`

	// Header Parameter description.
	Header map[string][]*string `json:"header,omitempty"`

	// Query Parameter description.
	Query map[string][]*string `json:"query,omitempty"`
}

BackendCredentialsContract - Details of the Credentials used to connect to Backend.

func (BackendCredentialsContract) MarshalJSON 

func (b BackendCredentialsContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackendCredentialsContract.

type BackendDeleteOptions 

type BackendDeleteOptions struct {
}

BackendDeleteOptions contains the optional parameters for the Backend.Delete method.

type BackendDeleteResponse 

type BackendDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BackendDeleteResponse contains the response from method Backend.Delete.

type BackendGetEntityTagOptions 

type BackendGetEntityTagOptions struct {
}

BackendGetEntityTagOptions contains the optional parameters for the Backend.GetEntityTag method.

type BackendGetEntityTagResponse 

type BackendGetEntityTagResponse struct {
	BackendGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BackendGetEntityTagResponse contains the response from method Backend.GetEntityTag.

type BackendGetEntityTagResult 

type BackendGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

BackendGetEntityTagResult contains the result from method Backend.GetEntityTag.

type BackendGetOptions 

type BackendGetOptions struct {
}

BackendGetOptions contains the optional parameters for the Backend.Get method.

type BackendGetResponse 

type BackendGetResponse struct {
	BackendGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BackendGetResponse contains the response from method Backend.Get.

type BackendGetResult 

type BackendGetResult struct {
	BackendContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

BackendGetResult contains the result from method Backend.Get.

type BackendListByServiceOptions 

type BackendListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

BackendListByServiceOptions contains the optional parameters for the Backend.ListByService method.

type BackendListByServicePager 

type BackendListByServicePager struct {
	// contains filtered or unexported fields
}

BackendListByServicePager provides operations for iterating over paged responses.

func (*BackendListByServicePager) Err 

func (p *BackendListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*BackendListByServicePager) NextPage 

func (p *BackendListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*BackendListByServicePager) PageResponse 

func (p *BackendListByServicePager) PageResponse() BackendListByServiceResponse

PageResponse returns the current BackendListByServiceResponse page.

type BackendListByServiceResponse 

type BackendListByServiceResponse struct {
	BackendListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BackendListByServiceResponse contains the response from method Backend.ListByService.

type BackendListByServiceResult 

type BackendListByServiceResult struct {
	BackendCollection
}

BackendListByServiceResult contains the result from method Backend.ListByService.

type BackendProperties 

type BackendProperties struct {
	// Backend Service Fabric Cluster Properties
	ServiceFabricCluster *BackendServiceFabricClusterProperties `json:"serviceFabricCluster,omitempty"`
}

BackendProperties - Properties specific to the Backend Type.

type BackendProtocol 

type BackendProtocol string

BackendProtocol - Backend communication protocol. 

const (
	// BackendProtocolHTTP - The Backend is a RESTful service.
	BackendProtocolHTTP BackendProtocol = "http"
	// BackendProtocolSoap - The Backend is a SOAP service.
	BackendProtocolSoap BackendProtocol = "soap"
)

func PossibleBackendProtocolValues 

func PossibleBackendProtocolValues() []BackendProtocol

PossibleBackendProtocolValues returns the possible values for the BackendProtocol const type.

func (BackendProtocol) ToPtr 

func (c BackendProtocol) ToPtr() *BackendProtocol

ToPtr returns a *BackendProtocol pointing to the current value.

type BackendProxyContract 

type BackendProxyContract struct {
	// REQUIRED; WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
	URL *string `json:"url,omitempty"`

	// Password to connect to the WebProxy Server
	Password *string `json:"password,omitempty"`

	// Username to connect to the WebProxy server
	Username *string `json:"username,omitempty"`
}

BackendProxyContract - Details of the Backend WebProxy Server to use in the Request to Backend.

type BackendReconnectContract 

type BackendReconnectContract struct {
	Resource
	// Reconnect request properties.
	Properties *BackendReconnectProperties `json:"properties,omitempty"`
}

BackendReconnectContract - Reconnect request parameters.

func (BackendReconnectContract) MarshalJSON 

func (b BackendReconnectContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackendReconnectContract.

type BackendReconnectOptions 

type BackendReconnectOptions struct {
	// Reconnect request parameters.
	Parameters *BackendReconnectContract
}

BackendReconnectOptions contains the optional parameters for the Backend.Reconnect method.

type BackendReconnectProperties 

type BackendReconnectProperties struct {
	// Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M.
	After *string `json:"after,omitempty"`
}

BackendReconnectProperties - Properties to control reconnect requests.

type BackendReconnectResponse 

type BackendReconnectResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BackendReconnectResponse contains the response from method Backend.Reconnect.

type BackendServiceFabricClusterProperties 

type BackendServiceFabricClusterProperties struct {
	// REQUIRED; The cluster management endpoint.
	ManagementEndpoints []*string `json:"managementEndpoints,omitempty"`

	// The client certificate id for the management endpoint.
	ClientCertificateID *string `json:"clientCertificateId,omitempty"`

	// The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
	ClientCertificatethumbprint *string `json:"clientCertificatethumbprint,omitempty"`

	// Maximum number of retries while attempting resolve the partition.
	MaxPartitionResolutionRetries *int32 `json:"maxPartitionResolutionRetries,omitempty"`

	// Thumbprints of certificates cluster management service uses for tls communication
	ServerCertificateThumbprints []*string `json:"serverCertificateThumbprints,omitempty"`

	// Server X509 Certificate Names Collection
	ServerX509Names []*X509CertificateName `json:"serverX509Names,omitempty"`
}

BackendServiceFabricClusterProperties - Properties of the Service Fabric Type Backend.

func (BackendServiceFabricClusterProperties) MarshalJSON 

func (b BackendServiceFabricClusterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackendServiceFabricClusterProperties.

type BackendTLSProperties 

type BackendTLSProperties struct {
	// Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
	ValidateCertificateChain *bool `json:"validateCertificateChain,omitempty"`

	// Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
	ValidateCertificateName *bool `json:"validateCertificateName,omitempty"`
}

BackendTLSProperties - Properties controlling TLS Certificate Validation.

type BackendUpdateOptions 

type BackendUpdateOptions struct {
}

BackendUpdateOptions contains the optional parameters for the Backend.Update method.

type BackendUpdateParameterProperties 

type BackendUpdateParameterProperties struct {
	BackendBaseParameters
	// Backend communication protocol.
	Protocol *BackendProtocol `json:"protocol,omitempty"`

	// Runtime Url of the Backend.
	URL *string `json:"url,omitempty"`
}

BackendUpdateParameterProperties - Parameters supplied to the Update Backend operation.

type BackendUpdateParameters 

type BackendUpdateParameters struct {
	// Backend entity update contract properties.
	Properties *BackendUpdateParameterProperties `json:"properties,omitempty"`
}

BackendUpdateParameters - Backend update parameters.

func (BackendUpdateParameters) MarshalJSON 

func (b BackendUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackendUpdateParameters.

type BackendUpdateResponse 

type BackendUpdateResponse struct {
	BackendUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BackendUpdateResponse contains the response from method Backend.Update.

type BackendUpdateResult 

type BackendUpdateResult struct {
	BackendContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

BackendUpdateResult contains the result from method Backend.Update.

type BearerTokenSendingMethod 

type BearerTokenSendingMethod string
const (
	BearerTokenSendingMethodAuthorizationHeader BearerTokenSendingMethod = "authorizationHeader"
	BearerTokenSendingMethodQuery               BearerTokenSendingMethod = "query"
)

func PossibleBearerTokenSendingMethodValues 

func PossibleBearerTokenSendingMethodValues() []BearerTokenSendingMethod

PossibleBearerTokenSendingMethodValues returns the possible values for the BearerTokenSendingMethod const type.

func (BearerTokenSendingMethod) ToPtr 

func (c BearerTokenSendingMethod) ToPtr() *BearerTokenSendingMethod

ToPtr returns a *BearerTokenSendingMethod pointing to the current value.

type BearerTokenSendingMethods 

type BearerTokenSendingMethods string

BearerTokenSendingMethods - Form of an authorization grant, which the client uses to request the access token. 

const (
	// BearerTokenSendingMethodsAuthorizationHeader - Access token will be transmitted in the Authorization header using Bearer schema
	BearerTokenSendingMethodsAuthorizationHeader BearerTokenSendingMethods = "authorizationHeader"
	// BearerTokenSendingMethodsQuery - Access token will be transmitted as query parameters.
	BearerTokenSendingMethodsQuery BearerTokenSendingMethods = "query"
)

func PossibleBearerTokenSendingMethodsValues 

func PossibleBearerTokenSendingMethodsValues() []BearerTokenSendingMethods

PossibleBearerTokenSendingMethodsValues returns the possible values for the BearerTokenSendingMethods const type.

func (BearerTokenSendingMethods) ToPtr 

func (c BearerTokenSendingMethods) ToPtr() *BearerTokenSendingMethods

ToPtr returns a *BearerTokenSendingMethods pointing to the current value.

type BodyDiagnosticSettings 

type BodyDiagnosticSettings struct {
	// Number of request body bytes to log.
	Bytes *int32 `json:"bytes,omitempty"`
}

BodyDiagnosticSettings - Body logging settings.

type CacheClient 

type CacheClient struct {
	// contains filtered or unexported fields
}

CacheClient contains the methods for the Cache group. Don't use this type directly, use NewCacheClient() instead.

func NewCacheClient 

func NewCacheClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *CacheClient

NewCacheClient creates a new instance of CacheClient with the specified values.

func (*CacheClient) CreateOrUpdate 

func (client *CacheClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, cacheID string, parameters CacheContract, options *CacheCreateOrUpdateOptions) (CacheCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates an External Cache to be used in Api Management instance. If the operation fails it returns the *ErrorResponse error type.

func (*CacheClient) Delete 

func (client *CacheClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, cacheID string, ifMatch string, options *CacheDeleteOptions) (CacheDeleteResponse, error)

Delete - Deletes specific Cache. If the operation fails it returns the *ErrorResponse error type.

func (*CacheClient) Get 

func (client *CacheClient) Get(ctx context.Context, resourceGroupName string, serviceName string, cacheID string, options *CacheGetOptions) (CacheGetResponse, error)

Get - Gets the details of the Cache specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*CacheClient) GetEntityTag 

func (client *CacheClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, cacheID string, options *CacheGetEntityTagOptions) (CacheGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the Cache specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*CacheClient) ListByService 

func (client *CacheClient) ListByService(resourceGroupName string, serviceName string, options *CacheListByServiceOptions) *CacheListByServicePager

ListByService - Lists a collection of all external Caches in the specified service instance. If the operation fails it returns the *ErrorResponse error type.

func (*CacheClient) Update 

func (client *CacheClient) Update(ctx context.Context, resourceGroupName string, serviceName string, cacheID string, ifMatch string, parameters CacheUpdateParameters, options *CacheUpdateOptions) (CacheUpdateResponse, error)

Update - Updates the details of the cache specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type CacheCollection 

type CacheCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*CacheContract `json:"value,omitempty"`
}

CacheCollection - Paged Caches list representation.

func (CacheCollection) MarshalJSON 

func (c CacheCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CacheCollection.

type CacheContract 

type CacheContract struct {
	Resource
	// Cache properties details.
	Properties *CacheContractProperties `json:"properties,omitempty"`
}

CacheContract - Cache details.

func (CacheContract) MarshalJSON 

func (c CacheContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CacheContract.

type CacheContractProperties 

type CacheContractProperties struct {
	// REQUIRED; Runtime connection string to cache
	ConnectionString *string `json:"connectionString,omitempty"`

	// REQUIRED; Location identifier to use cache from (should be either 'default' or valid Azure region identifier)
	UseFromLocation *string `json:"useFromLocation,omitempty"`

	// Cache description
	Description *string `json:"description,omitempty"`

	// Original uri of entity in external system cache points to
	ResourceID *string `json:"resourceId,omitempty"`
}

CacheContractProperties - Properties of the Cache contract.

type CacheCreateOrUpdateOptions 

type CacheCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

CacheCreateOrUpdateOptions contains the optional parameters for the Cache.CreateOrUpdate method.

type CacheCreateOrUpdateResponse 

type CacheCreateOrUpdateResponse struct {
	CacheCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CacheCreateOrUpdateResponse contains the response from method Cache.CreateOrUpdate.

type CacheCreateOrUpdateResult 

type CacheCreateOrUpdateResult struct {
	CacheContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

CacheCreateOrUpdateResult contains the result from method Cache.CreateOrUpdate.

type CacheDeleteOptions 

type CacheDeleteOptions struct {
}

CacheDeleteOptions contains the optional parameters for the Cache.Delete method.

type CacheDeleteResponse 

type CacheDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CacheDeleteResponse contains the response from method Cache.Delete.

type CacheGetEntityTagOptions 

type CacheGetEntityTagOptions struct {
}

CacheGetEntityTagOptions contains the optional parameters for the Cache.GetEntityTag method.

type CacheGetEntityTagResponse 

type CacheGetEntityTagResponse struct {
	CacheGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CacheGetEntityTagResponse contains the response from method Cache.GetEntityTag.

type CacheGetEntityTagResult 

type CacheGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

CacheGetEntityTagResult contains the result from method Cache.GetEntityTag.

type CacheGetOptions 

type CacheGetOptions struct {
}

CacheGetOptions contains the optional parameters for the Cache.Get method.

type CacheGetResponse 

type CacheGetResponse struct {
	CacheGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CacheGetResponse contains the response from method Cache.Get.

type CacheGetResult 

type CacheGetResult struct {
	CacheContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

CacheGetResult contains the result from method Cache.Get.

type CacheListByServiceOptions 

type CacheListByServiceOptions struct {
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

CacheListByServiceOptions contains the optional parameters for the Cache.ListByService method.

type CacheListByServicePager 

type CacheListByServicePager struct {
	// contains filtered or unexported fields
}

CacheListByServicePager provides operations for iterating over paged responses.

func (*CacheListByServicePager) Err 

func (p *CacheListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*CacheListByServicePager) NextPage 

func (p *CacheListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*CacheListByServicePager) PageResponse 

func (p *CacheListByServicePager) PageResponse() CacheListByServiceResponse

PageResponse returns the current CacheListByServiceResponse page.

type CacheListByServiceResponse 

type CacheListByServiceResponse struct {
	CacheListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CacheListByServiceResponse contains the response from method Cache.ListByService.

type CacheListByServiceResult 

type CacheListByServiceResult struct {
	CacheCollection
}

CacheListByServiceResult contains the result from method Cache.ListByService.

type CacheUpdateOptions 

type CacheUpdateOptions struct {
}

CacheUpdateOptions contains the optional parameters for the Cache.Update method.

type CacheUpdateParameters 

type CacheUpdateParameters struct {
	// Cache update properties details.
	Properties *CacheUpdateProperties `json:"properties,omitempty"`
}

CacheUpdateParameters - Cache update details.

func (CacheUpdateParameters) MarshalJSON 

func (c CacheUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CacheUpdateParameters.

type CacheUpdateProperties 

type CacheUpdateProperties struct {
	// Runtime connection string to cache
	ConnectionString *string `json:"connectionString,omitempty"`

	// Cache description
	Description *string `json:"description,omitempty"`

	// Original uri of entity in external system cache points to
	ResourceID *string `json:"resourceId,omitempty"`

	// Location identifier to use cache from (should be either 'default' or valid Azure region identifier)
	UseFromLocation *string `json:"useFromLocation,omitempty"`
}

CacheUpdateProperties - Parameters supplied to the Update Cache operation.

type CacheUpdateResponse 

type CacheUpdateResponse struct {
	CacheUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CacheUpdateResponse contains the response from method Cache.Update.

type CacheUpdateResult 

type CacheUpdateResult struct {
	CacheContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

CacheUpdateResult contains the result from method Cache.Update.

type CertificateClient 

type CertificateClient struct {
	// contains filtered or unexported fields
}

CertificateClient contains the methods for the Certificate group. Don't use this type directly, use NewCertificateClient() instead.

func NewCertificateClient 

func NewCertificateClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *CertificateClient

NewCertificateClient creates a new instance of CertificateClient with the specified values.

func (*CertificateClient) CreateOrUpdate 

func (client *CertificateClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, parameters CertificateCreateOrUpdateParameters, options *CertificateCreateOrUpdateOptions) (CertificateCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the certificate being used for authentication with the backend. If the operation fails it returns the *ErrorResponse error type.

func (*CertificateClient) Delete 

func (client *CertificateClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, ifMatch string, options *CertificateDeleteOptions) (CertificateDeleteResponse, error)

Delete - Deletes specific certificate. If the operation fails it returns the *ErrorResponse error type.

func (*CertificateClient) Get 

func (client *CertificateClient) Get(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, options *CertificateGetOptions) (CertificateGetResponse, error)

Get - Gets the details of the certificate specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*CertificateClient) GetEntityTag 

func (client *CertificateClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, options *CertificateGetEntityTagOptions) (CertificateGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the certificate specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*CertificateClient) ListByService 

func (client *CertificateClient) ListByService(resourceGroupName string, serviceName string, options *CertificateListByServiceOptions) *CertificateListByServicePager

ListByService - Lists a collection of all certificates in the specified service instance. If the operation fails it returns the *ErrorResponse error type.

func (*CertificateClient) RefreshSecret 

func (client *CertificateClient) RefreshSecret(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, options *CertificateRefreshSecretOptions) (CertificateRefreshSecretResponse, error)

RefreshSecret - From KeyVault, Refresh the certificate being used for authentication with the backend. If the operation fails it returns the *ErrorResponse error type.

type CertificateCollection 

type CertificateCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*CertificateContract `json:"value,omitempty"`
}

CertificateCollection - Paged Certificates list representation.

func (CertificateCollection) MarshalJSON 

func (c CertificateCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateCollection.

type CertificateConfiguration 

type CertificateConfiguration struct {
	// REQUIRED; The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
	StoreName *CertificateConfigurationStoreName `json:"storeName,omitempty"`

	// Certificate information.
	Certificate *CertificateInformation `json:"certificate,omitempty"`

	// Certificate Password.
	CertificatePassword *string `json:"certificatePassword,omitempty"`

	// Base64 Encoded certificate.
	EncodedCertificate *string `json:"encodedCertificate,omitempty"`
}

CertificateConfiguration - Certificate configuration which consist of non-trusted intermediates and root certificates.

type CertificateConfigurationStoreName 

type CertificateConfigurationStoreName string

CertificateConfigurationStoreName - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. 

const (
	CertificateConfigurationStoreNameCertificateAuthority CertificateConfigurationStoreName = "CertificateAuthority"
	CertificateConfigurationStoreNameRoot                 CertificateConfigurationStoreName = "Root"
)

func PossibleCertificateConfigurationStoreNameValues 

func PossibleCertificateConfigurationStoreNameValues() []CertificateConfigurationStoreName

PossibleCertificateConfigurationStoreNameValues returns the possible values for the CertificateConfigurationStoreName const type.

func (CertificateConfigurationStoreName) ToPtr 

func (c CertificateConfigurationStoreName) ToPtr() *CertificateConfigurationStoreName

ToPtr returns a *CertificateConfigurationStoreName pointing to the current value.

type CertificateContract 

type CertificateContract struct {
	Resource
	// Certificate properties details.
	Properties *CertificateContractProperties `json:"properties,omitempty"`
}

CertificateContract - Certificate details.

func (CertificateContract) MarshalJSON 

func (c CertificateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateContract.

type CertificateContractProperties 

type CertificateContractProperties struct {
	// REQUIRED; Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	ExpirationDate *time.Time `json:"expirationDate,omitempty"`

	// REQUIRED; Subject attribute of the certificate.
	Subject *string `json:"subject,omitempty"`

	// REQUIRED; Thumbprint of the certificate.
	Thumbprint *string `json:"thumbprint,omitempty"`

	// KeyVault location details of the certificate.
	KeyVault *KeyVaultContractProperties `json:"keyVault,omitempty"`
}

CertificateContractProperties - Properties of the Certificate contract.

func (CertificateContractProperties) MarshalJSON 

func (c CertificateContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateContractProperties.

func (*CertificateContractProperties) UnmarshalJSON 

func (c *CertificateContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateContractProperties.

type CertificateCreateOrUpdateOptions 

type CertificateCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

CertificateCreateOrUpdateOptions contains the optional parameters for the Certificate.CreateOrUpdate method.

type CertificateCreateOrUpdateParameters 

type CertificateCreateOrUpdateParameters struct {
	// Certificate create or update properties details.
	Properties *CertificateCreateOrUpdateProperties `json:"properties,omitempty"`
}

CertificateCreateOrUpdateParameters - Certificate create or update details.

type CertificateCreateOrUpdateProperties 

type CertificateCreateOrUpdateProperties struct {
	// Base 64 encoded certificate using the application/x-pkcs12 representation.
	Data *string `json:"data,omitempty"`

	// KeyVault location details of the certificate.
	KeyVault *KeyVaultContractCreateProperties `json:"keyVault,omitempty"`

	// Password for the Certificate
	Password *string `json:"password,omitempty"`
}

CertificateCreateOrUpdateProperties - Parameters supplied to the CreateOrUpdate certificate operation.

type CertificateCreateOrUpdateResponse 

type CertificateCreateOrUpdateResponse struct {
	CertificateCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificateCreateOrUpdateResponse contains the response from method Certificate.CreateOrUpdate.

type CertificateCreateOrUpdateResult 

type CertificateCreateOrUpdateResult struct {
	CertificateContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

CertificateCreateOrUpdateResult contains the result from method Certificate.CreateOrUpdate.

type CertificateDeleteOptions 

type CertificateDeleteOptions struct {
}

CertificateDeleteOptions contains the optional parameters for the Certificate.Delete method.

type CertificateDeleteResponse 

type CertificateDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificateDeleteResponse contains the response from method Certificate.Delete.

type CertificateGetEntityTagOptions 

type CertificateGetEntityTagOptions struct {
}

CertificateGetEntityTagOptions contains the optional parameters for the Certificate.GetEntityTag method.

type CertificateGetEntityTagResponse 

type CertificateGetEntityTagResponse struct {
	CertificateGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificateGetEntityTagResponse contains the response from method Certificate.GetEntityTag.

type CertificateGetEntityTagResult 

type CertificateGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

CertificateGetEntityTagResult contains the result from method Certificate.GetEntityTag.

type CertificateGetOptions 

type CertificateGetOptions struct {
}

CertificateGetOptions contains the optional parameters for the Certificate.Get method.

type CertificateGetResponse 

type CertificateGetResponse struct {
	CertificateGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificateGetResponse contains the response from method Certificate.Get.

type CertificateGetResult 

type CertificateGetResult struct {
	CertificateContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

CertificateGetResult contains the result from method Certificate.Get.

type CertificateInformation 

type CertificateInformation struct {
	// REQUIRED; Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	Expiry *time.Time `json:"expiry,omitempty"`

	// REQUIRED; Subject of the certificate.
	Subject *string `json:"subject,omitempty"`

	// REQUIRED; Thumbprint of the certificate.
	Thumbprint *string `json:"thumbprint,omitempty"`
}

CertificateInformation - SSL certificate information.

func (CertificateInformation) MarshalJSON 

func (c CertificateInformation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateInformation.

func (*CertificateInformation) UnmarshalJSON 

func (c *CertificateInformation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateInformation.

type CertificateListByServiceOptions 

type CertificateListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| expirationDate | filter | ge, le,
	// eq, ne, gt, lt | |</br>
	Filter *string
	// When set to true, the response contains only certificates entities which failed refresh.
	IsKeyVaultRefreshFailed *bool
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

CertificateListByServiceOptions contains the optional parameters for the Certificate.ListByService method.

type CertificateListByServicePager 

type CertificateListByServicePager struct {
	// contains filtered or unexported fields
}

CertificateListByServicePager provides operations for iterating over paged responses.

func (*CertificateListByServicePager) Err 

func (p *CertificateListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*CertificateListByServicePager) NextPage 

func (p *CertificateListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*CertificateListByServicePager) PageResponse 

func (p *CertificateListByServicePager) PageResponse() CertificateListByServiceResponse

PageResponse returns the current CertificateListByServiceResponse page.

type CertificateListByServiceResponse 

type CertificateListByServiceResponse struct {
	CertificateListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificateListByServiceResponse contains the response from method Certificate.ListByService.

type CertificateListByServiceResult 

type CertificateListByServiceResult struct {
	CertificateCollection
}

CertificateListByServiceResult contains the result from method Certificate.ListByService.

type CertificateRefreshSecretOptions 

type CertificateRefreshSecretOptions struct {
}

CertificateRefreshSecretOptions contains the optional parameters for the Certificate.RefreshSecret method.

type CertificateRefreshSecretResponse 

type CertificateRefreshSecretResponse struct {
	CertificateRefreshSecretResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificateRefreshSecretResponse contains the response from method Certificate.RefreshSecret.

type CertificateRefreshSecretResult 

type CertificateRefreshSecretResult struct {
	CertificateContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

CertificateRefreshSecretResult contains the result from method Certificate.RefreshSecret.

type CertificateSource 

type CertificateSource string

CertificateSource - Certificate Source. 

const (
	CertificateSourceBuiltIn  CertificateSource = "BuiltIn"
	CertificateSourceCustom   CertificateSource = "Custom"
	CertificateSourceKeyVault CertificateSource = "KeyVault"
	CertificateSourceManaged  CertificateSource = "Managed"
)

func PossibleCertificateSourceValues 

func PossibleCertificateSourceValues() []CertificateSource

PossibleCertificateSourceValues returns the possible values for the CertificateSource const type.

func (CertificateSource) ToPtr 

func (c CertificateSource) ToPtr() *CertificateSource

ToPtr returns a *CertificateSource pointing to the current value.

type CertificateStatus 

type CertificateStatus string

CertificateStatus - Certificate Status. 

const (
	CertificateStatusCompleted  CertificateStatus = "Completed"
	CertificateStatusFailed     CertificateStatus = "Failed"
	CertificateStatusInProgress CertificateStatus = "InProgress"
)

func PossibleCertificateStatusValues 

func PossibleCertificateStatusValues() []CertificateStatus

PossibleCertificateStatusValues returns the possible values for the CertificateStatus const type.

func (CertificateStatus) ToPtr 

func (c CertificateStatus) ToPtr() *CertificateStatus

ToPtr returns a *CertificateStatus pointing to the current value.

type ClientAuthenticationMethod 

type ClientAuthenticationMethod string
const (
	// ClientAuthenticationMethodBasic - Basic Client Authentication method.
	ClientAuthenticationMethodBasic ClientAuthenticationMethod = "Basic"
	// ClientAuthenticationMethodBody - Body based Authentication method.
	ClientAuthenticationMethodBody ClientAuthenticationMethod = "Body"
)

func PossibleClientAuthenticationMethodValues 

func PossibleClientAuthenticationMethodValues() []ClientAuthenticationMethod

PossibleClientAuthenticationMethodValues returns the possible values for the ClientAuthenticationMethod const type.

func (ClientAuthenticationMethod) ToPtr 

func (c ClientAuthenticationMethod) ToPtr() *ClientAuthenticationMethod

ToPtr returns a *ClientAuthenticationMethod pointing to the current value.

type ClientSecretContract 

type ClientSecretContract struct {
	// Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

ClientSecretContract - Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

type ConfigurationIDName 

type ConfigurationIDName string
const (
	ConfigurationIDNameConfiguration ConfigurationIDName = "configuration"
)

func PossibleConfigurationIDNameValues 

func PossibleConfigurationIDNameValues() []ConfigurationIDName

PossibleConfigurationIDNameValues returns the possible values for the ConfigurationIDName const type.

func (ConfigurationIDName) ToPtr 

func (c ConfigurationIDName) ToPtr() *ConfigurationIDName

ToPtr returns a *ConfigurationIDName pointing to the current value.

type Confirmation 

type Confirmation string

Confirmation - Determines the type of confirmation e-mail that will be sent to the newly created user. 

const (
	// ConfirmationInvite - Send an e-mail inviting the user to sign-up and complete registration.
	ConfirmationInvite Confirmation = "invite"
	// ConfirmationSignup - Send an e-mail to the user confirming they have successfully signed up.
	ConfirmationSignup Confirmation = "signup"
)

func PossibleConfirmationValues 

func PossibleConfirmationValues() []Confirmation

PossibleConfirmationValues returns the possible values for the Confirmation const type.

func (Confirmation) ToPtr 

func (c Confirmation) ToPtr() *Confirmation

ToPtr returns a *Confirmation pointing to the current value.

type ConnectionStatus 

type ConnectionStatus string

ConnectionStatus - The connection status. 

const (
	ConnectionStatusConnected    ConnectionStatus = "Connected"
	ConnectionStatusDegraded     ConnectionStatus = "Degraded"
	ConnectionStatusDisconnected ConnectionStatus = "Disconnected"
	ConnectionStatusUnknown      ConnectionStatus = "Unknown"
)

func PossibleConnectionStatusValues 

func PossibleConnectionStatusValues() []ConnectionStatus

PossibleConnectionStatusValues returns the possible values for the ConnectionStatus const type.

func (ConnectionStatus) ToPtr 

func (c ConnectionStatus) ToPtr() *ConnectionStatus

ToPtr returns a *ConnectionStatus pointing to the current value.

type ConnectivityCheckProtocol 

type ConnectivityCheckProtocol string

ConnectivityCheckProtocol - The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value. 

const (
	ConnectivityCheckProtocolHTTP  ConnectivityCheckProtocol = "HTTP"
	ConnectivityCheckProtocolHTTPS ConnectivityCheckProtocol = "HTTPS"
	ConnectivityCheckProtocolTCP   ConnectivityCheckProtocol = "TCP"
)

func PossibleConnectivityCheckProtocolValues 

func PossibleConnectivityCheckProtocolValues() []ConnectivityCheckProtocol

PossibleConnectivityCheckProtocolValues returns the possible values for the ConnectivityCheckProtocol const type.

func (ConnectivityCheckProtocol) ToPtr 

func (c ConnectivityCheckProtocol) ToPtr() *ConnectivityCheckProtocol

ToPtr returns a *ConnectivityCheckProtocol pointing to the current value.

type ConnectivityCheckRequest 

type ConnectivityCheckRequest struct {
	// REQUIRED; The connectivity check operation destination.
	Destination *ConnectivityCheckRequestDestination `json:"destination,omitempty"`

	// REQUIRED; Definitions about the connectivity check origin.
	Source *ConnectivityCheckRequestSource `json:"source,omitempty"`

	// The IP version to be used. Only IPv4 is supported for now.
	PreferredIPVersion *PreferredIPVersion `json:"preferredIPVersion,omitempty"`

	// The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent
	// with this value.
	Protocol *ConnectivityCheckProtocol `json:"protocol,omitempty"`

	// Protocol-specific configuration.
	ProtocolConfiguration *ConnectivityCheckRequestProtocolConfiguration `json:"protocolConfiguration,omitempty"`
}

ConnectivityCheckRequest - A request to perform the connectivity check operation on a API Management service.

type ConnectivityCheckRequestDestination 

type ConnectivityCheckRequestDestination struct {
	// REQUIRED; Destination address. Can either be an IP address or a FQDN.
	Address *string `json:"address,omitempty"`

	// REQUIRED; Destination port.
	Port *int64 `json:"port,omitempty"`
}

ConnectivityCheckRequestDestination - The connectivity check operation destination.

type ConnectivityCheckRequestProtocolConfiguration 

type ConnectivityCheckRequestProtocolConfiguration struct {
	// Configuration for HTTP or HTTPS requests.
	HTTPConfiguration *ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration `json:"HTTPConfiguration,omitempty"`
}

ConnectivityCheckRequestProtocolConfiguration - Protocol-specific configuration.

type ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration 

type ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration struct {
	// List of headers to be included in the request.
	Headers []*HTTPHeader `json:"headers,omitempty"`

	// The HTTP method to be used.
	Method *Method `json:"method,omitempty"`

	// List of HTTP status codes considered valid for the request response.
	ValidStatusCodes []*int64 `json:"validStatusCodes,omitempty"`
}

ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration - Configuration for HTTP or HTTPS requests.

func (ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration) MarshalJSON 

func (c ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration.

type ConnectivityCheckRequestSource 

type ConnectivityCheckRequestSource struct {
	// REQUIRED; The API Management service region from where to start the connectivity check operation.
	Region *string `json:"region,omitempty"`

	// The particular VMSS instance from which to fire the request.
	Instance *int64 `json:"instance,omitempty"`
}

ConnectivityCheckRequestSource - Definitions about the connectivity check origin.

type ConnectivityCheckResponse 

type ConnectivityCheckResponse struct {
	// READ-ONLY; Average latency in milliseconds.
	AvgLatencyInMs *int64 `json:"avgLatencyInMs,omitempty" azure:"ro"`

	// READ-ONLY; The connection status.
	ConnectionStatus *ConnectionStatus `json:"connectionStatus,omitempty" azure:"ro"`

	// READ-ONLY; List of hops between the source and the destination.
	Hops []*ConnectivityHop `json:"hops,omitempty" azure:"ro"`

	// READ-ONLY; Maximum latency in milliseconds.
	MaxLatencyInMs *int64 `json:"maxLatencyInMs,omitempty" azure:"ro"`

	// READ-ONLY; Minimum latency in milliseconds.
	MinLatencyInMs *int64 `json:"minLatencyInMs,omitempty" azure:"ro"`

	// READ-ONLY; Number of failed probes.
	ProbesFailed *int64 `json:"probesFailed,omitempty" azure:"ro"`

	// READ-ONLY; Total number of probes sent.
	ProbesSent *int64 `json:"probesSent,omitempty" azure:"ro"`
}

ConnectivityCheckResponse - Information on the connectivity status.

func (ConnectivityCheckResponse) MarshalJSON 

func (c ConnectivityCheckResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityCheckResponse.

type ConnectivityHop 

type ConnectivityHop struct {
	// READ-ONLY; The IP address of the hop.
	Address *string `json:"address,omitempty" azure:"ro"`

	// READ-ONLY; The ID of the hop.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; List of issues.
	Issues []*ConnectivityIssue `json:"issues,omitempty" azure:"ro"`

	// READ-ONLY; List of next hop identifiers.
	NextHopIDs []*string `json:"nextHopIds,omitempty" azure:"ro"`

	// READ-ONLY; The ID of the resource corresponding to this hop.
	ResourceID *string `json:"resourceId,omitempty" azure:"ro"`

	// READ-ONLY; The type of the hop.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ConnectivityHop - Information about a hop between the source and the destination.

func (ConnectivityHop) MarshalJSON 

func (c ConnectivityHop) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityHop.

type ConnectivityIssue 

type ConnectivityIssue struct {
	// READ-ONLY; Provides additional context on the issue.
	Context []map[string]*string `json:"context,omitempty" azure:"ro"`

	// READ-ONLY; The origin of the issue.
	Origin *Origin `json:"origin,omitempty" azure:"ro"`

	// READ-ONLY; The severity of the issue.
	Severity *Severity `json:"severity,omitempty" azure:"ro"`

	// READ-ONLY; The type of issue.
	Type *IssueType `json:"type,omitempty" azure:"ro"`
}

ConnectivityIssue - Information about an issue encountered in the process of checking for connectivity.

func (ConnectivityIssue) MarshalJSON 

func (c ConnectivityIssue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityIssue.

type ConnectivityStatusContract 

type ConnectivityStatusContract struct {
	// REQUIRED; Whether this is optional.
	IsOptional *bool `json:"isOptional,omitempty"`

	// REQUIRED; The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format:
	// yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601
	// standard.
	LastStatusChange *time.Time `json:"lastStatusChange,omitempty"`

	// REQUIRED; The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been
	// updated, then it means that the service has lost network
	// connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO
	// 8601 standard.
	LastUpdated *time.Time `json:"lastUpdated,omitempty"`

	// REQUIRED; The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service
	// depends upon.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Resource Type.
	ResourceType *string `json:"resourceType,omitempty"`

	// REQUIRED; Resource Connectivity Status Type identifier.
	Status *ConnectivityStatusType `json:"status,omitempty"`

	// Error details of the connectivity to the resource.
	Error *string `json:"error,omitempty"`
}

ConnectivityStatusContract - Details about connectivity to a resource.

func (ConnectivityStatusContract) MarshalJSON 

func (c ConnectivityStatusContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityStatusContract.

func (*ConnectivityStatusContract) UnmarshalJSON 

func (c *ConnectivityStatusContract) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectivityStatusContract.

type ConnectivityStatusType 

type ConnectivityStatusType string

ConnectivityStatusType - Resource Connectivity Status Type identifier. 

const (
	ConnectivityStatusTypeFailure      ConnectivityStatusType = "failure"
	ConnectivityStatusTypeInitializing ConnectivityStatusType = "initializing"
	ConnectivityStatusTypeSuccess      ConnectivityStatusType = "success"
)

func PossibleConnectivityStatusTypeValues 

func PossibleConnectivityStatusTypeValues() []ConnectivityStatusType

PossibleConnectivityStatusTypeValues returns the possible values for the ConnectivityStatusType const type.

func (ConnectivityStatusType) ToPtr 

func (c ConnectivityStatusType) ToPtr() *ConnectivityStatusType

ToPtr returns a *ConnectivityStatusType pointing to the current value.

type ContentFormat 

type ContentFormat string

ContentFormat - Format of the Content in which the API is getting imported. 

const (
	// ContentFormatGraphqlLink - The GraphQL API endpoint hosted on a publicly accessible internet address.
	ContentFormatGraphqlLink ContentFormat = "graphql-link"
	// ContentFormatOpenapi - The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
	ContentFormatOpenapi ContentFormat = "openapi"
	// ContentFormatOpenapiJSON - The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
	ContentFormatOpenapiJSON ContentFormat = "openapi+json"
	// ContentFormatOpenapiJSONLink - The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
	ContentFormatOpenapiJSONLink ContentFormat = "openapi+json-link"
	// ContentFormatOpenapiLink - The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
	ContentFormatOpenapiLink ContentFormat = "openapi-link"
	// ContentFormatSwaggerJSON - The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
	ContentFormatSwaggerJSON ContentFormat = "swagger-json"
	// ContentFormatSwaggerLinkJSON - The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
	ContentFormatSwaggerLinkJSON ContentFormat = "swagger-link-json"
	// ContentFormatWadlLinkJSON - The WADL document is hosted on a publicly accessible internet address.
	ContentFormatWadlLinkJSON ContentFormat = "wadl-link-json"
	// ContentFormatWadlXML - The contents are inline and Content type is a WADL document.
	ContentFormatWadlXML ContentFormat = "wadl-xml"
	// ContentFormatWsdl - The contents are inline and the document is a WSDL/Soap document.
	ContentFormatWsdl ContentFormat = "wsdl"
	// ContentFormatWsdlLink - The WSDL document is hosted on a publicly accessible internet address.
	ContentFormatWsdlLink ContentFormat = "wsdl-link"
)

func PossibleContentFormatValues 

func PossibleContentFormatValues() []ContentFormat

PossibleContentFormatValues returns the possible values for the ContentFormat const type.

func (ContentFormat) ToPtr 

func (c ContentFormat) ToPtr() *ContentFormat

ToPtr returns a *ContentFormat pointing to the current value.

type ContentItemClient 

type ContentItemClient struct {
	// contains filtered or unexported fields
}

ContentItemClient contains the methods for the ContentItem group. Don't use this type directly, use NewContentItemClient() instead.

func NewContentItemClient 

func NewContentItemClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ContentItemClient

NewContentItemClient creates a new instance of ContentItemClient with the specified values.

func (*ContentItemClient) CreateOrUpdate 

func (client *ContentItemClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, contentTypeID string, contentItemID string, options *ContentItemCreateOrUpdateOptions) (ContentItemCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new developer portal's content item specified by the provided content type. If the operation fails it returns the *ErrorResponse error type.

func (*ContentItemClient) Delete 

func (client *ContentItemClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, contentTypeID string, contentItemID string, ifMatch string, options *ContentItemDeleteOptions) (ContentItemDeleteResponse, error)

Delete - Removes the specified developer portal's content item. If the operation fails it returns the *ErrorResponse error type.

func (*ContentItemClient) Get 

func (client *ContentItemClient) Get(ctx context.Context, resourceGroupName string, serviceName string, contentTypeID string, contentItemID string, options *ContentItemGetOptions) (ContentItemGetResponse, error)

Get - Returns the developer portal's content item specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*ContentItemClient) GetEntityTag 

func (client *ContentItemClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, contentTypeID string, contentItemID string, options *ContentItemGetEntityTagOptions) (ContentItemGetEntityTagResponse, error)

GetEntityTag - Returns the entity state (ETag) version of the developer portal's content item specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*ContentItemClient) ListByService 

func (client *ContentItemClient) ListByService(resourceGroupName string, serviceName string, contentTypeID string, options *ContentItemListByServiceOptions) *ContentItemListByServicePager

ListByService - Lists developer portal's content items specified by the provided content type. If the operation fails it returns the *ErrorResponse error type.

type ContentItemCollection 

type ContentItemCollection struct {
	// READ-ONLY; Next page link, if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Collection of content items.
	Value []*ContentItemContract `json:"value,omitempty" azure:"ro"`
}

ContentItemCollection - Paged list of content items.

func (ContentItemCollection) MarshalJSON 

func (c ContentItemCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContentItemCollection.

type ContentItemContract 

type ContentItemContract struct {
	Resource
	// Properties of the content item.
	Properties map[string]interface{} `json:"properties,omitempty"`
}

ContentItemContract - Content type contract details.

func (ContentItemContract) MarshalJSON 

func (c ContentItemContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContentItemContract.

type ContentItemCreateOrUpdateOptions 

type ContentItemCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

ContentItemCreateOrUpdateOptions contains the optional parameters for the ContentItem.CreateOrUpdate method.

type ContentItemCreateOrUpdateResponse 

type ContentItemCreateOrUpdateResponse struct {
	ContentItemCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ContentItemCreateOrUpdateResponse contains the response from method ContentItem.CreateOrUpdate.

type ContentItemCreateOrUpdateResult 

type ContentItemCreateOrUpdateResult struct {
	ContentItemContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

ContentItemCreateOrUpdateResult contains the result from method ContentItem.CreateOrUpdate.

type ContentItemDeleteOptions 

type ContentItemDeleteOptions struct {
}

ContentItemDeleteOptions contains the optional parameters for the ContentItem.Delete method.

type ContentItemDeleteResponse 

type ContentItemDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ContentItemDeleteResponse contains the response from method ContentItem.Delete.

type ContentItemGetEntityTagOptions 

type ContentItemGetEntityTagOptions struct {
}

ContentItemGetEntityTagOptions contains the optional parameters for the ContentItem.GetEntityTag method.

type ContentItemGetEntityTagResponse 

type ContentItemGetEntityTagResponse struct {
	ContentItemGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ContentItemGetEntityTagResponse contains the response from method ContentItem.GetEntityTag.

type ContentItemGetEntityTagResult 

type ContentItemGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

ContentItemGetEntityTagResult contains the result from method ContentItem.GetEntityTag.

type ContentItemGetOptions 

type ContentItemGetOptions struct {
}

ContentItemGetOptions contains the optional parameters for the ContentItem.Get method.

type ContentItemGetResponse 

type ContentItemGetResponse struct {
	ContentItemGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ContentItemGetResponse contains the response from method ContentItem.Get.

type ContentItemGetResult 

type ContentItemGetResult struct {
	ContentItemContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

ContentItemGetResult contains the result from method ContentItem.Get.

type ContentItemListByServiceOptions 

type ContentItemListByServiceOptions struct {
}

ContentItemListByServiceOptions contains the optional parameters for the ContentItem.ListByService method.

type ContentItemListByServicePager 

type ContentItemListByServicePager struct {
	// contains filtered or unexported fields
}

ContentItemListByServicePager provides operations for iterating over paged responses.

func (*ContentItemListByServicePager) Err 

func (p *ContentItemListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*ContentItemListByServicePager) NextPage 

func (p *ContentItemListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ContentItemListByServicePager) PageResponse 

func (p *ContentItemListByServicePager) PageResponse() ContentItemListByServiceResponse

PageResponse returns the current ContentItemListByServiceResponse page.

type ContentItemListByServiceResponse 

type ContentItemListByServiceResponse struct {
	ContentItemListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ContentItemListByServiceResponse contains the response from method ContentItem.ListByService.

type ContentItemListByServiceResult 

type ContentItemListByServiceResult struct {
	ContentItemCollection
}

ContentItemListByServiceResult contains the result from method ContentItem.ListByService.

type ContentTypeClient 

type ContentTypeClient struct {
	// contains filtered or unexported fields
}

ContentTypeClient contains the methods for the ContentType group. Don't use this type directly, use NewContentTypeClient() instead.

func NewContentTypeClient 

func NewContentTypeClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ContentTypeClient

NewContentTypeClient creates a new instance of ContentTypeClient with the specified values.

func (*ContentTypeClient) CreateOrUpdate 

func (client *ContentTypeClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, contentTypeID string, options *ContentTypeCreateOrUpdateOptions) (ContentTypeCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the c- prefix. Built-in content types can't be modified. If the operation fails it returns the *ErrorResponse error type.

func (*ContentTypeClient) Delete 

func (client *ContentTypeClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, contentTypeID string, ifMatch string, options *ContentTypeDeleteOptions) (ContentTypeDeleteResponse, error)

Delete - Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the c- prefix) can't be removed. If the operation fails it returns the *ErrorResponse error type.

func (*ContentTypeClient) Get 

func (client *ContentTypeClient) Get(ctx context.Context, resourceGroupName string, serviceName string, contentTypeID string, options *ContentTypeGetOptions) (ContentTypeGetResponse, error)

Get - Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. If the operation fails it returns the *ErrorResponse error type.

func (*ContentTypeClient) ListByService 

func (client *ContentTypeClient) ListByService(resourceGroupName string, serviceName string, options *ContentTypeListByServiceOptions) *ContentTypeListByServicePager

ListByService - Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints. If the operation fails it returns the *ErrorResponse error type.

type ContentTypeCollection 

type ContentTypeCollection struct {
	// READ-ONLY; Next page link, if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Collection of content types.
	Value []*ContentTypeContract `json:"value,omitempty" azure:"ro"`
}

ContentTypeCollection - Paged list of content types.

func (ContentTypeCollection) MarshalJSON 

func (c ContentTypeCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContentTypeCollection.

type ContentTypeContract 

type ContentTypeContract struct {
	Resource
	// Properties of the content type.
	Properties *ContentTypeContractProperties `json:"properties,omitempty"`
}

ContentTypeContract - Content type contract details.

func (ContentTypeContract) MarshalJSON 

func (c ContentTypeContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContentTypeContract.

type ContentTypeContractProperties 

type ContentTypeContractProperties struct {
	// Content type description.
	Description *string `json:"description,omitempty"`

	// Content type identifier
	ID *string `json:"id,omitempty"`

	// Content type name. Must be 1 to 250 characters long.
	Name *string `json:"name,omitempty"`

	// Content type schema.
	Schema map[string]interface{} `json:"schema,omitempty"`

	// Content type version.
	Version *string `json:"version,omitempty"`
}

type ContentTypeCreateOrUpdateOptions 

type ContentTypeCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

ContentTypeCreateOrUpdateOptions contains the optional parameters for the ContentType.CreateOrUpdate method.

type ContentTypeCreateOrUpdateResponse 

type ContentTypeCreateOrUpdateResponse struct {
	ContentTypeCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ContentTypeCreateOrUpdateResponse contains the response from method ContentType.CreateOrUpdate.

type ContentTypeCreateOrUpdateResult 

type ContentTypeCreateOrUpdateResult struct {
	ContentTypeContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

ContentTypeCreateOrUpdateResult contains the result from method ContentType.CreateOrUpdate.

type ContentTypeDeleteOptions 

type ContentTypeDeleteOptions struct {
}

ContentTypeDeleteOptions contains the optional parameters for the ContentType.Delete method.

type ContentTypeDeleteResponse 

type ContentTypeDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ContentTypeDeleteResponse contains the response from method ContentType.Delete.

type ContentTypeGetOptions 

type ContentTypeGetOptions struct {
}

ContentTypeGetOptions contains the optional parameters for the ContentType.Get method.

type ContentTypeGetResponse 

type ContentTypeGetResponse struct {
	ContentTypeGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ContentTypeGetResponse contains the response from method ContentType.Get.

type ContentTypeGetResult 

type ContentTypeGetResult struct {
	ContentTypeContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

ContentTypeGetResult contains the result from method ContentType.Get.

type ContentTypeListByServiceOptions 

type ContentTypeListByServiceOptions struct {
}

ContentTypeListByServiceOptions contains the optional parameters for the ContentType.ListByService method.

type ContentTypeListByServicePager 

type ContentTypeListByServicePager struct {
	// contains filtered or unexported fields
}

ContentTypeListByServicePager provides operations for iterating over paged responses.

func (*ContentTypeListByServicePager) Err 

func (p *ContentTypeListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*ContentTypeListByServicePager) NextPage 

func (p *ContentTypeListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ContentTypeListByServicePager) PageResponse 

func (p *ContentTypeListByServicePager) PageResponse() ContentTypeListByServiceResponse

PageResponse returns the current ContentTypeListByServiceResponse page.

type ContentTypeListByServiceResponse 

type ContentTypeListByServiceResponse struct {
	ContentTypeListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ContentTypeListByServiceResponse contains the response from method ContentType.ListByService.

type ContentTypeListByServiceResult 

type ContentTypeListByServiceResult struct {
	ContentTypeCollection
}

ContentTypeListByServiceResult contains the result from method ContentType.ListByService.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

func (CreatedByType) ToPtr 

func (c CreatedByType) ToPtr() *CreatedByType

ToPtr returns a *CreatedByType pointing to the current value.

type DataMasking 

type DataMasking struct {
	// Masking settings for headers
	Headers []*DataMaskingEntity `json:"headers,omitempty"`

	// Masking settings for Url query parameters
	QueryParams []*DataMaskingEntity `json:"queryParams,omitempty"`
}

func (DataMasking) MarshalJSON 

func (d DataMasking) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataMasking.

type DataMaskingEntity 

type DataMaskingEntity struct {
	// Data masking mode.
	Mode *DataMaskingMode `json:"mode,omitempty"`

	// The name of an entity to mask (e.g. a name of a header or a query parameter).
	Value *string `json:"value,omitempty"`
}

type DataMaskingMode 

type DataMaskingMode string

DataMaskingMode - Data masking mode. 

const (
	// DataMaskingModeHide - Hide the presence of an entity.
	DataMaskingModeHide DataMaskingMode = "Hide"
	// DataMaskingModeMask - Mask the value of an entity.
	DataMaskingModeMask DataMaskingMode = "Mask"
)

func PossibleDataMaskingModeValues 

func PossibleDataMaskingModeValues() []DataMaskingMode

PossibleDataMaskingModeValues returns the possible values for the DataMaskingMode const type.

func (DataMaskingMode) ToPtr 

func (c DataMaskingMode) ToPtr() *DataMaskingMode

ToPtr returns a *DataMaskingMode pointing to the current value.

type DelegationSettingsClient 

type DelegationSettingsClient struct {
	// contains filtered or unexported fields
}

DelegationSettingsClient contains the methods for the DelegationSettings group. Don't use this type directly, use NewDelegationSettingsClient() instead.

func NewDelegationSettingsClient 

func NewDelegationSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DelegationSettingsClient

NewDelegationSettingsClient creates a new instance of DelegationSettingsClient with the specified values.

func (*DelegationSettingsClient) CreateOrUpdate 

func (client *DelegationSettingsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalDelegationSettings, options *DelegationSettingsCreateOrUpdateOptions) (DelegationSettingsCreateOrUpdateResponse, error)

CreateOrUpdate - Create or Update Delegation settings. If the operation fails it returns the *ErrorResponse error type.

func (*DelegationSettingsClient) Get 

func (client *DelegationSettingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, options *DelegationSettingsGetOptions) (DelegationSettingsGetResponse, error)

Get - Get Delegation Settings for the Portal. If the operation fails it returns the *ErrorResponse error type.

func (*DelegationSettingsClient) GetEntityTag 

func (client *DelegationSettingsClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, options *DelegationSettingsGetEntityTagOptions) (DelegationSettingsGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the DelegationSettings. If the operation fails it returns the *ErrorResponse error type.

func (*DelegationSettingsClient) ListSecrets 

func (client *DelegationSettingsClient) ListSecrets(ctx context.Context, resourceGroupName string, serviceName string, options *DelegationSettingsListSecretsOptions) (DelegationSettingsListSecretsResponse, error)

ListSecrets - Gets the secret validation key of the DelegationSettings. If the operation fails it returns the *ErrorResponse error type.

func (*DelegationSettingsClient) Update 

func (client *DelegationSettingsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, ifMatch string, parameters PortalDelegationSettings, options *DelegationSettingsUpdateOptions) (DelegationSettingsUpdateResponse, error)

Update - Update Delegation settings. If the operation fails it returns the *ErrorResponse error type.

type DelegationSettingsCreateOrUpdateOptions 

type DelegationSettingsCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

DelegationSettingsCreateOrUpdateOptions contains the optional parameters for the DelegationSettings.CreateOrUpdate method.

type DelegationSettingsCreateOrUpdateResponse 

type DelegationSettingsCreateOrUpdateResponse struct {
	DelegationSettingsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DelegationSettingsCreateOrUpdateResponse contains the response from method DelegationSettings.CreateOrUpdate.

type DelegationSettingsCreateOrUpdateResult 

type DelegationSettingsCreateOrUpdateResult struct {
	PortalDelegationSettings
}

DelegationSettingsCreateOrUpdateResult contains the result from method DelegationSettings.CreateOrUpdate.

type DelegationSettingsGetEntityTagOptions 

type DelegationSettingsGetEntityTagOptions struct {
}

DelegationSettingsGetEntityTagOptions contains the optional parameters for the DelegationSettings.GetEntityTag method.

type DelegationSettingsGetEntityTagResponse 

type DelegationSettingsGetEntityTagResponse struct {
	DelegationSettingsGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DelegationSettingsGetEntityTagResponse contains the response from method DelegationSettings.GetEntityTag.

type DelegationSettingsGetEntityTagResult 

type DelegationSettingsGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

DelegationSettingsGetEntityTagResult contains the result from method DelegationSettings.GetEntityTag.

type DelegationSettingsGetOptions 

type DelegationSettingsGetOptions struct {
}

DelegationSettingsGetOptions contains the optional parameters for the DelegationSettings.Get method.

type DelegationSettingsGetResponse 

type DelegationSettingsGetResponse struct {
	DelegationSettingsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DelegationSettingsGetResponse contains the response from method DelegationSettings.Get.

type DelegationSettingsGetResult 

type DelegationSettingsGetResult struct {
	PortalDelegationSettings
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

DelegationSettingsGetResult contains the result from method DelegationSettings.Get.

type DelegationSettingsListSecretsOptions 

type DelegationSettingsListSecretsOptions struct {
}

DelegationSettingsListSecretsOptions contains the optional parameters for the DelegationSettings.ListSecrets method.

type DelegationSettingsListSecretsResponse 

type DelegationSettingsListSecretsResponse struct {
	DelegationSettingsListSecretsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DelegationSettingsListSecretsResponse contains the response from method DelegationSettings.ListSecrets.

type DelegationSettingsListSecretsResult 

type DelegationSettingsListSecretsResult struct {
	PortalSettingValidationKeyContract
}

DelegationSettingsListSecretsResult contains the result from method DelegationSettings.ListSecrets.

type DelegationSettingsUpdateOptions 

type DelegationSettingsUpdateOptions struct {
}

DelegationSettingsUpdateOptions contains the optional parameters for the DelegationSettings.Update method.

type DelegationSettingsUpdateResponse 

type DelegationSettingsUpdateResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DelegationSettingsUpdateResponse contains the response from method DelegationSettings.Update.

type DeletedServiceContract 

type DeletedServiceContract struct {
	Resource
	// Deleted API Management Service details.
	Properties *DeletedServiceContractProperties `json:"properties,omitempty"`

	// READ-ONLY; API Management Service Master Location.
	Location *string `json:"location,omitempty" azure:"ro"`
}

DeletedServiceContract - Deleted API Management Service information.

func (DeletedServiceContract) MarshalJSON 

func (d DeletedServiceContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedServiceContract.

type DeletedServiceContractProperties 

type DeletedServiceContractProperties struct {
	// UTC Timestamp when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	DeletionDate *time.Time `json:"deletionDate,omitempty"`

	// UTC Date and Time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the
	// ISO 8601 standard.
	ScheduledPurgeDate *time.Time `json:"scheduledPurgeDate,omitempty"`

	// Fully-qualified API Management Service Resource ID
	ServiceID *string `json:"serviceId,omitempty"`
}

func (DeletedServiceContractProperties) MarshalJSON 

func (d DeletedServiceContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedServiceContractProperties.

func (*DeletedServiceContractProperties) UnmarshalJSON 

func (d *DeletedServiceContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeletedServiceContractProperties.

type DeletedServicesBeginPurgeOptions 

type DeletedServicesBeginPurgeOptions struct {
}

DeletedServicesBeginPurgeOptions contains the optional parameters for the DeletedServices.BeginPurge method.

type DeletedServicesClient 

type DeletedServicesClient struct {
	// contains filtered or unexported fields
}

DeletedServicesClient contains the methods for the DeletedServices group. Don't use this type directly, use NewDeletedServicesClient() instead.

func NewDeletedServicesClient 

func NewDeletedServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DeletedServicesClient

NewDeletedServicesClient creates a new instance of DeletedServicesClient with the specified values.

func (*DeletedServicesClient) BeginPurge 

func (client *DeletedServicesClient) BeginPurge(ctx context.Context, serviceName string, location string, options *DeletedServicesBeginPurgeOptions) (DeletedServicesPurgePollerResponse, error)

BeginPurge - Purges Api Management Service (deletes it with no option to undelete). If the operation fails it returns the *ErrorResponse error type.

func (*DeletedServicesClient) GetByName 

func (client *DeletedServicesClient) GetByName(ctx context.Context, serviceName string, location string, options *DeletedServicesGetByNameOptions) (DeletedServicesGetByNameResponse, error)

GetByName - Get soft-deleted Api Management Service by name. If the operation fails it returns the *ErrorResponse error type.

func (*DeletedServicesClient) ListBySubscription 

func (client *DeletedServicesClient) ListBySubscription(options *DeletedServicesListBySubscriptionOptions) *DeletedServicesListBySubscriptionPager

ListBySubscription - Lists all soft-deleted services available for undelete for the given subscription. If the operation fails it returns the *ErrorResponse error type.

type DeletedServicesCollection 

type DeletedServicesCollection struct {
	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Page values.
	Value []*DeletedServiceContract `json:"value,omitempty" azure:"ro"`
}

DeletedServicesCollection - Paged deleted API Management Services List Representation.

func (DeletedServicesCollection) MarshalJSON 

func (d DeletedServicesCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedServicesCollection.

type DeletedServicesGetByNameOptions 

type DeletedServicesGetByNameOptions struct {
}

DeletedServicesGetByNameOptions contains the optional parameters for the DeletedServices.GetByName method.

type DeletedServicesGetByNameResponse 

type DeletedServicesGetByNameResponse struct {
	DeletedServicesGetByNameResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeletedServicesGetByNameResponse contains the response from method DeletedServices.GetByName.

type DeletedServicesGetByNameResult 

type DeletedServicesGetByNameResult struct {
	DeletedServiceContract
}

DeletedServicesGetByNameResult contains the result from method DeletedServices.GetByName.

type DeletedServicesListBySubscriptionOptions 

type DeletedServicesListBySubscriptionOptions struct {
}

DeletedServicesListBySubscriptionOptions contains the optional parameters for the DeletedServices.ListBySubscription method.

type DeletedServicesListBySubscriptionPager 

type DeletedServicesListBySubscriptionPager struct {
	// contains filtered or unexported fields
}

DeletedServicesListBySubscriptionPager provides operations for iterating over paged responses.

func (*DeletedServicesListBySubscriptionPager) Err 

func (p *DeletedServicesListBySubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*DeletedServicesListBySubscriptionPager) NextPage 

func (p *DeletedServicesListBySubscriptionPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeletedServicesListBySubscriptionPager) PageResponse 

func (p *DeletedServicesListBySubscriptionPager) PageResponse() DeletedServicesListBySubscriptionResponse

PageResponse returns the current DeletedServicesListBySubscriptionResponse page.

type DeletedServicesListBySubscriptionResponse 

type DeletedServicesListBySubscriptionResponse struct {
	DeletedServicesListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeletedServicesListBySubscriptionResponse contains the response from method DeletedServices.ListBySubscription.

type DeletedServicesListBySubscriptionResult 

type DeletedServicesListBySubscriptionResult struct {
	DeletedServicesCollection
}

DeletedServicesListBySubscriptionResult contains the result from method DeletedServices.ListBySubscription.

type DeletedServicesPurgePoller 

type DeletedServicesPurgePoller struct {
	// contains filtered or unexported fields
}

DeletedServicesPurgePoller provides polling facilities until the operation reaches a terminal state.

func (*DeletedServicesPurgePoller) Done 

func (p *DeletedServicesPurgePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeletedServicesPurgePoller) FinalResponse 

func (p *DeletedServicesPurgePoller) FinalResponse(ctx context.Context) (DeletedServicesPurgeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeletedServicesPurgeResponse will be returned.

func (*DeletedServicesPurgePoller) Poll 

func (p *DeletedServicesPurgePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeletedServicesPurgePoller) ResumeToken 

func (p *DeletedServicesPurgePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeletedServicesPurgePollerResponse 

type DeletedServicesPurgePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeletedServicesPurgePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeletedServicesPurgePollerResponse contains the response from method DeletedServices.Purge.

func (DeletedServicesPurgePollerResponse) PollUntilDone 

func (l DeletedServicesPurgePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeletedServicesPurgeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeletedServicesPurgePollerResponse) Resume 

func (l *DeletedServicesPurgePollerResponse) Resume(ctx context.Context, client *DeletedServicesClient, token string) error

Resume rehydrates a DeletedServicesPurgePollerResponse from the provided client and resume token.

type DeletedServicesPurgeResponse 

type DeletedServicesPurgeResponse struct {
	DeletedServicesPurgeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeletedServicesPurgeResponse contains the response from method DeletedServices.Purge.

type DeletedServicesPurgeResult 

type DeletedServicesPurgeResult struct {
	DeletedServiceContract
}

DeletedServicesPurgeResult contains the result from method DeletedServices.Purge.

type DeployConfigurationParameterProperties 

type DeployConfigurationParameterProperties struct {
	// REQUIRED; The name of the Git branch from which the configuration is to be deployed to the configuration database.
	Branch *string `json:"branch,omitempty"`

	// The value enforcing deleting subscriptions to products that are deleted in this update.
	Force *bool `json:"force,omitempty"`
}

DeployConfigurationParameterProperties - Parameters supplied to the Deploy Configuration operation.

type DeployConfigurationParameters 

type DeployConfigurationParameters struct {
	// Deploy Configuration Parameter contract properties.
	Properties *DeployConfigurationParameterProperties `json:"properties,omitempty"`
}

DeployConfigurationParameters - Deploy Tenant Configuration Contract.

type DiagnosticClient 

type DiagnosticClient struct {
	// contains filtered or unexported fields
}

DiagnosticClient contains the methods for the Diagnostic group. Don't use this type directly, use NewDiagnosticClient() instead.

func NewDiagnosticClient 

func NewDiagnosticClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DiagnosticClient

NewDiagnosticClient creates a new instance of DiagnosticClient with the specified values.

func (*DiagnosticClient) CreateOrUpdate 

func (client *DiagnosticClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, parameters DiagnosticContract, options *DiagnosticCreateOrUpdateOptions) (DiagnosticCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new Diagnostic or updates an existing one. If the operation fails it returns the *ErrorResponse error type.

func (*DiagnosticClient) Delete 

func (client *DiagnosticClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, ifMatch string, options *DiagnosticDeleteOptions) (DiagnosticDeleteResponse, error)

Delete - Deletes the specified Diagnostic. If the operation fails it returns the *ErrorResponse error type.

func (*DiagnosticClient) Get 

func (client *DiagnosticClient) Get(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, options *DiagnosticGetOptions) (DiagnosticGetResponse, error)

Get - Gets the details of the Diagnostic specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*DiagnosticClient) GetEntityTag 

func (client *DiagnosticClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, options *DiagnosticGetEntityTagOptions) (DiagnosticGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the Diagnostic specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*DiagnosticClient) ListByService 

func (client *DiagnosticClient) ListByService(resourceGroupName string, serviceName string, options *DiagnosticListByServiceOptions) *DiagnosticListByServicePager

ListByService - Lists all diagnostics of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*DiagnosticClient) Update 

func (client *DiagnosticClient) Update(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, ifMatch string, parameters DiagnosticContract, options *DiagnosticUpdateOptions) (DiagnosticUpdateResponse, error)

Update - Updates the details of the Diagnostic specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type DiagnosticCollection 

type DiagnosticCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*DiagnosticContract `json:"value,omitempty"`
}

DiagnosticCollection - Paged Diagnostic list representation.

func (DiagnosticCollection) MarshalJSON 

func (d DiagnosticCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DiagnosticCollection.

type DiagnosticContract 

type DiagnosticContract struct {
	Resource
	// Diagnostic entity contract properties.
	Properties *DiagnosticContractProperties `json:"properties,omitempty"`
}

DiagnosticContract - Diagnostic details.

func (DiagnosticContract) MarshalJSON 

func (d DiagnosticContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DiagnosticContract.

type DiagnosticContractProperties 

type DiagnosticContractProperties struct {
	// REQUIRED; Resource Id of a target logger.
	LoggerID *string `json:"loggerId,omitempty"`

	// Specifies for what type of messages sampling settings should not apply.
	AlwaysLog *AlwaysLog `json:"alwaysLog,omitempty"`

	// Diagnostic settings for incoming/outgoing HTTP messages to the Backend
	Backend *PipelineDiagnosticSettings `json:"backend,omitempty"`

	// Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
	Frontend *PipelineDiagnosticSettings `json:"frontend,omitempty"`

	// Sets correlation protocol to use for Application Insights diagnostics.
	HTTPCorrelationProtocol *HTTPCorrelationProtocol `json:"httpCorrelationProtocol,omitempty"`

	// Log the ClientIP. Default is false.
	LogClientIP *bool `json:"logClientIp,omitempty"`

	// The format of the Operation Name for Application Insights telemetries. Default is Name.
	OperationNameFormat *OperationNameFormat `json:"operationNameFormat,omitempty"`

	// Sampling settings for Diagnostic.
	Sampling *SamplingSettings `json:"sampling,omitempty"`

	// The verbosity level applied to traces emitted by trace policies.
	Verbosity *Verbosity `json:"verbosity,omitempty"`
}

DiagnosticContractProperties - Diagnostic Entity Properties

type DiagnosticCreateOrUpdateOptions 

type DiagnosticCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

DiagnosticCreateOrUpdateOptions contains the optional parameters for the Diagnostic.CreateOrUpdate method.

type DiagnosticCreateOrUpdateResponse 

type DiagnosticCreateOrUpdateResponse struct {
	DiagnosticCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiagnosticCreateOrUpdateResponse contains the response from method Diagnostic.CreateOrUpdate.

type DiagnosticCreateOrUpdateResult 

type DiagnosticCreateOrUpdateResult struct {
	DiagnosticContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

DiagnosticCreateOrUpdateResult contains the result from method Diagnostic.CreateOrUpdate.

type DiagnosticDeleteOptions 

type DiagnosticDeleteOptions struct {
}

DiagnosticDeleteOptions contains the optional parameters for the Diagnostic.Delete method.

type DiagnosticDeleteResponse 

type DiagnosticDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiagnosticDeleteResponse contains the response from method Diagnostic.Delete.

type DiagnosticGetEntityTagOptions 

type DiagnosticGetEntityTagOptions struct {
}

DiagnosticGetEntityTagOptions contains the optional parameters for the Diagnostic.GetEntityTag method.

type DiagnosticGetEntityTagResponse 

type DiagnosticGetEntityTagResponse struct {
	DiagnosticGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiagnosticGetEntityTagResponse contains the response from method Diagnostic.GetEntityTag.

type DiagnosticGetEntityTagResult 

type DiagnosticGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

DiagnosticGetEntityTagResult contains the result from method Diagnostic.GetEntityTag.

type DiagnosticGetOptions 

type DiagnosticGetOptions struct {
}

DiagnosticGetOptions contains the optional parameters for the Diagnostic.Get method.

type DiagnosticGetResponse 

type DiagnosticGetResponse struct {
	DiagnosticGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiagnosticGetResponse contains the response from method Diagnostic.Get.

type DiagnosticGetResult 

type DiagnosticGetResult struct {
	DiagnosticContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

DiagnosticGetResult contains the result from method Diagnostic.Get.

type DiagnosticListByServiceOptions 

type DiagnosticListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

DiagnosticListByServiceOptions contains the optional parameters for the Diagnostic.ListByService method.

type DiagnosticListByServicePager 

type DiagnosticListByServicePager struct {
	// contains filtered or unexported fields
}

DiagnosticListByServicePager provides operations for iterating over paged responses.

func (*DiagnosticListByServicePager) Err 

func (p *DiagnosticListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*DiagnosticListByServicePager) NextPage 

func (p *DiagnosticListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DiagnosticListByServicePager) PageResponse 

func (p *DiagnosticListByServicePager) PageResponse() DiagnosticListByServiceResponse

PageResponse returns the current DiagnosticListByServiceResponse page.

type DiagnosticListByServiceResponse 

type DiagnosticListByServiceResponse struct {
	DiagnosticListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiagnosticListByServiceResponse contains the response from method Diagnostic.ListByService.

type DiagnosticListByServiceResult 

type DiagnosticListByServiceResult struct {
	DiagnosticCollection
}

DiagnosticListByServiceResult contains the result from method Diagnostic.ListByService.

type DiagnosticUpdateOptions 

type DiagnosticUpdateOptions struct {
}

DiagnosticUpdateOptions contains the optional parameters for the Diagnostic.Update method.

type DiagnosticUpdateResponse 

type DiagnosticUpdateResponse struct {
	DiagnosticUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiagnosticUpdateResponse contains the response from method Diagnostic.Update.

type DiagnosticUpdateResult 

type DiagnosticUpdateResult struct {
	DiagnosticContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

DiagnosticUpdateResult contains the result from method Diagnostic.Update.

type EmailTemplateClient 

type EmailTemplateClient struct {
	// contains filtered or unexported fields
}

EmailTemplateClient contains the methods for the EmailTemplate group. Don't use this type directly, use NewEmailTemplateClient() instead.

func NewEmailTemplateClient 

func NewEmailTemplateClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *EmailTemplateClient

NewEmailTemplateClient creates a new instance of EmailTemplateClient with the specified values.

func (*EmailTemplateClient) CreateOrUpdate 

func (client *EmailTemplateClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, parameters EmailTemplateUpdateParameters, options *EmailTemplateCreateOrUpdateOptions) (EmailTemplateCreateOrUpdateResponse, error)

CreateOrUpdate - Updates an Email Template. If the operation fails it returns the *ErrorResponse error type.

func (*EmailTemplateClient) Delete 

func (client *EmailTemplateClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, ifMatch string, options *EmailTemplateDeleteOptions) (EmailTemplateDeleteResponse, error)

Delete - Reset the Email Template to default template provided by the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*EmailTemplateClient) Get 

func (client *EmailTemplateClient) Get(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, options *EmailTemplateGetOptions) (EmailTemplateGetResponse, error)

Get - Gets the details of the email template specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*EmailTemplateClient) GetEntityTag 

func (client *EmailTemplateClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, options *EmailTemplateGetEntityTagOptions) (EmailTemplateGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the email template specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*EmailTemplateClient) ListByService 

func (client *EmailTemplateClient) ListByService(resourceGroupName string, serviceName string, options *EmailTemplateListByServiceOptions) *EmailTemplateListByServicePager

ListByService - Gets all email templates If the operation fails it returns the *ErrorResponse error type.

func (*EmailTemplateClient) Update 

func (client *EmailTemplateClient) Update(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, ifMatch string, parameters EmailTemplateUpdateParameters, options *EmailTemplateUpdateOptions) (EmailTemplateUpdateResponse, error)

Update - Updates API Management email template If the operation fails it returns the *ErrorResponse error type.

type EmailTemplateCollection 

type EmailTemplateCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*EmailTemplateContract `json:"value,omitempty"`
}

EmailTemplateCollection - Paged email template list representation.

func (EmailTemplateCollection) MarshalJSON 

func (e EmailTemplateCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EmailTemplateCollection.

type EmailTemplateContract 

type EmailTemplateContract struct {
	Resource
	// Email Template entity contract properties.
	Properties *EmailTemplateContractProperties `json:"properties,omitempty"`
}

EmailTemplateContract - Email Template details.

func (EmailTemplateContract) MarshalJSON 

func (e EmailTemplateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EmailTemplateContract.

type EmailTemplateContractProperties 

type EmailTemplateContractProperties struct {
	// REQUIRED; Email Template Body. This should be a valid XDocument
	Body *string `json:"body,omitempty"`

	// REQUIRED; Subject of the Template.
	Subject *string `json:"subject,omitempty"`

	// Description of the Email Template.
	Description *string `json:"description,omitempty"`

	// Email Template Parameter values.
	Parameters []*EmailTemplateParametersContractProperties `json:"parameters,omitempty"`

	// Title of the Template.
	Title *string `json:"title,omitempty"`

	// READ-ONLY; Whether the template is the default template provided by API Management or has been edited.
	IsDefault *bool `json:"isDefault,omitempty" azure:"ro"`
}

EmailTemplateContractProperties - Email Template Contract properties.

func (EmailTemplateContractProperties) MarshalJSON 

func (e EmailTemplateContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EmailTemplateContractProperties.

type EmailTemplateCreateOrUpdateOptions 

type EmailTemplateCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

EmailTemplateCreateOrUpdateOptions contains the optional parameters for the EmailTemplate.CreateOrUpdate method.

type EmailTemplateCreateOrUpdateResponse 

type EmailTemplateCreateOrUpdateResponse struct {
	EmailTemplateCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

EmailTemplateCreateOrUpdateResponse contains the response from method EmailTemplate.CreateOrUpdate.

type EmailTemplateCreateOrUpdateResult 

type EmailTemplateCreateOrUpdateResult struct {
	EmailTemplateContract
}

EmailTemplateCreateOrUpdateResult contains the result from method EmailTemplate.CreateOrUpdate.

type EmailTemplateDeleteOptions 

type EmailTemplateDeleteOptions struct {
}

EmailTemplateDeleteOptions contains the optional parameters for the EmailTemplate.Delete method.

type EmailTemplateDeleteResponse 

type EmailTemplateDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

EmailTemplateDeleteResponse contains the response from method EmailTemplate.Delete.

type EmailTemplateGetEntityTagOptions 

type EmailTemplateGetEntityTagOptions struct {
}

EmailTemplateGetEntityTagOptions contains the optional parameters for the EmailTemplate.GetEntityTag method.

type EmailTemplateGetEntityTagResponse 

type EmailTemplateGetEntityTagResponse struct {
	EmailTemplateGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

EmailTemplateGetEntityTagResponse contains the response from method EmailTemplate.GetEntityTag.

type EmailTemplateGetEntityTagResult 

type EmailTemplateGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

EmailTemplateGetEntityTagResult contains the result from method EmailTemplate.GetEntityTag.

type EmailTemplateGetOptions 

type EmailTemplateGetOptions struct {
}

EmailTemplateGetOptions contains the optional parameters for the EmailTemplate.Get method.

type EmailTemplateGetResponse 

type EmailTemplateGetResponse struct {
	EmailTemplateGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

EmailTemplateGetResponse contains the response from method EmailTemplate.Get.

type EmailTemplateGetResult 

type EmailTemplateGetResult struct {
	EmailTemplateContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

EmailTemplateGetResult contains the result from method EmailTemplate.Get.

type EmailTemplateListByServiceOptions 

type EmailTemplateListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

EmailTemplateListByServiceOptions contains the optional parameters for the EmailTemplate.ListByService method.

type EmailTemplateListByServicePager 

type EmailTemplateListByServicePager struct {
	// contains filtered or unexported fields
}

EmailTemplateListByServicePager provides operations for iterating over paged responses.

func (*EmailTemplateListByServicePager) Err 

func (p *EmailTemplateListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*EmailTemplateListByServicePager) NextPage 

func (p *EmailTemplateListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*EmailTemplateListByServicePager) PageResponse 

func (p *EmailTemplateListByServicePager) PageResponse() EmailTemplateListByServiceResponse

PageResponse returns the current EmailTemplateListByServiceResponse page.

type EmailTemplateListByServiceResponse 

type EmailTemplateListByServiceResponse struct {
	EmailTemplateListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

EmailTemplateListByServiceResponse contains the response from method EmailTemplate.ListByService.

type EmailTemplateListByServiceResult 

type EmailTemplateListByServiceResult struct {
	EmailTemplateCollection
}

EmailTemplateListByServiceResult contains the result from method EmailTemplate.ListByService.

type EmailTemplateParametersContractProperties 

type EmailTemplateParametersContractProperties struct {
	// Template parameter description.
	Description *string `json:"description,omitempty"`

	// Template parameter name.
	Name *string `json:"name,omitempty"`

	// Template parameter title.
	Title *string `json:"title,omitempty"`
}

EmailTemplateParametersContractProperties - Email Template Parameter contract.

type EmailTemplateUpdateOptions 

type EmailTemplateUpdateOptions struct {
}

EmailTemplateUpdateOptions contains the optional parameters for the EmailTemplate.Update method.

type EmailTemplateUpdateParameterProperties 

type EmailTemplateUpdateParameterProperties struct {
	// Email Template Body. This should be a valid XDocument
	Body *string `json:"body,omitempty"`

	// Description of the Email Template.
	Description *string `json:"description,omitempty"`

	// Email Template Parameter values.
	Parameters []*EmailTemplateParametersContractProperties `json:"parameters,omitempty"`

	// Subject of the Template.
	Subject *string `json:"subject,omitempty"`

	// Title of the Template.
	Title *string `json:"title,omitempty"`
}

EmailTemplateUpdateParameterProperties - Email Template Update Contract properties.

func (EmailTemplateUpdateParameterProperties) MarshalJSON 

func (e EmailTemplateUpdateParameterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EmailTemplateUpdateParameterProperties.

type EmailTemplateUpdateParameters 

type EmailTemplateUpdateParameters struct {
	// Email Template Update contract properties.
	Properties *EmailTemplateUpdateParameterProperties `json:"properties,omitempty"`
}

EmailTemplateUpdateParameters - Email Template update Parameters.

func (EmailTemplateUpdateParameters) MarshalJSON 

func (e EmailTemplateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EmailTemplateUpdateParameters.

type EmailTemplateUpdateResponse 

type EmailTemplateUpdateResponse struct {
	EmailTemplateUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

EmailTemplateUpdateResponse contains the response from method EmailTemplate.Update.

type EmailTemplateUpdateResult 

type EmailTemplateUpdateResult struct {
	EmailTemplateContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

EmailTemplateUpdateResult contains the result from method EmailTemplate.Update.

type EndpointDependency 

type EndpointDependency struct {
	// The domain name of the dependency.
	DomainName *string `json:"domainName,omitempty"`

	// The Ports used when connecting to DomainName.
	EndpointDetails []*EndpointDetail `json:"endpointDetails,omitempty"`
}

EndpointDependency - A domain name that a service is reached at.

func (EndpointDependency) MarshalJSON 

func (e EndpointDependency) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointDependency.

type EndpointDetail 

type EndpointDetail struct {
	// The port an endpoint is connected to.
	Port *int32 `json:"port,omitempty"`

	// The region of the dependency.
	Region *string `json:"region,omitempty"`
}

EndpointDetail - Current TCP connectivity information from the Api Management Service to a single endpoint.

type ErrorFieldContract 

type ErrorFieldContract struct {
	// Property level error code.
	Code *string `json:"code,omitempty"`

	// Human-readable representation of property-level error.
	Message *string `json:"message,omitempty"`

	// Property name.
	Target *string `json:"target,omitempty"`
}

ErrorFieldContract - Error Field contract.

type ErrorResponse 

type ErrorResponse struct {

	// Properties of the Error Response.
	InnerError *ErrorResponseBody `json:"error,omitempty"`
	// contains filtered or unexported fields
}

ErrorResponse - Error Response. Implements the error and azcore.HTTPResponse interfaces.

func (ErrorResponse) Error 

func (e ErrorResponse) Error() string

Error implements the error interface for type ErrorResponse. The contents of the error text are not contractual and subject to change.

type ErrorResponseBody 

type ErrorResponseBody struct {
	// Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
	Code *string `json:"code,omitempty"`

	// The list of invalid fields send in request, in case of validation error.
	Details []*ErrorFieldContract `json:"details,omitempty"`

	// Human-readable representation of the error.
	Message *string `json:"message,omitempty"`
}

ErrorResponseBody - Error Body contract.

func (ErrorResponseBody) MarshalJSON 

func (e ErrorResponseBody) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponseBody.

type ExportAPI 

type ExportAPI string
const (
	ExportAPITrue ExportAPI = "true"
)

func PossibleExportAPIValues 

func PossibleExportAPIValues() []ExportAPI

PossibleExportAPIValues returns the possible values for the ExportAPI const type.

func (ExportAPI) ToPtr 

func (c ExportAPI) ToPtr() *ExportAPI

ToPtr returns a *ExportAPI pointing to the current value.

type ExportFormat 

type ExportFormat string
const (
	// ExportFormatOpenapi - Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob.
	ExportFormatOpenapi ExportFormat = "openapi-link"
	// ExportFormatOpenapiJSON - Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob.
	ExportFormatOpenapiJSON ExportFormat = "openapi+json-link"
	// ExportFormatSwagger - Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob.
	ExportFormatSwagger ExportFormat = "swagger-link"
	// ExportFormatWadl - Export the Api Definition in WADL Schema to Storage Blob.
	ExportFormatWadl ExportFormat = "wadl-link"
	// ExportFormatWsdl - Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`
	ExportFormatWsdl ExportFormat = "wsdl-link"
)

func PossibleExportFormatValues 

func PossibleExportFormatValues() []ExportFormat

PossibleExportFormatValues returns the possible values for the ExportFormat const type.

func (ExportFormat) ToPtr 

func (c ExportFormat) ToPtr() *ExportFormat

ToPtr returns a *ExportFormat pointing to the current value.

type ExportResultFormat 

type ExportResultFormat string

ExportResultFormat - Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes. 

const (
	// ExportResultFormatOpenAPI - Export the API Definition in OpenAPI Specification 3.0 to Storage Blob.
	ExportResultFormatOpenAPI ExportResultFormat = "openapi-link"
	// ExportResultFormatSwagger - The API Definition is exported in OpenAPI Specification 2.0 format to the Storage Blob.
	ExportResultFormatSwagger ExportResultFormat = "swagger-link-json"
	// ExportResultFormatWadl - Export the API Definition in WADL Schema to Storage Blob.
	ExportResultFormatWadl ExportResultFormat = "wadl-link-json"
	// ExportResultFormatWsdl - The API Definition is exported in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`
	ExportResultFormatWsdl ExportResultFormat = "wsdl-link+xml"
)

func PossibleExportResultFormatValues 

func PossibleExportResultFormatValues() []ExportResultFormat

PossibleExportResultFormatValues returns the possible values for the ExportResultFormat const type.

func (ExportResultFormat) ToPtr 

func (c ExportResultFormat) ToPtr() *ExportResultFormat

ToPtr returns a *ExportResultFormat pointing to the current value.

type GatewayAPIClient 

type GatewayAPIClient struct {
	// contains filtered or unexported fields
}

GatewayAPIClient contains the methods for the GatewayAPI group. Don't use this type directly, use NewGatewayAPIClient() instead.

func NewGatewayAPIClient 

func NewGatewayAPIClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *GatewayAPIClient

NewGatewayAPIClient creates a new instance of GatewayAPIClient with the specified values.

func (*GatewayAPIClient) CreateOrUpdate 

func (client *GatewayAPIClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, apiID string, options *GatewayAPICreateOrUpdateOptions) (GatewayAPICreateOrUpdateResponse, error)

CreateOrUpdate - Adds an API to the specified Gateway. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayAPIClient) Delete 

func (client *GatewayAPIClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, apiID string, options *GatewayAPIDeleteOptions) (GatewayAPIDeleteResponse, error)

Delete - Deletes the specified API from the specified Gateway. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayAPIClient) GetEntityTag 

func (client *GatewayAPIClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, apiID string, options *GatewayAPIGetEntityTagOptions) (GatewayAPIGetEntityTagResponse, error)

GetEntityTag - Checks that API entity specified by identifier is associated with the Gateway entity. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayAPIClient) ListByService 

func (client *GatewayAPIClient) ListByService(resourceGroupName string, serviceName string, gatewayID string, options *GatewayAPIListByServiceOptions) *GatewayAPIListByServicePager

ListByService - Lists a collection of the APIs associated with a gateway. If the operation fails it returns the *ErrorResponse error type.

type GatewayAPICreateOrUpdateOptions 

type GatewayAPICreateOrUpdateOptions struct {
	Parameters *AssociationContract
}

GatewayAPICreateOrUpdateOptions contains the optional parameters for the GatewayAPI.CreateOrUpdate method.

type GatewayAPICreateOrUpdateResponse 

type GatewayAPICreateOrUpdateResponse struct {
	GatewayAPICreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayAPICreateOrUpdateResponse contains the response from method GatewayAPI.CreateOrUpdate.

type GatewayAPICreateOrUpdateResult 

type GatewayAPICreateOrUpdateResult struct {
	APIContract
}

GatewayAPICreateOrUpdateResult contains the result from method GatewayAPI.CreateOrUpdate.

type GatewayAPIDeleteOptions 

type GatewayAPIDeleteOptions struct {
}

GatewayAPIDeleteOptions contains the optional parameters for the GatewayAPI.Delete method.

type GatewayAPIDeleteResponse 

type GatewayAPIDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayAPIDeleteResponse contains the response from method GatewayAPI.Delete.

type GatewayAPIGetEntityTagOptions 

type GatewayAPIGetEntityTagOptions struct {
}

GatewayAPIGetEntityTagOptions contains the optional parameters for the GatewayAPI.GetEntityTag method.

type GatewayAPIGetEntityTagResponse 

type GatewayAPIGetEntityTagResponse struct {
	GatewayAPIGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayAPIGetEntityTagResponse contains the response from method GatewayAPI.GetEntityTag.

type GatewayAPIGetEntityTagResult 

type GatewayAPIGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

GatewayAPIGetEntityTagResult contains the result from method GatewayAPI.GetEntityTag.

type GatewayAPIListByServiceOptions 

type GatewayAPIListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

GatewayAPIListByServiceOptions contains the optional parameters for the GatewayAPI.ListByService method.

type GatewayAPIListByServicePager 

type GatewayAPIListByServicePager struct {
	// contains filtered or unexported fields
}

GatewayAPIListByServicePager provides operations for iterating over paged responses.

func (*GatewayAPIListByServicePager) Err 

func (p *GatewayAPIListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*GatewayAPIListByServicePager) NextPage 

func (p *GatewayAPIListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*GatewayAPIListByServicePager) PageResponse 

func (p *GatewayAPIListByServicePager) PageResponse() GatewayAPIListByServiceResponse

PageResponse returns the current GatewayAPIListByServiceResponse page.

type GatewayAPIListByServiceResponse 

type GatewayAPIListByServiceResponse struct {
	GatewayAPIListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayAPIListByServiceResponse contains the response from method GatewayAPI.ListByService.

type GatewayAPIListByServiceResult 

type GatewayAPIListByServiceResult struct {
	APICollection
}

GatewayAPIListByServiceResult contains the result from method GatewayAPI.ListByService.

type GatewayCertificateAuthorityClient 

type GatewayCertificateAuthorityClient struct {
	// contains filtered or unexported fields
}

GatewayCertificateAuthorityClient contains the methods for the GatewayCertificateAuthority group. Don't use this type directly, use NewGatewayCertificateAuthorityClient() instead.

func NewGatewayCertificateAuthorityClient 

func NewGatewayCertificateAuthorityClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *GatewayCertificateAuthorityClient

NewGatewayCertificateAuthorityClient creates a new instance of GatewayCertificateAuthorityClient with the specified values.

func (*GatewayCertificateAuthorityClient) CreateOrUpdate 

func (client *GatewayCertificateAuthorityClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, certificateID string, parameters GatewayCertificateAuthorityContract, options *GatewayCertificateAuthorityCreateOrUpdateOptions) (GatewayCertificateAuthorityCreateOrUpdateResponse, error)

CreateOrUpdate - Assign Certificate entity to Gateway entity as Certificate Authority. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayCertificateAuthorityClient) Delete 

func (client *GatewayCertificateAuthorityClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, certificateID string, ifMatch string, options *GatewayCertificateAuthorityDeleteOptions) (GatewayCertificateAuthorityDeleteResponse, error)

Delete - Remove relationship between Certificate Authority and Gateway entity. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayCertificateAuthorityClient) Get 

func (client *GatewayCertificateAuthorityClient) Get(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, certificateID string, options *GatewayCertificateAuthorityGetOptions) (GatewayCertificateAuthorityGetResponse, error)

Get - Get assigned Gateway Certificate Authority details. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayCertificateAuthorityClient) GetEntityTag 

func (client *GatewayCertificateAuthorityClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, certificateID string, options *GatewayCertificateAuthorityGetEntityTagOptions) (GatewayCertificateAuthorityGetEntityTagResponse, error)

GetEntityTag - Checks if Certificate entity is assigned to Gateway entity as Certificate Authority. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayCertificateAuthorityClient) ListByService 

func (client *GatewayCertificateAuthorityClient) ListByService(resourceGroupName string, serviceName string, gatewayID string, options *GatewayCertificateAuthorityListByServiceOptions) *GatewayCertificateAuthorityListByServicePager

ListByService - Lists the collection of Certificate Authorities for the specified Gateway entity. If the operation fails it returns the *ErrorResponse error type.

type GatewayCertificateAuthorityCollection 

type GatewayCertificateAuthorityCollection struct {
	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Page values.
	Value []*GatewayCertificateAuthorityContract `json:"value,omitempty" azure:"ro"`
}

GatewayCertificateAuthorityCollection - Paged Gateway certificate authority list representation.

func (GatewayCertificateAuthorityCollection) MarshalJSON 

func (g GatewayCertificateAuthorityCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayCertificateAuthorityCollection.

type GatewayCertificateAuthorityContract 

type GatewayCertificateAuthorityContract struct {
	Resource
	// Gateway certificate authority details.
	Properties *GatewayCertificateAuthorityContractProperties `json:"properties,omitempty"`
}

GatewayCertificateAuthorityContract - Gateway certificate authority details.

func (GatewayCertificateAuthorityContract) MarshalJSON 

func (g GatewayCertificateAuthorityContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayCertificateAuthorityContract.

type GatewayCertificateAuthorityContractProperties 

type GatewayCertificateAuthorityContractProperties struct {
	// Determines whether certificate authority is trusted.
	IsTrusted *bool `json:"isTrusted,omitempty"`
}

GatewayCertificateAuthorityContractProperties - Gateway certificate authority details.

type GatewayCertificateAuthorityCreateOrUpdateOptions 

type GatewayCertificateAuthorityCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

GatewayCertificateAuthorityCreateOrUpdateOptions contains the optional parameters for the GatewayCertificateAuthority.CreateOrUpdate method.

type GatewayCertificateAuthorityCreateOrUpdateResponse 

type GatewayCertificateAuthorityCreateOrUpdateResponse struct {
	GatewayCertificateAuthorityCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayCertificateAuthorityCreateOrUpdateResponse contains the response from method GatewayCertificateAuthority.CreateOrUpdate.

type GatewayCertificateAuthorityCreateOrUpdateResult 

type GatewayCertificateAuthorityCreateOrUpdateResult struct {
	GatewayCertificateAuthorityContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GatewayCertificateAuthorityCreateOrUpdateResult contains the result from method GatewayCertificateAuthority.CreateOrUpdate.

type GatewayCertificateAuthorityDeleteOptions 

type GatewayCertificateAuthorityDeleteOptions struct {
}

GatewayCertificateAuthorityDeleteOptions contains the optional parameters for the GatewayCertificateAuthority.Delete method.

type GatewayCertificateAuthorityDeleteResponse 

type GatewayCertificateAuthorityDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayCertificateAuthorityDeleteResponse contains the response from method GatewayCertificateAuthority.Delete.

type GatewayCertificateAuthorityGetEntityTagOptions 

type GatewayCertificateAuthorityGetEntityTagOptions struct {
}

GatewayCertificateAuthorityGetEntityTagOptions contains the optional parameters for the GatewayCertificateAuthority.GetEntityTag method.

type GatewayCertificateAuthorityGetEntityTagResponse 

type GatewayCertificateAuthorityGetEntityTagResponse struct {
	GatewayCertificateAuthorityGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayCertificateAuthorityGetEntityTagResponse contains the response from method GatewayCertificateAuthority.GetEntityTag.

type GatewayCertificateAuthorityGetEntityTagResult 

type GatewayCertificateAuthorityGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

GatewayCertificateAuthorityGetEntityTagResult contains the result from method GatewayCertificateAuthority.GetEntityTag.

type GatewayCertificateAuthorityGetOptions 

type GatewayCertificateAuthorityGetOptions struct {
}

GatewayCertificateAuthorityGetOptions contains the optional parameters for the GatewayCertificateAuthority.Get method.

type GatewayCertificateAuthorityGetResponse 

type GatewayCertificateAuthorityGetResponse struct {
	GatewayCertificateAuthorityGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayCertificateAuthorityGetResponse contains the response from method GatewayCertificateAuthority.Get.

type GatewayCertificateAuthorityGetResult 

type GatewayCertificateAuthorityGetResult struct {
	GatewayCertificateAuthorityContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GatewayCertificateAuthorityGetResult contains the result from method GatewayCertificateAuthority.Get.

type GatewayCertificateAuthorityListByServiceOptions 

type GatewayCertificateAuthorityListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | eq,
	// ne | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

GatewayCertificateAuthorityListByServiceOptions contains the optional parameters for the GatewayCertificateAuthority.ListByService method.

type GatewayCertificateAuthorityListByServicePager 

type GatewayCertificateAuthorityListByServicePager struct {
	// contains filtered or unexported fields
}

GatewayCertificateAuthorityListByServicePager provides operations for iterating over paged responses.

func (*GatewayCertificateAuthorityListByServicePager) Err 

func (p *GatewayCertificateAuthorityListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*GatewayCertificateAuthorityListByServicePager) NextPage 

func (p *GatewayCertificateAuthorityListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*GatewayCertificateAuthorityListByServicePager) PageResponse 

func (p *GatewayCertificateAuthorityListByServicePager) PageResponse() GatewayCertificateAuthorityListByServiceResponse

PageResponse returns the current GatewayCertificateAuthorityListByServiceResponse page.

type GatewayCertificateAuthorityListByServiceResponse 

type GatewayCertificateAuthorityListByServiceResponse struct {
	GatewayCertificateAuthorityListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayCertificateAuthorityListByServiceResponse contains the response from method GatewayCertificateAuthority.ListByService.

type GatewayCertificateAuthorityListByServiceResult 

type GatewayCertificateAuthorityListByServiceResult struct {
	GatewayCertificateAuthorityCollection
}

GatewayCertificateAuthorityListByServiceResult contains the result from method GatewayCertificateAuthority.ListByService.

type GatewayClient 

type GatewayClient struct {
	// contains filtered or unexported fields
}

GatewayClient contains the methods for the Gateway group. Don't use this type directly, use NewGatewayClient() instead.

func NewGatewayClient 

func NewGatewayClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *GatewayClient

NewGatewayClient creates a new instance of GatewayClient with the specified values.

func (*GatewayClient) CreateOrUpdate 

func (client *GatewayClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, parameters GatewayContract, options *GatewayCreateOrUpdateOptions) (GatewayCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a Gateway to be used in Api Management instance. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayClient) Delete 

func (client *GatewayClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, ifMatch string, options *GatewayDeleteOptions) (GatewayDeleteResponse, error)

Delete - Deletes specific Gateway. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayClient) GenerateToken 

func (client *GatewayClient) GenerateToken(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, parameters GatewayTokenRequestContract, options *GatewayGenerateTokenOptions) (GatewayGenerateTokenResponse, error)

GenerateToken - Gets the Shared Access Authorization Token for the gateway. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayClient) Get 

func (client *GatewayClient) Get(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, options *GatewayGetOptions) (GatewayGetResponse, error)

Get - Gets the details of the Gateway specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayClient) GetEntityTag 

func (client *GatewayClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, options *GatewayGetEntityTagOptions) (GatewayGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the Gateway specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayClient) ListByService 

func (client *GatewayClient) ListByService(resourceGroupName string, serviceName string, options *GatewayListByServiceOptions) *GatewayListByServicePager

ListByService - Lists a collection of gateways registered with service instance. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayClient) ListKeys 

func (client *GatewayClient) ListKeys(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, options *GatewayListKeysOptions) (GatewayListKeysResponse, error)

ListKeys - Retrieves gateway keys. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayClient) RegenerateKey 

func (client *GatewayClient) RegenerateKey(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, parameters GatewayKeyRegenerationRequestContract, options *GatewayRegenerateKeyOptions) (GatewayRegenerateKeyResponse, error)

RegenerateKey - Regenerates specified gateway key invalidating any tokens created with it. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayClient) Update 

func (client *GatewayClient) Update(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, ifMatch string, parameters GatewayContract, options *GatewayUpdateOptions) (GatewayUpdateResponse, error)

Update - Updates the details of the gateway specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type GatewayCollection 

type GatewayCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Page values.
	Value []*GatewayContract `json:"value,omitempty" azure:"ro"`
}

GatewayCollection - Paged Gateway list representation.

func (GatewayCollection) MarshalJSON 

func (g GatewayCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayCollection.

type GatewayContract 

type GatewayContract struct {
	Resource
	// Gateway details.
	Properties *GatewayContractProperties `json:"properties,omitempty"`
}

GatewayContract - Gateway details.

func (GatewayContract) MarshalJSON 

func (g GatewayContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayContract.

type GatewayContractProperties 

type GatewayContractProperties struct {
	// Gateway description
	Description *string `json:"description,omitempty"`

	// Gateway location.
	LocationData *ResourceLocationDataContract `json:"locationData,omitempty"`
}

GatewayContractProperties - Properties of the Gateway contract.

type GatewayCreateOrUpdateOptions 

type GatewayCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

GatewayCreateOrUpdateOptions contains the optional parameters for the Gateway.CreateOrUpdate method.

type GatewayCreateOrUpdateResponse 

type GatewayCreateOrUpdateResponse struct {
	GatewayCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayCreateOrUpdateResponse contains the response from method Gateway.CreateOrUpdate.

type GatewayCreateOrUpdateResult 

type GatewayCreateOrUpdateResult struct {
	GatewayContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GatewayCreateOrUpdateResult contains the result from method Gateway.CreateOrUpdate.

type GatewayDeleteOptions 

type GatewayDeleteOptions struct {
}

GatewayDeleteOptions contains the optional parameters for the Gateway.Delete method.

type GatewayDeleteResponse 

type GatewayDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayDeleteResponse contains the response from method Gateway.Delete.

type GatewayGenerateTokenOptions 

type GatewayGenerateTokenOptions struct {
}

GatewayGenerateTokenOptions contains the optional parameters for the Gateway.GenerateToken method.

type GatewayGenerateTokenResponse 

type GatewayGenerateTokenResponse struct {
	GatewayGenerateTokenResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayGenerateTokenResponse contains the response from method Gateway.GenerateToken.

type GatewayGenerateTokenResult 

type GatewayGenerateTokenResult struct {
	GatewayTokenContract
}

GatewayGenerateTokenResult contains the result from method Gateway.GenerateToken.

type GatewayGetEntityTagOptions 

type GatewayGetEntityTagOptions struct {
}

GatewayGetEntityTagOptions contains the optional parameters for the Gateway.GetEntityTag method.

type GatewayGetEntityTagResponse 

type GatewayGetEntityTagResponse struct {
	GatewayGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayGetEntityTagResponse contains the response from method Gateway.GetEntityTag.

type GatewayGetEntityTagResult 

type GatewayGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

GatewayGetEntityTagResult contains the result from method Gateway.GetEntityTag.

type GatewayGetOptions 

type GatewayGetOptions struct {
}

GatewayGetOptions contains the optional parameters for the Gateway.Get method.

type GatewayGetResponse 

type GatewayGetResponse struct {
	GatewayGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayGetResponse contains the response from method Gateway.Get.

type GatewayGetResult 

type GatewayGetResult struct {
	GatewayContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GatewayGetResult contains the result from method Gateway.Get.

type GatewayHostnameConfigurationClient 

type GatewayHostnameConfigurationClient struct {
	// contains filtered or unexported fields
}

GatewayHostnameConfigurationClient contains the methods for the GatewayHostnameConfiguration group. Don't use this type directly, use NewGatewayHostnameConfigurationClient() instead.

func NewGatewayHostnameConfigurationClient 

func NewGatewayHostnameConfigurationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *GatewayHostnameConfigurationClient

NewGatewayHostnameConfigurationClient creates a new instance of GatewayHostnameConfigurationClient with the specified values.

func (*GatewayHostnameConfigurationClient) CreateOrUpdate 

func (client *GatewayHostnameConfigurationClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, hcID string, parameters GatewayHostnameConfigurationContract, options *GatewayHostnameConfigurationCreateOrUpdateOptions) (GatewayHostnameConfigurationCreateOrUpdateResponse, error)

CreateOrUpdate - Creates of updates hostname configuration for a Gateway. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayHostnameConfigurationClient) Delete 

func (client *GatewayHostnameConfigurationClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, hcID string, ifMatch string, options *GatewayHostnameConfigurationDeleteOptions) (GatewayHostnameConfigurationDeleteResponse, error)

Delete - Deletes the specified hostname configuration from the specified Gateway. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayHostnameConfigurationClient) Get 

func (client *GatewayHostnameConfigurationClient) Get(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, hcID string, options *GatewayHostnameConfigurationGetOptions) (GatewayHostnameConfigurationGetResponse, error)

Get - Get details of a hostname configuration If the operation fails it returns the *ErrorResponse error type.

func (*GatewayHostnameConfigurationClient) GetEntityTag 

func (client *GatewayHostnameConfigurationClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, gatewayID string, hcID string, options *GatewayHostnameConfigurationGetEntityTagOptions) (GatewayHostnameConfigurationGetEntityTagResponse, error)

GetEntityTag - Checks that hostname configuration entity specified by identifier exists for specified Gateway entity. If the operation fails it returns the *ErrorResponse error type.

func (*GatewayHostnameConfigurationClient) ListByService 

func (client *GatewayHostnameConfigurationClient) ListByService(resourceGroupName string, serviceName string, gatewayID string, options *GatewayHostnameConfigurationListByServiceOptions) *GatewayHostnameConfigurationListByServicePager

ListByService - Lists the collection of hostname configurations for the specified gateway. If the operation fails it returns the *ErrorResponse error type.

type GatewayHostnameConfigurationCollection 

type GatewayHostnameConfigurationCollection struct {
	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Page values.
	Value []*GatewayHostnameConfigurationContract `json:"value,omitempty" azure:"ro"`
}

GatewayHostnameConfigurationCollection - Paged Gateway hostname configuration list representation.

func (GatewayHostnameConfigurationCollection) MarshalJSON 

func (g GatewayHostnameConfigurationCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayHostnameConfigurationCollection.

type GatewayHostnameConfigurationContract 

type GatewayHostnameConfigurationContract struct {
	Resource
	// Gateway hostname configuration details.
	Properties *GatewayHostnameConfigurationContractProperties `json:"properties,omitempty"`
}

GatewayHostnameConfigurationContract - Gateway hostname configuration details.

func (GatewayHostnameConfigurationContract) MarshalJSON 

func (g GatewayHostnameConfigurationContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayHostnameConfigurationContract.

type GatewayHostnameConfigurationContractProperties 

type GatewayHostnameConfigurationContractProperties struct {
	// Identifier of Certificate entity that will be used for TLS connection establishment
	CertificateID *string `json:"certificateId,omitempty"`

	// Specifies if HTTP/2.0 is supported
	HTTP2Enabled *bool `json:"http2Enabled,omitempty"`

	// Hostname value. Supports valid domain name, partial or full wildcard
	Hostname *string `json:"hostname,omitempty"`

	// Determines whether gateway requests client certificate
	NegotiateClientCertificate *bool `json:"negotiateClientCertificate,omitempty"`

	// Specifies if TLS 1.0 is supported
	Tls10Enabled *bool `json:"tls10Enabled,omitempty"`

	// Specifies if TLS 1.1 is supported
	Tls11Enabled *bool `json:"tls11Enabled,omitempty"`
}

GatewayHostnameConfigurationContractProperties - Gateway hostname configuration details.

type GatewayHostnameConfigurationCreateOrUpdateOptions 

type GatewayHostnameConfigurationCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

GatewayHostnameConfigurationCreateOrUpdateOptions contains the optional parameters for the GatewayHostnameConfiguration.CreateOrUpdate method.

type GatewayHostnameConfigurationCreateOrUpdateResponse 

type GatewayHostnameConfigurationCreateOrUpdateResponse struct {
	GatewayHostnameConfigurationCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayHostnameConfigurationCreateOrUpdateResponse contains the response from method GatewayHostnameConfiguration.CreateOrUpdate.

type GatewayHostnameConfigurationCreateOrUpdateResult 

type GatewayHostnameConfigurationCreateOrUpdateResult struct {
	GatewayHostnameConfigurationContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GatewayHostnameConfigurationCreateOrUpdateResult contains the result from method GatewayHostnameConfiguration.CreateOrUpdate.

type GatewayHostnameConfigurationDeleteOptions 

type GatewayHostnameConfigurationDeleteOptions struct {
}

GatewayHostnameConfigurationDeleteOptions contains the optional parameters for the GatewayHostnameConfiguration.Delete method.

type GatewayHostnameConfigurationDeleteResponse 

type GatewayHostnameConfigurationDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayHostnameConfigurationDeleteResponse contains the response from method GatewayHostnameConfiguration.Delete.

type GatewayHostnameConfigurationGetEntityTagOptions 

type GatewayHostnameConfigurationGetEntityTagOptions struct {
}

GatewayHostnameConfigurationGetEntityTagOptions contains the optional parameters for the GatewayHostnameConfiguration.GetEntityTag method.

type GatewayHostnameConfigurationGetEntityTagResponse 

type GatewayHostnameConfigurationGetEntityTagResponse struct {
	GatewayHostnameConfigurationGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayHostnameConfigurationGetEntityTagResponse contains the response from method GatewayHostnameConfiguration.GetEntityTag.

type GatewayHostnameConfigurationGetEntityTagResult 

type GatewayHostnameConfigurationGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

GatewayHostnameConfigurationGetEntityTagResult contains the result from method GatewayHostnameConfiguration.GetEntityTag.

type GatewayHostnameConfigurationGetOptions 

type GatewayHostnameConfigurationGetOptions struct {
}

GatewayHostnameConfigurationGetOptions contains the optional parameters for the GatewayHostnameConfiguration.Get method.

type GatewayHostnameConfigurationGetResponse 

type GatewayHostnameConfigurationGetResponse struct {
	GatewayHostnameConfigurationGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayHostnameConfigurationGetResponse contains the response from method GatewayHostnameConfiguration.Get.

type GatewayHostnameConfigurationGetResult 

type GatewayHostnameConfigurationGetResult struct {
	GatewayHostnameConfigurationContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GatewayHostnameConfigurationGetResult contains the result from method GatewayHostnameConfiguration.Get.

type GatewayHostnameConfigurationListByServiceOptions 

type GatewayHostnameConfigurationListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

GatewayHostnameConfigurationListByServiceOptions contains the optional parameters for the GatewayHostnameConfiguration.ListByService method.

type GatewayHostnameConfigurationListByServicePager 

type GatewayHostnameConfigurationListByServicePager struct {
	// contains filtered or unexported fields
}

GatewayHostnameConfigurationListByServicePager provides operations for iterating over paged responses.

func (*GatewayHostnameConfigurationListByServicePager) Err 

func (p *GatewayHostnameConfigurationListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*GatewayHostnameConfigurationListByServicePager) NextPage 

func (p *GatewayHostnameConfigurationListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*GatewayHostnameConfigurationListByServicePager) PageResponse 

func (p *GatewayHostnameConfigurationListByServicePager) PageResponse() GatewayHostnameConfigurationListByServiceResponse

PageResponse returns the current GatewayHostnameConfigurationListByServiceResponse page.

type GatewayHostnameConfigurationListByServiceResponse 

type GatewayHostnameConfigurationListByServiceResponse struct {
	GatewayHostnameConfigurationListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayHostnameConfigurationListByServiceResponse contains the response from method GatewayHostnameConfiguration.ListByService.

type GatewayHostnameConfigurationListByServiceResult 

type GatewayHostnameConfigurationListByServiceResult struct {
	GatewayHostnameConfigurationCollection
}

GatewayHostnameConfigurationListByServiceResult contains the result from method GatewayHostnameConfiguration.ListByService.

type GatewayKeyRegenerationRequestContract 

type GatewayKeyRegenerationRequestContract struct {
	// REQUIRED; The Key being regenerated.
	KeyType *KeyType `json:"keyType,omitempty"`
}

GatewayKeyRegenerationRequestContract - Gateway key regeneration request contract properties.

type GatewayKeysContract 

type GatewayKeysContract struct {
	// Primary gateway key.
	Primary *string `json:"primary,omitempty"`

	// Secondary gateway key.
	Secondary *string `json:"secondary,omitempty"`
}

GatewayKeysContract - Gateway authentication keys.

type GatewayListByServiceOptions 

type GatewayListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

GatewayListByServiceOptions contains the optional parameters for the Gateway.ListByService method.

type GatewayListByServicePager 

type GatewayListByServicePager struct {
	// contains filtered or unexported fields
}

GatewayListByServicePager provides operations for iterating over paged responses.

func (*GatewayListByServicePager) Err 

func (p *GatewayListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*GatewayListByServicePager) NextPage 

func (p *GatewayListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*GatewayListByServicePager) PageResponse 

func (p *GatewayListByServicePager) PageResponse() GatewayListByServiceResponse

PageResponse returns the current GatewayListByServiceResponse page.

type GatewayListByServiceResponse 

type GatewayListByServiceResponse struct {
	GatewayListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayListByServiceResponse contains the response from method Gateway.ListByService.

type GatewayListByServiceResult 

type GatewayListByServiceResult struct {
	GatewayCollection
}

GatewayListByServiceResult contains the result from method Gateway.ListByService.

type GatewayListKeysOptions 

type GatewayListKeysOptions struct {
}

GatewayListKeysOptions contains the optional parameters for the Gateway.ListKeys method.

type GatewayListKeysResponse 

type GatewayListKeysResponse struct {
	GatewayListKeysResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayListKeysResponse contains the response from method Gateway.ListKeys.

type GatewayListKeysResult 

type GatewayListKeysResult struct {
	GatewayKeysContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GatewayListKeysResult contains the result from method Gateway.ListKeys.

type GatewayRegenerateKeyOptions 

type GatewayRegenerateKeyOptions struct {
}

GatewayRegenerateKeyOptions contains the optional parameters for the Gateway.RegenerateKey method.

type GatewayRegenerateKeyResponse 

type GatewayRegenerateKeyResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayRegenerateKeyResponse contains the response from method Gateway.RegenerateKey.

type GatewayTokenContract 

type GatewayTokenContract struct {
	// Shared Access Authentication token value for the Gateway.
	Value *string `json:"value,omitempty"`
}

GatewayTokenContract - Gateway access token.

type GatewayTokenRequestContract 

type GatewayTokenRequestContract struct {
	// REQUIRED; The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ
	// as specified by the ISO 8601 standard.
	Expiry *time.Time `json:"expiry,omitempty"`

	// REQUIRED; The Key to be used to generate gateway token.
	KeyType *KeyType `json:"keyType,omitempty"`
}

GatewayTokenRequestContract - Gateway token request contract properties.

func (GatewayTokenRequestContract) MarshalJSON 

func (g GatewayTokenRequestContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayTokenRequestContract.

func (*GatewayTokenRequestContract) UnmarshalJSON 

func (g *GatewayTokenRequestContract) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayTokenRequestContract.

type GatewayUpdateOptions 

type GatewayUpdateOptions struct {
}

GatewayUpdateOptions contains the optional parameters for the Gateway.Update method.

type GatewayUpdateResponse 

type GatewayUpdateResponse struct {
	GatewayUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GatewayUpdateResponse contains the response from method Gateway.Update.

type GatewayUpdateResult 

type GatewayUpdateResult struct {
	GatewayContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GatewayUpdateResult contains the result from method Gateway.Update.

type GenerateSsoURLResult 

type GenerateSsoURLResult struct {
	// Redirect Url containing the SSO URL value.
	Value *string `json:"value,omitempty"`
}

GenerateSsoURLResult - Generate SSO Url operations response details.

type GrantType 

type GrantType string
const (
	// GrantTypeAuthorizationCode - Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1.
	GrantTypeAuthorizationCode GrantType = "authorizationCode"
	// GrantTypeClientCredentials - Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4.
	GrantTypeClientCredentials GrantType = "clientCredentials"
	// GrantTypeImplicit - Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
	GrantTypeImplicit GrantType = "implicit"
	// GrantTypeResourceOwnerPassword - Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.
	GrantTypeResourceOwnerPassword GrantType = "resourceOwnerPassword"
)

func PossibleGrantTypeValues 

func PossibleGrantTypeValues() []GrantType

PossibleGrantTypeValues returns the possible values for the GrantType const type.

func (GrantType) ToPtr 

func (c GrantType) ToPtr() *GrantType

ToPtr returns a *GrantType pointing to the current value.

type GroupClient 

type GroupClient struct {
	// contains filtered or unexported fields
}

GroupClient contains the methods for the Group group. Don't use this type directly, use NewGroupClient() instead.

func NewGroupClient 

func NewGroupClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *GroupClient

NewGroupClient creates a new instance of GroupClient with the specified values.

func (*GroupClient) CreateOrUpdate 

func (client *GroupClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, groupID string, parameters GroupCreateParameters, options *GroupCreateOrUpdateOptions) (GroupCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or Updates a group. If the operation fails it returns the *ErrorResponse error type.

func (*GroupClient) Delete 

func (client *GroupClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, groupID string, ifMatch string, options *GroupDeleteOptions) (GroupDeleteResponse, error)

Delete - Deletes specific group of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*GroupClient) Get 

func (client *GroupClient) Get(ctx context.Context, resourceGroupName string, serviceName string, groupID string, options *GroupGetOptions) (GroupGetResponse, error)

Get - Gets the details of the group specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*GroupClient) GetEntityTag 

func (client *GroupClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, groupID string, options *GroupGetEntityTagOptions) (GroupGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the group specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*GroupClient) ListByService 

func (client *GroupClient) ListByService(resourceGroupName string, serviceName string, options *GroupListByServiceOptions) *GroupListByServicePager

ListByService - Lists a collection of groups defined within a service instance. If the operation fails it returns the *ErrorResponse error type.

func (*GroupClient) Update 

func (client *GroupClient) Update(ctx context.Context, resourceGroupName string, serviceName string, groupID string, ifMatch string, parameters GroupUpdateParameters, options *GroupUpdateOptions) (GroupUpdateResponse, error)

Update - Updates the details of the group specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type GroupCollection 

type GroupCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*GroupContract `json:"value,omitempty"`
}

GroupCollection - Paged Group list representation.

func (GroupCollection) MarshalJSON 

func (g GroupCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GroupCollection.

type GroupContract 

type GroupContract struct {
	Resource
	// Group entity contract properties.
	Properties *GroupContractProperties `json:"properties,omitempty"`
}

GroupContract - Contract details.

func (GroupContract) MarshalJSON 

func (g GroupContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GroupContract.

type GroupContractProperties 

type GroupContractProperties struct {
	// REQUIRED; Group name.
	DisplayName *string `json:"displayName,omitempty"`

	// Group description. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`

	// For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group
	// object id>; otherwise
	// the value is null.
	ExternalID *string `json:"externalId,omitempty"`

	// Group type.
	Type *GroupType `json:"type,omitempty"`

	// READ-ONLY; true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
	BuiltIn *bool `json:"builtIn,omitempty" azure:"ro"`
}

GroupContractProperties - Group contract Properties.

type GroupCreateOrUpdateOptions 

type GroupCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

GroupCreateOrUpdateOptions contains the optional parameters for the Group.CreateOrUpdate method.

type GroupCreateOrUpdateResponse 

type GroupCreateOrUpdateResponse struct {
	GroupCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GroupCreateOrUpdateResponse contains the response from method Group.CreateOrUpdate.

type GroupCreateOrUpdateResult 

type GroupCreateOrUpdateResult struct {
	GroupContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GroupCreateOrUpdateResult contains the result from method Group.CreateOrUpdate.

type GroupCreateParameters 

type GroupCreateParameters struct {
	// Properties supplied to Create Group operation.
	Properties *GroupCreateParametersProperties `json:"properties,omitempty"`
}

GroupCreateParameters - Parameters supplied to the Create Group operation.

type GroupCreateParametersProperties 

type GroupCreateParametersProperties struct {
	// REQUIRED; Group name.
	DisplayName *string `json:"displayName,omitempty"`

	// Group description.
	Description *string `json:"description,omitempty"`

	// Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group
	// object
	// id>; otherwise the value is null.
	ExternalID *string `json:"externalId,omitempty"`

	// Group type.
	Type *GroupType `json:"type,omitempty"`
}

GroupCreateParametersProperties - Parameters supplied to the Create Group operation.

type GroupDeleteOptions 

type GroupDeleteOptions struct {
}

GroupDeleteOptions contains the optional parameters for the Group.Delete method.

type GroupDeleteResponse 

type GroupDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GroupDeleteResponse contains the response from method Group.Delete.

type GroupGetEntityTagOptions 

type GroupGetEntityTagOptions struct {
}

GroupGetEntityTagOptions contains the optional parameters for the Group.GetEntityTag method.

type GroupGetEntityTagResponse 

type GroupGetEntityTagResponse struct {
	GroupGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GroupGetEntityTagResponse contains the response from method Group.GetEntityTag.

type GroupGetEntityTagResult 

type GroupGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

GroupGetEntityTagResult contains the result from method Group.GetEntityTag.

type GroupGetOptions 

type GroupGetOptions struct {
}

GroupGetOptions contains the optional parameters for the Group.Get method.

type GroupGetResponse 

type GroupGetResponse struct {
	GroupGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GroupGetResponse contains the response from method Group.Get.

type GroupGetResult 

type GroupGetResult struct {
	GroupContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GroupGetResult contains the result from method Group.Get.

type GroupListByServiceOptions 

type GroupListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| externalId | filter | eq | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

GroupListByServiceOptions contains the optional parameters for the Group.ListByService method.

type GroupListByServicePager 

type GroupListByServicePager struct {
	// contains filtered or unexported fields
}

GroupListByServicePager provides operations for iterating over paged responses.

func (*GroupListByServicePager) Err 

func (p *GroupListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*GroupListByServicePager) NextPage 

func (p *GroupListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*GroupListByServicePager) PageResponse 

func (p *GroupListByServicePager) PageResponse() GroupListByServiceResponse

PageResponse returns the current GroupListByServiceResponse page.

type GroupListByServiceResponse 

type GroupListByServiceResponse struct {
	GroupListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GroupListByServiceResponse contains the response from method Group.ListByService.

type GroupListByServiceResult 

type GroupListByServiceResult struct {
	GroupCollection
}

GroupListByServiceResult contains the result from method Group.ListByService.

type GroupType 

type GroupType string

GroupType - Group type. 

const (
	GroupTypeCustom   GroupType = "custom"
	GroupTypeSystem   GroupType = "system"
	GroupTypeExternal GroupType = "external"
)

func PossibleGroupTypeValues 

func PossibleGroupTypeValues() []GroupType

PossibleGroupTypeValues returns the possible values for the GroupType const type.

func (GroupType) ToPtr 

func (c GroupType) ToPtr() *GroupType

ToPtr returns a *GroupType pointing to the current value.

type GroupUpdateOptions 

type GroupUpdateOptions struct {
}

GroupUpdateOptions contains the optional parameters for the Group.Update method.

type GroupUpdateParameters 

type GroupUpdateParameters struct {
	// Group entity update contract properties.
	Properties *GroupUpdateParametersProperties `json:"properties,omitempty"`
}

GroupUpdateParameters - Parameters supplied to the Update Group operation.

func (GroupUpdateParameters) MarshalJSON 

func (g GroupUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GroupUpdateParameters.

type GroupUpdateParametersProperties 

type GroupUpdateParametersProperties struct {
	// Group description.
	Description *string `json:"description,omitempty"`

	// Group name.
	DisplayName *string `json:"displayName,omitempty"`

	// Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group
	// object
	// id>; otherwise the value is null.
	ExternalID *string `json:"externalId,omitempty"`

	// Group type.
	Type *GroupType `json:"type,omitempty"`
}

GroupUpdateParametersProperties - Parameters supplied to the Update Group operation.

type GroupUpdateResponse 

type GroupUpdateResponse struct {
	GroupUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GroupUpdateResponse contains the response from method Group.Update.

type GroupUpdateResult 

type GroupUpdateResult struct {
	GroupContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GroupUpdateResult contains the result from method Group.Update.

type GroupUserCheckEntityExistsOptions 

type GroupUserCheckEntityExistsOptions struct {
}

GroupUserCheckEntityExistsOptions contains the optional parameters for the GroupUser.CheckEntityExists method.

type GroupUserCheckEntityExistsResponse 

type GroupUserCheckEntityExistsResponse struct {
	GroupUserCheckEntityExistsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GroupUserCheckEntityExistsResponse contains the response from method GroupUser.CheckEntityExists.

type GroupUserCheckEntityExistsResult 

type GroupUserCheckEntityExistsResult struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

GroupUserCheckEntityExistsResult contains the result from method GroupUser.CheckEntityExists.

type GroupUserClient 

type GroupUserClient struct {
	// contains filtered or unexported fields
}

GroupUserClient contains the methods for the GroupUser group. Don't use this type directly, use NewGroupUserClient() instead.

func NewGroupUserClient 

func NewGroupUserClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *GroupUserClient

NewGroupUserClient creates a new instance of GroupUserClient with the specified values.

func (*GroupUserClient) CheckEntityExists 

func (client *GroupUserClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, groupID string, userID string, options *GroupUserCheckEntityExistsOptions) (GroupUserCheckEntityExistsResponse, error)

CheckEntityExists - Checks that user entity specified by identifier is associated with the group entity. If the operation fails it returns the *ErrorResponse error type.

func (*GroupUserClient) Create 

func (client *GroupUserClient) Create(ctx context.Context, resourceGroupName string, serviceName string, groupID string, userID string, options *GroupUserCreateOptions) (GroupUserCreateResponse, error)

Create - Add existing user to existing group If the operation fails it returns the *ErrorResponse error type.

func (*GroupUserClient) Delete 

func (client *GroupUserClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, groupID string, userID string, options *GroupUserDeleteOptions) (GroupUserDeleteResponse, error)

Delete - Remove existing user from existing group. If the operation fails it returns the *ErrorResponse error type.

func (*GroupUserClient) List 

func (client *GroupUserClient) List(resourceGroupName string, serviceName string, groupID string, options *GroupUserListOptions) *GroupUserListPager

List - Lists a collection of user entities associated with the group. If the operation fails it returns the *ErrorResponse error type.

type GroupUserCreateOptions 

type GroupUserCreateOptions struct {
}

GroupUserCreateOptions contains the optional parameters for the GroupUser.Create method.

type GroupUserCreateResponse 

type GroupUserCreateResponse struct {
	GroupUserCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GroupUserCreateResponse contains the response from method GroupUser.Create.

type GroupUserCreateResult 

type GroupUserCreateResult struct {
	UserContract
}

GroupUserCreateResult contains the result from method GroupUser.Create.

type GroupUserDeleteOptions 

type GroupUserDeleteOptions struct {
}

GroupUserDeleteOptions contains the optional parameters for the GroupUser.Delete method.

type GroupUserDeleteResponse 

type GroupUserDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GroupUserDeleteResponse contains the response from method GroupUser.Delete.

type GroupUserListOptions 

type GroupUserListOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| email | filter | ge, le, eq, ne, gt,
	// lt | substringof, contains, startswith, endswith |</br>| registrationDate | filter | ge, le, eq, ne, gt, lt | |</br>| note | filter | ge, le, eq, ne,
	// gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

GroupUserListOptions contains the optional parameters for the GroupUser.List method.

type GroupUserListPager 

type GroupUserListPager struct {
	// contains filtered or unexported fields
}

GroupUserListPager provides operations for iterating over paged responses.

func (*GroupUserListPager) Err 

func (p *GroupUserListPager) Err() error

Err returns the last error encountered while paging.

func (*GroupUserListPager) NextPage 

func (p *GroupUserListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*GroupUserListPager) PageResponse 

func (p *GroupUserListPager) PageResponse() GroupUserListResponse

PageResponse returns the current GroupUserListResponse page.

type GroupUserListResponse 

type GroupUserListResponse struct {
	GroupUserListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

GroupUserListResponse contains the response from method GroupUser.List.

type GroupUserListResult 

type GroupUserListResult struct {
	UserCollection
}

GroupUserListResult contains the result from method GroupUser.List.

type HTTPCorrelationProtocol 

type HTTPCorrelationProtocol string

HTTPCorrelationProtocol - Sets correlation protocol to use for Application Insights diagnostics. 

const (
	// HTTPCorrelationProtocolLegacy - Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
	HTTPCorrelationProtocolLegacy HTTPCorrelationProtocol = "Legacy"
	// HTTPCorrelationProtocolNone - Do not read and inject correlation headers.
	HTTPCorrelationProtocolNone HTTPCorrelationProtocol = "None"
	// HTTPCorrelationProtocolW3C - Inject Trace Context headers. See https://w3c.github.io/trace-context.
	HTTPCorrelationProtocolW3C HTTPCorrelationProtocol = "W3C"
)

func PossibleHTTPCorrelationProtocolValues 

func PossibleHTTPCorrelationProtocolValues() []HTTPCorrelationProtocol

PossibleHTTPCorrelationProtocolValues returns the possible values for the HTTPCorrelationProtocol const type.

func (HTTPCorrelationProtocol) ToPtr 

func (c HTTPCorrelationProtocol) ToPtr() *HTTPCorrelationProtocol

ToPtr returns a *HTTPCorrelationProtocol pointing to the current value.

type HTTPHeader 

type HTTPHeader struct {
	// REQUIRED; Header name.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Header value.
	Value *string `json:"value,omitempty"`
}

HTTPHeader - HTTP header and it's value.

type HTTPMessageDiagnostic 

type HTTPMessageDiagnostic struct {
	// Body logging settings.
	Body *BodyDiagnosticSettings `json:"body,omitempty"`

	// Data masking settings.
	DataMasking *DataMasking `json:"dataMasking,omitempty"`

	// Array of HTTP Headers to log.
	Headers []*string `json:"headers,omitempty"`
}

HTTPMessageDiagnostic - Http message diagnostic settings.

func (HTTPMessageDiagnostic) MarshalJSON 

func (h HTTPMessageDiagnostic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HTTPMessageDiagnostic.

type HostnameConfiguration 

type HostnameConfiguration struct {
	// REQUIRED; Hostname to configure on the Api Management service.
	HostName *string `json:"hostName,omitempty"`

	// REQUIRED; Hostname type.
	Type *HostnameType `json:"type,omitempty"`

	// Certificate information.
	Certificate *CertificateInformation `json:"certificate,omitempty"`

	// Certificate Password.
	CertificatePassword *string `json:"certificatePassword,omitempty"`

	// Certificate Source.
	CertificateSource *CertificateSource `json:"certificateSource,omitempty"`

	// Certificate Status.
	CertificateStatus *CertificateStatus `json:"certificateStatus,omitempty"`

	// Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this
	// will be the certificate that will be challenged.
	// The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied
	// to Proxy Hostname Type.
	DefaultSSLBinding *bool `json:"defaultSslBinding,omitempty"`

	// Base64 Encoded certificate.
	EncodedCertificate *string `json:"encodedCertificate,omitempty"`

	// System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
	IdentityClientID *string `json:"identityClientId,omitempty"`

	// Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work.
	// This requires Api Management service to be
	// configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
	KeyVaultID *string `json:"keyVaultId,omitempty"`

	// Specify true to always negotiate client certificate on the hostname. Default Value is false.
	NegotiateClientCertificate *bool `json:"negotiateClientCertificate,omitempty"`
}

HostnameConfiguration - Custom hostname configuration.

type HostnameType 

type HostnameType string

HostnameType - Hostname type. 

const (
	HostnameTypeDeveloperPortal HostnameType = "DeveloperPortal"
	HostnameTypeManagement      HostnameType = "Management"
	HostnameTypePortal          HostnameType = "Portal"
	HostnameTypeProxy           HostnameType = "Proxy"
	HostnameTypeScm             HostnameType = "Scm"
)

func PossibleHostnameTypeValues 

func PossibleHostnameTypeValues() []HostnameType

PossibleHostnameTypeValues returns the possible values for the HostnameType const type.

func (HostnameType) ToPtr 

func (c HostnameType) ToPtr() *HostnameType

ToPtr returns a *HostnameType pointing to the current value.

type IdentityProviderBaseParameters 

type IdentityProviderBaseParameters struct {
	// List of Allowed Tenants when configuring Azure Active Directory login.
	AllowedTenants []*string `json:"allowedTenants,omitempty"`

	// OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
	Authority *string `json:"authority,omitempty"`

	// Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
	PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`

	// Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
	ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`

	// Signin Policy Name. Only applies to AAD B2C Identity Provider.
	SigninPolicyName *string `json:"signinPolicyName,omitempty"`

	// The TenantId to use instead of Common when logging into Active Directory
	SigninTenant *string `json:"signinTenant,omitempty"`

	// Signup Policy Name. Only applies to AAD B2C Identity Provider.
	SignupPolicyName *string `json:"signupPolicyName,omitempty"`

	// Identity Provider Type identifier.
	Type *IdentityProviderType `json:"type,omitempty"`
}

IdentityProviderBaseParameters - Identity Provider Base Parameter Properties.

func (IdentityProviderBaseParameters) MarshalJSON 

func (i IdentityProviderBaseParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityProviderBaseParameters.

type IdentityProviderClient 

type IdentityProviderClient struct {
	// contains filtered or unexported fields
}

IdentityProviderClient contains the methods for the IdentityProvider group. Don't use this type directly, use NewIdentityProviderClient() instead.

func NewIdentityProviderClient 

func NewIdentityProviderClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *IdentityProviderClient

NewIdentityProviderClient creates a new instance of IdentityProviderClient with the specified values.

func (*IdentityProviderClient) CreateOrUpdate 

func (client *IdentityProviderClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, parameters IdentityProviderCreateContract, options *IdentityProviderCreateOrUpdateOptions) (IdentityProviderCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or Updates the IdentityProvider configuration. If the operation fails it returns the *ErrorResponse error type.

func (*IdentityProviderClient) Delete 

func (client *IdentityProviderClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, ifMatch string, options *IdentityProviderDeleteOptions) (IdentityProviderDeleteResponse, error)

Delete - Deletes the specified identity provider configuration. If the operation fails it returns the *ErrorResponse error type.

func (*IdentityProviderClient) Get 

func (client *IdentityProviderClient) Get(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, options *IdentityProviderGetOptions) (IdentityProviderGetResponse, error)

Get - Gets the configuration details of the identity Provider configured in specified service instance. If the operation fails it returns the *ErrorResponse error type.

func (*IdentityProviderClient) GetEntityTag 

func (client *IdentityProviderClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, options *IdentityProviderGetEntityTagOptions) (IdentityProviderGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the identityProvider specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*IdentityProviderClient) ListByService 

func (client *IdentityProviderClient) ListByService(resourceGroupName string, serviceName string, options *IdentityProviderListByServiceOptions) *IdentityProviderListByServicePager

ListByService - Lists a collection of Identity Provider configured in the specified service instance. If the operation fails it returns the *ErrorResponse error type.

func (*IdentityProviderClient) ListSecrets 

func (client *IdentityProviderClient) ListSecrets(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, options *IdentityProviderListSecretsOptions) (IdentityProviderListSecretsResponse, error)

ListSecrets - Gets the client secret details of the Identity Provider. If the operation fails it returns the *ErrorResponse error type.

func (*IdentityProviderClient) Update 

func (client *IdentityProviderClient) Update(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, ifMatch string, parameters IdentityProviderUpdateParameters, options *IdentityProviderUpdateOptions) (IdentityProviderUpdateResponse, error)

Update - Updates an existing IdentityProvider configuration. If the operation fails it returns the *ErrorResponse error type.

type IdentityProviderContract 

type IdentityProviderContract struct {
	Resource
	// Identity Provider contract properties.
	Properties *IdentityProviderContractProperties `json:"properties,omitempty"`
}

IdentityProviderContract - Identity Provider details.

func (IdentityProviderContract) MarshalJSON 

func (i IdentityProviderContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityProviderContract.

type IdentityProviderContractProperties 

type IdentityProviderContractProperties struct {
	IdentityProviderBaseParameters
	// REQUIRED; Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
	ClientID *string `json:"clientId,omitempty"`

	// Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login,
	// API Key for Google login, Public Key for
	// Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

IdentityProviderContractProperties - The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.

func (IdentityProviderContractProperties) MarshalJSON 

func (i IdentityProviderContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityProviderContractProperties.

type IdentityProviderCreateContract 

type IdentityProviderCreateContract struct {
	Resource
	// Identity Provider contract properties.
	Properties *IdentityProviderCreateContractProperties `json:"properties,omitempty"`
}

IdentityProviderCreateContract - Identity Provider details.

func (IdentityProviderCreateContract) MarshalJSON 

func (i IdentityProviderCreateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityProviderCreateContract.

type IdentityProviderCreateContractProperties 

type IdentityProviderCreateContractProperties struct {
	IdentityProviderBaseParameters
	// REQUIRED; Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
	ClientID *string `json:"clientId,omitempty"`

	// REQUIRED; Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook
	// login, API Key for Google login, Public Key for
	// Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

IdentityProviderCreateContractProperties - The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.

func (IdentityProviderCreateContractProperties) MarshalJSON 

func (i IdentityProviderCreateContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityProviderCreateContractProperties.

type IdentityProviderCreateOrUpdateOptions 

type IdentityProviderCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

IdentityProviderCreateOrUpdateOptions contains the optional parameters for the IdentityProvider.CreateOrUpdate method.

type IdentityProviderCreateOrUpdateResponse 

type IdentityProviderCreateOrUpdateResponse struct {
	IdentityProviderCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IdentityProviderCreateOrUpdateResponse contains the response from method IdentityProvider.CreateOrUpdate.

type IdentityProviderCreateOrUpdateResult 

type IdentityProviderCreateOrUpdateResult struct {
	IdentityProviderContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

IdentityProviderCreateOrUpdateResult contains the result from method IdentityProvider.CreateOrUpdate.

type IdentityProviderDeleteOptions 

type IdentityProviderDeleteOptions struct {
}

IdentityProviderDeleteOptions contains the optional parameters for the IdentityProvider.Delete method.

type IdentityProviderDeleteResponse 

type IdentityProviderDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IdentityProviderDeleteResponse contains the response from method IdentityProvider.Delete.

type IdentityProviderGetEntityTagOptions 

type IdentityProviderGetEntityTagOptions struct {
}

IdentityProviderGetEntityTagOptions contains the optional parameters for the IdentityProvider.GetEntityTag method.

type IdentityProviderGetEntityTagResponse 

type IdentityProviderGetEntityTagResponse struct {
	IdentityProviderGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IdentityProviderGetEntityTagResponse contains the response from method IdentityProvider.GetEntityTag.

type IdentityProviderGetEntityTagResult 

type IdentityProviderGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

IdentityProviderGetEntityTagResult contains the result from method IdentityProvider.GetEntityTag.

type IdentityProviderGetOptions 

type IdentityProviderGetOptions struct {
}

IdentityProviderGetOptions contains the optional parameters for the IdentityProvider.Get method.

type IdentityProviderGetResponse 

type IdentityProviderGetResponse struct {
	IdentityProviderGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IdentityProviderGetResponse contains the response from method IdentityProvider.Get.

type IdentityProviderGetResult 

type IdentityProviderGetResult struct {
	IdentityProviderContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

IdentityProviderGetResult contains the result from method IdentityProvider.Get.

type IdentityProviderList 

type IdentityProviderList struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Identity Provider configuration values.
	Value []*IdentityProviderContract `json:"value,omitempty"`
}

IdentityProviderList - List of all the Identity Providers configured on the service instance.

func (IdentityProviderList) MarshalJSON 

func (i IdentityProviderList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityProviderList.

type IdentityProviderListByServiceOptions 

type IdentityProviderListByServiceOptions struct {
}

IdentityProviderListByServiceOptions contains the optional parameters for the IdentityProvider.ListByService method.

type IdentityProviderListByServicePager 

type IdentityProviderListByServicePager struct {
	// contains filtered or unexported fields
}

IdentityProviderListByServicePager provides operations for iterating over paged responses.

func (*IdentityProviderListByServicePager) Err 

func (p *IdentityProviderListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*IdentityProviderListByServicePager) NextPage 

func (p *IdentityProviderListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IdentityProviderListByServicePager) PageResponse 

func (p *IdentityProviderListByServicePager) PageResponse() IdentityProviderListByServiceResponse

PageResponse returns the current IdentityProviderListByServiceResponse page.

type IdentityProviderListByServiceResponse 

type IdentityProviderListByServiceResponse struct {
	IdentityProviderListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IdentityProviderListByServiceResponse contains the response from method IdentityProvider.ListByService.

type IdentityProviderListByServiceResult 

type IdentityProviderListByServiceResult struct {
	IdentityProviderList
}

IdentityProviderListByServiceResult contains the result from method IdentityProvider.ListByService.

type IdentityProviderListSecretsOptions 

type IdentityProviderListSecretsOptions struct {
}

IdentityProviderListSecretsOptions contains the optional parameters for the IdentityProvider.ListSecrets method.

type IdentityProviderListSecretsResponse 

type IdentityProviderListSecretsResponse struct {
	IdentityProviderListSecretsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IdentityProviderListSecretsResponse contains the response from method IdentityProvider.ListSecrets.

type IdentityProviderListSecretsResult 

type IdentityProviderListSecretsResult struct {
	ClientSecretContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

IdentityProviderListSecretsResult contains the result from method IdentityProvider.ListSecrets.

type IdentityProviderType 

type IdentityProviderType string
const (
	// IdentityProviderTypeAAD - Azure Active Directory as Identity provider.
	IdentityProviderTypeAAD IdentityProviderType = "aad"
	// IdentityProviderTypeAADB2C - Azure Active Directory B2C as Identity provider.
	IdentityProviderTypeAADB2C IdentityProviderType = "aadB2C"
	// IdentityProviderTypeFacebook - Facebook as Identity provider.
	IdentityProviderTypeFacebook IdentityProviderType = "facebook"
	// IdentityProviderTypeGoogle - Google as Identity provider.
	IdentityProviderTypeGoogle IdentityProviderType = "google"
	// IdentityProviderTypeMicrosoft - Microsoft Live as Identity provider.
	IdentityProviderTypeMicrosoft IdentityProviderType = "microsoft"
	// IdentityProviderTypeTwitter - Twitter as Identity provider.
	IdentityProviderTypeTwitter IdentityProviderType = "twitter"
)

func PossibleIdentityProviderTypeValues 

func PossibleIdentityProviderTypeValues() []IdentityProviderType

PossibleIdentityProviderTypeValues returns the possible values for the IdentityProviderType const type.

func (IdentityProviderType) ToPtr 

func (c IdentityProviderType) ToPtr() *IdentityProviderType

ToPtr returns a *IdentityProviderType pointing to the current value.

type IdentityProviderUpdateOptions 

type IdentityProviderUpdateOptions struct {
}

IdentityProviderUpdateOptions contains the optional parameters for the IdentityProvider.Update method.

type IdentityProviderUpdateParameters 

type IdentityProviderUpdateParameters struct {
	// Identity Provider update properties.
	Properties *IdentityProviderUpdateProperties `json:"properties,omitempty"`
}

IdentityProviderUpdateParameters - Parameters supplied to update Identity Provider

func (IdentityProviderUpdateParameters) MarshalJSON 

func (i IdentityProviderUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityProviderUpdateParameters.

type IdentityProviderUpdateProperties 

type IdentityProviderUpdateProperties struct {
	IdentityProviderBaseParameters
	// Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
	ClientID *string `json:"clientId,omitempty"`

	// Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login,
	// API Key for Google login, Public Key for
	// Microsoft.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

IdentityProviderUpdateProperties - Parameters supplied to the Update Identity Provider operation.

func (IdentityProviderUpdateProperties) MarshalJSON 

func (i IdentityProviderUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityProviderUpdateProperties.

type IdentityProviderUpdateResponse 

type IdentityProviderUpdateResponse struct {
	IdentityProviderUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IdentityProviderUpdateResponse contains the response from method IdentityProvider.Update.

type IdentityProviderUpdateResult 

type IdentityProviderUpdateResult struct {
	IdentityProviderContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

IdentityProviderUpdateResult contains the result from method IdentityProvider.Update.

type IssueAttachmentCollection 

type IssueAttachmentCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Issue Attachment values.
	Value []*IssueAttachmentContract `json:"value,omitempty" azure:"ro"`
}

IssueAttachmentCollection - Paged Issue Attachment list representation.

func (IssueAttachmentCollection) MarshalJSON 

func (i IssueAttachmentCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueAttachmentCollection.

type IssueAttachmentContract 

type IssueAttachmentContract struct {
	Resource
	// Properties of the Issue Attachment.
	Properties *IssueAttachmentContractProperties `json:"properties,omitempty"`
}

IssueAttachmentContract - Issue Attachment Contract details.

func (IssueAttachmentContract) MarshalJSON 

func (i IssueAttachmentContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueAttachmentContract.

type IssueAttachmentContractProperties 

type IssueAttachmentContractProperties struct {
	// REQUIRED; An HTTP link or Base64-encoded binary data.
	Content *string `json:"content,omitempty"`

	// REQUIRED; Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.
	ContentFormat *string `json:"contentFormat,omitempty"`

	// REQUIRED; Filename by which the binary data will be saved.
	Title *string `json:"title,omitempty"`
}

IssueAttachmentContractProperties - Issue Attachment contract Properties.

type IssueClient 

type IssueClient struct {
	// contains filtered or unexported fields
}

IssueClient contains the methods for the Issue group. Don't use this type directly, use NewIssueClient() instead.

func NewIssueClient 

func NewIssueClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *IssueClient

NewIssueClient creates a new instance of IssueClient with the specified values.

func (*IssueClient) Get 

func (client *IssueClient) Get(ctx context.Context, resourceGroupName string, serviceName string, issueID string, options *IssueGetOptions) (IssueGetResponse, error)

Get - Gets API Management issue details If the operation fails it returns the *ErrorResponse error type.

func (*IssueClient) ListByService 

func (client *IssueClient) ListByService(resourceGroupName string, serviceName string, options *IssueListByServiceOptions) *IssueListByServicePager

ListByService - Lists a collection of issues in the specified service instance. If the operation fails it returns the *ErrorResponse error type.

type IssueCollection 

type IssueCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Issue values.
	Value []*IssueContract `json:"value,omitempty" azure:"ro"`
}

IssueCollection - Paged Issue list representation.

func (IssueCollection) MarshalJSON 

func (i IssueCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueCollection.

type IssueCommentCollection 

type IssueCommentCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Issue Comment values.
	Value []*IssueCommentContract `json:"value,omitempty" azure:"ro"`
}

IssueCommentCollection - Paged Issue Comment list representation.

func (IssueCommentCollection) MarshalJSON 

func (i IssueCommentCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueCommentCollection.

type IssueCommentContract 

type IssueCommentContract struct {
	Resource
	// Properties of the Issue Comment.
	Properties *IssueCommentContractProperties `json:"properties,omitempty"`
}

IssueCommentContract - Issue Comment Contract details.

func (IssueCommentContract) MarshalJSON 

func (i IssueCommentContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueCommentContract.

type IssueCommentContractProperties 

type IssueCommentContractProperties struct {
	// REQUIRED; Comment text.
	Text *string `json:"text,omitempty"`

	// REQUIRED; A resource identifier for the user who left the comment.
	UserID *string `json:"userId,omitempty"`

	// Date and time when the comment was created.
	CreatedDate *time.Time `json:"createdDate,omitempty"`
}

IssueCommentContractProperties - Issue Comment contract Properties.

func (IssueCommentContractProperties) MarshalJSON 

func (i IssueCommentContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueCommentContractProperties.

func (*IssueCommentContractProperties) UnmarshalJSON 

func (i *IssueCommentContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IssueCommentContractProperties.

type IssueContract 

type IssueContract struct {
	Resource
	// Properties of the Issue.
	Properties *IssueContractProperties `json:"properties,omitempty"`
}

IssueContract - Issue Contract details.

func (IssueContract) MarshalJSON 

func (i IssueContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueContract.

type IssueContractBaseProperties 

type IssueContractBaseProperties struct {
	// A resource identifier for the API the issue was created for.
	APIID *string `json:"apiId,omitempty"`

	// Date and time when the issue was created.
	CreatedDate *time.Time `json:"createdDate,omitempty"`

	// Status of the issue.
	State *State `json:"state,omitempty"`
}

IssueContractBaseProperties - Issue contract Base Properties.

func (IssueContractBaseProperties) MarshalJSON 

func (i IssueContractBaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueContractBaseProperties.

func (*IssueContractBaseProperties) UnmarshalJSON 

func (i *IssueContractBaseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IssueContractBaseProperties.

type IssueContractProperties 

type IssueContractProperties struct {
	IssueContractBaseProperties
	// REQUIRED; Text describing the issue.
	Description *string `json:"description,omitempty"`

	// REQUIRED; The issue title.
	Title *string `json:"title,omitempty"`

	// REQUIRED; A resource identifier for the user created the issue.
	UserID *string `json:"userId,omitempty"`
}

IssueContractProperties - Issue contract Properties.

func (IssueContractProperties) MarshalJSON 

func (i IssueContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueContractProperties.

func (*IssueContractProperties) UnmarshalJSON 

func (i *IssueContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IssueContractProperties.

type IssueGetOptions 

type IssueGetOptions struct {
}

IssueGetOptions contains the optional parameters for the Issue.Get method.

type IssueGetResponse 

type IssueGetResponse struct {
	IssueGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IssueGetResponse contains the response from method Issue.Get.

type IssueGetResult 

type IssueGetResult struct {
	IssueContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

IssueGetResult contains the result from method Issue.Get.

type IssueListByServiceOptions 

type IssueListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne,
	// gt, lt | substringof, contains, startswith, endswith |</br>| authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith
	// |</br>| state | filter | eq | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

IssueListByServiceOptions contains the optional parameters for the Issue.ListByService method.

type IssueListByServicePager 

type IssueListByServicePager struct {
	// contains filtered or unexported fields
}

IssueListByServicePager provides operations for iterating over paged responses.

func (*IssueListByServicePager) Err 

func (p *IssueListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*IssueListByServicePager) NextPage 

func (p *IssueListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IssueListByServicePager) PageResponse 

func (p *IssueListByServicePager) PageResponse() IssueListByServiceResponse

PageResponse returns the current IssueListByServiceResponse page.

type IssueListByServiceResponse 

type IssueListByServiceResponse struct {
	IssueListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IssueListByServiceResponse contains the response from method Issue.ListByService.

type IssueListByServiceResult 

type IssueListByServiceResult struct {
	IssueCollection
}

IssueListByServiceResult contains the result from method Issue.ListByService.

type IssueType 

type IssueType string

IssueType - The type of issue. 

const (
	IssueTypeAgentStopped        IssueType = "AgentStopped"
	IssueTypeDNSResolution       IssueType = "DnsResolution"
	IssueTypeGuestFirewall       IssueType = "GuestFirewall"
	IssueTypeNetworkSecurityRule IssueType = "NetworkSecurityRule"
	IssueTypePlatform            IssueType = "Platform"
	IssueTypePortThrottled       IssueType = "PortThrottled"
	IssueTypeSocketBind          IssueType = "SocketBind"
	IssueTypeUnknown             IssueType = "Unknown"
	IssueTypeUserDefinedRoute    IssueType = "UserDefinedRoute"
)

func PossibleIssueTypeValues 

func PossibleIssueTypeValues() []IssueType

PossibleIssueTypeValues returns the possible values for the IssueType const type.

func (IssueType) ToPtr 

func (c IssueType) ToPtr() *IssueType

ToPtr returns a *IssueType pointing to the current value.

type IssueUpdateContract 

type IssueUpdateContract struct {
	// Issue entity Update contract properties.
	Properties *IssueUpdateContractProperties `json:"properties,omitempty"`
}

IssueUpdateContract - Issue update Parameters.

func (IssueUpdateContract) MarshalJSON 

func (i IssueUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueUpdateContract.

type IssueUpdateContractProperties 

type IssueUpdateContractProperties struct {
	IssueContractBaseProperties
	// Text describing the issue.
	Description *string `json:"description,omitempty"`

	// The issue title.
	Title *string `json:"title,omitempty"`

	// A resource identifier for the user created the issue.
	UserID *string `json:"userId,omitempty"`
}

IssueUpdateContractProperties - Issue contract Update Properties.

func (IssueUpdateContractProperties) MarshalJSON 

func (i IssueUpdateContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IssueUpdateContractProperties.

func (*IssueUpdateContractProperties) UnmarshalJSON 

func (i *IssueUpdateContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IssueUpdateContractProperties.

type KeyType 

type KeyType string

KeyType - The Key to be used to generate token for user. 

const (
	KeyTypePrimary   KeyType = "primary"
	KeyTypeSecondary KeyType = "secondary"
)

func PossibleKeyTypeValues 

func PossibleKeyTypeValues() []KeyType

PossibleKeyTypeValues returns the possible values for the KeyType const type.

func (KeyType) ToPtr 

func (c KeyType) ToPtr() *KeyType

ToPtr returns a *KeyType pointing to the current value.

type KeyVaultContractCreateProperties 

type KeyVaultContractCreateProperties struct {
	// SystemAssignedIdentity or UserAssignedIdentity Client Id which will be used to access key vault secret.
	IdentityClientID *string `json:"identityClientId,omitempty"`

	// Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured
	// with aka.ms/apimmsi
	SecretIdentifier *string `json:"secretIdentifier,omitempty"`
}

KeyVaultContractCreateProperties - Create keyVault contract details.

type KeyVaultContractProperties 

type KeyVaultContractProperties struct {
	KeyVaultContractCreateProperties
	// Last time sync and refresh status of secret from key vault.
	LastStatus *KeyVaultLastAccessStatusContractProperties `json:"lastStatus,omitempty"`
}

KeyVaultContractProperties - KeyVault contract details.

type KeyVaultLastAccessStatusContractProperties 

type KeyVaultLastAccessStatusContractProperties struct {
	// Last status code for sync and refresh of secret from key vault.
	Code *string `json:"code,omitempty"`

	// Details of the error else empty.
	Message *string `json:"message,omitempty"`

	// Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	TimeStampUTC *time.Time `json:"timeStampUtc,omitempty"`
}

KeyVaultLastAccessStatusContractProperties - Issue contract Update Properties.

func (KeyVaultLastAccessStatusContractProperties) MarshalJSON 

func (k KeyVaultLastAccessStatusContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyVaultLastAccessStatusContractProperties.

func (*KeyVaultLastAccessStatusContractProperties) UnmarshalJSON 

func (k *KeyVaultLastAccessStatusContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyVaultLastAccessStatusContractProperties.

type LoggerClient 

type LoggerClient struct {
	// contains filtered or unexported fields
}

LoggerClient contains the methods for the Logger group. Don't use this type directly, use NewLoggerClient() instead.

func NewLoggerClient 

func NewLoggerClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LoggerClient

NewLoggerClient creates a new instance of LoggerClient with the specified values.

func (*LoggerClient) CreateOrUpdate 

func (client *LoggerClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, loggerID string, parameters LoggerContract, options *LoggerCreateOrUpdateOptions) (LoggerCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or Updates a logger. If the operation fails it returns the *ErrorResponse error type.

func (*LoggerClient) Delete 

func (client *LoggerClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, loggerID string, ifMatch string, options *LoggerDeleteOptions) (LoggerDeleteResponse, error)

Delete - Deletes the specified logger. If the operation fails it returns the *ErrorResponse error type.

func (*LoggerClient) Get 

func (client *LoggerClient) Get(ctx context.Context, resourceGroupName string, serviceName string, loggerID string, options *LoggerGetOptions) (LoggerGetResponse, error)

Get - Gets the details of the logger specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*LoggerClient) GetEntityTag 

func (client *LoggerClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, loggerID string, options *LoggerGetEntityTagOptions) (LoggerGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the logger specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*LoggerClient) ListByService 

func (client *LoggerClient) ListByService(resourceGroupName string, serviceName string, options *LoggerListByServiceOptions) *LoggerListByServicePager

ListByService - Lists a collection of loggers in the specified service instance. If the operation fails it returns the *ErrorResponse error type.

func (*LoggerClient) Update 

func (client *LoggerClient) Update(ctx context.Context, resourceGroupName string, serviceName string, loggerID string, ifMatch string, parameters LoggerUpdateContract, options *LoggerUpdateOptions) (LoggerUpdateResponse, error)

Update - Updates an existing logger. If the operation fails it returns the *ErrorResponse error type.

type LoggerCollection 

type LoggerCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Logger values.
	Value []*LoggerContract `json:"value,omitempty"`
}

LoggerCollection - Paged Logger list representation.

func (LoggerCollection) MarshalJSON 

func (l LoggerCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoggerCollection.

type LoggerContract 

type LoggerContract struct {
	Resource
	// Logger entity contract properties.
	Properties *LoggerContractProperties `json:"properties,omitempty"`
}

LoggerContract - Logger details.

func (LoggerContract) MarshalJSON 

func (l LoggerContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoggerContract.

type LoggerContractProperties 

type LoggerContractProperties struct {
	// REQUIRED; Logger type.
	LoggerType *LoggerType `json:"loggerType,omitempty"`

	// The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger.
	Credentials map[string]*string `json:"credentials,omitempty"`

	// Logger description.
	Description *string `json:"description,omitempty"`

	// Whether records are buffered in the logger before publishing. Default is assumed to be true.
	IsBuffered *bool `json:"isBuffered,omitempty"`

	// Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).
	ResourceID *string `json:"resourceId,omitempty"`
}

LoggerContractProperties - The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.

func (LoggerContractProperties) MarshalJSON 

func (l LoggerContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoggerContractProperties.

type LoggerCreateOrUpdateOptions 

type LoggerCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

LoggerCreateOrUpdateOptions contains the optional parameters for the Logger.CreateOrUpdate method.

type LoggerCreateOrUpdateResponse 

type LoggerCreateOrUpdateResponse struct {
	LoggerCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoggerCreateOrUpdateResponse contains the response from method Logger.CreateOrUpdate.

type LoggerCreateOrUpdateResult 

type LoggerCreateOrUpdateResult struct {
	LoggerContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

LoggerCreateOrUpdateResult contains the result from method Logger.CreateOrUpdate.

type LoggerDeleteOptions 

type LoggerDeleteOptions struct {
}

LoggerDeleteOptions contains the optional parameters for the Logger.Delete method.

type LoggerDeleteResponse 

type LoggerDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoggerDeleteResponse contains the response from method Logger.Delete.

type LoggerGetEntityTagOptions 

type LoggerGetEntityTagOptions struct {
}

LoggerGetEntityTagOptions contains the optional parameters for the Logger.GetEntityTag method.

type LoggerGetEntityTagResponse 

type LoggerGetEntityTagResponse struct {
	LoggerGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoggerGetEntityTagResponse contains the response from method Logger.GetEntityTag.

type LoggerGetEntityTagResult 

type LoggerGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

LoggerGetEntityTagResult contains the result from method Logger.GetEntityTag.

type LoggerGetOptions 

type LoggerGetOptions struct {
}

LoggerGetOptions contains the optional parameters for the Logger.Get method.

type LoggerGetResponse 

type LoggerGetResponse struct {
	LoggerGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoggerGetResponse contains the response from method Logger.Get.

type LoggerGetResult 

type LoggerGetResult struct {
	LoggerContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

LoggerGetResult contains the result from method Logger.Get.

type LoggerListByServiceOptions 

type LoggerListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| loggerType | filter | eq | |</br>| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

LoggerListByServiceOptions contains the optional parameters for the Logger.ListByService method.

type LoggerListByServicePager 

type LoggerListByServicePager struct {
	// contains filtered or unexported fields
}

LoggerListByServicePager provides operations for iterating over paged responses.

func (*LoggerListByServicePager) Err 

func (p *LoggerListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*LoggerListByServicePager) NextPage 

func (p *LoggerListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LoggerListByServicePager) PageResponse 

func (p *LoggerListByServicePager) PageResponse() LoggerListByServiceResponse

PageResponse returns the current LoggerListByServiceResponse page.

type LoggerListByServiceResponse 

type LoggerListByServiceResponse struct {
	LoggerListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoggerListByServiceResponse contains the response from method Logger.ListByService.

type LoggerListByServiceResult 

type LoggerListByServiceResult struct {
	LoggerCollection
}

LoggerListByServiceResult contains the result from method Logger.ListByService.

type LoggerType 

type LoggerType string

LoggerType - Logger type. 

const (
	// LoggerTypeApplicationInsights - Azure Application Insights as log destination.
	LoggerTypeApplicationInsights LoggerType = "applicationInsights"
	// LoggerTypeAzureEventHub - Azure Event Hub as log destination.
	LoggerTypeAzureEventHub LoggerType = "azureEventHub"
	// LoggerTypeAzureMonitor - Azure Monitor
	LoggerTypeAzureMonitor LoggerType = "azureMonitor"
)

func PossibleLoggerTypeValues 

func PossibleLoggerTypeValues() []LoggerType

PossibleLoggerTypeValues returns the possible values for the LoggerType const type.

func (LoggerType) ToPtr 

func (c LoggerType) ToPtr() *LoggerType

ToPtr returns a *LoggerType pointing to the current value.

type LoggerUpdateContract 

type LoggerUpdateContract struct {
	// Logger entity update contract properties.
	Properties *LoggerUpdateParameters `json:"properties,omitempty"`
}

LoggerUpdateContract - Logger update contract.

func (LoggerUpdateContract) MarshalJSON 

func (l LoggerUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoggerUpdateContract.

type LoggerUpdateOptions 

type LoggerUpdateOptions struct {
}

LoggerUpdateOptions contains the optional parameters for the Logger.Update method.

type LoggerUpdateParameters 

type LoggerUpdateParameters struct {
	// Logger credentials.
	Credentials map[string]*string `json:"credentials,omitempty"`

	// Logger description.
	Description *string `json:"description,omitempty"`

	// Whether records are buffered in the logger before publishing. Default is assumed to be true.
	IsBuffered *bool `json:"isBuffered,omitempty"`

	// Logger type.
	LoggerType *LoggerType `json:"loggerType,omitempty"`
}

LoggerUpdateParameters - Parameters supplied to the Update Logger operation.

func (LoggerUpdateParameters) MarshalJSON 

func (l LoggerUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoggerUpdateParameters.

type LoggerUpdateResponse 

type LoggerUpdateResponse struct {
	LoggerUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoggerUpdateResponse contains the response from method Logger.Update.

type LoggerUpdateResult 

type LoggerUpdateResult struct {
	LoggerContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

LoggerUpdateResult contains the result from method Logger.Update.

type Method 

type Method string

Method - The HTTP method to be used. 

const (
	MethodGET  Method = "GET"
	MethodPOST Method = "POST"
)

func PossibleMethodValues 

func PossibleMethodValues() []Method

PossibleMethodValues returns the possible values for the Method const type.

func (Method) ToPtr 

func (c Method) ToPtr() *Method

ToPtr returns a *Method pointing to the current value.

type NameAvailabilityReason 

type NameAvailabilityReason string

NameAvailabilityReason - Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. 

const (
	NameAvailabilityReasonValid         NameAvailabilityReason = "Valid"
	NameAvailabilityReasonInvalid       NameAvailabilityReason = "Invalid"
	NameAvailabilityReasonAlreadyExists NameAvailabilityReason = "AlreadyExists"
)

func PossibleNameAvailabilityReasonValues 

func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason

PossibleNameAvailabilityReasonValues returns the possible values for the NameAvailabilityReason const type.

func (NameAvailabilityReason) ToPtr 

func (c NameAvailabilityReason) ToPtr() *NameAvailabilityReason

ToPtr returns a *NameAvailabilityReason pointing to the current value.

type NamedValueBeginCreateOrUpdateOptions 

type NamedValueBeginCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

NamedValueBeginCreateOrUpdateOptions contains the optional parameters for the NamedValue.BeginCreateOrUpdate method.

type NamedValueBeginRefreshSecretOptions 

type NamedValueBeginRefreshSecretOptions struct {
}

NamedValueBeginRefreshSecretOptions contains the optional parameters for the NamedValue.BeginRefreshSecret method.

type NamedValueBeginUpdateOptions 

type NamedValueBeginUpdateOptions struct {
}

NamedValueBeginUpdateOptions contains the optional parameters for the NamedValue.BeginUpdate method.

type NamedValueClient 

type NamedValueClient struct {
	// contains filtered or unexported fields
}

NamedValueClient contains the methods for the NamedValue group. Don't use this type directly, use NewNamedValueClient() instead.

func NewNamedValueClient 

func NewNamedValueClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *NamedValueClient

NewNamedValueClient creates a new instance of NamedValueClient with the specified values.

func (*NamedValueClient) BeginCreateOrUpdate 

func (client *NamedValueClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, namedValueID string, parameters NamedValueCreateContract, options *NamedValueBeginCreateOrUpdateOptions) (NamedValueCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates named value. If the operation fails it returns the *ErrorResponse error type.

func (*NamedValueClient) BeginRefreshSecret 

func (client *NamedValueClient) BeginRefreshSecret(ctx context.Context, resourceGroupName string, serviceName string, namedValueID string, options *NamedValueBeginRefreshSecretOptions) (NamedValueRefreshSecretPollerResponse, error)

BeginRefreshSecret - Refresh the secret of the named value specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*NamedValueClient) BeginUpdate 

func (client *NamedValueClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, namedValueID string, ifMatch string, parameters NamedValueUpdateParameters, options *NamedValueBeginUpdateOptions) (NamedValueUpdatePollerResponse, error)

BeginUpdate - Updates the specific named value. If the operation fails it returns the *ErrorResponse error type.

func (*NamedValueClient) Delete 

func (client *NamedValueClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, namedValueID string, ifMatch string, options *NamedValueDeleteOptions) (NamedValueDeleteResponse, error)

Delete - Deletes specific named value from the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*NamedValueClient) Get 

func (client *NamedValueClient) Get(ctx context.Context, resourceGroupName string, serviceName string, namedValueID string, options *NamedValueGetOptions) (NamedValueGetResponse, error)

Get - Gets the details of the named value specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*NamedValueClient) GetEntityTag 

func (client *NamedValueClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, namedValueID string, options *NamedValueGetEntityTagOptions) (NamedValueGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the named value specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*NamedValueClient) ListByService 

func (client *NamedValueClient) ListByService(resourceGroupName string, serviceName string, options *NamedValueListByServiceOptions) *NamedValueListByServicePager

ListByService - Lists a collection of named values defined within a service instance. If the operation fails it returns the *ErrorResponse error type.

func (*NamedValueClient) ListValue 

func (client *NamedValueClient) ListValue(ctx context.Context, resourceGroupName string, serviceName string, namedValueID string, options *NamedValueListValueOptions) (NamedValueListValueResponse, error)

ListValue - Gets the secret of the named value specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type NamedValueCollection 

type NamedValueCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*NamedValueContract `json:"value,omitempty"`
}

NamedValueCollection - Paged NamedValue list representation.

func (NamedValueCollection) MarshalJSON 

func (n NamedValueCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NamedValueCollection.

type NamedValueContract 

type NamedValueContract struct {
	Resource
	// NamedValue entity contract properties.
	Properties *NamedValueContractProperties `json:"properties,omitempty"`
}

NamedValueContract - NamedValue details.

func (NamedValueContract) MarshalJSON 

func (n NamedValueContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NamedValueContract.

type NamedValueContractProperties 

type NamedValueContractProperties struct {
	NamedValueEntityBaseParameters
	// REQUIRED; Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
	DisplayName *string `json:"displayName,omitempty"`

	// KeyVault location details of the namedValue.
	KeyVault *KeyVaultContractProperties `json:"keyVault,omitempty"`

	// Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET'
	// operations! Use '/listSecrets' POST request to get
	// the value.
	Value *string `json:"value,omitempty"`
}

NamedValueContractProperties - NamedValue Contract properties.

func (NamedValueContractProperties) MarshalJSON 

func (n NamedValueContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NamedValueContractProperties.

type NamedValueCreateContract 

type NamedValueCreateContract struct {
	Resource
	// NamedValue entity contract properties for PUT operation.
	Properties *NamedValueCreateContractProperties `json:"properties,omitempty"`
}

NamedValueCreateContract - NamedValue details.

func (NamedValueCreateContract) MarshalJSON 

func (n NamedValueCreateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NamedValueCreateContract.

type NamedValueCreateContractProperties 

type NamedValueCreateContractProperties struct {
	NamedValueEntityBaseParameters
	// REQUIRED; Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
	DisplayName *string `json:"displayName,omitempty"`

	// KeyVault location details of the namedValue.
	KeyVault *KeyVaultContractCreateProperties `json:"keyVault,omitempty"`

	// Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET'
	// operations! Use '/listSecrets' POST request to get
	// the value.
	Value *string `json:"value,omitempty"`
}

NamedValueCreateContractProperties - NamedValue Contract properties.

func (NamedValueCreateContractProperties) MarshalJSON 

func (n NamedValueCreateContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NamedValueCreateContractProperties.

type NamedValueCreateOrUpdatePoller 

type NamedValueCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

NamedValueCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*NamedValueCreateOrUpdatePoller) Done 

func (p *NamedValueCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*NamedValueCreateOrUpdatePoller) FinalResponse 

func (p *NamedValueCreateOrUpdatePoller) FinalResponse(ctx context.Context) (NamedValueCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final NamedValueCreateOrUpdateResponse will be returned.

func (*NamedValueCreateOrUpdatePoller) Poll 

func (p *NamedValueCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*NamedValueCreateOrUpdatePoller) ResumeToken 

func (p *NamedValueCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type NamedValueCreateOrUpdatePollerResponse 

type NamedValueCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *NamedValueCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueCreateOrUpdatePollerResponse contains the response from method NamedValue.CreateOrUpdate.

func (NamedValueCreateOrUpdatePollerResponse) PollUntilDone 

func (l NamedValueCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (NamedValueCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*NamedValueCreateOrUpdatePollerResponse) Resume 

func (l *NamedValueCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *NamedValueClient, token string) error

Resume rehydrates a NamedValueCreateOrUpdatePollerResponse from the provided client and resume token.

type NamedValueCreateOrUpdateResponse 

type NamedValueCreateOrUpdateResponse struct {
	NamedValueCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueCreateOrUpdateResponse contains the response from method NamedValue.CreateOrUpdate.

type NamedValueCreateOrUpdateResult 

type NamedValueCreateOrUpdateResult struct {
	NamedValueContract
}

NamedValueCreateOrUpdateResult contains the result from method NamedValue.CreateOrUpdate.

type NamedValueDeleteOptions 

type NamedValueDeleteOptions struct {
}

NamedValueDeleteOptions contains the optional parameters for the NamedValue.Delete method.

type NamedValueDeleteResponse 

type NamedValueDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueDeleteResponse contains the response from method NamedValue.Delete.

type NamedValueEntityBaseParameters 

type NamedValueEntityBaseParameters struct {
	// Determines whether the value is a secret and should be encrypted or not. Default value is false.
	Secret *bool `json:"secret,omitempty"`

	// Optional tags that when provided can be used to filter the NamedValue list.
	Tags []*string `json:"tags,omitempty"`
}

NamedValueEntityBaseParameters - NamedValue Entity Base Parameters set.

func (NamedValueEntityBaseParameters) MarshalJSON 

func (n NamedValueEntityBaseParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NamedValueEntityBaseParameters.

type NamedValueGetEntityTagOptions 

type NamedValueGetEntityTagOptions struct {
}

NamedValueGetEntityTagOptions contains the optional parameters for the NamedValue.GetEntityTag method.

type NamedValueGetEntityTagResponse 

type NamedValueGetEntityTagResponse struct {
	NamedValueGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueGetEntityTagResponse contains the response from method NamedValue.GetEntityTag.

type NamedValueGetEntityTagResult 

type NamedValueGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

NamedValueGetEntityTagResult contains the result from method NamedValue.GetEntityTag.

type NamedValueGetOptions 

type NamedValueGetOptions struct {
}

NamedValueGetOptions contains the optional parameters for the NamedValue.Get method.

type NamedValueGetResponse 

type NamedValueGetResponse struct {
	NamedValueGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueGetResponse contains the response from method NamedValue.Get.

type NamedValueGetResult 

type NamedValueGetResult struct {
	NamedValueContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

NamedValueGetResult contains the result from method NamedValue.Get.

type NamedValueListByServiceOptions 

type NamedValueListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| tags | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains,
	// startswith, endswith |</br>
	Filter *string
	// When set to true, the response contains only named value entities which failed refresh.
	IsKeyVaultRefreshFailed *bool
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

NamedValueListByServiceOptions contains the optional parameters for the NamedValue.ListByService method.

type NamedValueListByServicePager 

type NamedValueListByServicePager struct {
	// contains filtered or unexported fields
}

NamedValueListByServicePager provides operations for iterating over paged responses.

func (*NamedValueListByServicePager) Err 

func (p *NamedValueListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*NamedValueListByServicePager) NextPage 

func (p *NamedValueListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*NamedValueListByServicePager) PageResponse 

func (p *NamedValueListByServicePager) PageResponse() NamedValueListByServiceResponse

PageResponse returns the current NamedValueListByServiceResponse page.

type NamedValueListByServiceResponse 

type NamedValueListByServiceResponse struct {
	NamedValueListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueListByServiceResponse contains the response from method NamedValue.ListByService.

type NamedValueListByServiceResult 

type NamedValueListByServiceResult struct {
	NamedValueCollection
}

NamedValueListByServiceResult contains the result from method NamedValue.ListByService.

type NamedValueListValueOptions 

type NamedValueListValueOptions struct {
}

NamedValueListValueOptions contains the optional parameters for the NamedValue.ListValue method.

type NamedValueListValueResponse 

type NamedValueListValueResponse struct {
	NamedValueListValueResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueListValueResponse contains the response from method NamedValue.ListValue.

type NamedValueListValueResult 

type NamedValueListValueResult struct {
	NamedValueSecretContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

NamedValueListValueResult contains the result from method NamedValue.ListValue.

type NamedValueRefreshSecretPoller 

type NamedValueRefreshSecretPoller struct {
	// contains filtered or unexported fields
}

NamedValueRefreshSecretPoller provides polling facilities until the operation reaches a terminal state.

func (*NamedValueRefreshSecretPoller) Done 

func (p *NamedValueRefreshSecretPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*NamedValueRefreshSecretPoller) FinalResponse 

func (p *NamedValueRefreshSecretPoller) FinalResponse(ctx context.Context) (NamedValueRefreshSecretResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final NamedValueRefreshSecretResponse will be returned.

func (*NamedValueRefreshSecretPoller) Poll 

func (p *NamedValueRefreshSecretPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*NamedValueRefreshSecretPoller) ResumeToken 

func (p *NamedValueRefreshSecretPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type NamedValueRefreshSecretPollerResponse 

type NamedValueRefreshSecretPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *NamedValueRefreshSecretPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueRefreshSecretPollerResponse contains the response from method NamedValue.RefreshSecret.

func (NamedValueRefreshSecretPollerResponse) PollUntilDone 

func (l NamedValueRefreshSecretPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (NamedValueRefreshSecretResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*NamedValueRefreshSecretPollerResponse) Resume 

func (l *NamedValueRefreshSecretPollerResponse) Resume(ctx context.Context, client *NamedValueClient, token string) error

Resume rehydrates a NamedValueRefreshSecretPollerResponse from the provided client and resume token.

type NamedValueRefreshSecretResponse 

type NamedValueRefreshSecretResponse struct {
	NamedValueRefreshSecretResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueRefreshSecretResponse contains the response from method NamedValue.RefreshSecret.

type NamedValueRefreshSecretResult 

type NamedValueRefreshSecretResult struct {
	NamedValueContract
}

NamedValueRefreshSecretResult contains the result from method NamedValue.RefreshSecret.

type NamedValueSecretContract 

type NamedValueSecretContract struct {
	// This is secret value of the NamedValue entity.
	Value *string `json:"value,omitempty"`
}

NamedValueSecretContract - Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

type NamedValueUpdateParameterProperties 

type NamedValueUpdateParameterProperties struct {
	NamedValueEntityBaseParameters
	// Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
	DisplayName *string `json:"displayName,omitempty"`

	// KeyVault location details of the namedValue.
	KeyVault *KeyVaultContractCreateProperties `json:"keyVault,omitempty"`

	// Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace.
	Value *string `json:"value,omitempty"`
}

NamedValueUpdateParameterProperties - NamedValue Contract properties.

func (NamedValueUpdateParameterProperties) MarshalJSON 

func (n NamedValueUpdateParameterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NamedValueUpdateParameterProperties.

type NamedValueUpdateParameters 

type NamedValueUpdateParameters struct {
	// NamedValue entity Update contract properties.
	Properties *NamedValueUpdateParameterProperties `json:"properties,omitempty"`
}

NamedValueUpdateParameters - NamedValue update Parameters.

func (NamedValueUpdateParameters) MarshalJSON 

func (n NamedValueUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NamedValueUpdateParameters.

type NamedValueUpdatePoller 

type NamedValueUpdatePoller struct {
	// contains filtered or unexported fields
}

NamedValueUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*NamedValueUpdatePoller) Done 

func (p *NamedValueUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*NamedValueUpdatePoller) FinalResponse 

func (p *NamedValueUpdatePoller) FinalResponse(ctx context.Context) (NamedValueUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final NamedValueUpdateResponse will be returned.

func (*NamedValueUpdatePoller) Poll 

func (p *NamedValueUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*NamedValueUpdatePoller) ResumeToken 

func (p *NamedValueUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type NamedValueUpdatePollerResponse 

type NamedValueUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *NamedValueUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueUpdatePollerResponse contains the response from method NamedValue.Update.

func (NamedValueUpdatePollerResponse) PollUntilDone 

func (l NamedValueUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (NamedValueUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*NamedValueUpdatePollerResponse) Resume 

func (l *NamedValueUpdatePollerResponse) Resume(ctx context.Context, client *NamedValueClient, token string) error

Resume rehydrates a NamedValueUpdatePollerResponse from the provided client and resume token.

type NamedValueUpdateResponse 

type NamedValueUpdateResponse struct {
	NamedValueUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NamedValueUpdateResponse contains the response from method NamedValue.Update.

type NamedValueUpdateResult 

type NamedValueUpdateResult struct {
	NamedValueContract
}

NamedValueUpdateResult contains the result from method NamedValue.Update.

type NetworkStatusClient 

type NetworkStatusClient struct {
	// contains filtered or unexported fields
}

NetworkStatusClient contains the methods for the NetworkStatus group. Don't use this type directly, use NewNetworkStatusClient() instead.

func NewNetworkStatusClient 

func NewNetworkStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *NetworkStatusClient

NewNetworkStatusClient creates a new instance of NetworkStatusClient with the specified values.

func (*NetworkStatusClient) ListByLocation 

func (client *NetworkStatusClient) ListByLocation(ctx context.Context, resourceGroupName string, serviceName string, locationName string, options *NetworkStatusListByLocationOptions) (NetworkStatusListByLocationResponse, error)

ListByLocation - Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService. If the operation fails it returns the *ErrorResponse error type.

func (*NetworkStatusClient) ListByService 

func (client *NetworkStatusClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, options *NetworkStatusListByServiceOptions) (NetworkStatusListByServiceResponse, error)

ListByService - Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService. If the operation fails it returns the *ErrorResponse error type.

type NetworkStatusContract 

type NetworkStatusContract struct {
	// REQUIRED; Gets the list of Connectivity Status to the Resources on which the service depends upon.
	ConnectivityStatus []*ConnectivityStatusContract `json:"connectivityStatus,omitempty"`

	// REQUIRED; Gets the list of DNS servers IPV4 addresses.
	DNSServers []*string `json:"dnsServers,omitempty"`
}

NetworkStatusContract - Network Status details.

func (NetworkStatusContract) MarshalJSON 

func (n NetworkStatusContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkStatusContract.

type NetworkStatusContractByLocation 

type NetworkStatusContractByLocation struct {
	// Location of service
	Location *string `json:"location,omitempty"`

	// Network status in Location
	NetworkStatus *NetworkStatusContract `json:"networkStatus,omitempty"`
}

NetworkStatusContractByLocation - Network Status in the Location

type NetworkStatusListByLocationOptions 

type NetworkStatusListByLocationOptions struct {
}

NetworkStatusListByLocationOptions contains the optional parameters for the NetworkStatus.ListByLocation method.

type NetworkStatusListByLocationResponse 

type NetworkStatusListByLocationResponse struct {
	NetworkStatusListByLocationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NetworkStatusListByLocationResponse contains the response from method NetworkStatus.ListByLocation.

type NetworkStatusListByLocationResult 

type NetworkStatusListByLocationResult struct {
	NetworkStatusContract
}

NetworkStatusListByLocationResult contains the result from method NetworkStatus.ListByLocation.

type NetworkStatusListByServiceOptions 

type NetworkStatusListByServiceOptions struct {
}

NetworkStatusListByServiceOptions contains the optional parameters for the NetworkStatus.ListByService method.

type NetworkStatusListByServiceResponse 

type NetworkStatusListByServiceResponse struct {
	NetworkStatusListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NetworkStatusListByServiceResponse contains the response from method NetworkStatus.ListByService.

type NetworkStatusListByServiceResult 

type NetworkStatusListByServiceResult struct {
	// List of Network Status values.
	NetworkStatusContractByLocationArray []*NetworkStatusContractByLocation
}

NetworkStatusListByServiceResult contains the result from method NetworkStatus.ListByService.

type NotificationClient 

type NotificationClient struct {
	// contains filtered or unexported fields
}

NotificationClient contains the methods for the Notification group. Don't use this type directly, use NewNotificationClient() instead.

func NewNotificationClient 

func NewNotificationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *NotificationClient

NewNotificationClient creates a new instance of NotificationClient with the specified values.

func (*NotificationClient) CreateOrUpdate 

func (client *NotificationClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, options *NotificationCreateOrUpdateOptions) (NotificationCreateOrUpdateResponse, error)

CreateOrUpdate - Create or Update API Management publisher notification. If the operation fails it returns the *ErrorResponse error type.

func (*NotificationClient) Get 

func (client *NotificationClient) Get(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, options *NotificationGetOptions) (NotificationGetResponse, error)

Get - Gets the details of the Notification specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*NotificationClient) ListByService 

func (client *NotificationClient) ListByService(resourceGroupName string, serviceName string, options *NotificationListByServiceOptions) *NotificationListByServicePager

ListByService - Lists a collection of properties defined within a service instance. If the operation fails it returns the *ErrorResponse error type.

type NotificationCollection 

type NotificationCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*NotificationContract `json:"value,omitempty"`
}

NotificationCollection - Paged Notification list representation.

func (NotificationCollection) MarshalJSON 

func (n NotificationCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NotificationCollection.

type NotificationContract 

type NotificationContract struct {
	Resource
	// Notification entity contract properties.
	Properties *NotificationContractProperties `json:"properties,omitempty"`
}

NotificationContract - Notification details.

func (NotificationContract) MarshalJSON 

func (n NotificationContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NotificationContract.

type NotificationContractProperties 

type NotificationContractProperties struct {
	// REQUIRED; Title of the Notification.
	Title *string `json:"title,omitempty"`

	// Description of the Notification.
	Description *string `json:"description,omitempty"`

	// Recipient Parameter values.
	Recipients *RecipientsContractProperties `json:"recipients,omitempty"`
}

NotificationContractProperties - Notification Contract properties.

type NotificationCreateOrUpdateOptions 

type NotificationCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

NotificationCreateOrUpdateOptions contains the optional parameters for the Notification.CreateOrUpdate method.

type NotificationCreateOrUpdateResponse 

type NotificationCreateOrUpdateResponse struct {
	NotificationCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationCreateOrUpdateResponse contains the response from method Notification.CreateOrUpdate.

type NotificationCreateOrUpdateResult 

type NotificationCreateOrUpdateResult struct {
	NotificationContract
}

NotificationCreateOrUpdateResult contains the result from method Notification.CreateOrUpdate.

type NotificationGetOptions 

type NotificationGetOptions struct {
}

NotificationGetOptions contains the optional parameters for the Notification.Get method.

type NotificationGetResponse 

type NotificationGetResponse struct {
	NotificationGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationGetResponse contains the response from method Notification.Get.

type NotificationGetResult 

type NotificationGetResult struct {
	NotificationContract
}

NotificationGetResult contains the result from method Notification.Get.

type NotificationListByServiceOptions 

type NotificationListByServiceOptions struct {
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

NotificationListByServiceOptions contains the optional parameters for the Notification.ListByService method.

type NotificationListByServicePager 

type NotificationListByServicePager struct {
	// contains filtered or unexported fields
}

NotificationListByServicePager provides operations for iterating over paged responses.

func (*NotificationListByServicePager) Err 

func (p *NotificationListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*NotificationListByServicePager) NextPage 

func (p *NotificationListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*NotificationListByServicePager) PageResponse 

func (p *NotificationListByServicePager) PageResponse() NotificationListByServiceResponse

PageResponse returns the current NotificationListByServiceResponse page.

type NotificationListByServiceResponse 

type NotificationListByServiceResponse struct {
	NotificationListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationListByServiceResponse contains the response from method Notification.ListByService.

type NotificationListByServiceResult 

type NotificationListByServiceResult struct {
	NotificationCollection
}

NotificationListByServiceResult contains the result from method Notification.ListByService.

type NotificationName 

type NotificationName string
const (
	// NotificationNameAccountClosedPublisher - The following email recipients and users will receive email notifications when developer closes his account.
	NotificationNameAccountClosedPublisher NotificationName = "AccountClosedPublisher"
	// NotificationNameBCC - The following recipients will receive blind carbon copies of all emails sent to developers.
	NotificationNameBCC NotificationName = "BCC"
	// NotificationNameNewApplicationNotificationMessage - The following email recipients and users will receive email notifications when new applications are
	// submitted to the application gallery.
	NotificationNameNewApplicationNotificationMessage NotificationName = "NewApplicationNotificationMessage"
	// NotificationNameNewIssuePublisherNotificationMessage - The following email recipients and users will receive email notifications when a new issue or
	// comment is submitted on the developer portal.
	NotificationNameNewIssuePublisherNotificationMessage NotificationName = "NewIssuePublisherNotificationMessage"
	// NotificationNamePurchasePublisherNotificationMessage - The following email recipients and users will receive email notifications about new API product
	// subscriptions.
	NotificationNamePurchasePublisherNotificationMessage NotificationName = "PurchasePublisherNotificationMessage"
	// NotificationNameQuotaLimitApproachingPublisherNotificationMessage - The following email recipients and users will receive email notifications when subscription
	// usage gets close to usage quota.
	NotificationNameQuotaLimitApproachingPublisherNotificationMessage NotificationName = "QuotaLimitApproachingPublisherNotificationMessage"
	// NotificationNameRequestPublisherNotificationMessage - The following email recipients and users will receive email notifications about subscription requests
	// for API products requiring approval.
	NotificationNameRequestPublisherNotificationMessage NotificationName = "RequestPublisherNotificationMessage"
)

func PossibleNotificationNameValues 

func PossibleNotificationNameValues() []NotificationName

PossibleNotificationNameValues returns the possible values for the NotificationName const type.

func (NotificationName) ToPtr 

func (c NotificationName) ToPtr() *NotificationName

ToPtr returns a *NotificationName pointing to the current value.

type NotificationRecipientEmailCheckEntityExistsOptions 

type NotificationRecipientEmailCheckEntityExistsOptions struct {
}

NotificationRecipientEmailCheckEntityExistsOptions contains the optional parameters for the NotificationRecipientEmail.CheckEntityExists method.

type NotificationRecipientEmailCheckEntityExistsResponse 

type NotificationRecipientEmailCheckEntityExistsResponse struct {
	NotificationRecipientEmailCheckEntityExistsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationRecipientEmailCheckEntityExistsResponse contains the response from method NotificationRecipientEmail.CheckEntityExists.

type NotificationRecipientEmailCheckEntityExistsResult 

type NotificationRecipientEmailCheckEntityExistsResult struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

NotificationRecipientEmailCheckEntityExistsResult contains the result from method NotificationRecipientEmail.CheckEntityExists.

type NotificationRecipientEmailClient 

type NotificationRecipientEmailClient struct {
	// contains filtered or unexported fields
}

NotificationRecipientEmailClient contains the methods for the NotificationRecipientEmail group. Don't use this type directly, use NewNotificationRecipientEmailClient() instead.

func NewNotificationRecipientEmailClient 

func NewNotificationRecipientEmailClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *NotificationRecipientEmailClient

NewNotificationRecipientEmailClient creates a new instance of NotificationRecipientEmailClient with the specified values.

func (*NotificationRecipientEmailClient) CheckEntityExists 

func (client *NotificationRecipientEmailClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string, options *NotificationRecipientEmailCheckEntityExistsOptions) (NotificationRecipientEmailCheckEntityExistsResponse, error)

CheckEntityExists - Determine if Notification Recipient Email subscribed to the notification. If the operation fails it returns the *ErrorResponse error type.

func (*NotificationRecipientEmailClient) CreateOrUpdate 

func (client *NotificationRecipientEmailClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string, options *NotificationRecipientEmailCreateOrUpdateOptions) (NotificationRecipientEmailCreateOrUpdateResponse, error)

CreateOrUpdate - Adds the Email address to the list of Recipients for the Notification. If the operation fails it returns the *ErrorResponse error type.

func (*NotificationRecipientEmailClient) Delete 

func (client *NotificationRecipientEmailClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string, options *NotificationRecipientEmailDeleteOptions) (NotificationRecipientEmailDeleteResponse, error)

Delete - Removes the email from the list of Notification. If the operation fails it returns the *ErrorResponse error type.

func (*NotificationRecipientEmailClient) ListByNotification 

func (client *NotificationRecipientEmailClient) ListByNotification(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, options *NotificationRecipientEmailListByNotificationOptions) (NotificationRecipientEmailListByNotificationResponse, error)

ListByNotification - Gets the list of the Notification Recipient Emails subscribed to a notification. If the operation fails it returns the *ErrorResponse error type.

type NotificationRecipientEmailCreateOrUpdateOptions 

type NotificationRecipientEmailCreateOrUpdateOptions struct {
}

NotificationRecipientEmailCreateOrUpdateOptions contains the optional parameters for the NotificationRecipientEmail.CreateOrUpdate method.

type NotificationRecipientEmailCreateOrUpdateResponse 

type NotificationRecipientEmailCreateOrUpdateResponse struct {
	NotificationRecipientEmailCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationRecipientEmailCreateOrUpdateResponse contains the response from method NotificationRecipientEmail.CreateOrUpdate.

type NotificationRecipientEmailCreateOrUpdateResult 

type NotificationRecipientEmailCreateOrUpdateResult struct {
	RecipientEmailContract
}

NotificationRecipientEmailCreateOrUpdateResult contains the result from method NotificationRecipientEmail.CreateOrUpdate.

type NotificationRecipientEmailDeleteOptions 

type NotificationRecipientEmailDeleteOptions struct {
}

NotificationRecipientEmailDeleteOptions contains the optional parameters for the NotificationRecipientEmail.Delete method.

type NotificationRecipientEmailDeleteResponse 

type NotificationRecipientEmailDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationRecipientEmailDeleteResponse contains the response from method NotificationRecipientEmail.Delete.

type NotificationRecipientEmailListByNotificationOptions 

type NotificationRecipientEmailListByNotificationOptions struct {
}

NotificationRecipientEmailListByNotificationOptions contains the optional parameters for the NotificationRecipientEmail.ListByNotification method.

type NotificationRecipientEmailListByNotificationResponse 

type NotificationRecipientEmailListByNotificationResponse struct {
	NotificationRecipientEmailListByNotificationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationRecipientEmailListByNotificationResponse contains the response from method NotificationRecipientEmail.ListByNotification.

type NotificationRecipientEmailListByNotificationResult 

type NotificationRecipientEmailListByNotificationResult struct {
	RecipientEmailCollection
}

NotificationRecipientEmailListByNotificationResult contains the result from method NotificationRecipientEmail.ListByNotification.

type NotificationRecipientUserCheckEntityExistsOptions 

type NotificationRecipientUserCheckEntityExistsOptions struct {
}

NotificationRecipientUserCheckEntityExistsOptions contains the optional parameters for the NotificationRecipientUser.CheckEntityExists method.

type NotificationRecipientUserCheckEntityExistsResponse 

type NotificationRecipientUserCheckEntityExistsResponse struct {
	NotificationRecipientUserCheckEntityExistsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationRecipientUserCheckEntityExistsResponse contains the response from method NotificationRecipientUser.CheckEntityExists.

type NotificationRecipientUserCheckEntityExistsResult 

type NotificationRecipientUserCheckEntityExistsResult struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

NotificationRecipientUserCheckEntityExistsResult contains the result from method NotificationRecipientUser.CheckEntityExists.

type NotificationRecipientUserClient 

type NotificationRecipientUserClient struct {
	// contains filtered or unexported fields
}

NotificationRecipientUserClient contains the methods for the NotificationRecipientUser group. Don't use this type directly, use NewNotificationRecipientUserClient() instead.

func NewNotificationRecipientUserClient 

func NewNotificationRecipientUserClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *NotificationRecipientUserClient

NewNotificationRecipientUserClient creates a new instance of NotificationRecipientUserClient with the specified values.

func (*NotificationRecipientUserClient) CheckEntityExists 

func (client *NotificationRecipientUserClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, userID string, options *NotificationRecipientUserCheckEntityExistsOptions) (NotificationRecipientUserCheckEntityExistsResponse, error)

CheckEntityExists - Determine if the Notification Recipient User is subscribed to the notification. If the operation fails it returns the *ErrorResponse error type.

func (*NotificationRecipientUserClient) CreateOrUpdate 

func (client *NotificationRecipientUserClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, userID string, options *NotificationRecipientUserCreateOrUpdateOptions) (NotificationRecipientUserCreateOrUpdateResponse, error)

CreateOrUpdate - Adds the API Management User to the list of Recipients for the Notification. If the operation fails it returns the *ErrorResponse error type.

func (*NotificationRecipientUserClient) Delete 

func (client *NotificationRecipientUserClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, userID string, options *NotificationRecipientUserDeleteOptions) (NotificationRecipientUserDeleteResponse, error)

Delete - Removes the API Management user from the list of Notification. If the operation fails it returns the *ErrorResponse error type.

func (*NotificationRecipientUserClient) ListByNotification 

func (client *NotificationRecipientUserClient) ListByNotification(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, options *NotificationRecipientUserListByNotificationOptions) (NotificationRecipientUserListByNotificationResponse, error)

ListByNotification - Gets the list of the Notification Recipient User subscribed to the notification. If the operation fails it returns the *ErrorResponse error type.

type NotificationRecipientUserCreateOrUpdateOptions 

type NotificationRecipientUserCreateOrUpdateOptions struct {
}

NotificationRecipientUserCreateOrUpdateOptions contains the optional parameters for the NotificationRecipientUser.CreateOrUpdate method.

type NotificationRecipientUserCreateOrUpdateResponse 

type NotificationRecipientUserCreateOrUpdateResponse struct {
	NotificationRecipientUserCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationRecipientUserCreateOrUpdateResponse contains the response from method NotificationRecipientUser.CreateOrUpdate.

type NotificationRecipientUserCreateOrUpdateResult 

type NotificationRecipientUserCreateOrUpdateResult struct {
	RecipientUserContract
}

NotificationRecipientUserCreateOrUpdateResult contains the result from method NotificationRecipientUser.CreateOrUpdate.

type NotificationRecipientUserDeleteOptions 

type NotificationRecipientUserDeleteOptions struct {
}

NotificationRecipientUserDeleteOptions contains the optional parameters for the NotificationRecipientUser.Delete method.

type NotificationRecipientUserDeleteResponse 

type NotificationRecipientUserDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationRecipientUserDeleteResponse contains the response from method NotificationRecipientUser.Delete.

type NotificationRecipientUserListByNotificationOptions 

type NotificationRecipientUserListByNotificationOptions struct {
}

NotificationRecipientUserListByNotificationOptions contains the optional parameters for the NotificationRecipientUser.ListByNotification method.

type NotificationRecipientUserListByNotificationResponse 

type NotificationRecipientUserListByNotificationResponse struct {
	NotificationRecipientUserListByNotificationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NotificationRecipientUserListByNotificationResponse contains the response from method NotificationRecipientUser.ListByNotification.

type NotificationRecipientUserListByNotificationResult 

type NotificationRecipientUserListByNotificationResult struct {
	RecipientUserCollection
}

NotificationRecipientUserListByNotificationResult contains the result from method NotificationRecipientUser.ListByNotification.

type OAuth2AuthenticationSettingsContract 

type OAuth2AuthenticationSettingsContract struct {
	// OAuth authorization server identifier.
	AuthorizationServerID *string `json:"authorizationServerId,omitempty"`

	// operations scope.
	Scope *string `json:"scope,omitempty"`
}

OAuth2AuthenticationSettingsContract - API OAuth2 Authentication settings details.

type OpenIDAuthenticationSettingsContract 

type OpenIDAuthenticationSettingsContract struct {
	// How to send token to the server.
	BearerTokenSendingMethods []*BearerTokenSendingMethods `json:"bearerTokenSendingMethods,omitempty"`

	// OAuth authorization server identifier.
	OpenidProviderID *string `json:"openidProviderId,omitempty"`
}

OpenIDAuthenticationSettingsContract - API OAuth2 Authentication settings details.

func (OpenIDAuthenticationSettingsContract) MarshalJSON 

func (o OpenIDAuthenticationSettingsContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenIDAuthenticationSettingsContract.

type OpenIDConnectProviderClient 

type OpenIDConnectProviderClient struct {
	// contains filtered or unexported fields
}

OpenIDConnectProviderClient contains the methods for the OpenIDConnectProvider group. Don't use this type directly, use NewOpenIDConnectProviderClient() instead.

func NewOpenIDConnectProviderClient 

func NewOpenIDConnectProviderClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *OpenIDConnectProviderClient

NewOpenIDConnectProviderClient creates a new instance of OpenIDConnectProviderClient with the specified values.

func (*OpenIDConnectProviderClient) CreateOrUpdate 

func (client *OpenIDConnectProviderClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, opid string, parameters OpenidConnectProviderContract, options *OpenIDConnectProviderCreateOrUpdateOptions) (OpenIDConnectProviderCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the OpenID Connect Provider. If the operation fails it returns the *ErrorResponse error type.

func (*OpenIDConnectProviderClient) Delete 

func (client *OpenIDConnectProviderClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, opid string, ifMatch string, options *OpenIDConnectProviderDeleteOptions) (OpenIDConnectProviderDeleteResponse, error)

Delete - Deletes specific OpenID Connect Provider of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*OpenIDConnectProviderClient) Get 

func (client *OpenIDConnectProviderClient) Get(ctx context.Context, resourceGroupName string, serviceName string, opid string, options *OpenIDConnectProviderGetOptions) (OpenIDConnectProviderGetResponse, error)

Get - Gets specific OpenID Connect Provider without secrets. If the operation fails it returns the *ErrorResponse error type.

func (*OpenIDConnectProviderClient) GetEntityTag 

func (client *OpenIDConnectProviderClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, opid string, options *OpenIDConnectProviderGetEntityTagOptions) (OpenIDConnectProviderGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*OpenIDConnectProviderClient) ListByService 

func (client *OpenIDConnectProviderClient) ListByService(resourceGroupName string, serviceName string, options *OpenIDConnectProviderListByServiceOptions) *OpenIDConnectProviderListByServicePager

ListByService - Lists of all the OpenId Connect Providers. If the operation fails it returns the *ErrorResponse error type.

func (*OpenIDConnectProviderClient) ListSecrets 

func (client *OpenIDConnectProviderClient) ListSecrets(ctx context.Context, resourceGroupName string, serviceName string, opid string, options *OpenIDConnectProviderListSecretsOptions) (OpenIDConnectProviderListSecretsResponse, error)

ListSecrets - Gets the client secret details of the OpenID Connect Provider. If the operation fails it returns the *ErrorResponse error type.

func (*OpenIDConnectProviderClient) Update 

func (client *OpenIDConnectProviderClient) Update(ctx context.Context, resourceGroupName string, serviceName string, opid string, ifMatch string, parameters OpenidConnectProviderUpdateContract, options *OpenIDConnectProviderUpdateOptions) (OpenIDConnectProviderUpdateResponse, error)

Update - Updates the specific OpenID Connect Provider. If the operation fails it returns the *ErrorResponse error type.

type OpenIDConnectProviderCollection 

type OpenIDConnectProviderCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*OpenidConnectProviderContract `json:"value,omitempty"`
}

OpenIDConnectProviderCollection - Paged OpenIdProviders list representation.

func (OpenIDConnectProviderCollection) MarshalJSON 

func (o OpenIDConnectProviderCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenIDConnectProviderCollection.

type OpenIDConnectProviderCreateOrUpdateOptions 

type OpenIDConnectProviderCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

OpenIDConnectProviderCreateOrUpdateOptions contains the optional parameters for the OpenIDConnectProvider.CreateOrUpdate method.

type OpenIDConnectProviderCreateOrUpdateResponse 

type OpenIDConnectProviderCreateOrUpdateResponse struct {
	OpenIDConnectProviderCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OpenIDConnectProviderCreateOrUpdateResponse contains the response from method OpenIDConnectProvider.CreateOrUpdate.

type OpenIDConnectProviderCreateOrUpdateResult 

type OpenIDConnectProviderCreateOrUpdateResult struct {
	OpenidConnectProviderContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

OpenIDConnectProviderCreateOrUpdateResult contains the result from method OpenIDConnectProvider.CreateOrUpdate.

type OpenIDConnectProviderDeleteOptions 

type OpenIDConnectProviderDeleteOptions struct {
}

OpenIDConnectProviderDeleteOptions contains the optional parameters for the OpenIDConnectProvider.Delete method.

type OpenIDConnectProviderDeleteResponse 

type OpenIDConnectProviderDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OpenIDConnectProviderDeleteResponse contains the response from method OpenIDConnectProvider.Delete.

type OpenIDConnectProviderGetEntityTagOptions 

type OpenIDConnectProviderGetEntityTagOptions struct {
}

OpenIDConnectProviderGetEntityTagOptions contains the optional parameters for the OpenIDConnectProvider.GetEntityTag method.

type OpenIDConnectProviderGetEntityTagResponse 

type OpenIDConnectProviderGetEntityTagResponse struct {
	OpenIDConnectProviderGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OpenIDConnectProviderGetEntityTagResponse contains the response from method OpenIDConnectProvider.GetEntityTag.

type OpenIDConnectProviderGetEntityTagResult 

type OpenIDConnectProviderGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

OpenIDConnectProviderGetEntityTagResult contains the result from method OpenIDConnectProvider.GetEntityTag.

type OpenIDConnectProviderGetOptions 

type OpenIDConnectProviderGetOptions struct {
}

OpenIDConnectProviderGetOptions contains the optional parameters for the OpenIDConnectProvider.Get method.

type OpenIDConnectProviderGetResponse 

type OpenIDConnectProviderGetResponse struct {
	OpenIDConnectProviderGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OpenIDConnectProviderGetResponse contains the response from method OpenIDConnectProvider.Get.

type OpenIDConnectProviderGetResult 

type OpenIDConnectProviderGetResult struct {
	OpenidConnectProviderContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

OpenIDConnectProviderGetResult contains the result from method OpenIDConnectProvider.Get.

type OpenIDConnectProviderListByServiceOptions 

type OpenIDConnectProviderListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

OpenIDConnectProviderListByServiceOptions contains the optional parameters for the OpenIDConnectProvider.ListByService method.

type OpenIDConnectProviderListByServicePager 

type OpenIDConnectProviderListByServicePager struct {
	// contains filtered or unexported fields
}

OpenIDConnectProviderListByServicePager provides operations for iterating over paged responses.

func (*OpenIDConnectProviderListByServicePager) Err 

func (p *OpenIDConnectProviderListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*OpenIDConnectProviderListByServicePager) NextPage 

func (p *OpenIDConnectProviderListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OpenIDConnectProviderListByServicePager) PageResponse 

func (p *OpenIDConnectProviderListByServicePager) PageResponse() OpenIDConnectProviderListByServiceResponse

PageResponse returns the current OpenIDConnectProviderListByServiceResponse page.

type OpenIDConnectProviderListByServiceResponse 

type OpenIDConnectProviderListByServiceResponse struct {
	OpenIDConnectProviderListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OpenIDConnectProviderListByServiceResponse contains the response from method OpenIDConnectProvider.ListByService.

type OpenIDConnectProviderListByServiceResult 

type OpenIDConnectProviderListByServiceResult struct {
	OpenIDConnectProviderCollection
}

OpenIDConnectProviderListByServiceResult contains the result from method OpenIDConnectProvider.ListByService.

type OpenIDConnectProviderListSecretsOptions 

type OpenIDConnectProviderListSecretsOptions struct {
}

OpenIDConnectProviderListSecretsOptions contains the optional parameters for the OpenIDConnectProvider.ListSecrets method.

type OpenIDConnectProviderListSecretsResponse 

type OpenIDConnectProviderListSecretsResponse struct {
	OpenIDConnectProviderListSecretsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OpenIDConnectProviderListSecretsResponse contains the response from method OpenIDConnectProvider.ListSecrets.

type OpenIDConnectProviderListSecretsResult 

type OpenIDConnectProviderListSecretsResult struct {
	ClientSecretContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

OpenIDConnectProviderListSecretsResult contains the result from method OpenIDConnectProvider.ListSecrets.

type OpenIDConnectProviderUpdateOptions 

type OpenIDConnectProviderUpdateOptions struct {
}

OpenIDConnectProviderUpdateOptions contains the optional parameters for the OpenIDConnectProvider.Update method.

type OpenIDConnectProviderUpdateResponse 

type OpenIDConnectProviderUpdateResponse struct {
	OpenIDConnectProviderUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OpenIDConnectProviderUpdateResponse contains the response from method OpenIDConnectProvider.Update.

type OpenIDConnectProviderUpdateResult 

type OpenIDConnectProviderUpdateResult struct {
	OpenidConnectProviderContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

OpenIDConnectProviderUpdateResult contains the result from method OpenIDConnectProvider.Update.

type OpenidConnectProviderContract 

type OpenidConnectProviderContract struct {
	Resource
	// OpenId Connect Provider contract properties.
	Properties *OpenidConnectProviderContractProperties `json:"properties,omitempty"`
}

OpenidConnectProviderContract - OpenId Connect Provider details.

func (OpenidConnectProviderContract) MarshalJSON 

func (o OpenidConnectProviderContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenidConnectProviderContract.

type OpenidConnectProviderContractProperties 

type OpenidConnectProviderContractProperties struct {
	// REQUIRED; Client ID of developer console which is the client application.
	ClientID *string `json:"clientId,omitempty"`

	// REQUIRED; User-friendly OpenID Connect Provider name.
	DisplayName *string `json:"displayName,omitempty"`

	// REQUIRED; Metadata endpoint URI.
	MetadataEndpoint *string `json:"metadataEndpoint,omitempty"`

	// Client Secret of developer console which is the client application.
	ClientSecret *string `json:"clientSecret,omitempty"`

	// User-friendly description of OpenID Connect Provider.
	Description *string `json:"description,omitempty"`
}

OpenidConnectProviderContractProperties - OpenID Connect Providers Contract.

type OpenidConnectProviderUpdateContract 

type OpenidConnectProviderUpdateContract struct {
	// OpenId Connect Provider Update contract properties.
	Properties *OpenidConnectProviderUpdateContractProperties `json:"properties,omitempty"`
}

OpenidConnectProviderUpdateContract - Parameters supplied to the Update OpenID Connect Provider operation.

func (OpenidConnectProviderUpdateContract) MarshalJSON 

func (o OpenidConnectProviderUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenidConnectProviderUpdateContract.

type OpenidConnectProviderUpdateContractProperties 

type OpenidConnectProviderUpdateContractProperties struct {
	// Client ID of developer console which is the client application.
	ClientID *string `json:"clientId,omitempty"`

	// Client Secret of developer console which is the client application.
	ClientSecret *string `json:"clientSecret,omitempty"`

	// User-friendly description of OpenID Connect Provider.
	Description *string `json:"description,omitempty"`

	// User-friendly OpenID Connect Provider name.
	DisplayName *string `json:"displayName,omitempty"`

	// Metadata endpoint URI.
	MetadataEndpoint *string `json:"metadataEndpoint,omitempty"`
}

OpenidConnectProviderUpdateContractProperties - Parameters supplied to the Update OpenID Connect Provider operation.

type Operation 

type Operation struct {
	// The object that describes the operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`

	// The operation origin.
	Origin *string `json:"origin,omitempty"`

	// The operation properties.
	Properties map[string]interface{} `json:"properties,omitempty"`
}

Operation - REST API operation

type OperationClient 

type OperationClient struct {
	// contains filtered or unexported fields
}

OperationClient contains the methods for the Operation group. Don't use this type directly, use NewOperationClient() instead.

func NewOperationClient 

func NewOperationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *OperationClient

NewOperationClient creates a new instance of OperationClient with the specified values.

func (*OperationClient) ListByTags 

func (client *OperationClient) ListByTags(resourceGroupName string, serviceName string, apiID string, options *OperationListByTagsOptions) *OperationListByTagsPager

ListByTags - Lists a collection of operations associated with tags. If the operation fails it returns the *ErrorResponse error type.

type OperationCollection 

type OperationCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Page values.
	Value []*OperationContract `json:"value,omitempty" azure:"ro"`
}

OperationCollection - Paged Operation list representation.

func (OperationCollection) MarshalJSON 

func (o OperationCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationCollection.

type OperationContract 

type OperationContract struct {
	Resource
	// Properties of the Operation Contract.
	Properties *OperationContractProperties `json:"properties,omitempty"`
}

OperationContract - API Operation details.

func (OperationContract) MarshalJSON 

func (o OperationContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationContract.

type OperationContractProperties 

type OperationContractProperties struct {
	OperationEntityBaseContract
	// REQUIRED; Operation Name.
	DisplayName *string `json:"displayName,omitempty"`

	// REQUIRED; A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
	Method *string `json:"method,omitempty"`

	// REQUIRED; Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
	URLTemplate *string `json:"urlTemplate,omitempty"`
}

OperationContractProperties - Operation Contract Properties

func (OperationContractProperties) MarshalJSON 

func (o OperationContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationContractProperties.

type OperationDisplay 

type OperationDisplay struct {
	// Friendly name of the operation
	Description *string `json:"description,omitempty"`

	// Operation type: read, write, delete, listKeys/action, etc.
	Operation *string `json:"operation,omitempty"`

	// Friendly name of the resource provider
	Provider *string `json:"provider,omitempty"`

	// Resource type on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - The object that describes the operation.

type OperationEntityBaseContract 

type OperationEntityBaseContract struct {
	// Description of the operation. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`

	// Operation Policies
	Policies *string `json:"policies,omitempty"`

	// An entity containing request details.
	Request *RequestContract `json:"request,omitempty"`

	// Array of Operation responses.
	Responses []*ResponseContract `json:"responses,omitempty"`

	// Collection of URL template parameters.
	TemplateParameters []*ParameterContract `json:"templateParameters,omitempty"`
}

OperationEntityBaseContract - API Operation Entity Base Contract details.

func (OperationEntityBaseContract) MarshalJSON 

func (o OperationEntityBaseContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationEntityBaseContract.

type OperationListByTagsOptions 

type OperationListByTagsOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne,
	// gt, lt | substringof, contains, startswith, endswith |</br>| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|
	// urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Include not tagged Operations.
	IncludeNotTaggedOperations *bool
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

OperationListByTagsOptions contains the optional parameters for the Operation.ListByTags method.

type OperationListByTagsPager 

type OperationListByTagsPager struct {
	// contains filtered or unexported fields
}

OperationListByTagsPager provides operations for iterating over paged responses.

func (*OperationListByTagsPager) Err 

func (p *OperationListByTagsPager) Err() error

Err returns the last error encountered while paging.

func (*OperationListByTagsPager) NextPage 

func (p *OperationListByTagsPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationListByTagsPager) PageResponse 

func (p *OperationListByTagsPager) PageResponse() OperationListByTagsResponse

PageResponse returns the current OperationListByTagsResponse page.

type OperationListByTagsResponse 

type OperationListByTagsResponse struct {
	OperationListByTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationListByTagsResponse contains the response from method Operation.ListByTags.

type OperationListByTagsResult 

type OperationListByTagsResult struct {
	TagResourceCollection
}

OperationListByTagsResult contains the result from method Operation.ListByTags.

type OperationListResult 

type OperationListResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of operations supported by the resource provider.
	Value []*Operation `json:"value,omitempty"`
}

OperationListResult - Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

func (OperationListResult) MarshalJSON 

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationNameFormat 

type OperationNameFormat string

OperationNameFormat - The format of the Operation Name for Application Insights telemetries. Default is Name. 

const (
	// OperationNameFormatName - API_NAME;rev=API_REVISION - OPERATION_NAME
	OperationNameFormatName OperationNameFormat = "Name"
	// OperationNameFormatURL - HTTP_VERB URL
	OperationNameFormatURL OperationNameFormat = "Url"
)

func PossibleOperationNameFormatValues 

func PossibleOperationNameFormatValues() []OperationNameFormat

PossibleOperationNameFormatValues returns the possible values for the OperationNameFormat const type.

func (OperationNameFormat) ToPtr 

func (c OperationNameFormat) ToPtr() *OperationNameFormat

ToPtr returns a *OperationNameFormat pointing to the current value.

type OperationResultContract 

type OperationResultContract struct {
	Resource
	// Properties of the Operation Contract.
	Properties *OperationResultContractProperties `json:"properties,omitempty"`
}

OperationResultContract - Long Running Git Operation Results.

func (OperationResultContract) MarshalJSON 

func (o OperationResultContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResultContract.

type OperationResultContractProperties 

type OperationResultContractProperties struct {
	// Error Body Contract
	Error *ErrorResponseBody `json:"error,omitempty"`

	// Operation result identifier.
	ID *string `json:"id,omitempty"`

	// Optional result info.
	ResultInfo *string `json:"resultInfo,omitempty"`

	// Start time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	Started *time.Time `json:"started,omitempty"`

	// Status of an async operation.
	Status *AsyncOperationStatus `json:"status,omitempty"`

	// Last update time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	Updated *time.Time `json:"updated,omitempty"`

	// READ-ONLY; This property if only provided as part of the TenantConfigurationValidate operation. It contains the log the entities which will be updated/created/deleted
	// as part of the TenantConfigurationDeploy
	// operation.
	ActionLog []*OperationResultLogItemContract `json:"actionLog,omitempty" azure:"ro"`
}

OperationResultContractProperties - Operation Result.

func (OperationResultContractProperties) MarshalJSON 

func (o OperationResultContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResultContractProperties.

func (*OperationResultContractProperties) UnmarshalJSON 

func (o *OperationResultContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResultContractProperties.

type OperationResultLogItemContract 

type OperationResultLogItemContract struct {
	// Action like create/update/delete.
	Action *string `json:"action,omitempty"`

	// Identifier of the entity being created/updated/deleted.
	ObjectKey *string `json:"objectKey,omitempty"`

	// The type of entity contract.
	ObjectType *string `json:"objectType,omitempty"`
}

OperationResultLogItemContract - Log of the entity being created, updated or deleted.

type OperationTagResourceContractProperties 

type OperationTagResourceContractProperties struct {
	// Identifier of the operation in form /operations/{operationId}.
	ID *string `json:"id,omitempty"`

	// READ-ONLY; API Name.
	APIName *string `json:"apiName,omitempty" azure:"ro"`

	// READ-ONLY; API Revision.
	APIRevision *string `json:"apiRevision,omitempty" azure:"ro"`

	// READ-ONLY; API Version.
	APIVersion *string `json:"apiVersion,omitempty" azure:"ro"`

	// READ-ONLY; Operation Description.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
	Method *string `json:"method,omitempty" azure:"ro"`

	// READ-ONLY; Operation name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
	URLTemplate *string `json:"urlTemplate,omitempty" azure:"ro"`
}

OperationTagResourceContractProperties - Operation Entity contract Properties.

type OperationUpdateContract 

type OperationUpdateContract struct {
	// Properties of the API Operation entity that can be updated.
	Properties *OperationUpdateContractProperties `json:"properties,omitempty"`
}

OperationUpdateContract - API Operation Update Contract details.

func (OperationUpdateContract) MarshalJSON 

func (o OperationUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationUpdateContract.

type OperationUpdateContractProperties 

type OperationUpdateContractProperties struct {
	OperationEntityBaseContract
	// Operation Name.
	DisplayName *string `json:"displayName,omitempty"`

	// A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
	Method *string `json:"method,omitempty"`

	// Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
	URLTemplate *string `json:"urlTemplate,omitempty"`
}

OperationUpdateContractProperties - Operation Update Contract Properties.

func (OperationUpdateContractProperties) MarshalJSON 

func (o OperationUpdateContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationUpdateContractProperties.

type Origin 

type Origin string

Origin - The origin of the issue. 

const (
	OriginInbound  Origin = "Inbound"
	OriginLocal    Origin = "Local"
	OriginOutbound Origin = "Outbound"
)

func PossibleOriginValues 

func PossibleOriginValues() []Origin

PossibleOriginValues returns the possible values for the Origin const type.

func (Origin) ToPtr 

func (c Origin) ToPtr() *Origin

ToPtr returns a *Origin pointing to the current value.

type OutboundEnvironmentEndpoint 

type OutboundEnvironmentEndpoint struct {
	// The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.
	Category *string `json:"category,omitempty"`

	// The endpoints that the Api Management Service reaches the service at.
	Endpoints []*EndpointDependency `json:"endpoints,omitempty"`
}

OutboundEnvironmentEndpoint - Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to.

func (OutboundEnvironmentEndpoint) MarshalJSON 

func (o OutboundEnvironmentEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundEnvironmentEndpoint.

type OutboundEnvironmentEndpointList 

type OutboundEnvironmentEndpointList struct {
	// REQUIRED; Collection of resources.
	Value []*OutboundEnvironmentEndpoint `json:"value,omitempty"`

	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

OutboundEnvironmentEndpointList - Collection of Outbound Environment Endpoints

func (OutboundEnvironmentEndpointList) MarshalJSON 

func (o OutboundEnvironmentEndpointList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundEnvironmentEndpointList.

type OutboundNetworkDependenciesEndpointsClient 

type OutboundNetworkDependenciesEndpointsClient struct {
	// contains filtered or unexported fields
}

OutboundNetworkDependenciesEndpointsClient contains the methods for the OutboundNetworkDependenciesEndpoints group. Don't use this type directly, use NewOutboundNetworkDependenciesEndpointsClient() instead.

func NewOutboundNetworkDependenciesEndpointsClient 

func NewOutboundNetworkDependenciesEndpointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *OutboundNetworkDependenciesEndpointsClient

NewOutboundNetworkDependenciesEndpointsClient creates a new instance of OutboundNetworkDependenciesEndpointsClient with the specified values.

func (*OutboundNetworkDependenciesEndpointsClient) ListByService 

func (client *OutboundNetworkDependenciesEndpointsClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, options *OutboundNetworkDependenciesEndpointsListByServiceOptions) (OutboundNetworkDependenciesEndpointsListByServiceResponse, error)

ListByService - Gets the network endpoints of all outbound dependencies of a ApiManagement service. If the operation fails it returns the *ErrorResponse error type.

type OutboundNetworkDependenciesEndpointsListByServiceOptions 

type OutboundNetworkDependenciesEndpointsListByServiceOptions struct {
}

OutboundNetworkDependenciesEndpointsListByServiceOptions contains the optional parameters for the OutboundNetworkDependenciesEndpoints.ListByService method.

type OutboundNetworkDependenciesEndpointsListByServiceResponse 

type OutboundNetworkDependenciesEndpointsListByServiceResponse struct {
	OutboundNetworkDependenciesEndpointsListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OutboundNetworkDependenciesEndpointsListByServiceResponse contains the response from method OutboundNetworkDependenciesEndpoints.ListByService.

type OutboundNetworkDependenciesEndpointsListByServiceResult 

type OutboundNetworkDependenciesEndpointsListByServiceResult struct {
	OutboundEnvironmentEndpointList
}

OutboundNetworkDependenciesEndpointsListByServiceResult contains the result from method OutboundNetworkDependenciesEndpoints.ListByService.

type ParameterContract 

type ParameterContract struct {
	// REQUIRED; Parameter name.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Parameter type.
	Type *string `json:"type,omitempty"`

	// Default parameter value.
	DefaultValue *string `json:"defaultValue,omitempty"`

	// Parameter description.
	Description *string `json:"description,omitempty"`

	// Exampled defined for the parameter.
	Examples map[string]*ParameterExampleContract `json:"examples,omitempty"`

	// Specifies whether parameter is required or not.
	Required *bool `json:"required,omitempty"`

	// Schema identifier.
	SchemaID *string `json:"schemaId,omitempty"`

	// Type name defined by the schema.
	TypeName *string `json:"typeName,omitempty"`

	// Parameter values.
	Values []*string `json:"values,omitempty"`
}

ParameterContract - Operation parameters details.

func (ParameterContract) MarshalJSON 

func (p ParameterContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ParameterContract.

type ParameterExampleContract 

type ParameterExampleContract struct {
	// Long description for the example
	Description *string `json:"description,omitempty"`

	// A URL that points to the literal example
	ExternalValue *string `json:"externalValue,omitempty"`

	// Short description for the example
	Summary *string `json:"summary,omitempty"`

	// Example value. May be a primitive value, or an object.
	Value interface{} `json:"value,omitempty"`
}

ParameterExampleContract - Parameter example.

type PipelineDiagnosticSettings 

type PipelineDiagnosticSettings struct {
	// Diagnostic settings for request.
	Request *HTTPMessageDiagnostic `json:"request,omitempty"`

	// Diagnostic settings for response.
	Response *HTTPMessageDiagnostic `json:"response,omitempty"`
}

PipelineDiagnosticSettings - Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

type PlatformVersion 

type PlatformVersion string

PlatformVersion - Compute Platform Version running the service. 

const (
	// PlatformVersionMtv1 - Platform running the service on Multi Tenant V1 platform.
	PlatformVersionMtv1 PlatformVersion = "mtv1"
	// PlatformVersionStv1 - Platform running the service on Single Tenant V1 platform.
	PlatformVersionStv1 PlatformVersion = "stv1"
	// PlatformVersionStv2 - Platform running the service on Single Tenant V2 platform.
	PlatformVersionStv2 PlatformVersion = "stv2"
	// PlatformVersionUndetermined - Platform version cannot be determined, as compute platform is not deployed.
	PlatformVersionUndetermined PlatformVersion = "undetermined"
)

func PossiblePlatformVersionValues 

func PossiblePlatformVersionValues() []PlatformVersion

PossiblePlatformVersionValues returns the possible values for the PlatformVersion const type.

func (PlatformVersion) ToPtr 

func (c PlatformVersion) ToPtr() *PlatformVersion

ToPtr returns a *PlatformVersion pointing to the current value.

type PolicyClient 

type PolicyClient struct {
	// contains filtered or unexported fields
}

PolicyClient contains the methods for the Policy group. Don't use this type directly, use NewPolicyClient() instead.

func NewPolicyClient 

func NewPolicyClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PolicyClient

NewPolicyClient creates a new instance of PolicyClient with the specified values.

func (*PolicyClient) CreateOrUpdate 

func (client *PolicyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, policyID PolicyIDName, parameters PolicyContract, options *PolicyCreateOrUpdateOptions) (PolicyCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the global policy configuration of the Api Management service. If the operation fails it returns the *ErrorResponse error type.

func (*PolicyClient) Delete 

func (client *PolicyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, policyID PolicyIDName, ifMatch string, options *PolicyDeleteOptions) (PolicyDeleteResponse, error)

Delete - Deletes the global policy configuration of the Api Management Service. If the operation fails it returns the *ErrorResponse error type.

func (*PolicyClient) Get 

func (client *PolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, policyID PolicyIDName, options *PolicyGetOptions) (PolicyGetResponse, error)

Get - Get the Global policy definition of the Api Management service. If the operation fails it returns the *ErrorResponse error type.

func (*PolicyClient) GetEntityTag 

func (client *PolicyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, policyID PolicyIDName, options *PolicyGetEntityTagOptions) (PolicyGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the Global policy definition in the Api Management service. If the operation fails it returns the *ErrorResponse error type.

func (*PolicyClient) ListByService 

func (client *PolicyClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, options *PolicyListByServiceOptions) (PolicyListByServiceResponse, error)

ListByService - Lists all the Global Policy definitions of the Api Management service. If the operation fails it returns the *ErrorResponse error type.

type PolicyCollection 

type PolicyCollection struct {
	// Total record count number.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Policy Contract value.
	Value []*PolicyContract `json:"value,omitempty"`
}

PolicyCollection - The response of the list policy operation.

func (PolicyCollection) MarshalJSON 

func (p PolicyCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyCollection.

type PolicyContentFormat 

type PolicyContentFormat string

PolicyContentFormat - Format of the policyContent. 

const (
	// PolicyContentFormatRawxml - The contents are inline and Content type is a non XML encoded policy document.
	PolicyContentFormatRawxml PolicyContentFormat = "rawxml"
	// PolicyContentFormatRawxmlLink - The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.
	PolicyContentFormatRawxmlLink PolicyContentFormat = "rawxml-link"
	// PolicyContentFormatXML - The contents are inline and Content type is an XML document.
	PolicyContentFormatXML PolicyContentFormat = "xml"
	// PolicyContentFormatXMLLink - The policy XML document is hosted on a http endpoint accessible from the API Management service.
	PolicyContentFormatXMLLink PolicyContentFormat = "xml-link"
)

func PossiblePolicyContentFormatValues 

func PossiblePolicyContentFormatValues() []PolicyContentFormat

PossiblePolicyContentFormatValues returns the possible values for the PolicyContentFormat const type.

func (PolicyContentFormat) ToPtr 

func (c PolicyContentFormat) ToPtr() *PolicyContentFormat

ToPtr returns a *PolicyContentFormat pointing to the current value.

type PolicyContract 

type PolicyContract struct {
	Resource
	// Properties of the Policy.
	Properties *PolicyContractProperties `json:"properties,omitempty"`
}

PolicyContract - Policy Contract details.

func (PolicyContract) MarshalJSON 

func (p PolicyContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyContract.

type PolicyContractProperties 

type PolicyContractProperties struct {
	// REQUIRED; Contents of the Policy as defined by the format.
	Value *string `json:"value,omitempty"`

	// Format of the policyContent.
	Format *PolicyContentFormat `json:"format,omitempty"`
}

PolicyContractProperties - Policy contract Properties.

type PolicyCreateOrUpdateOptions 

type PolicyCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

PolicyCreateOrUpdateOptions contains the optional parameters for the Policy.CreateOrUpdate method.

type PolicyCreateOrUpdateResponse 

type PolicyCreateOrUpdateResponse struct {
	PolicyCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyCreateOrUpdateResponse contains the response from method Policy.CreateOrUpdate.

type PolicyCreateOrUpdateResult 

type PolicyCreateOrUpdateResult struct {
	PolicyContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

PolicyCreateOrUpdateResult contains the result from method Policy.CreateOrUpdate.

type PolicyDeleteOptions 

type PolicyDeleteOptions struct {
}

PolicyDeleteOptions contains the optional parameters for the Policy.Delete method.

type PolicyDeleteResponse 

type PolicyDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDeleteResponse contains the response from method Policy.Delete.

type PolicyDescriptionClient 

type PolicyDescriptionClient struct {
	// contains filtered or unexported fields
}

PolicyDescriptionClient contains the methods for the PolicyDescription group. Don't use this type directly, use NewPolicyDescriptionClient() instead.

func NewPolicyDescriptionClient 

func NewPolicyDescriptionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PolicyDescriptionClient

NewPolicyDescriptionClient creates a new instance of PolicyDescriptionClient with the specified values.

func (*PolicyDescriptionClient) ListByService 

func (client *PolicyDescriptionClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, options *PolicyDescriptionListByServiceOptions) (PolicyDescriptionListByServiceResponse, error)

ListByService - Lists all policy descriptions. If the operation fails it returns the *ErrorResponse error type.

type PolicyDescriptionCollection 

type PolicyDescriptionCollection struct {
	// Total record count number.
	Count *int64 `json:"count,omitempty"`

	// Descriptions of APIM policies.
	Value []*PolicyDescriptionContract `json:"value,omitempty"`
}

PolicyDescriptionCollection - Descriptions of APIM policies.

func (PolicyDescriptionCollection) MarshalJSON 

func (p PolicyDescriptionCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyDescriptionCollection.

type PolicyDescriptionContract 

type PolicyDescriptionContract struct {
	Resource
	// Policy description contract properties.
	Properties *PolicyDescriptionContractProperties `json:"properties,omitempty"`
}

PolicyDescriptionContract - Policy description details.

func (PolicyDescriptionContract) MarshalJSON 

func (p PolicyDescriptionContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyDescriptionContract.

type PolicyDescriptionContractProperties 

type PolicyDescriptionContractProperties struct {
	// READ-ONLY; Policy description.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; Binary OR value of the Snippet scope.
	Scope *int64 `json:"scope,omitempty" azure:"ro"`
}

PolicyDescriptionContractProperties - Policy description properties.

type PolicyDescriptionListByServiceOptions 

type PolicyDescriptionListByServiceOptions struct {
	// Policy scope.
	Scope *PolicyScopeContract
}

PolicyDescriptionListByServiceOptions contains the optional parameters for the PolicyDescription.ListByService method.

type PolicyDescriptionListByServiceResponse 

type PolicyDescriptionListByServiceResponse struct {
	PolicyDescriptionListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyDescriptionListByServiceResponse contains the response from method PolicyDescription.ListByService.

type PolicyDescriptionListByServiceResult 

type PolicyDescriptionListByServiceResult struct {
	PolicyDescriptionCollection
}

PolicyDescriptionListByServiceResult contains the result from method PolicyDescription.ListByService.

type PolicyExportFormat 

type PolicyExportFormat string
const (
	// PolicyExportFormatRawxml - The contents are inline and Content type is a non XML encoded policy document.
	PolicyExportFormatRawxml PolicyExportFormat = "rawxml"
	// PolicyExportFormatXML - The contents are inline and Content type is an XML document.
	PolicyExportFormatXML PolicyExportFormat = "xml"
)

func PossiblePolicyExportFormatValues 

func PossiblePolicyExportFormatValues() []PolicyExportFormat

PossiblePolicyExportFormatValues returns the possible values for the PolicyExportFormat const type.

func (PolicyExportFormat) ToPtr 

func (c PolicyExportFormat) ToPtr() *PolicyExportFormat

ToPtr returns a *PolicyExportFormat pointing to the current value.

type PolicyGetEntityTagOptions 

type PolicyGetEntityTagOptions struct {
}

PolicyGetEntityTagOptions contains the optional parameters for the Policy.GetEntityTag method.

type PolicyGetEntityTagResponse 

type PolicyGetEntityTagResponse struct {
	PolicyGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyGetEntityTagResponse contains the response from method Policy.GetEntityTag.

type PolicyGetEntityTagResult 

type PolicyGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

PolicyGetEntityTagResult contains the result from method Policy.GetEntityTag.

type PolicyGetOptions 

type PolicyGetOptions struct {
	// Policy Export Format.
	Format *PolicyExportFormat
}

PolicyGetOptions contains the optional parameters for the Policy.Get method.

type PolicyGetResponse 

type PolicyGetResponse struct {
	PolicyGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyGetResponse contains the response from method Policy.Get.

type PolicyGetResult 

type PolicyGetResult struct {
	PolicyContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

PolicyGetResult contains the result from method Policy.Get.

type PolicyIDName 

type PolicyIDName string
const (
	PolicyIDNamePolicy PolicyIDName = "policy"
)

func PossiblePolicyIDNameValues 

func PossiblePolicyIDNameValues() []PolicyIDName

PossiblePolicyIDNameValues returns the possible values for the PolicyIDName const type.

func (PolicyIDName) ToPtr 

func (c PolicyIDName) ToPtr() *PolicyIDName

ToPtr returns a *PolicyIDName pointing to the current value.

type PolicyListByServiceOptions 

type PolicyListByServiceOptions struct {
}

PolicyListByServiceOptions contains the optional parameters for the Policy.ListByService method.

type PolicyListByServiceResponse 

type PolicyListByServiceResponse struct {
	PolicyListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PolicyListByServiceResponse contains the response from method Policy.ListByService.

type PolicyListByServiceResult 

type PolicyListByServiceResult struct {
	PolicyCollection
}

PolicyListByServiceResult contains the result from method Policy.ListByService.

type PolicyScopeContract 

type PolicyScopeContract string
const (
	PolicyScopeContractTenant    PolicyScopeContract = "Tenant"
	PolicyScopeContractProduct   PolicyScopeContract = "Product"
	PolicyScopeContractAPI       PolicyScopeContract = "Api"
	PolicyScopeContractOperation PolicyScopeContract = "Operation"
	PolicyScopeContractAll       PolicyScopeContract = "All"
)

func PossiblePolicyScopeContractValues 

func PossiblePolicyScopeContractValues() []PolicyScopeContract

PossiblePolicyScopeContractValues returns the possible values for the PolicyScopeContract const type.

func (PolicyScopeContract) ToPtr 

func (c PolicyScopeContract) ToPtr() *PolicyScopeContract

ToPtr returns a *PolicyScopeContract pointing to the current value.

type PortalDelegationSettings 

type PortalDelegationSettings struct {
	Resource
	// Delegation settings contract properties.
	Properties *PortalDelegationSettingsProperties `json:"properties,omitempty"`
}

PortalDelegationSettings - Delegation settings for a developer portal.

func (PortalDelegationSettings) MarshalJSON 

func (p PortalDelegationSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PortalDelegationSettings.

type PortalDelegationSettingsProperties 

type PortalDelegationSettingsProperties struct {
	// Subscriptions delegation settings.
	Subscriptions *SubscriptionsDelegationSettingsProperties `json:"subscriptions,omitempty"`

	// A delegation Url.
	URL *string `json:"url,omitempty"`

	// User registration delegation settings.
	UserRegistration *RegistrationDelegationSettingsProperties `json:"userRegistration,omitempty"`

	// A base64-encoded validation key to validate, that a request is coming from Azure API Management.
	ValidationKey *string `json:"validationKey,omitempty"`
}

PortalDelegationSettingsProperties - Delegation settings contract properties.

type PortalRevisionBeginCreateOrUpdateOptions 

type PortalRevisionBeginCreateOrUpdateOptions struct {
}

PortalRevisionBeginCreateOrUpdateOptions contains the optional parameters for the PortalRevision.BeginCreateOrUpdate method.

type PortalRevisionBeginUpdateOptions 

type PortalRevisionBeginUpdateOptions struct {
}

PortalRevisionBeginUpdateOptions contains the optional parameters for the PortalRevision.BeginUpdate method.

type PortalRevisionClient 

type PortalRevisionClient struct {
	// contains filtered or unexported fields
}

PortalRevisionClient contains the methods for the PortalRevision group. Don't use this type directly, use NewPortalRevisionClient() instead.

func NewPortalRevisionClient 

func NewPortalRevisionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PortalRevisionClient

NewPortalRevisionClient creates a new instance of PortalRevisionClient with the specified values.

func (*PortalRevisionClient) BeginCreateOrUpdate 

func (client *PortalRevisionClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, portalRevisionID string, parameters PortalRevisionContract, options *PortalRevisionBeginCreateOrUpdateOptions) (PortalRevisionCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a new developer portal's revision by running the portal's publishing. The isCurrent property indicates if the revision is publicly accessible. If the operation fails it returns the *ErrorResponse error type.

func (*PortalRevisionClient) BeginUpdate 

func (client *PortalRevisionClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, portalRevisionID string, ifMatch string, parameters PortalRevisionContract, options *PortalRevisionBeginUpdateOptions) (PortalRevisionUpdatePollerResponse, error)

BeginUpdate - Updates the description of specified portal revision or makes it current. If the operation fails it returns the *ErrorResponse error type.

func (*PortalRevisionClient) Get 

func (client *PortalRevisionClient) Get(ctx context.Context, resourceGroupName string, serviceName string, portalRevisionID string, options *PortalRevisionGetOptions) (PortalRevisionGetResponse, error)

Get - Gets the developer portal's revision specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*PortalRevisionClient) GetEntityTag 

func (client *PortalRevisionClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, portalRevisionID string, options *PortalRevisionGetEntityTagOptions) (PortalRevisionGetEntityTagResponse, error)

GetEntityTag - Gets the developer portal revision specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*PortalRevisionClient) ListByService 

func (client *PortalRevisionClient) ListByService(resourceGroupName string, serviceName string, options *PortalRevisionListByServiceOptions) *PortalRevisionListByServicePager

ListByService - Lists developer portal's revisions. If the operation fails it returns the *ErrorResponse error type.

type PortalRevisionCollection 

type PortalRevisionCollection struct {
	// READ-ONLY; Next page link, if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Collection of portal revisions.
	Value []*PortalRevisionContract `json:"value,omitempty" azure:"ro"`
}

PortalRevisionCollection - Paged list of portal revisions.

func (PortalRevisionCollection) MarshalJSON 

func (p PortalRevisionCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PortalRevisionCollection.

type PortalRevisionContract 

type PortalRevisionContract struct {
	Resource
	// Properties of the portal revisions.
	Properties *PortalRevisionContractProperties `json:"properties,omitempty"`
}

PortalRevisionContract - Portal Revision's contract details.

func (PortalRevisionContract) MarshalJSON 

func (p PortalRevisionContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PortalRevisionContract.

type PortalRevisionContractProperties 

type PortalRevisionContractProperties struct {
	// Portal revision description.
	Description *string `json:"description,omitempty"`

	// Indicates if the portal's revision is public.
	IsCurrent *bool `json:"isCurrent,omitempty"`

	// READ-ONLY; Portal's revision creation date and time.
	CreatedDateTime *time.Time `json:"createdDateTime,omitempty" azure:"ro"`

	// READ-ONLY; Status of the portal's revision.
	Status *PortalRevisionStatus `json:"status,omitempty" azure:"ro"`

	// READ-ONLY; Portal revision publishing status details.
	StatusDetails *string `json:"statusDetails,omitempty" azure:"ro"`

	// READ-ONLY; Last updated date and time.
	UpdatedDateTime *time.Time `json:"updatedDateTime,omitempty" azure:"ro"`
}

func (PortalRevisionContractProperties) MarshalJSON 

func (p PortalRevisionContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PortalRevisionContractProperties.

func (*PortalRevisionContractProperties) UnmarshalJSON 

func (p *PortalRevisionContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PortalRevisionContractProperties.

type PortalRevisionCreateOrUpdatePoller 

type PortalRevisionCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

PortalRevisionCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PortalRevisionCreateOrUpdatePoller) Done 

func (p *PortalRevisionCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PortalRevisionCreateOrUpdatePoller) FinalResponse 

func (p *PortalRevisionCreateOrUpdatePoller) FinalResponse(ctx context.Context) (PortalRevisionCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PortalRevisionCreateOrUpdateResponse will be returned.

func (*PortalRevisionCreateOrUpdatePoller) Poll 

func (p *PortalRevisionCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PortalRevisionCreateOrUpdatePoller) ResumeToken 

func (p *PortalRevisionCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PortalRevisionCreateOrUpdatePollerResponse 

type PortalRevisionCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PortalRevisionCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PortalRevisionCreateOrUpdatePollerResponse contains the response from method PortalRevision.CreateOrUpdate.

func (PortalRevisionCreateOrUpdatePollerResponse) PollUntilDone 

func (l PortalRevisionCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PortalRevisionCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PortalRevisionCreateOrUpdatePollerResponse) Resume 

func (l *PortalRevisionCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *PortalRevisionClient, token string) error

Resume rehydrates a PortalRevisionCreateOrUpdatePollerResponse from the provided client and resume token.

type PortalRevisionCreateOrUpdateResponse 

type PortalRevisionCreateOrUpdateResponse struct {
	PortalRevisionCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PortalRevisionCreateOrUpdateResponse contains the response from method PortalRevision.CreateOrUpdate.

type PortalRevisionCreateOrUpdateResult 

type PortalRevisionCreateOrUpdateResult struct {
	PortalRevisionContract
}

PortalRevisionCreateOrUpdateResult contains the result from method PortalRevision.CreateOrUpdate.

type PortalRevisionGetEntityTagOptions 

type PortalRevisionGetEntityTagOptions struct {
}

PortalRevisionGetEntityTagOptions contains the optional parameters for the PortalRevision.GetEntityTag method.

type PortalRevisionGetEntityTagResponse 

type PortalRevisionGetEntityTagResponse struct {
	PortalRevisionGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PortalRevisionGetEntityTagResponse contains the response from method PortalRevision.GetEntityTag.

type PortalRevisionGetEntityTagResult 

type PortalRevisionGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

PortalRevisionGetEntityTagResult contains the result from method PortalRevision.GetEntityTag.

type PortalRevisionGetOptions 

type PortalRevisionGetOptions struct {
}

PortalRevisionGetOptions contains the optional parameters for the PortalRevision.Get method.

type PortalRevisionGetResponse 

type PortalRevisionGetResponse struct {
	PortalRevisionGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PortalRevisionGetResponse contains the response from method PortalRevision.Get.

type PortalRevisionGetResult 

type PortalRevisionGetResult struct {
	PortalRevisionContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

PortalRevisionGetResult contains the result from method PortalRevision.Get.

type PortalRevisionListByServiceOptions 

type PortalRevisionListByServiceOptions struct {
	// | Field | Supported operators | Supported functions |
	// |-------------|------------------------|-----------------------------------|
	//
	// |name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|
	// |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|
	// |isCurrent | eq, ne | |
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

PortalRevisionListByServiceOptions contains the optional parameters for the PortalRevision.ListByService method.

type PortalRevisionListByServicePager 

type PortalRevisionListByServicePager struct {
	// contains filtered or unexported fields
}

PortalRevisionListByServicePager provides operations for iterating over paged responses.

func (*PortalRevisionListByServicePager) Err 

func (p *PortalRevisionListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*PortalRevisionListByServicePager) NextPage 

func (p *PortalRevisionListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PortalRevisionListByServicePager) PageResponse 

func (p *PortalRevisionListByServicePager) PageResponse() PortalRevisionListByServiceResponse

PageResponse returns the current PortalRevisionListByServiceResponse page.

type PortalRevisionListByServiceResponse 

type PortalRevisionListByServiceResponse struct {
	PortalRevisionListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PortalRevisionListByServiceResponse contains the response from method PortalRevision.ListByService.

type PortalRevisionListByServiceResult 

type PortalRevisionListByServiceResult struct {
	PortalRevisionCollection
}

PortalRevisionListByServiceResult contains the result from method PortalRevision.ListByService.

type PortalRevisionStatus 

type PortalRevisionStatus string

PortalRevisionStatus - Status of the portal's revision. 

const (
	// PortalRevisionStatusCompleted - Portal's revision publishing completed.
	PortalRevisionStatusCompleted PortalRevisionStatus = "completed"
	// PortalRevisionStatusFailed - Portal's revision publishing failed.
	PortalRevisionStatusFailed PortalRevisionStatus = "failed"
	// PortalRevisionStatusPending - Portal's revision has been queued.
	PortalRevisionStatusPending PortalRevisionStatus = "pending"
	// PortalRevisionStatusPublishing - Portal's revision is being published.
	PortalRevisionStatusPublishing PortalRevisionStatus = "publishing"
)

func PossiblePortalRevisionStatusValues 

func PossiblePortalRevisionStatusValues() []PortalRevisionStatus

PossiblePortalRevisionStatusValues returns the possible values for the PortalRevisionStatus const type.

func (PortalRevisionStatus) ToPtr 

func (c PortalRevisionStatus) ToPtr() *PortalRevisionStatus

ToPtr returns a *PortalRevisionStatus pointing to the current value.

type PortalRevisionUpdatePoller 

type PortalRevisionUpdatePoller struct {
	// contains filtered or unexported fields
}

PortalRevisionUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PortalRevisionUpdatePoller) Done 

func (p *PortalRevisionUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PortalRevisionUpdatePoller) FinalResponse 

func (p *PortalRevisionUpdatePoller) FinalResponse(ctx context.Context) (PortalRevisionUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PortalRevisionUpdateResponse will be returned.

func (*PortalRevisionUpdatePoller) Poll 

func (p *PortalRevisionUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PortalRevisionUpdatePoller) ResumeToken 

func (p *PortalRevisionUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PortalRevisionUpdatePollerResponse 

type PortalRevisionUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PortalRevisionUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PortalRevisionUpdatePollerResponse contains the response from method PortalRevision.Update.

func (PortalRevisionUpdatePollerResponse) PollUntilDone 

func (l PortalRevisionUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PortalRevisionUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PortalRevisionUpdatePollerResponse) Resume 

func (l *PortalRevisionUpdatePollerResponse) Resume(ctx context.Context, client *PortalRevisionClient, token string) error

Resume rehydrates a PortalRevisionUpdatePollerResponse from the provided client and resume token.

type PortalRevisionUpdateResponse 

type PortalRevisionUpdateResponse struct {
	PortalRevisionUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PortalRevisionUpdateResponse contains the response from method PortalRevision.Update.

type PortalRevisionUpdateResult 

type PortalRevisionUpdateResult struct {
	PortalRevisionContract
}

PortalRevisionUpdateResult contains the result from method PortalRevision.Update.

type PortalSettingValidationKeyContract 

type PortalSettingValidationKeyContract struct {
	// This is secret value of the validation key in portal settings.
	ValidationKey *string `json:"validationKey,omitempty"`
}

PortalSettingValidationKeyContract - Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

type PortalSettingsClient 

type PortalSettingsClient struct {
	// contains filtered or unexported fields
}

PortalSettingsClient contains the methods for the PortalSettings group. Don't use this type directly, use NewPortalSettingsClient() instead.

func NewPortalSettingsClient 

func NewPortalSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PortalSettingsClient

NewPortalSettingsClient creates a new instance of PortalSettingsClient with the specified values.

func (*PortalSettingsClient) ListByService 

func (client *PortalSettingsClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, options *PortalSettingsListByServiceOptions) (PortalSettingsListByServiceResponse, error)

ListByService - Lists a collection of portalsettings defined within a service instance.. If the operation fails it returns the *ErrorResponse error type.

type PortalSettingsCollection 

type PortalSettingsCollection struct {
	// Total record count number.
	Count *int64 `json:"count,omitempty"`

	// Descriptions of APIM policies.
	Value []*PortalSettingsContract `json:"value,omitempty"`
}

PortalSettingsCollection - Descriptions of APIM policies.

func (PortalSettingsCollection) MarshalJSON 

func (p PortalSettingsCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PortalSettingsCollection.

type PortalSettingsContract 

type PortalSettingsContract struct {
	Resource
	// Portal Settings contract properties.
	Properties *PortalSettingsContractProperties `json:"properties,omitempty"`
}

PortalSettingsContract - Portal Settings for the Developer Portal.

func (PortalSettingsContract) MarshalJSON 

func (p PortalSettingsContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PortalSettingsContract.

type PortalSettingsContractProperties 

type PortalSettingsContractProperties struct {
	// Redirect Anonymous users to the Sign-In page.
	Enabled *bool `json:"enabled,omitempty"`

	// Subscriptions delegation settings.
	Subscriptions *SubscriptionsDelegationSettingsProperties `json:"subscriptions,omitempty"`

	// Terms of service contract properties.
	TermsOfService *TermsOfServiceProperties `json:"termsOfService,omitempty"`

	// A delegation Url.
	URL *string `json:"url,omitempty"`

	// User registration delegation settings.
	UserRegistration *RegistrationDelegationSettingsProperties `json:"userRegistration,omitempty"`

	// A base64-encoded validation key to validate, that a request is coming from Azure API Management.
	ValidationKey *string `json:"validationKey,omitempty"`
}

PortalSettingsContractProperties - Sign-in settings contract properties.

type PortalSettingsListByServiceOptions 

type PortalSettingsListByServiceOptions struct {
}

PortalSettingsListByServiceOptions contains the optional parameters for the PortalSettings.ListByService method.

type PortalSettingsListByServiceResponse 

type PortalSettingsListByServiceResponse struct {
	PortalSettingsListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PortalSettingsListByServiceResponse contains the response from method PortalSettings.ListByService.

type PortalSettingsListByServiceResult 

type PortalSettingsListByServiceResult struct {
	PortalSettingsCollection
}

PortalSettingsListByServiceResult contains the result from method PortalSettings.ListByService.

type PortalSigninSettingProperties 

type PortalSigninSettingProperties struct {
	// Redirect Anonymous users to the Sign-In page.
	Enabled *bool `json:"enabled,omitempty"`
}

PortalSigninSettingProperties - Sign-in settings contract properties.

type PortalSigninSettings 

type PortalSigninSettings struct {
	Resource
	// Sign-in settings contract properties.
	Properties *PortalSigninSettingProperties `json:"properties,omitempty"`
}

PortalSigninSettings - Sign-In settings for the Developer Portal.

func (PortalSigninSettings) MarshalJSON 

func (p PortalSigninSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PortalSigninSettings.

type PortalSignupSettings 

type PortalSignupSettings struct {
	Resource
	// Sign-up settings contract properties.
	Properties *PortalSignupSettingsProperties `json:"properties,omitempty"`
}

PortalSignupSettings - Sign-Up settings for a developer portal.

func (PortalSignupSettings) MarshalJSON 

func (p PortalSignupSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PortalSignupSettings.

type PortalSignupSettingsProperties 

type PortalSignupSettingsProperties struct {
	// Allow users to sign up on a developer portal.
	Enabled *bool `json:"enabled,omitempty"`

	// Terms of service contract properties.
	TermsOfService *TermsOfServiceProperties `json:"termsOfService,omitempty"`
}

PortalSignupSettingsProperties - Sign-up settings contract properties.

type PreferredIPVersion 

type PreferredIPVersion string

PreferredIPVersion - The IP version to be used. Only IPv4 is supported for now. 

const (
	PreferredIPVersionIPv4 PreferredIPVersion = "IPv4"
)

func PossiblePreferredIPVersionValues 

func PossiblePreferredIPVersionValues() []PreferredIPVersion

PossiblePreferredIPVersionValues returns the possible values for the PreferredIPVersion const type.

func (PreferredIPVersion) ToPtr 

func (c PreferredIPVersion) ToPtr() *PreferredIPVersion

ToPtr returns a *PreferredIPVersion pointing to the current value.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// READ-ONLY; The ARM identifier for Private Endpoint
	ID *string `json:"id,omitempty" azure:"ro"`
}

PrivateEndpoint - The Private Endpoint resource.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	Resource
	// Resource properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
}

PrivateEndpointConnection - The Private Endpoint Connection resource.

func (PrivateEndpointConnection) MarshalJSON 

func (p PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionBeginCreateOrUpdateOptions 

type PrivateEndpointConnectionBeginCreateOrUpdateOptions struct {
}

PrivateEndpointConnectionBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnection.BeginCreateOrUpdate method.

type PrivateEndpointConnectionBeginDeleteOptions 

type PrivateEndpointConnectionBeginDeleteOptions struct {
}

PrivateEndpointConnectionBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnection.BeginDelete method.

type PrivateEndpointConnectionClient 

type PrivateEndpointConnectionClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionClient contains the methods for the PrivateEndpointConnection group. Don't use this type directly, use NewPrivateEndpointConnectionClient() instead.

func NewPrivateEndpointConnectionClient 

func NewPrivateEndpointConnectionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateEndpointConnectionClient

NewPrivateEndpointConnectionClient creates a new instance of PrivateEndpointConnectionClient with the specified values.

func (*PrivateEndpointConnectionClient) BeginCreateOrUpdate 

func (client *PrivateEndpointConnectionClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, privateEndpointConnectionName string, privateEndpointConnectionRequest PrivateEndpointConnectionRequest, options *PrivateEndpointConnectionBeginCreateOrUpdateOptions) (PrivateEndpointConnectionCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a new Private Endpoint Connection or updates an existing one. If the operation fails it returns the *ErrorResponse error type.

func (*PrivateEndpointConnectionClient) BeginDelete 

func (client *PrivateEndpointConnectionClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionBeginDeleteOptions) (PrivateEndpointConnectionDeletePollerResponse, error)

BeginDelete - Deletes the specified Private Endpoint Connection. If the operation fails it returns the *ErrorResponse error type.

func (*PrivateEndpointConnectionClient) GetByName 

func (client *PrivateEndpointConnectionClient) GetByName(ctx context.Context, resourceGroupName string, serviceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionGetByNameOptions) (PrivateEndpointConnectionGetByNameResponse, error)

GetByName - Gets the details of the Private Endpoint Connection specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*PrivateEndpointConnectionClient) GetPrivateLinkResource 

func (client *PrivateEndpointConnectionClient) GetPrivateLinkResource(ctx context.Context, resourceGroupName string, serviceName string, privateLinkSubResourceName string, options *PrivateEndpointConnectionGetPrivateLinkResourceOptions) (PrivateEndpointConnectionGetPrivateLinkResourceResponse, error)

GetPrivateLinkResource - Description for Gets the private link resources If the operation fails it returns the *ErrorResponse error type.

func (*PrivateEndpointConnectionClient) ListByService 

func (client *PrivateEndpointConnectionClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, options *PrivateEndpointConnectionListByServiceOptions) (PrivateEndpointConnectionListByServiceResponse, error)

ListByService - Lists all private endpoint connections of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*PrivateEndpointConnectionClient) ListPrivateLinkResources 

func (client *PrivateEndpointConnectionClient) ListPrivateLinkResources(ctx context.Context, resourceGroupName string, serviceName string, options *PrivateEndpointConnectionListPrivateLinkResourcesOptions) (PrivateEndpointConnectionListPrivateLinkResourcesResponse, error)

ListPrivateLinkResources - Description for Gets the private link resources If the operation fails it returns the *ErrorResponse error type.

type PrivateEndpointConnectionCreateOrUpdatePoller 

type PrivateEndpointConnectionCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionCreateOrUpdatePoller) Done 

func (p *PrivateEndpointConnectionCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionCreateOrUpdatePoller) FinalResponse 

func (p *PrivateEndpointConnectionCreateOrUpdatePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionCreateOrUpdateResponse will be returned.

func (*PrivateEndpointConnectionCreateOrUpdatePoller) Poll 

func (p *PrivateEndpointConnectionCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionCreateOrUpdatePoller) ResumeToken 

func (p *PrivateEndpointConnectionCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionCreateOrUpdatePollerResponse 

type PrivateEndpointConnectionCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionCreateOrUpdatePollerResponse contains the response from method PrivateEndpointConnection.CreateOrUpdate.

func (PrivateEndpointConnectionCreateOrUpdatePollerResponse) PollUntilDone 

func (l PrivateEndpointConnectionCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionCreateOrUpdatePollerResponse) Resume 

func (l *PrivateEndpointConnectionCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionClient, token string) error

Resume rehydrates a PrivateEndpointConnectionCreateOrUpdatePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionCreateOrUpdateResponse 

type PrivateEndpointConnectionCreateOrUpdateResponse struct {
	PrivateEndpointConnectionCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionCreateOrUpdateResponse contains the response from method PrivateEndpointConnection.CreateOrUpdate.

type PrivateEndpointConnectionCreateOrUpdateResult 

type PrivateEndpointConnectionCreateOrUpdateResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionCreateOrUpdateResult contains the result from method PrivateEndpointConnection.CreateOrUpdate.

type PrivateEndpointConnectionDeletePoller 

type PrivateEndpointConnectionDeletePoller struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionDeletePoller) Done 

func (p *PrivateEndpointConnectionDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionDeletePoller) FinalResponse 

func (p *PrivateEndpointConnectionDeletePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionDeleteResponse will be returned.

func (*PrivateEndpointConnectionDeletePoller) Poll 

func (p *PrivateEndpointConnectionDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionDeletePoller) ResumeToken 

func (p *PrivateEndpointConnectionDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionDeletePollerResponse 

type PrivateEndpointConnectionDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionDeletePollerResponse contains the response from method PrivateEndpointConnection.Delete.

func (PrivateEndpointConnectionDeletePollerResponse) PollUntilDone 

func (l PrivateEndpointConnectionDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionDeletePollerResponse) Resume 

func (l *PrivateEndpointConnectionDeletePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionClient, token string) error

Resume rehydrates a PrivateEndpointConnectionDeletePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionDeleteResponse 

type PrivateEndpointConnectionDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionDeleteResponse contains the response from method PrivateEndpointConnection.Delete.

type PrivateEndpointConnectionGetByNameOptions 

type PrivateEndpointConnectionGetByNameOptions struct {
}

PrivateEndpointConnectionGetByNameOptions contains the optional parameters for the PrivateEndpointConnection.GetByName method.

type PrivateEndpointConnectionGetByNameResponse 

type PrivateEndpointConnectionGetByNameResponse struct {
	PrivateEndpointConnectionGetByNameResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionGetByNameResponse contains the response from method PrivateEndpointConnection.GetByName.

type PrivateEndpointConnectionGetByNameResult 

type PrivateEndpointConnectionGetByNameResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionGetByNameResult contains the result from method PrivateEndpointConnection.GetByName.

type PrivateEndpointConnectionGetPrivateLinkResourceOptions 

type PrivateEndpointConnectionGetPrivateLinkResourceOptions struct {
}

PrivateEndpointConnectionGetPrivateLinkResourceOptions contains the optional parameters for the PrivateEndpointConnection.GetPrivateLinkResource method.

type PrivateEndpointConnectionGetPrivateLinkResourceResponse 

type PrivateEndpointConnectionGetPrivateLinkResourceResponse struct {
	PrivateEndpointConnectionGetPrivateLinkResourceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionGetPrivateLinkResourceResponse contains the response from method PrivateEndpointConnection.GetPrivateLinkResource.

type PrivateEndpointConnectionGetPrivateLinkResourceResult 

type PrivateEndpointConnectionGetPrivateLinkResourceResult struct {
	PrivateLinkResource
}

PrivateEndpointConnectionGetPrivateLinkResourceResult contains the result from method PrivateEndpointConnection.GetPrivateLinkResource.

type PrivateEndpointConnectionListByServiceOptions 

type PrivateEndpointConnectionListByServiceOptions struct {
}

PrivateEndpointConnectionListByServiceOptions contains the optional parameters for the PrivateEndpointConnection.ListByService method.

type PrivateEndpointConnectionListByServiceResponse 

type PrivateEndpointConnectionListByServiceResponse struct {
	PrivateEndpointConnectionListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionListByServiceResponse contains the response from method PrivateEndpointConnection.ListByService.

type PrivateEndpointConnectionListByServiceResult 

type PrivateEndpointConnectionListByServiceResult struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionListByServiceResult contains the result from method PrivateEndpointConnection.ListByService.

type PrivateEndpointConnectionListPrivateLinkResourcesOptions 

type PrivateEndpointConnectionListPrivateLinkResourcesOptions struct {
}

PrivateEndpointConnectionListPrivateLinkResourcesOptions contains the optional parameters for the PrivateEndpointConnection.ListPrivateLinkResources method.

type PrivateEndpointConnectionListPrivateLinkResourcesResponse 

type PrivateEndpointConnectionListPrivateLinkResourcesResponse struct {
	PrivateEndpointConnectionListPrivateLinkResourcesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionListPrivateLinkResourcesResponse contains the response from method PrivateEndpointConnection.ListPrivateLinkResources.

type PrivateEndpointConnectionListPrivateLinkResourcesResult 

type PrivateEndpointConnectionListPrivateLinkResourcesResult struct {
	PrivateLinkResourceListResult
}

PrivateEndpointConnectionListPrivateLinkResourcesResult contains the result from method PrivateEndpointConnection.ListPrivateLinkResources.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// Array of private endpoint connections
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - List of private endpoint connection associated with the specified storage account

func (PrivateEndpointConnectionListResult) MarshalJSON 

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The resource of private end point.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionProperties - Properties of the PrivateEndpointConnectProperties.

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState - The current provisioning state. 

const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues 

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns the possible values for the PrivateEndpointConnectionProvisioningState const type.

func (PrivateEndpointConnectionProvisioningState) ToPtr 

func (c PrivateEndpointConnectionProvisioningState) ToPtr() *PrivateEndpointConnectionProvisioningState

ToPtr returns a *PrivateEndpointConnectionProvisioningState pointing to the current value.

type PrivateEndpointConnectionRequest 

type PrivateEndpointConnectionRequest struct {
	// Private Endpoint Connection Resource Id.
	ID *string `json:"id,omitempty"`

	// The connection state of the private endpoint connection.
	Properties *PrivateEndpointConnectionRequestProperties `json:"properties,omitempty"`
}

PrivateEndpointConnectionRequest - A request to approve or reject a private endpoint connection

type PrivateEndpointConnectionRequestProperties 

type PrivateEndpointConnectionRequestProperties struct {
	// A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
}

PrivateEndpointConnectionRequestProperties - The connection state of the private endpoint connection.

type PrivateEndpointConnectionWrapperProperties 

type PrivateEndpointConnectionWrapperProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The resource of private end point.
	PrivateEndpoint *ArmIDWrapper `json:"privateEndpoint,omitempty"`

	// READ-ONLY; All the Group ids.
	GroupIDs []*string `json:"groupIds,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionWrapperProperties - Properties of the PrivateEndpointConnectProperties.

func (PrivateEndpointConnectionWrapperProperties) MarshalJSON 

func (p PrivateEndpointConnectionWrapperProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionWrapperProperties.

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus - The private endpoint connection status. 

const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func PossiblePrivateEndpointServiceConnectionStatusValues 

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns the possible values for the PrivateEndpointServiceConnectionStatus const type.

func (PrivateEndpointServiceConnectionStatus) ToPtr 

func (c PrivateEndpointServiceConnectionStatus) ToPtr() *PrivateEndpointServiceConnectionStatus

ToPtr returns a *PrivateEndpointServiceConnectionStatus pointing to the current value.

type PrivateLinkResource 

type PrivateLinkResource struct {
	Resource
	// Resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`
}

PrivateLinkResource - A private link resource

func (PrivateLinkResource) MarshalJSON 

func (p PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult - A list of private link resources

func (PrivateLinkResourceListResult) MarshalJSON 

func (p PrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// The private link resource Private link DNS zone name.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string `json:"actionsRequired,omitempty"`

	// The reason for approval/rejection of the connection.
	Description *string `json:"description,omitempty"`

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.

type ProductAPICheckEntityExistsOptions 

type ProductAPICheckEntityExistsOptions struct {
}

ProductAPICheckEntityExistsOptions contains the optional parameters for the ProductAPI.CheckEntityExists method.

type ProductAPICheckEntityExistsResponse 

type ProductAPICheckEntityExistsResponse struct {
	ProductAPICheckEntityExistsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductAPICheckEntityExistsResponse contains the response from method ProductAPI.CheckEntityExists.

type ProductAPICheckEntityExistsResult 

type ProductAPICheckEntityExistsResult struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

ProductAPICheckEntityExistsResult contains the result from method ProductAPI.CheckEntityExists.

type ProductAPIClient 

type ProductAPIClient struct {
	// contains filtered or unexported fields
}

ProductAPIClient contains the methods for the ProductAPI group. Don't use this type directly, use NewProductAPIClient() instead.

func NewProductAPIClient 

func NewProductAPIClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ProductAPIClient

NewProductAPIClient creates a new instance of ProductAPIClient with the specified values.

func (*ProductAPIClient) CheckEntityExists 

func (client *ProductAPIClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiID string, options *ProductAPICheckEntityExistsOptions) (ProductAPICheckEntityExistsResponse, error)

CheckEntityExists - Checks that API entity specified by identifier is associated with the Product entity. If the operation fails it returns the *ErrorResponse error type.

func (*ProductAPIClient) CreateOrUpdate 

func (client *ProductAPIClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiID string, options *ProductAPICreateOrUpdateOptions) (ProductAPICreateOrUpdateResponse, error)

CreateOrUpdate - Adds an API to the specified product. If the operation fails it returns the *ErrorResponse error type.

func (*ProductAPIClient) Delete 

func (client *ProductAPIClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiID string, options *ProductAPIDeleteOptions) (ProductAPIDeleteResponse, error)

Delete - Deletes the specified API from the specified product. If the operation fails it returns the *ErrorResponse error type.

func (*ProductAPIClient) ListByProduct 

func (client *ProductAPIClient) ListByProduct(resourceGroupName string, serviceName string, productID string, options *ProductAPIListByProductOptions) *ProductAPIListByProductPager

ListByProduct - Lists a collection of the APIs associated with a product. If the operation fails it returns the *ErrorResponse error type.

type ProductAPICreateOrUpdateOptions 

type ProductAPICreateOrUpdateOptions struct {
}

ProductAPICreateOrUpdateOptions contains the optional parameters for the ProductAPI.CreateOrUpdate method.

type ProductAPICreateOrUpdateResponse 

type ProductAPICreateOrUpdateResponse struct {
	ProductAPICreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductAPICreateOrUpdateResponse contains the response from method ProductAPI.CreateOrUpdate.

type ProductAPICreateOrUpdateResult 

type ProductAPICreateOrUpdateResult struct {
	APIContract
}

ProductAPICreateOrUpdateResult contains the result from method ProductAPI.CreateOrUpdate.

type ProductAPIDeleteOptions 

type ProductAPIDeleteOptions struct {
}

ProductAPIDeleteOptions contains the optional parameters for the ProductAPI.Delete method.

type ProductAPIDeleteResponse 

type ProductAPIDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductAPIDeleteResponse contains the response from method ProductAPI.Delete.

type ProductAPIListByProductOptions 

type ProductAPIListByProductOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| serviceUrl | filter | ge, le, eq,
	// ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith
	// |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ProductAPIListByProductOptions contains the optional parameters for the ProductAPI.ListByProduct method.

type ProductAPIListByProductPager 

type ProductAPIListByProductPager struct {
	// contains filtered or unexported fields
}

ProductAPIListByProductPager provides operations for iterating over paged responses.

func (*ProductAPIListByProductPager) Err 

func (p *ProductAPIListByProductPager) Err() error

Err returns the last error encountered while paging.

func (*ProductAPIListByProductPager) NextPage 

func (p *ProductAPIListByProductPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ProductAPIListByProductPager) PageResponse 

func (p *ProductAPIListByProductPager) PageResponse() ProductAPIListByProductResponse

PageResponse returns the current ProductAPIListByProductResponse page.

type ProductAPIListByProductResponse 

type ProductAPIListByProductResponse struct {
	ProductAPIListByProductResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductAPIListByProductResponse contains the response from method ProductAPI.ListByProduct.

type ProductAPIListByProductResult 

type ProductAPIListByProductResult struct {
	APICollection
}

ProductAPIListByProductResult contains the result from method ProductAPI.ListByProduct.

type ProductClient 

type ProductClient struct {
	// contains filtered or unexported fields
}

ProductClient contains the methods for the Product group. Don't use this type directly, use NewProductClient() instead.

func NewProductClient 

func NewProductClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ProductClient

NewProductClient creates a new instance of ProductClient with the specified values.

func (*ProductClient) CreateOrUpdate 

func (client *ProductClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductContract, options *ProductCreateOrUpdateOptions) (ProductCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or Updates a product. If the operation fails it returns the *ErrorResponse error type.

func (*ProductClient) Delete 

func (client *ProductClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string, options *ProductDeleteOptions) (ProductDeleteResponse, error)

Delete - Delete product. If the operation fails it returns the *ErrorResponse error type.

func (*ProductClient) Get 

func (client *ProductClient) Get(ctx context.Context, resourceGroupName string, serviceName string, productID string, options *ProductGetOptions) (ProductGetResponse, error)

Get - Gets the details of the product specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*ProductClient) GetEntityTag 

func (client *ProductClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, productID string, options *ProductGetEntityTagOptions) (ProductGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the product specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*ProductClient) ListByService 

func (client *ProductClient) ListByService(resourceGroupName string, serviceName string, options *ProductListByServiceOptions) *ProductListByServicePager

ListByService - Lists a collection of products in the specified service instance. If the operation fails it returns the *ErrorResponse error type.

func (*ProductClient) ListByTags 

func (client *ProductClient) ListByTags(resourceGroupName string, serviceName string, options *ProductListByTagsOptions) *ProductListByTagsPager

ListByTags - Lists a collection of products associated with tags. If the operation fails it returns the *ErrorResponse error type.

func (*ProductClient) Update 

func (client *ProductClient) Update(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string, parameters ProductUpdateParameters, options *ProductUpdateOptions) (ProductUpdateResponse, error)

Update - Update existing product details. If the operation fails it returns the *ErrorResponse error type.

type ProductCollection 

type ProductCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*ProductContract `json:"value,omitempty"`
}

ProductCollection - Paged Products list representation.

func (ProductCollection) MarshalJSON 

func (p ProductCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProductCollection.

type ProductContract 

type ProductContract struct {
	Resource
	// Product entity contract properties.
	Properties *ProductContractProperties `json:"properties,omitempty"`
}

ProductContract - Product details.

func (ProductContract) MarshalJSON 

func (p ProductContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProductContract.

type ProductContractProperties 

type ProductContractProperties struct {
	ProductEntityBaseParameters
	// REQUIRED; Product name.
	DisplayName *string `json:"displayName,omitempty"`
}

ProductContractProperties - Product profile.

type ProductCreateOrUpdateOptions 

type ProductCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

ProductCreateOrUpdateOptions contains the optional parameters for the Product.CreateOrUpdate method.

type ProductCreateOrUpdateResponse 

type ProductCreateOrUpdateResponse struct {
	ProductCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductCreateOrUpdateResponse contains the response from method Product.CreateOrUpdate.

type ProductCreateOrUpdateResult 

type ProductCreateOrUpdateResult struct {
	ProductContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

ProductCreateOrUpdateResult contains the result from method Product.CreateOrUpdate.

type ProductDeleteOptions 

type ProductDeleteOptions struct {
	// Delete existing subscriptions associated with the product or not.
	DeleteSubscriptions *bool
}

ProductDeleteOptions contains the optional parameters for the Product.Delete method.

type ProductDeleteResponse 

type ProductDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductDeleteResponse contains the response from method Product.Delete.

type ProductEntityBaseParameters 

type ProductEntityBaseParameters struct {
	// whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs
	// immediately after subscribing. If true,
	// administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired
	// property is present and has a value of false.
	ApprovalRequired *bool `json:"approvalRequired,omitempty"`

	// Product description. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`

	// whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators.
	// Default state of Product is
	// notPublished.
	State *ProductState `json:"state,omitempty"`

	// Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid
	// subscription key is required for a request to an
	// API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without
	// a subscription key. If property is omitted
	// when creating a new product it's value is assumed to be true.
	SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`

	// Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions.
	// Can be present only if subscriptionRequired
	// property is present and has a value of false.
	SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`

	// Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the
	// subscription process.
	Terms *string `json:"terms,omitempty"`
}

ProductEntityBaseParameters - Product Entity Base Parameters

type ProductGetEntityTagOptions 

type ProductGetEntityTagOptions struct {
}

ProductGetEntityTagOptions contains the optional parameters for the Product.GetEntityTag method.

type ProductGetEntityTagResponse 

type ProductGetEntityTagResponse struct {
	ProductGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductGetEntityTagResponse contains the response from method Product.GetEntityTag.

type ProductGetEntityTagResult 

type ProductGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

ProductGetEntityTagResult contains the result from method Product.GetEntityTag.

type ProductGetOptions 

type ProductGetOptions struct {
}

ProductGetOptions contains the optional parameters for the Product.Get method.

type ProductGetResponse 

type ProductGetResponse struct {
	ProductGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductGetResponse contains the response from method Product.Get.

type ProductGetResult 

type ProductGetResult struct {
	ProductContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

ProductGetResult contains the result from method Product.Get.

type ProductGroupCheckEntityExistsOptions 

type ProductGroupCheckEntityExistsOptions struct {
}

ProductGroupCheckEntityExistsOptions contains the optional parameters for the ProductGroup.CheckEntityExists method.

type ProductGroupCheckEntityExistsResponse 

type ProductGroupCheckEntityExistsResponse struct {
	ProductGroupCheckEntityExistsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductGroupCheckEntityExistsResponse contains the response from method ProductGroup.CheckEntityExists.

type ProductGroupCheckEntityExistsResult 

type ProductGroupCheckEntityExistsResult struct {
	// Success indicates if the operation succeeded or failed.
	Success bool
}

ProductGroupCheckEntityExistsResult contains the result from method ProductGroup.CheckEntityExists.

type ProductGroupClient 

type ProductGroupClient struct {
	// contains filtered or unexported fields
}

ProductGroupClient contains the methods for the ProductGroup group. Don't use this type directly, use NewProductGroupClient() instead.

func NewProductGroupClient 

func NewProductGroupClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ProductGroupClient

NewProductGroupClient creates a new instance of ProductGroupClient with the specified values.

func (*ProductGroupClient) CheckEntityExists 

func (client *ProductGroupClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string, options *ProductGroupCheckEntityExistsOptions) (ProductGroupCheckEntityExistsResponse, error)

CheckEntityExists - Checks that Group entity specified by identifier is associated with the Product entity. If the operation fails it returns the *ErrorResponse error type.

func (*ProductGroupClient) CreateOrUpdate 

func (client *ProductGroupClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string, options *ProductGroupCreateOrUpdateOptions) (ProductGroupCreateOrUpdateResponse, error)

CreateOrUpdate - Adds the association between the specified developer group with the specified product. If the operation fails it returns the *ErrorResponse error type.

func (*ProductGroupClient) Delete 

func (client *ProductGroupClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string, options *ProductGroupDeleteOptions) (ProductGroupDeleteResponse, error)

Delete - Deletes the association between the specified group and product. If the operation fails it returns the *ErrorResponse error type.

func (*ProductGroupClient) ListByProduct 

func (client *ProductGroupClient) ListByProduct(resourceGroupName string, serviceName string, productID string, options *ProductGroupListByProductOptions) *ProductGroupListByProductPager

ListByProduct - Lists the collection of developer groups associated with the specified product. If the operation fails it returns the *ErrorResponse error type.

type ProductGroupCreateOrUpdateOptions 

type ProductGroupCreateOrUpdateOptions struct {
}

ProductGroupCreateOrUpdateOptions contains the optional parameters for the ProductGroup.CreateOrUpdate method.

type ProductGroupCreateOrUpdateResponse 

type ProductGroupCreateOrUpdateResponse struct {
	ProductGroupCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductGroupCreateOrUpdateResponse contains the response from method ProductGroup.CreateOrUpdate.

type ProductGroupCreateOrUpdateResult 

type ProductGroupCreateOrUpdateResult struct {
	GroupContract
}

ProductGroupCreateOrUpdateResult contains the result from method ProductGroup.CreateOrUpdate.

type ProductGroupDeleteOptions 

type ProductGroupDeleteOptions struct {
}

ProductGroupDeleteOptions contains the optional parameters for the ProductGroup.Delete method.

type ProductGroupDeleteResponse 

type ProductGroupDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductGroupDeleteResponse contains the response from method ProductGroup.Delete.

type ProductGroupListByProductOptions 

type ProductGroupListByProductOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | |</br>| displayName | filter | eq, ne | |</br>| description | filter | eq, ne | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ProductGroupListByProductOptions contains the optional parameters for the ProductGroup.ListByProduct method.

type ProductGroupListByProductPager 

type ProductGroupListByProductPager struct {
	// contains filtered or unexported fields
}

ProductGroupListByProductPager provides operations for iterating over paged responses.

func (*ProductGroupListByProductPager) Err 

func (p *ProductGroupListByProductPager) Err() error

Err returns the last error encountered while paging.

func (*ProductGroupListByProductPager) NextPage 

func (p *ProductGroupListByProductPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ProductGroupListByProductPager) PageResponse 

func (p *ProductGroupListByProductPager) PageResponse() ProductGroupListByProductResponse

PageResponse returns the current ProductGroupListByProductResponse page.

type ProductGroupListByProductResponse 

type ProductGroupListByProductResponse struct {
	ProductGroupListByProductResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductGroupListByProductResponse contains the response from method ProductGroup.ListByProduct.

type ProductGroupListByProductResult 

type ProductGroupListByProductResult struct {
	GroupCollection
}

ProductGroupListByProductResult contains the result from method ProductGroup.ListByProduct.

type ProductListByServiceOptions 

type ProductListByServiceOptions struct {
	// When set to true, the response contains an array of groups that have visibility to the product. The default is false.
	ExpandGroups *bool
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| terms | filter | ge, le, eq, ne,
	// gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | |</br>| groups | expand | | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Products which are part of a specific tag.
	Tags *string
	// Number of records to return.
	Top *int32
}

ProductListByServiceOptions contains the optional parameters for the Product.ListByService method.

type ProductListByServicePager 

type ProductListByServicePager struct {
	// contains filtered or unexported fields
}

ProductListByServicePager provides operations for iterating over paged responses.

func (*ProductListByServicePager) Err 

func (p *ProductListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*ProductListByServicePager) NextPage 

func (p *ProductListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ProductListByServicePager) PageResponse 

func (p *ProductListByServicePager) PageResponse() ProductListByServiceResponse

PageResponse returns the current ProductListByServiceResponse page.

type ProductListByServiceResponse 

type ProductListByServiceResponse struct {
	ProductListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductListByServiceResponse contains the response from method Product.ListByService.

type ProductListByServiceResult 

type ProductListByServiceResult struct {
	ProductCollection
}

ProductListByServiceResult contains the result from method Product.ListByService.

type ProductListByTagsOptions 

type ProductListByTagsOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| terms | filter | ge, le, eq, ne,
	// gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Include not tagged Products.
	IncludeNotTaggedProducts *bool
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ProductListByTagsOptions contains the optional parameters for the Product.ListByTags method.

type ProductListByTagsPager 

type ProductListByTagsPager struct {
	// contains filtered or unexported fields
}

ProductListByTagsPager provides operations for iterating over paged responses.

func (*ProductListByTagsPager) Err 

func (p *ProductListByTagsPager) Err() error

Err returns the last error encountered while paging.

func (*ProductListByTagsPager) NextPage 

func (p *ProductListByTagsPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ProductListByTagsPager) PageResponse 

func (p *ProductListByTagsPager) PageResponse() ProductListByTagsResponse

PageResponse returns the current ProductListByTagsResponse page.

type ProductListByTagsResponse 

type ProductListByTagsResponse struct {
	ProductListByTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductListByTagsResponse contains the response from method Product.ListByTags.

type ProductListByTagsResult 

type ProductListByTagsResult struct {
	TagResourceCollection
}

ProductListByTagsResult contains the result from method Product.ListByTags.

type ProductPolicyClient 

type ProductPolicyClient struct {
	// contains filtered or unexported fields
}

ProductPolicyClient contains the methods for the ProductPolicy group. Don't use this type directly, use NewProductPolicyClient() instead.

func NewProductPolicyClient 

func NewProductPolicyClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ProductPolicyClient

NewProductPolicyClient creates a new instance of ProductPolicyClient with the specified values.

func (*ProductPolicyClient) CreateOrUpdate 

func (client *ProductPolicyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, policyID PolicyIDName, parameters PolicyContract, options *ProductPolicyCreateOrUpdateOptions) (ProductPolicyCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates policy configuration for the Product. If the operation fails it returns the *ErrorResponse error type.

func (*ProductPolicyClient) Delete 

func (client *ProductPolicyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, policyID PolicyIDName, ifMatch string, options *ProductPolicyDeleteOptions) (ProductPolicyDeleteResponse, error)

Delete - Deletes the policy configuration at the Product. If the operation fails it returns the *ErrorResponse error type.

func (*ProductPolicyClient) Get 

func (client *ProductPolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, productID string, policyID PolicyIDName, options *ProductPolicyGetOptions) (ProductPolicyGetResponse, error)

Get - Get the policy configuration at the Product level. If the operation fails it returns the *ErrorResponse error type.

func (*ProductPolicyClient) GetEntityTag 

func (client *ProductPolicyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, productID string, policyID PolicyIDName, options *ProductPolicyGetEntityTagOptions) (ProductPolicyGetEntityTagResponse, error)

GetEntityTag - Get the ETag of the policy configuration at the Product level. If the operation fails it returns the *ErrorResponse error type.

func (*ProductPolicyClient) ListByProduct 

func (client *ProductPolicyClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, options *ProductPolicyListByProductOptions) (ProductPolicyListByProductResponse, error)

ListByProduct - Get the policy configuration at the Product level. If the operation fails it returns the *ErrorResponse error type.

type ProductPolicyCreateOrUpdateOptions 

type ProductPolicyCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

ProductPolicyCreateOrUpdateOptions contains the optional parameters for the ProductPolicy.CreateOrUpdate method.

type ProductPolicyCreateOrUpdateResponse 

type ProductPolicyCreateOrUpdateResponse struct {
	ProductPolicyCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductPolicyCreateOrUpdateResponse contains the response from method ProductPolicy.CreateOrUpdate.

type ProductPolicyCreateOrUpdateResult 

type ProductPolicyCreateOrUpdateResult struct {
	PolicyContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

ProductPolicyCreateOrUpdateResult contains the result from method ProductPolicy.CreateOrUpdate.

type ProductPolicyDeleteOptions 

type ProductPolicyDeleteOptions struct {
}

ProductPolicyDeleteOptions contains the optional parameters for the ProductPolicy.Delete method.

type ProductPolicyDeleteResponse 

type ProductPolicyDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductPolicyDeleteResponse contains the response from method ProductPolicy.Delete.

type ProductPolicyGetEntityTagOptions 

type ProductPolicyGetEntityTagOptions struct {
}

ProductPolicyGetEntityTagOptions contains the optional parameters for the ProductPolicy.GetEntityTag method.

type ProductPolicyGetEntityTagResponse 

type ProductPolicyGetEntityTagResponse struct {
	ProductPolicyGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductPolicyGetEntityTagResponse contains the response from method ProductPolicy.GetEntityTag.

type ProductPolicyGetEntityTagResult 

type ProductPolicyGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

ProductPolicyGetEntityTagResult contains the result from method ProductPolicy.GetEntityTag.

type ProductPolicyGetOptions 

type ProductPolicyGetOptions struct {
	// Policy Export Format.
	Format *PolicyExportFormat
}

ProductPolicyGetOptions contains the optional parameters for the ProductPolicy.Get method.

type ProductPolicyGetResponse 

type ProductPolicyGetResponse struct {
	ProductPolicyGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductPolicyGetResponse contains the response from method ProductPolicy.Get.

type ProductPolicyGetResult 

type ProductPolicyGetResult struct {
	PolicyContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

ProductPolicyGetResult contains the result from method ProductPolicy.Get.

type ProductPolicyListByProductOptions 

type ProductPolicyListByProductOptions struct {
}

ProductPolicyListByProductOptions contains the optional parameters for the ProductPolicy.ListByProduct method.

type ProductPolicyListByProductResponse 

type ProductPolicyListByProductResponse struct {
	ProductPolicyListByProductResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductPolicyListByProductResponse contains the response from method ProductPolicy.ListByProduct.

type ProductPolicyListByProductResult 

type ProductPolicyListByProductResult struct {
	PolicyCollection
}

ProductPolicyListByProductResult contains the result from method ProductPolicy.ListByProduct.

type ProductState 

type ProductState string

ProductState - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. 

const (
	ProductStateNotPublished ProductState = "notPublished"
	ProductStatePublished    ProductState = "published"
)

func PossibleProductStateValues 

func PossibleProductStateValues() []ProductState

PossibleProductStateValues returns the possible values for the ProductState const type.

func (ProductState) ToPtr 

func (c ProductState) ToPtr() *ProductState

ToPtr returns a *ProductState pointing to the current value.

type ProductSubscriptionsClient 

type ProductSubscriptionsClient struct {
	// contains filtered or unexported fields
}

ProductSubscriptionsClient contains the methods for the ProductSubscriptions group. Don't use this type directly, use NewProductSubscriptionsClient() instead.

func NewProductSubscriptionsClient 

func NewProductSubscriptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ProductSubscriptionsClient

NewProductSubscriptionsClient creates a new instance of ProductSubscriptionsClient with the specified values.

func (*ProductSubscriptionsClient) List 

func (client *ProductSubscriptionsClient) List(resourceGroupName string, serviceName string, productID string, options *ProductSubscriptionsListOptions) *ProductSubscriptionsListPager

List - Lists the collection of subscriptions to the specified product. If the operation fails it returns the *ErrorResponse error type.

type ProductSubscriptionsListOptions 

type ProductSubscriptionsListOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| ownerId | filter | ge, le, eq,
	// ne, gt, lt | substringof, contains, startswith, endswith |</br>| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith
	// |</br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| productId | filter | ge, le, eq, ne, gt, lt |
	// substringof, contains, startswith, endswith |</br>| state | filter | eq | |</br>| user | expand | | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ProductSubscriptionsListOptions contains the optional parameters for the ProductSubscriptions.List method.

type ProductSubscriptionsListPager 

type ProductSubscriptionsListPager struct {
	// contains filtered or unexported fields
}

ProductSubscriptionsListPager provides operations for iterating over paged responses.

func (*ProductSubscriptionsListPager) Err 

func (p *ProductSubscriptionsListPager) Err() error

Err returns the last error encountered while paging.

func (*ProductSubscriptionsListPager) NextPage 

func (p *ProductSubscriptionsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ProductSubscriptionsListPager) PageResponse 

func (p *ProductSubscriptionsListPager) PageResponse() ProductSubscriptionsListResponse

PageResponse returns the current ProductSubscriptionsListResponse page.

type ProductSubscriptionsListResponse 

type ProductSubscriptionsListResponse struct {
	ProductSubscriptionsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductSubscriptionsListResponse contains the response from method ProductSubscriptions.List.

type ProductSubscriptionsListResult 

type ProductSubscriptionsListResult struct {
	SubscriptionCollection
}

ProductSubscriptionsListResult contains the result from method ProductSubscriptions.List.

type ProductTagResourceContractProperties 

type ProductTagResourceContractProperties struct {
	ProductEntityBaseParameters
	// REQUIRED; Product name.
	Name *string `json:"name,omitempty"`

	// Identifier of the product in the form of /products/{productId}
	ID *string `json:"id,omitempty"`
}

ProductTagResourceContractProperties - Product profile.

type ProductUpdateOptions 

type ProductUpdateOptions struct {
}

ProductUpdateOptions contains the optional parameters for the Product.Update method.

type ProductUpdateParameters 

type ProductUpdateParameters struct {
	// Product entity Update contract properties.
	Properties *ProductUpdateProperties `json:"properties,omitempty"`
}

ProductUpdateParameters - Product Update parameters.

func (ProductUpdateParameters) MarshalJSON 

func (p ProductUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProductUpdateParameters.

type ProductUpdateProperties 

type ProductUpdateProperties struct {
	ProductEntityBaseParameters
	// Product name.
	DisplayName *string `json:"displayName,omitempty"`
}

ProductUpdateProperties - Parameters supplied to the Update Product operation.

type ProductUpdateResponse 

type ProductUpdateResponse struct {
	ProductUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProductUpdateResponse contains the response from method Product.Update.

type ProductUpdateResult 

type ProductUpdateResult struct {
	ProductContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

ProductUpdateResult contains the result from method Product.Update.

type Protocol 

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

func PossibleProtocolValues 

func PossibleProtocolValues() []Protocol

PossibleProtocolValues returns the possible values for the Protocol const type.

func (Protocol) ToPtr 

func (c Protocol) ToPtr() *Protocol

ToPtr returns a *Protocol pointing to the current value.

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess - Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' 

const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

func (PublicNetworkAccess) ToPtr 

func (c PublicNetworkAccess) ToPtr() *PublicNetworkAccess

ToPtr returns a *PublicNetworkAccess pointing to the current value.

type QuotaByCounterKeysClient 

type QuotaByCounterKeysClient struct {
	// contains filtered or unexported fields
}

QuotaByCounterKeysClient contains the methods for the QuotaByCounterKeys group. Don't use this type directly, use NewQuotaByCounterKeysClient() instead.

func NewQuotaByCounterKeysClient 

func NewQuotaByCounterKeysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *QuotaByCounterKeysClient

NewQuotaByCounterKeysClient creates a new instance of QuotaByCounterKeysClient with the specified values.

func (*QuotaByCounterKeysClient) ListByService 

func (client *QuotaByCounterKeysClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, options *QuotaByCounterKeysListByServiceOptions) (QuotaByCounterKeysListByServiceResponse, error)

ListByService - Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet. If the operation fails it returns the *ErrorResponse error type.

func (*QuotaByCounterKeysClient) Update 

func (client *QuotaByCounterKeysClient) Update(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, parameters QuotaCounterValueUpdateContract, options *QuotaByCounterKeysUpdateOptions) (QuotaByCounterKeysUpdateResponse, error)

Update - Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values. If the operation fails it returns the *ErrorResponse error type.

type QuotaByCounterKeysListByServiceOptions 

type QuotaByCounterKeysListByServiceOptions struct {
}

QuotaByCounterKeysListByServiceOptions contains the optional parameters for the QuotaByCounterKeys.ListByService method.

type QuotaByCounterKeysListByServiceResponse 

type QuotaByCounterKeysListByServiceResponse struct {
	QuotaByCounterKeysListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

QuotaByCounterKeysListByServiceResponse contains the response from method QuotaByCounterKeys.ListByService.

type QuotaByCounterKeysListByServiceResult 

type QuotaByCounterKeysListByServiceResult struct {
	QuotaCounterCollection
}

QuotaByCounterKeysListByServiceResult contains the result from method QuotaByCounterKeys.ListByService.

type QuotaByCounterKeysUpdateOptions 

type QuotaByCounterKeysUpdateOptions struct {
}

QuotaByCounterKeysUpdateOptions contains the optional parameters for the QuotaByCounterKeys.Update method.

type QuotaByCounterKeysUpdateResponse 

type QuotaByCounterKeysUpdateResponse struct {
	QuotaByCounterKeysUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

QuotaByCounterKeysUpdateResponse contains the response from method QuotaByCounterKeys.Update.

type QuotaByCounterKeysUpdateResult 

type QuotaByCounterKeysUpdateResult struct {
	QuotaCounterCollection
}

QuotaByCounterKeysUpdateResult contains the result from method QuotaByCounterKeys.Update.

type QuotaByPeriodKeysClient 

type QuotaByPeriodKeysClient struct {
	// contains filtered or unexported fields
}

QuotaByPeriodKeysClient contains the methods for the QuotaByPeriodKeys group. Don't use this type directly, use NewQuotaByPeriodKeysClient() instead.

func NewQuotaByPeriodKeysClient 

func NewQuotaByPeriodKeysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *QuotaByPeriodKeysClient

NewQuotaByPeriodKeysClient creates a new instance of QuotaByPeriodKeysClient with the specified values.

func (*QuotaByPeriodKeysClient) Get 

func (client *QuotaByPeriodKeysClient) Get(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string, options *QuotaByPeriodKeysGetOptions) (QuotaByPeriodKeysGetResponse, error)

Get - Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance. If the operation fails it returns the *ErrorResponse error type.

func (*QuotaByPeriodKeysClient) Update 

func (client *QuotaByPeriodKeysClient) Update(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string, parameters QuotaCounterValueUpdateContract, options *QuotaByPeriodKeysUpdateOptions) (QuotaByPeriodKeysUpdateResponse, error)

Update - Updates an existing quota counter value in the specified service instance. If the operation fails it returns the *ErrorResponse error type.

type QuotaByPeriodKeysGetOptions 

type QuotaByPeriodKeysGetOptions struct {
}

QuotaByPeriodKeysGetOptions contains the optional parameters for the QuotaByPeriodKeys.Get method.

type QuotaByPeriodKeysGetResponse 

type QuotaByPeriodKeysGetResponse struct {
	QuotaByPeriodKeysGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

QuotaByPeriodKeysGetResponse contains the response from method QuotaByPeriodKeys.Get.

type QuotaByPeriodKeysGetResult 

type QuotaByPeriodKeysGetResult struct {
	QuotaCounterContract
}

QuotaByPeriodKeysGetResult contains the result from method QuotaByPeriodKeys.Get.

type QuotaByPeriodKeysUpdateOptions 

type QuotaByPeriodKeysUpdateOptions struct {
}

QuotaByPeriodKeysUpdateOptions contains the optional parameters for the QuotaByPeriodKeys.Update method.

type QuotaByPeriodKeysUpdateResponse 

type QuotaByPeriodKeysUpdateResponse struct {
	QuotaByPeriodKeysUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

QuotaByPeriodKeysUpdateResponse contains the response from method QuotaByPeriodKeys.Update.

type QuotaByPeriodKeysUpdateResult 

type QuotaByPeriodKeysUpdateResult struct {
	QuotaCounterContract
}

QuotaByPeriodKeysUpdateResult contains the result from method QuotaByPeriodKeys.Update.

type QuotaCounterCollection 

type QuotaCounterCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Quota counter values.
	Value []*QuotaCounterContract `json:"value,omitempty"`
}

QuotaCounterCollection - Paged Quota Counter list representation.

func (QuotaCounterCollection) MarshalJSON 

func (q QuotaCounterCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaCounterCollection.

type QuotaCounterContract 

type QuotaCounterContract struct {
	// REQUIRED; The Key value of the Counter. Must not be empty.
	CounterKey *string `json:"counterKey,omitempty"`

	// REQUIRED; The date of the end of Counter Period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	PeriodEndTime *time.Time `json:"periodEndTime,omitempty"`

	// REQUIRED; Identifier of the Period for which the counter was collected. Must not be empty.
	PeriodKey *string `json:"periodKey,omitempty"`

	// REQUIRED; The date of the start of Counter Period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	PeriodStartTime *time.Time `json:"periodStartTime,omitempty"`

	// Quota Value Properties
	Value *QuotaCounterValueContractProperties `json:"value,omitempty"`
}

QuotaCounterContract - Quota counter details.

func (QuotaCounterContract) MarshalJSON 

func (q QuotaCounterContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaCounterContract.

func (*QuotaCounterContract) UnmarshalJSON 

func (q *QuotaCounterContract) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QuotaCounterContract.

type QuotaCounterValueContract 

type QuotaCounterValueContract struct {
	// Quota counter Value Properties.
	Value *QuotaCounterValueContractProperties `json:"value,omitempty"`
}

QuotaCounterValueContract - Quota counter value details.

type QuotaCounterValueContractProperties 

type QuotaCounterValueContractProperties struct {
	// Number of times Counter was called.
	CallsCount *int32 `json:"callsCount,omitempty"`

	// Data Transferred in KiloBytes.
	KbTransferred *float64 `json:"kbTransferred,omitempty"`
}

QuotaCounterValueContractProperties - Quota counter value details.

type QuotaCounterValueUpdateContract 

type QuotaCounterValueUpdateContract struct {
	// Quota counter value details.
	Properties *QuotaCounterValueContractProperties `json:"properties,omitempty"`
}

QuotaCounterValueUpdateContract - Quota counter value details.

func (QuotaCounterValueUpdateContract) MarshalJSON 

func (q QuotaCounterValueUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaCounterValueUpdateContract.

type RecipientEmailCollection 

type RecipientEmailCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*RecipientEmailContract `json:"value,omitempty"`
}

RecipientEmailCollection - Paged Recipient User list representation.

func (RecipientEmailCollection) MarshalJSON 

func (r RecipientEmailCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecipientEmailCollection.

type RecipientEmailContract 

type RecipientEmailContract struct {
	Resource
	// Recipient Email contract properties.
	Properties *RecipientEmailContractProperties `json:"properties,omitempty"`
}

RecipientEmailContract - Recipient Email details.

func (RecipientEmailContract) MarshalJSON 

func (r RecipientEmailContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecipientEmailContract.

type RecipientEmailContractProperties 

type RecipientEmailContractProperties struct {
	// User Email subscribed to notification.
	Email *string `json:"email,omitempty"`
}

RecipientEmailContractProperties - Recipient Email Contract Properties.

type RecipientUserCollection 

type RecipientUserCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*RecipientUserContract `json:"value,omitempty"`
}

RecipientUserCollection - Paged Recipient User list representation.

func (RecipientUserCollection) MarshalJSON 

func (r RecipientUserCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecipientUserCollection.

type RecipientUserContract 

type RecipientUserContract struct {
	Resource
	// Recipient User entity contract properties.
	Properties *RecipientUsersContractProperties `json:"properties,omitempty"`
}

RecipientUserContract - Recipient User details.

func (RecipientUserContract) MarshalJSON 

func (r RecipientUserContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecipientUserContract.

type RecipientUsersContractProperties 

type RecipientUsersContractProperties struct {
	// API Management UserId subscribed to notification.
	UserID *string `json:"userId,omitempty"`
}

RecipientUsersContractProperties - Recipient User Contract Properties.

type RecipientsContractProperties 

type RecipientsContractProperties struct {
	// List of Emails subscribed for the notification.
	Emails []*string `json:"emails,omitempty"`

	// List of Users subscribed for the notification.
	Users []*string `json:"users,omitempty"`
}

RecipientsContractProperties - Notification Parameter contract.

func (RecipientsContractProperties) MarshalJSON 

func (r RecipientsContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecipientsContractProperties.

type RegionClient 

type RegionClient struct {
	// contains filtered or unexported fields
}

RegionClient contains the methods for the Region group. Don't use this type directly, use NewRegionClient() instead.

func NewRegionClient 

func NewRegionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *RegionClient

NewRegionClient creates a new instance of RegionClient with the specified values.

func (*RegionClient) ListByService 

func (client *RegionClient) ListByService(resourceGroupName string, serviceName string, options *RegionListByServiceOptions) *RegionListByServicePager

ListByService - Lists all azure regions in which the service exists. If the operation fails it returns the *ErrorResponse error type.

type RegionContract 

type RegionContract struct {
	// whether Region is deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`

	// whether Region is the master region.
	IsMasterRegion *bool `json:"isMasterRegion,omitempty"`

	// READ-ONLY; Region name.
	Name *string `json:"name,omitempty" azure:"ro"`
}

RegionContract - Region profile.

type RegionListByServiceOptions 

type RegionListByServiceOptions struct {
}

RegionListByServiceOptions contains the optional parameters for the Region.ListByService method.

type RegionListByServicePager 

type RegionListByServicePager struct {
	// contains filtered or unexported fields
}

RegionListByServicePager provides operations for iterating over paged responses.

func (*RegionListByServicePager) Err 

func (p *RegionListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*RegionListByServicePager) NextPage 

func (p *RegionListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*RegionListByServicePager) PageResponse 

func (p *RegionListByServicePager) PageResponse() RegionListByServiceResponse

PageResponse returns the current RegionListByServiceResponse page.

type RegionListByServiceResponse 

type RegionListByServiceResponse struct {
	RegionListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RegionListByServiceResponse contains the response from method Region.ListByService.

type RegionListByServiceResult 

type RegionListByServiceResult struct {
	RegionListResult
}

RegionListByServiceResult contains the result from method Region.ListByService.

type RegionListResult 

type RegionListResult struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Lists of Regions.
	Value []*RegionContract `json:"value,omitempty"`
}

RegionListResult - Lists Regions operation response details.

func (RegionListResult) MarshalJSON 

func (r RegionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RegionListResult.

type RegistrationDelegationSettingsProperties 

type RegistrationDelegationSettingsProperties struct {
	// Enable or disable delegation for user registration.
	Enabled *bool `json:"enabled,omitempty"`
}

RegistrationDelegationSettingsProperties - User registration delegation settings properties.

type RemotePrivateEndpointConnectionWrapper 

type RemotePrivateEndpointConnectionWrapper struct {
	// Private Endpoint connection resource id
	ID *string `json:"id,omitempty"`

	// Private Endpoint Connection Name
	Name *string `json:"name,omitempty"`

	// Resource properties.
	Properties *PrivateEndpointConnectionWrapperProperties `json:"properties,omitempty"`

	// Private Endpoint Connection Resource Type
	Type *string `json:"type,omitempty"`
}

RemotePrivateEndpointConnectionWrapper - Remote Private Endpoint Connection resource.

type ReportCollection 

type ReportCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*ReportRecordContract `json:"value,omitempty"`
}

ReportCollection - Paged Report records list representation.

func (ReportCollection) MarshalJSON 

func (r ReportCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReportCollection.

type ReportRecordContract 

type ReportRecordContract struct {
	// API identifier path. /apis/{apiId}
	APIID *string `json:"apiId,omitempty"`

	// API region identifier.
	APIRegion *string `json:"apiRegion,omitempty"`

	// Average time it took to process request.
	APITimeAvg *float64 `json:"apiTimeAvg,omitempty"`

	// Maximum time it took to process request.
	APITimeMax *float64 `json:"apiTimeMax,omitempty"`

	// Minimum time it took to process request.
	APITimeMin *float64 `json:"apiTimeMin,omitempty"`

	// Bandwidth consumed.
	Bandwidth *int64 `json:"bandwidth,omitempty"`

	// Number of times when content was served from cache policy.
	CacheHitCount *int32 `json:"cacheHitCount,omitempty"`

	// Number of times content was fetched from backend.
	CacheMissCount *int32 `json:"cacheMissCount,omitempty"`

	// Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests
	CallCountBlocked *int32 `json:"callCountBlocked,omitempty"`

	// Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError
	// (500) and 600
	CallCountFailed *int32 `json:"callCountFailed,omitempty"`

	// Number of other calls.
	CallCountOther *int32 `json:"callCountOther,omitempty"`

	// Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect
	CallCountSuccess *int32 `json:"callCountSuccess,omitempty"`

	// Total number of calls.
	CallCountTotal *int32 `json:"callCountTotal,omitempty"`

	// Country to which this record data is related.
	Country *string `json:"country,omitempty"`

	// Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).
	Interval *string `json:"interval,omitempty"`

	// Name depending on report endpoint specifies product, API, operation or developer name.
	Name *string `json:"name,omitempty"`

	// Operation identifier path. /apis/{apiId}/operations/{operationId}
	OperationID *string `json:"operationId,omitempty"`

	// Country region to which this record data is related.
	Region *string `json:"region,omitempty"`

	// Average time it took to process request on backend.
	ServiceTimeAvg *float64 `json:"serviceTimeAvg,omitempty"`

	// Maximum time it took to process request on backend.
	ServiceTimeMax *float64 `json:"serviceTimeMax,omitempty"`

	// Minimum time it took to process request on backend.
	ServiceTimeMin *float64 `json:"serviceTimeMin,omitempty"`

	// Subscription identifier path. /subscriptions/{subscriptionId}
	SubscriptionID *string `json:"subscriptionId,omitempty"`

	// Start of aggregation period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	Timestamp *time.Time `json:"timestamp,omitempty"`

	// Zip code to which this record data is related.
	Zip *string `json:"zip,omitempty"`

	// READ-ONLY; Product identifier path. /products/{productId}
	ProductID *string `json:"productId,omitempty" azure:"ro"`

	// READ-ONLY; User identifier path. /users/{userId}
	UserID *string `json:"userId,omitempty" azure:"ro"`
}

ReportRecordContract - Report data.

func (ReportRecordContract) MarshalJSON 

func (r ReportRecordContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReportRecordContract.

func (*ReportRecordContract) UnmarshalJSON 

func (r *ReportRecordContract) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReportRecordContract.

type ReportsClient 

type ReportsClient struct {
	// contains filtered or unexported fields
}

ReportsClient contains the methods for the Reports group. Don't use this type directly, use NewReportsClient() instead.

func NewReportsClient 

func NewReportsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ReportsClient

NewReportsClient creates a new instance of ReportsClient with the specified values.

func (*ReportsClient) ListByAPI 

func (client *ReportsClient) ListByAPI(resourceGroupName string, serviceName string, filter string, options *ReportsListByAPIOptions) *ReportsListByAPIPager

ListByAPI - Lists report records by API. If the operation fails it returns the *ErrorResponse error type.

func (*ReportsClient) ListByGeo 

func (client *ReportsClient) ListByGeo(resourceGroupName string, serviceName string, filter string, options *ReportsListByGeoOptions) *ReportsListByGeoPager

ListByGeo - Lists report records by geography. If the operation fails it returns the *ErrorResponse error type.

func (*ReportsClient) ListByOperation 

func (client *ReportsClient) ListByOperation(resourceGroupName string, serviceName string, filter string, options *ReportsListByOperationOptions) *ReportsListByOperationPager

ListByOperation - Lists report records by API Operations. If the operation fails it returns the *ErrorResponse error type.

func (*ReportsClient) ListByProduct 

func (client *ReportsClient) ListByProduct(resourceGroupName string, serviceName string, filter string, options *ReportsListByProductOptions) *ReportsListByProductPager

ListByProduct - Lists report records by Product. If the operation fails it returns the *ErrorResponse error type.

func (*ReportsClient) ListByRequest 

func (client *ReportsClient) ListByRequest(ctx context.Context, resourceGroupName string, serviceName string, filter string, options *ReportsListByRequestOptions) (ReportsListByRequestResponse, error)

ListByRequest - Lists report records by Request. If the operation fails it returns the *ErrorResponse error type.

func (*ReportsClient) ListBySubscription 

func (client *ReportsClient) ListBySubscription(resourceGroupName string, serviceName string, filter string, options *ReportsListBySubscriptionOptions) *ReportsListBySubscriptionPager

ListBySubscription - Lists report records by subscription. If the operation fails it returns the *ErrorResponse error type.

func (*ReportsClient) ListByTime 

func (client *ReportsClient) ListByTime(resourceGroupName string, serviceName string, filter string, interval string, options *ReportsListByTimeOptions) *ReportsListByTimePager

ListByTime - Lists report records by Time. If the operation fails it returns the *ErrorResponse error type.

func (*ReportsClient) ListByUser 

func (client *ReportsClient) ListByUser(resourceGroupName string, serviceName string, filter string, options *ReportsListByUserOptions) *ReportsListByUserPager

ListByUser - Lists report records by User. If the operation fails it returns the *ErrorResponse error type.

type ReportsListByAPIOptions 

type ReportsListByAPIOptions struct {
	// OData order by query option.
	Orderby *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ReportsListByAPIOptions contains the optional parameters for the Reports.ListByAPI method.

type ReportsListByAPIPager 

type ReportsListByAPIPager struct {
	// contains filtered or unexported fields
}

ReportsListByAPIPager provides operations for iterating over paged responses.

func (*ReportsListByAPIPager) Err 

func (p *ReportsListByAPIPager) Err() error

Err returns the last error encountered while paging.

func (*ReportsListByAPIPager) NextPage 

func (p *ReportsListByAPIPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ReportsListByAPIPager) PageResponse 

func (p *ReportsListByAPIPager) PageResponse() ReportsListByAPIResponse

PageResponse returns the current ReportsListByAPIResponse page.

type ReportsListByAPIResponse 

type ReportsListByAPIResponse struct {
	ReportsListByAPIResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ReportsListByAPIResponse contains the response from method Reports.ListByAPI.

type ReportsListByAPIResult 

type ReportsListByAPIResult struct {
	ReportCollection
}

ReportsListByAPIResult contains the result from method Reports.ListByAPI.

type ReportsListByGeoOptions 

type ReportsListByGeoOptions struct {
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ReportsListByGeoOptions contains the optional parameters for the Reports.ListByGeo method.

type ReportsListByGeoPager 

type ReportsListByGeoPager struct {
	// contains filtered or unexported fields
}

ReportsListByGeoPager provides operations for iterating over paged responses.

func (*ReportsListByGeoPager) Err 

func (p *ReportsListByGeoPager) Err() error

Err returns the last error encountered while paging.

func (*ReportsListByGeoPager) NextPage 

func (p *ReportsListByGeoPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ReportsListByGeoPager) PageResponse 

func (p *ReportsListByGeoPager) PageResponse() ReportsListByGeoResponse

PageResponse returns the current ReportsListByGeoResponse page.

type ReportsListByGeoResponse 

type ReportsListByGeoResponse struct {
	ReportsListByGeoResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ReportsListByGeoResponse contains the response from method Reports.ListByGeo.

type ReportsListByGeoResult 

type ReportsListByGeoResult struct {
	ReportCollection
}

ReportsListByGeoResult contains the result from method Reports.ListByGeo.

type ReportsListByOperationOptions 

type ReportsListByOperationOptions struct {
	// OData order by query option.
	Orderby *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ReportsListByOperationOptions contains the optional parameters for the Reports.ListByOperation method.

type ReportsListByOperationPager 

type ReportsListByOperationPager struct {
	// contains filtered or unexported fields
}

ReportsListByOperationPager provides operations for iterating over paged responses.

func (*ReportsListByOperationPager) Err 

func (p *ReportsListByOperationPager) Err() error

Err returns the last error encountered while paging.

func (*ReportsListByOperationPager) NextPage 

func (p *ReportsListByOperationPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ReportsListByOperationPager) PageResponse 

func (p *ReportsListByOperationPager) PageResponse() ReportsListByOperationResponse

PageResponse returns the current ReportsListByOperationResponse page.

type ReportsListByOperationResponse 

type ReportsListByOperationResponse struct {
	ReportsListByOperationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ReportsListByOperationResponse contains the response from method Reports.ListByOperation.

type ReportsListByOperationResult 

type ReportsListByOperationResult struct {
	ReportCollection
}

ReportsListByOperationResult contains the result from method Reports.ListByOperation.

type ReportsListByProductOptions 

type ReportsListByProductOptions struct {
	// OData order by query option.
	Orderby *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ReportsListByProductOptions contains the optional parameters for the Reports.ListByProduct method.

type ReportsListByProductPager 

type ReportsListByProductPager struct {
	// contains filtered or unexported fields
}

ReportsListByProductPager provides operations for iterating over paged responses.

func (*ReportsListByProductPager) Err 

func (p *ReportsListByProductPager) Err() error

Err returns the last error encountered while paging.

func (*ReportsListByProductPager) NextPage 

func (p *ReportsListByProductPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ReportsListByProductPager) PageResponse 

func (p *ReportsListByProductPager) PageResponse() ReportsListByProductResponse

PageResponse returns the current ReportsListByProductResponse page.

type ReportsListByProductResponse 

type ReportsListByProductResponse struct {
	ReportsListByProductResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ReportsListByProductResponse contains the response from method Reports.ListByProduct.

type ReportsListByProductResult 

type ReportsListByProductResult struct {
	ReportCollection
}

ReportsListByProductResult contains the result from method Reports.ListByProduct.

type ReportsListByRequestOptions 

type ReportsListByRequestOptions struct {
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ReportsListByRequestOptions contains the optional parameters for the Reports.ListByRequest method.

type ReportsListByRequestResponse 

type ReportsListByRequestResponse struct {
	ReportsListByRequestResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ReportsListByRequestResponse contains the response from method Reports.ListByRequest.

type ReportsListByRequestResult 

type ReportsListByRequestResult struct {
	RequestReportCollection
}

ReportsListByRequestResult contains the result from method Reports.ListByRequest.

type ReportsListBySubscriptionOptions 

type ReportsListBySubscriptionOptions struct {
	// OData order by query option.
	Orderby *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ReportsListBySubscriptionOptions contains the optional parameters for the Reports.ListBySubscription method.

type ReportsListBySubscriptionPager 

type ReportsListBySubscriptionPager struct {
	// contains filtered or unexported fields
}

ReportsListBySubscriptionPager provides operations for iterating over paged responses.

func (*ReportsListBySubscriptionPager) Err 

func (p *ReportsListBySubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*ReportsListBySubscriptionPager) NextPage 

func (p *ReportsListBySubscriptionPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ReportsListBySubscriptionPager) PageResponse 

func (p *ReportsListBySubscriptionPager) PageResponse() ReportsListBySubscriptionResponse

PageResponse returns the current ReportsListBySubscriptionResponse page.

type ReportsListBySubscriptionResponse 

type ReportsListBySubscriptionResponse struct {
	ReportsListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ReportsListBySubscriptionResponse contains the response from method Reports.ListBySubscription.

type ReportsListBySubscriptionResult 

type ReportsListBySubscriptionResult struct {
	ReportCollection
}

ReportsListBySubscriptionResult contains the result from method Reports.ListBySubscription.

type ReportsListByTimeOptions 

type ReportsListByTimeOptions struct {
	// OData order by query option.
	Orderby *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ReportsListByTimeOptions contains the optional parameters for the Reports.ListByTime method.

type ReportsListByTimePager 

type ReportsListByTimePager struct {
	// contains filtered or unexported fields
}

ReportsListByTimePager provides operations for iterating over paged responses.

func (*ReportsListByTimePager) Err 

func (p *ReportsListByTimePager) Err() error

Err returns the last error encountered while paging.

func (*ReportsListByTimePager) NextPage 

func (p *ReportsListByTimePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ReportsListByTimePager) PageResponse 

func (p *ReportsListByTimePager) PageResponse() ReportsListByTimeResponse

PageResponse returns the current ReportsListByTimeResponse page.

type ReportsListByTimeResponse 

type ReportsListByTimeResponse struct {
	ReportsListByTimeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ReportsListByTimeResponse contains the response from method Reports.ListByTime.

type ReportsListByTimeResult 

type ReportsListByTimeResult struct {
	ReportCollection
}

ReportsListByTimeResult contains the result from method Reports.ListByTime.

type ReportsListByUserOptions 

type ReportsListByUserOptions struct {
	// OData order by query option.
	Orderby *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

ReportsListByUserOptions contains the optional parameters for the Reports.ListByUser method.

type ReportsListByUserPager 

type ReportsListByUserPager struct {
	// contains filtered or unexported fields
}

ReportsListByUserPager provides operations for iterating over paged responses.

func (*ReportsListByUserPager) Err 

func (p *ReportsListByUserPager) Err() error

Err returns the last error encountered while paging.

func (*ReportsListByUserPager) NextPage 

func (p *ReportsListByUserPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ReportsListByUserPager) PageResponse 

func (p *ReportsListByUserPager) PageResponse() ReportsListByUserResponse

PageResponse returns the current ReportsListByUserResponse page.

type ReportsListByUserResponse 

type ReportsListByUserResponse struct {
	ReportsListByUserResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ReportsListByUserResponse contains the response from method Reports.ListByUser.

type ReportsListByUserResult 

type ReportsListByUserResult struct {
	ReportCollection
}

ReportsListByUserResult contains the result from method Reports.ListByUser.

type RepresentationContract 

type RepresentationContract struct {
	// REQUIRED; Specifies a registered or custom content type for this representation, e.g. application/xml.
	ContentType *string `json:"contentType,omitempty"`

	// Exampled defined for the representation.
	Examples map[string]*ParameterExampleContract `json:"examples,omitempty"`

	// Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
	FormParameters []*ParameterContract `json:"formParameters,omitempty"`

	// Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
	SchemaID *string `json:"schemaId,omitempty"`

	// Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
	TypeName *string `json:"typeName,omitempty"`
}

RepresentationContract - Operation request/response representation details.

func (RepresentationContract) MarshalJSON 

func (r RepresentationContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RepresentationContract.

type RequestContract 

type RequestContract struct {
	// Operation request description.
	Description *string `json:"description,omitempty"`

	// Collection of operation request headers.
	Headers []*ParameterContract `json:"headers,omitempty"`

	// Collection of operation request query parameters.
	QueryParameters []*ParameterContract `json:"queryParameters,omitempty"`

	// Collection of operation request representations.
	Representations []*RepresentationContract `json:"representations,omitempty"`
}

RequestContract - Operation request details.

func (RequestContract) MarshalJSON 

func (r RequestContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RequestContract.

type RequestReportCollection 

type RequestReportCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Page values.
	Value []*RequestReportRecordContract `json:"value,omitempty"`
}

RequestReportCollection - Paged Report records list representation.

func (RequestReportCollection) MarshalJSON 

func (r RequestReportCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RequestReportCollection.

type RequestReportRecordContract 

type RequestReportRecordContract struct {
	// API identifier path. /apis/{apiId}
	APIID *string `json:"apiId,omitempty"`

	// Azure region where the gateway that processed this request is located.
	APIRegion *string `json:"apiRegion,omitempty"`

	// The total time it took to process this request.
	APITime *float64 `json:"apiTime,omitempty"`

	// The HTTP status code received by the gateway as a result of forwarding this request to the backend.
	BackendResponseCode *string `json:"backendResponseCode,omitempty"`

	// Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response
	// was returned. If the value is miss, the cache
	// was used but lookup resulted in a miss and request was fulfilled by the backend.
	Cache *string `json:"cache,omitempty"`

	// The client IP address associated with this request.
	IPAddress *string `json:"ipAddress,omitempty"`

	// The HTTP method associated with this request..
	Method *string `json:"method,omitempty"`

	// Operation identifier path. /apis/{apiId}/operations/{operationId}
	OperationID *string `json:"operationId,omitempty"`

	// Request Identifier.
	RequestID *string `json:"requestId,omitempty"`

	// The size of this request..
	RequestSize *int32 `json:"requestSize,omitempty"`

	// The HTTP status code returned by the gateway.
	ResponseCode *int32 `json:"responseCode,omitempty"`

	// The size of the response returned by the gateway.
	ResponseSize *int32 `json:"responseSize,omitempty"`

	// he time it took to forward this request to the backend and get the response back.
	ServiceTime *float64 `json:"serviceTime,omitempty"`

	// Subscription identifier path. /subscriptions/{subscriptionId}
	SubscriptionID *string `json:"subscriptionId,omitempty"`

	// The date and time when this request was received by the gateway in ISO 8601 format.
	Timestamp *time.Time `json:"timestamp,omitempty"`

	// The full URL associated with this request.
	URL *string `json:"url,omitempty"`

	// READ-ONLY; Product identifier path. /products/{productId}
	ProductID *string `json:"productId,omitempty" azure:"ro"`

	// READ-ONLY; User identifier path. /users/{userId}
	UserID *string `json:"userId,omitempty" azure:"ro"`
}

RequestReportRecordContract - Request Report data.

func (RequestReportRecordContract) MarshalJSON 

func (r RequestReportRecordContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RequestReportRecordContract.

func (*RequestReportRecordContract) UnmarshalJSON 

func (r *RequestReportRecordContract) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RequestReportRecordContract.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

type ResourceLocationDataContract 

type ResourceLocationDataContract struct {
	// REQUIRED; A canonical name for the geographic or physical location.
	Name *string `json:"name,omitempty"`

	// The city or locality where the resource is located.
	City *string `json:"city,omitempty"`

	// The country or region where the resource is located.
	CountryOrRegion *string `json:"countryOrRegion,omitempty"`

	// The district, state, or province where the resource is located.
	District *string `json:"district,omitempty"`
}

ResourceLocationDataContract - Resource location data properties.

type ResourceSKU 

type ResourceSKU struct {
	// Name of the Sku.
	Name *SKUType `json:"name,omitempty"`
}

ResourceSKU - Describes an available API Management SKU.

type ResourceSKUCapacity 

type ResourceSKUCapacity struct {
	// READ-ONLY; The default capacity.
	Default *int32 `json:"default,omitempty" azure:"ro"`

	// READ-ONLY; The maximum capacity that can be set.
	Maximum *int32 `json:"maximum,omitempty" azure:"ro"`

	// READ-ONLY; The minimum capacity.
	Minimum *int32 `json:"minimum,omitempty" azure:"ro"`

	// READ-ONLY; The scale type applicable to the sku.
	ScaleType *ResourceSKUCapacityScaleType `json:"scaleType,omitempty" azure:"ro"`
}

ResourceSKUCapacity - Describes scaling information of a SKU.

type ResourceSKUCapacityScaleType 

type ResourceSKUCapacityScaleType string

ResourceSKUCapacityScaleType - The scale type applicable to the sku. 

const (
	// ResourceSKUCapacityScaleTypeAutomatic - Supported scale type automatic.
	ResourceSKUCapacityScaleTypeAutomatic ResourceSKUCapacityScaleType = "automatic"
	// ResourceSKUCapacityScaleTypeManual - Supported scale type manual.
	ResourceSKUCapacityScaleTypeManual ResourceSKUCapacityScaleType = "manual"
	// ResourceSKUCapacityScaleTypeNone - Scaling not supported.
	ResourceSKUCapacityScaleTypeNone ResourceSKUCapacityScaleType = "none"
)

func PossibleResourceSKUCapacityScaleTypeValues 

func PossibleResourceSKUCapacityScaleTypeValues() []ResourceSKUCapacityScaleType

PossibleResourceSKUCapacityScaleTypeValues returns the possible values for the ResourceSKUCapacityScaleType const type.

func (ResourceSKUCapacityScaleType) ToPtr 

func (c ResourceSKUCapacityScaleType) ToPtr() *ResourceSKUCapacityScaleType

ToPtr returns a *ResourceSKUCapacityScaleType pointing to the current value.

type ResourceSKUResult 

type ResourceSKUResult struct {
	// READ-ONLY; Specifies the number of API Management units.
	Capacity *ResourceSKUCapacity `json:"capacity,omitempty" azure:"ro"`

	// READ-ONLY; The type of resource the SKU applies to.
	ResourceType *string `json:"resourceType,omitempty" azure:"ro"`

	// READ-ONLY; Specifies API Management SKU.
	SKU *ResourceSKU `json:"sku,omitempty" azure:"ro"`
}

ResourceSKUResult - Describes an available API Management service SKU.

type ResourceSKUResults 

type ResourceSKUResults struct {
	// REQUIRED; The list of skus available for the service.
	Value []*ResourceSKUResult `json:"value,omitempty"`

	// The uri to fetch the next page of API Management service Skus.
	NextLink *string `json:"nextLink,omitempty"`
}

ResourceSKUResults - The API Management service SKUs operation response.

func (ResourceSKUResults) MarshalJSON 

func (r ResourceSKUResults) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKUResults.

type ResponseContract 

type ResponseContract struct {
	// REQUIRED; Operation response HTTP status code.
	StatusCode *int32 `json:"statusCode,omitempty"`

	// Operation response description.
	Description *string `json:"description,omitempty"`

	// Collection of operation response headers.
	Headers []*ParameterContract `json:"headers,omitempty"`

	// Collection of operation response representations.
	Representations []*RepresentationContract `json:"representations,omitempty"`
}

ResponseContract - Operation response details.

func (ResponseContract) MarshalJSON 

func (r ResponseContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResponseContract.

type SKUType 

type SKUType string

SKUType - Name of the Sku. 

const (
	// SKUTypeBasic - Basic SKU of Api Management.
	SKUTypeBasic SKUType = "Basic"
	// SKUTypeConsumption - Consumption SKU of Api Management.
	SKUTypeConsumption SKUType = "Consumption"
	// SKUTypeDeveloper - Developer SKU of Api Management.
	SKUTypeDeveloper SKUType = "Developer"
	// SKUTypeIsolated - Isolated SKU of Api Management.
	SKUTypeIsolated SKUType = "Isolated"
	// SKUTypePremium - Premium SKU of Api Management.
	SKUTypePremium SKUType = "Premium"
	// SKUTypeStandard - Standard SKU of Api Management.
	SKUTypeStandard SKUType = "Standard"
)

func PossibleSKUTypeValues 

func PossibleSKUTypeValues() []SKUType

PossibleSKUTypeValues returns the possible values for the SKUType const type.

func (SKUType) ToPtr 

func (c SKUType) ToPtr() *SKUType

ToPtr returns a *SKUType pointing to the current value.

type SamplingSettings 

type SamplingSettings struct {
	// Rate of sampling for fixed-rate sampling.
	Percentage *float64 `json:"percentage,omitempty"`

	// Sampling type.
	SamplingType *SamplingType `json:"samplingType,omitempty"`
}

SamplingSettings - Sampling settings for Diagnostic.

type SamplingType 

type SamplingType string

SamplingType - Sampling type. 

const (
	// SamplingTypeFixed - Fixed-rate sampling.
	SamplingTypeFixed SamplingType = "fixed"
)

func PossibleSamplingTypeValues 

func PossibleSamplingTypeValues() []SamplingType

PossibleSamplingTypeValues returns the possible values for the SamplingType const type.

func (SamplingType) ToPtr 

func (c SamplingType) ToPtr() *SamplingType

ToPtr returns a *SamplingType pointing to the current value.

type SaveConfigurationParameter 

type SaveConfigurationParameter struct {
	// Properties of the Save Configuration Parameters.
	Properties *SaveConfigurationParameterProperties `json:"properties,omitempty"`
}

SaveConfigurationParameter - Save Tenant Configuration Contract details.

type SaveConfigurationParameterProperties 

type SaveConfigurationParameterProperties struct {
	// REQUIRED; The name of the Git branch in which to commit the current configuration snapshot.
	Branch *string `json:"branch,omitempty"`

	// The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be
	// overwritten.
	Force *bool `json:"force,omitempty"`
}

SaveConfigurationParameterProperties - Parameters supplied to the Save Tenant Configuration operation.

type SchemaCollection 

type SchemaCollection struct {
	// Total record count number.
	Count *int64 `json:"count,omitempty"`

	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; API Schema Contract value.
	Value []*SchemaContract `json:"value,omitempty" azure:"ro"`
}

SchemaCollection - The response of the list schema operation.

func (SchemaCollection) MarshalJSON 

func (s SchemaCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SchemaCollection.

type SchemaContract 

type SchemaContract struct {
	Resource
	// Properties of the Schema.
	Properties *SchemaContractProperties `json:"properties,omitempty"`
}

SchemaContract - Schema Contract details.

func (SchemaContract) MarshalJSON 

func (s SchemaContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SchemaContract.

type SchemaContractProperties 

type SchemaContractProperties struct {
	// REQUIRED; Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json,
	// application/xml).
	// - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json
	// - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
	// - OpenApi Schema use application/vnd.oai.openapi.components+json
	// - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.
	ContentType *string `json:"contentType,omitempty"`

	// Create or update Properties of the Schema Document.
	Document *SchemaDocumentProperties `json:"document,omitempty"`
}

SchemaContractProperties - API Schema create or update contract Properties.

type SchemaDocumentProperties 

type SchemaDocumentProperties struct {
	// Types definitions. Used for OpenAPI v3 schemas only, null otherwise.
	Components map[string]interface{} `json:"components,omitempty"`

	// Types definitions. Used for OpenAPI v2 (Swagger) schemas only, null otherwise.
	Definitions map[string]interface{} `json:"definitions,omitempty"`

	// Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
	Value *string `json:"value,omitempty"`
}

SchemaDocumentProperties - Schema Document Properties.

type SettingsTypeName 

type SettingsTypeName string
const (
	SettingsTypeNamePublic SettingsTypeName = "public"
)

func PossibleSettingsTypeNameValues 

func PossibleSettingsTypeNameValues() []SettingsTypeName

PossibleSettingsTypeNameValues returns the possible values for the SettingsTypeName const type.

func (SettingsTypeName) ToPtr 

func (c SettingsTypeName) ToPtr() *SettingsTypeName

ToPtr returns a *SettingsTypeName pointing to the current value.

type Severity 

type Severity string

Severity - The severity of the issue. 

const (
	SeverityError   Severity = "Error"
	SeverityWarning Severity = "Warning"
)

func PossibleSeverityValues 

func PossibleSeverityValues() []Severity

PossibleSeverityValues returns the possible values for the Severity const type.

func (Severity) ToPtr 

func (c Severity) ToPtr() *Severity

ToPtr returns a *Severity pointing to the current value.

type SignInSettingsClient 

type SignInSettingsClient struct {
	// contains filtered or unexported fields
}

SignInSettingsClient contains the methods for the SignInSettings group. Don't use this type directly, use NewSignInSettingsClient() instead.

func NewSignInSettingsClient 

func NewSignInSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *SignInSettingsClient

NewSignInSettingsClient creates a new instance of SignInSettingsClient with the specified values.

func (*SignInSettingsClient) CreateOrUpdate 

func (client *SignInSettingsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSigninSettings, options *SignInSettingsCreateOrUpdateOptions) (SignInSettingsCreateOrUpdateResponse, error)

CreateOrUpdate - Create or Update Sign-In settings. If the operation fails it returns the *ErrorResponse error type.

func (*SignInSettingsClient) Get 

func (client *SignInSettingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, options *SignInSettingsGetOptions) (SignInSettingsGetResponse, error)

Get - Get Sign In Settings for the Portal If the operation fails it returns the *ErrorResponse error type.

func (*SignInSettingsClient) GetEntityTag 

func (client *SignInSettingsClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, options *SignInSettingsGetEntityTagOptions) (SignInSettingsGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the SignInSettings. If the operation fails it returns the *ErrorResponse error type.

func (*SignInSettingsClient) Update 

func (client *SignInSettingsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, ifMatch string, parameters PortalSigninSettings, options *SignInSettingsUpdateOptions) (SignInSettingsUpdateResponse, error)

Update - Update Sign-In settings. If the operation fails it returns the *ErrorResponse error type.

type SignInSettingsCreateOrUpdateOptions 

type SignInSettingsCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

SignInSettingsCreateOrUpdateOptions contains the optional parameters for the SignInSettings.CreateOrUpdate method.

type SignInSettingsCreateOrUpdateResponse 

type SignInSettingsCreateOrUpdateResponse struct {
	SignInSettingsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SignInSettingsCreateOrUpdateResponse contains the response from method SignInSettings.CreateOrUpdate.

type SignInSettingsCreateOrUpdateResult 

type SignInSettingsCreateOrUpdateResult struct {
	PortalSigninSettings
}

SignInSettingsCreateOrUpdateResult contains the result from method SignInSettings.CreateOrUpdate.

type SignInSettingsGetEntityTagOptions 

type SignInSettingsGetEntityTagOptions struct {
}

SignInSettingsGetEntityTagOptions contains the optional parameters for the SignInSettings.GetEntityTag method.

type SignInSettingsGetEntityTagResponse 

type SignInSettingsGetEntityTagResponse struct {
	SignInSettingsGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SignInSettingsGetEntityTagResponse contains the response from method SignInSettings.GetEntityTag.

type SignInSettingsGetEntityTagResult 

type SignInSettingsGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

SignInSettingsGetEntityTagResult contains the result from method SignInSettings.GetEntityTag.

type SignInSettingsGetOptions 

type SignInSettingsGetOptions struct {
}

SignInSettingsGetOptions contains the optional parameters for the SignInSettings.Get method.

type SignInSettingsGetResponse 

type SignInSettingsGetResponse struct {
	SignInSettingsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SignInSettingsGetResponse contains the response from method SignInSettings.Get.

type SignInSettingsGetResult 

type SignInSettingsGetResult struct {
	PortalSigninSettings
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

SignInSettingsGetResult contains the result from method SignInSettings.Get.

type SignInSettingsUpdateOptions 

type SignInSettingsUpdateOptions struct {
}

SignInSettingsUpdateOptions contains the optional parameters for the SignInSettings.Update method.

type SignInSettingsUpdateResponse 

type SignInSettingsUpdateResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SignInSettingsUpdateResponse contains the response from method SignInSettings.Update.

type SignUpSettingsClient 

type SignUpSettingsClient struct {
	// contains filtered or unexported fields
}

SignUpSettingsClient contains the methods for the SignUpSettings group. Don't use this type directly, use NewSignUpSettingsClient() instead.

func NewSignUpSettingsClient 

func NewSignUpSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *SignUpSettingsClient

NewSignUpSettingsClient creates a new instance of SignUpSettingsClient with the specified values.

func (*SignUpSettingsClient) CreateOrUpdate 

func (client *SignUpSettingsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSignupSettings, options *SignUpSettingsCreateOrUpdateOptions) (SignUpSettingsCreateOrUpdateResponse, error)

CreateOrUpdate - Create or Update Sign-Up settings. If the operation fails it returns the *ErrorResponse error type.

func (*SignUpSettingsClient) Get 

func (client *SignUpSettingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, options *SignUpSettingsGetOptions) (SignUpSettingsGetResponse, error)

Get - Get Sign Up Settings for the Portal If the operation fails it returns the *ErrorResponse error type.

func (*SignUpSettingsClient) GetEntityTag 

func (client *SignUpSettingsClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, options *SignUpSettingsGetEntityTagOptions) (SignUpSettingsGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the SignUpSettings. If the operation fails it returns the *ErrorResponse error type.

func (*SignUpSettingsClient) Update 

func (client *SignUpSettingsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, ifMatch string, parameters PortalSignupSettings, options *SignUpSettingsUpdateOptions) (SignUpSettingsUpdateResponse, error)

Update - Update Sign-Up settings. If the operation fails it returns the *ErrorResponse error type.

type SignUpSettingsCreateOrUpdateOptions 

type SignUpSettingsCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

SignUpSettingsCreateOrUpdateOptions contains the optional parameters for the SignUpSettings.CreateOrUpdate method.

type SignUpSettingsCreateOrUpdateResponse 

type SignUpSettingsCreateOrUpdateResponse struct {
	SignUpSettingsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SignUpSettingsCreateOrUpdateResponse contains the response from method SignUpSettings.CreateOrUpdate.

type SignUpSettingsCreateOrUpdateResult 

type SignUpSettingsCreateOrUpdateResult struct {
	PortalSignupSettings
}

SignUpSettingsCreateOrUpdateResult contains the result from method SignUpSettings.CreateOrUpdate.

type SignUpSettingsGetEntityTagOptions 

type SignUpSettingsGetEntityTagOptions struct {
}

SignUpSettingsGetEntityTagOptions contains the optional parameters for the SignUpSettings.GetEntityTag method.

type SignUpSettingsGetEntityTagResponse 

type SignUpSettingsGetEntityTagResponse struct {
	SignUpSettingsGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SignUpSettingsGetEntityTagResponse contains the response from method SignUpSettings.GetEntityTag.

type SignUpSettingsGetEntityTagResult 

type SignUpSettingsGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

SignUpSettingsGetEntityTagResult contains the result from method SignUpSettings.GetEntityTag.

type SignUpSettingsGetOptions 

type SignUpSettingsGetOptions struct {
}

SignUpSettingsGetOptions contains the optional parameters for the SignUpSettings.Get method.

type SignUpSettingsGetResponse 

type SignUpSettingsGetResponse struct {
	SignUpSettingsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SignUpSettingsGetResponse contains the response from method SignUpSettings.Get.

type SignUpSettingsGetResult 

type SignUpSettingsGetResult struct {
	PortalSignupSettings
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

SignUpSettingsGetResult contains the result from method SignUpSettings.Get.

type SignUpSettingsUpdateOptions 

type SignUpSettingsUpdateOptions struct {
}

SignUpSettingsUpdateOptions contains the optional parameters for the SignUpSettings.Update method.

type SignUpSettingsUpdateResponse 

type SignUpSettingsUpdateResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SignUpSettingsUpdateResponse contains the response from method SignUpSettings.Update.

type SoapAPIType 

type SoapAPIType string

SoapAPIType - Type of API to create. * http creates a REST API * soap creates a SOAP pass-through API * websocket creates websocket API * graphql creates GraphQL API. 

const (
	// SoapAPITypeGraphQL - Imports the API having a GraphQL front end.
	SoapAPITypeGraphQL SoapAPIType = "graphql"
	// SoapAPITypeSoapPassThrough - Imports the SOAP API having a SOAP front end.
	SoapAPITypeSoapPassThrough SoapAPIType = "soap"
	// SoapAPITypeSoapToRest - Imports a SOAP API having a RESTful front end.
	SoapAPITypeSoapToRest SoapAPIType = "http"
	// SoapAPITypeWebSocket - Imports the API having a Websocket front end.
	SoapAPITypeWebSocket SoapAPIType = "websocket"
)

func PossibleSoapAPITypeValues 

func PossibleSoapAPITypeValues() []SoapAPIType

PossibleSoapAPITypeValues returns the possible values for the SoapAPIType const type.

func (SoapAPIType) ToPtr 

func (c SoapAPIType) ToPtr() *SoapAPIType

ToPtr returns a *SoapAPIType pointing to the current value.

type State 

type State string

State - Status of the issue. 

const (
	// StateClosed - The issue was closed.
	StateClosed State = "closed"
	// StateOpen - The issue is opened.
	StateOpen State = "open"
	// StateProposed - The issue is proposed.
	StateProposed State = "proposed"
	// StateRemoved - The issue was removed.
	StateRemoved State = "removed"
	// StateResolved - The issue is now resolved.
	StateResolved State = "resolved"
)

func PossibleStateValues 

func PossibleStateValues() []State

PossibleStateValues returns the possible values for the State const type.

func (State) ToPtr 

func (c State) ToPtr() *State

ToPtr returns a *State pointing to the current value.

type SubscriptionClient 

type SubscriptionClient struct {
	// contains filtered or unexported fields
}

SubscriptionClient contains the methods for the Subscription group. Don't use this type directly, use NewSubscriptionClient() instead.

func NewSubscriptionClient 

func NewSubscriptionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *SubscriptionClient

NewSubscriptionClient creates a new instance of SubscriptionClient with the specified values.

func (*SubscriptionClient) CreateOrUpdate 

func (client *SubscriptionClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionCreateParameters, options *SubscriptionCreateOrUpdateOptions) (SubscriptionCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the subscription of specified user to the specified product. If the operation fails it returns the *ErrorResponse error type.

func (*SubscriptionClient) Delete 

func (client *SubscriptionClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, sid string, ifMatch string, options *SubscriptionDeleteOptions) (SubscriptionDeleteResponse, error)

Delete - Deletes the specified subscription. If the operation fails it returns the *ErrorResponse error type.

func (*SubscriptionClient) Get 

func (client *SubscriptionClient) Get(ctx context.Context, resourceGroupName string, serviceName string, sid string, options *SubscriptionGetOptions) (SubscriptionGetResponse, error)

Get - Gets the specified Subscription entity. If the operation fails it returns the *ErrorResponse error type.

func (*SubscriptionClient) GetEntityTag 

func (client *SubscriptionClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, sid string, options *SubscriptionGetEntityTagOptions) (SubscriptionGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*SubscriptionClient) List 

func (client *SubscriptionClient) List(resourceGroupName string, serviceName string, options *SubscriptionListOptions) *SubscriptionListPager

List - Lists all subscriptions of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*SubscriptionClient) ListSecrets 

func (client *SubscriptionClient) ListSecrets(ctx context.Context, resourceGroupName string, serviceName string, sid string, options *SubscriptionListSecretsOptions) (SubscriptionListSecretsResponse, error)

ListSecrets - Gets the specified Subscription keys. If the operation fails it returns the *ErrorResponse error type.

func (*SubscriptionClient) RegeneratePrimaryKey 

func (client *SubscriptionClient) RegeneratePrimaryKey(ctx context.Context, resourceGroupName string, serviceName string, sid string, options *SubscriptionRegeneratePrimaryKeyOptions) (SubscriptionRegeneratePrimaryKeyResponse, error)

RegeneratePrimaryKey - Regenerates primary key of existing subscription of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*SubscriptionClient) RegenerateSecondaryKey 

func (client *SubscriptionClient) RegenerateSecondaryKey(ctx context.Context, resourceGroupName string, serviceName string, sid string, options *SubscriptionRegenerateSecondaryKeyOptions) (SubscriptionRegenerateSecondaryKeyResponse, error)

RegenerateSecondaryKey - Regenerates secondary key of existing subscription of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*SubscriptionClient) Update 

func (client *SubscriptionClient) Update(ctx context.Context, resourceGroupName string, serviceName string, sid string, ifMatch string, parameters SubscriptionUpdateParameters, options *SubscriptionUpdateOptions) (SubscriptionUpdateResponse, error)

Update - Updates the details of a subscription specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type SubscriptionCollection 

type SubscriptionCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*SubscriptionContract `json:"value,omitempty"`
}

SubscriptionCollection - Paged Subscriptions list representation.

func (SubscriptionCollection) MarshalJSON 

func (s SubscriptionCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubscriptionCollection.

type SubscriptionContract 

type SubscriptionContract struct {
	Resource
	// Subscription contract properties.
	Properties *SubscriptionContractProperties `json:"properties,omitempty"`
}

SubscriptionContract - Subscription details.

func (SubscriptionContract) MarshalJSON 

func (s SubscriptionContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubscriptionContract.

type SubscriptionContractProperties 

type SubscriptionContractProperties struct {
	// REQUIRED; Scope like /products/{productId} or /apis or /apis/{apiId}.
	Scope *string `json:"scope,omitempty"`

	// REQUIRED; Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber
	// cannot call any APIs of the product, * submitted – the
	// subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied
	// by an administrator, * cancelled – the
	// subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
	State *SubscriptionState `json:"state,omitempty"`

	// Determines whether tracing is enabled
	AllowTracing *bool `json:"allowTracing,omitempty"`

	// The name of the subscription, or null if the subscription has no name.
	DisplayName *string `json:"displayName,omitempty"`

	// Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription
	// lifecycle can be managed by using the
	// state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	EndDate *time.Time `json:"endDate,omitempty"`

	// Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can
	// be managed by using the state property. The date
	// conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	ExpirationDate *time.Time `json:"expirationDate,omitempty"`

	// Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	NotificationDate *time.Time `json:"notificationDate,omitempty"`

	// The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier.
	OwnerID *string `json:"ownerId,omitempty"`

	// Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
	SecondaryKey *string `json:"secondaryKey,omitempty"`

	// Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle
	// can be managed by using the state property. The
	// date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	StartDate *time.Time `json:"startDate,omitempty"`

	// Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
	StateComment *string `json:"stateComment,omitempty"`

	// READ-ONLY; Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	CreatedDate *time.Time `json:"createdDate,omitempty" azure:"ro"`
}

SubscriptionContractProperties - Subscription details.

func (SubscriptionContractProperties) MarshalJSON 

func (s SubscriptionContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubscriptionContractProperties.

func (*SubscriptionContractProperties) UnmarshalJSON 

func (s *SubscriptionContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionContractProperties.

type SubscriptionCreateOrUpdateOptions 

type SubscriptionCreateOrUpdateOptions struct {
	// Determines the type of application which send the create user request. Default is legacy publisher portal.
	AppType *AppType
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
	// Notify change in Subscription State.
	// - If false, do not send any email notification for change of state of subscription
	// - If true, send email notification of change of state of subscription
	Notify *bool
}

SubscriptionCreateOrUpdateOptions contains the optional parameters for the Subscription.CreateOrUpdate method.

type SubscriptionCreateOrUpdateResponse 

type SubscriptionCreateOrUpdateResponse struct {
	SubscriptionCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubscriptionCreateOrUpdateResponse contains the response from method Subscription.CreateOrUpdate.

type SubscriptionCreateOrUpdateResult 

type SubscriptionCreateOrUpdateResult struct {
	SubscriptionContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

SubscriptionCreateOrUpdateResult contains the result from method Subscription.CreateOrUpdate.

type SubscriptionCreateParameterProperties 

type SubscriptionCreateParameterProperties struct {
	// REQUIRED; Subscription name.
	DisplayName *string `json:"displayName,omitempty"`

	// REQUIRED; Scope like /products/{productId} or /apis or /apis/{apiId}.
	Scope *string `json:"scope,omitempty"`

	// Determines whether tracing can be enabled
	AllowTracing *bool `json:"allowTracing,omitempty"`

	// User (user id path) for whom subscription is being created in form /users/{userId}
	OwnerID *string `json:"ownerId,omitempty"`

	// Primary subscription key. If not specified during request key will be generated automatically.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// Secondary subscription key. If not specified during request key will be generated automatically.
	SecondaryKey *string `json:"secondaryKey,omitempty"`

	// Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is
	// active, * suspended – the subscription is
	// blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet
	// been approved or rejected, * rejected – the
	// subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired
	// – the subscription reached its expiration date
	// and was deactivated.
	State *SubscriptionState `json:"state,omitempty"`
}

SubscriptionCreateParameterProperties - Parameters supplied to the Create subscription operation.

type SubscriptionCreateParameters 

type SubscriptionCreateParameters struct {
	// Subscription contract properties.
	Properties *SubscriptionCreateParameterProperties `json:"properties,omitempty"`
}

SubscriptionCreateParameters - Subscription create details.

type SubscriptionDeleteOptions 

type SubscriptionDeleteOptions struct {
}

SubscriptionDeleteOptions contains the optional parameters for the Subscription.Delete method.

type SubscriptionDeleteResponse 

type SubscriptionDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubscriptionDeleteResponse contains the response from method Subscription.Delete.

type SubscriptionGetEntityTagOptions 

type SubscriptionGetEntityTagOptions struct {
}

SubscriptionGetEntityTagOptions contains the optional parameters for the Subscription.GetEntityTag method.

type SubscriptionGetEntityTagResponse 

type SubscriptionGetEntityTagResponse struct {
	SubscriptionGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubscriptionGetEntityTagResponse contains the response from method Subscription.GetEntityTag.

type SubscriptionGetEntityTagResult 

type SubscriptionGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

SubscriptionGetEntityTagResult contains the result from method Subscription.GetEntityTag.

type SubscriptionGetOptions 

type SubscriptionGetOptions struct {
}

SubscriptionGetOptions contains the optional parameters for the Subscription.Get method.

type SubscriptionGetResponse 

type SubscriptionGetResponse struct {
	SubscriptionGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubscriptionGetResponse contains the response from method Subscription.Get.

type SubscriptionGetResult 

type SubscriptionGetResult struct {
	SubscriptionContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

SubscriptionGetResult contains the result from method Subscription.Get.

type SubscriptionKeyParameterNamesContract 

type SubscriptionKeyParameterNamesContract struct {
	// Subscription key header name.
	Header *string `json:"header,omitempty"`

	// Subscription key query string parameter name.
	Query *string `json:"query,omitempty"`
}

SubscriptionKeyParameterNamesContract - Subscription key parameter names details.

type SubscriptionKeysContract 

type SubscriptionKeysContract struct {
	// Subscription primary key.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// Subscription secondary key.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

SubscriptionKeysContract - Subscription keys.

type SubscriptionListOptions 

type SubscriptionListOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| ownerId | filter | ge, le, eq,
	// ne, gt, lt | substringof, contains, startswith, endswith |</br>| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith
	// |</br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| productId | filter | ge, le, eq, ne, gt, lt |
	// substringof, contains, startswith, endswith |</br>| state | filter | eq | |</br>| user | expand | | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

SubscriptionListOptions contains the optional parameters for the Subscription.List method.

type SubscriptionListPager 

type SubscriptionListPager struct {
	// contains filtered or unexported fields
}

SubscriptionListPager provides operations for iterating over paged responses.

func (*SubscriptionListPager) Err 

func (p *SubscriptionListPager) Err() error

Err returns the last error encountered while paging.

func (*SubscriptionListPager) NextPage 

func (p *SubscriptionListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*SubscriptionListPager) PageResponse 

func (p *SubscriptionListPager) PageResponse() SubscriptionListResponse

PageResponse returns the current SubscriptionListResponse page.

type SubscriptionListResponse 

type SubscriptionListResponse struct {
	SubscriptionListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubscriptionListResponse contains the response from method Subscription.List.

type SubscriptionListResult 

type SubscriptionListResult struct {
	SubscriptionCollection
}

SubscriptionListResult contains the result from method Subscription.List.

type SubscriptionListSecretsOptions 

type SubscriptionListSecretsOptions struct {
}

SubscriptionListSecretsOptions contains the optional parameters for the Subscription.ListSecrets method.

type SubscriptionListSecretsResponse 

type SubscriptionListSecretsResponse struct {
	SubscriptionListSecretsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubscriptionListSecretsResponse contains the response from method Subscription.ListSecrets.

type SubscriptionListSecretsResult 

type SubscriptionListSecretsResult struct {
	SubscriptionKeysContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

SubscriptionListSecretsResult contains the result from method Subscription.ListSecrets.

type SubscriptionRegeneratePrimaryKeyOptions 

type SubscriptionRegeneratePrimaryKeyOptions struct {
}

SubscriptionRegeneratePrimaryKeyOptions contains the optional parameters for the Subscription.RegeneratePrimaryKey method.

type SubscriptionRegeneratePrimaryKeyResponse 

type SubscriptionRegeneratePrimaryKeyResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubscriptionRegeneratePrimaryKeyResponse contains the response from method Subscription.RegeneratePrimaryKey.

type SubscriptionRegenerateSecondaryKeyOptions 

type SubscriptionRegenerateSecondaryKeyOptions struct {
}

SubscriptionRegenerateSecondaryKeyOptions contains the optional parameters for the Subscription.RegenerateSecondaryKey method.

type SubscriptionRegenerateSecondaryKeyResponse 

type SubscriptionRegenerateSecondaryKeyResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubscriptionRegenerateSecondaryKeyResponse contains the response from method Subscription.RegenerateSecondaryKey.

type SubscriptionState 

type SubscriptionState string

SubscriptionState - Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. 

const (
	SubscriptionStateSuspended SubscriptionState = "suspended"
	SubscriptionStateActive    SubscriptionState = "active"
	SubscriptionStateExpired   SubscriptionState = "expired"
	SubscriptionStateSubmitted SubscriptionState = "submitted"
	SubscriptionStateRejected  SubscriptionState = "rejected"
	SubscriptionStateCancelled SubscriptionState = "cancelled"
)

func PossibleSubscriptionStateValues 

func PossibleSubscriptionStateValues() []SubscriptionState

PossibleSubscriptionStateValues returns the possible values for the SubscriptionState const type.

func (SubscriptionState) ToPtr 

func (c SubscriptionState) ToPtr() *SubscriptionState

ToPtr returns a *SubscriptionState pointing to the current value.

type SubscriptionUpdateOptions 

type SubscriptionUpdateOptions struct {
	// Determines the type of application which send the create user request. Default is legacy publisher portal.
	AppType *AppType
	// Notify change in Subscription State.
	// - If false, do not send any email notification for change of state of subscription
	// - If true, send email notification of change of state of subscription
	Notify *bool
}

SubscriptionUpdateOptions contains the optional parameters for the Subscription.Update method.

type SubscriptionUpdateParameterProperties 

type SubscriptionUpdateParameterProperties struct {
	// Determines whether tracing can be enabled
	AllowTracing *bool `json:"allowTracing,omitempty"`

	// Subscription name.
	DisplayName *string `json:"displayName,omitempty"`

	// Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can
	// be managed by using the state property. The date
	// conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	ExpirationDate *time.Time `json:"expirationDate,omitempty"`

	// User identifier path: /users/{userId}
	OwnerID *string `json:"ownerId,omitempty"`

	// Primary subscription key.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// Scope like /products/{productId} or /apis or /apis/{apiId}
	Scope *string `json:"scope,omitempty"`

	// Secondary subscription key.
	SecondaryKey *string `json:"secondaryKey,omitempty"`

	// Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call
	// any APIs of the product, * submitted – the
	// subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied
	// by an administrator, * cancelled – the
	// subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
	State *SubscriptionState `json:"state,omitempty"`

	// Comments describing subscription state change by the administrator when the state is changed to the 'rejected'.
	StateComment *string `json:"stateComment,omitempty"`
}

SubscriptionUpdateParameterProperties - Parameters supplied to the Update subscription operation.

func (SubscriptionUpdateParameterProperties) MarshalJSON 

func (s SubscriptionUpdateParameterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubscriptionUpdateParameterProperties.

func (*SubscriptionUpdateParameterProperties) UnmarshalJSON 

func (s *SubscriptionUpdateParameterProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionUpdateParameterProperties.

type SubscriptionUpdateParameters 

type SubscriptionUpdateParameters struct {
	// Subscription Update contract properties.
	Properties *SubscriptionUpdateParameterProperties `json:"properties,omitempty"`
}

SubscriptionUpdateParameters - Subscription update details.

func (SubscriptionUpdateParameters) MarshalJSON 

func (s SubscriptionUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubscriptionUpdateParameters.

type SubscriptionUpdateResponse 

type SubscriptionUpdateResponse struct {
	SubscriptionUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubscriptionUpdateResponse contains the response from method Subscription.Update.

type SubscriptionUpdateResult 

type SubscriptionUpdateResult struct {
	SubscriptionContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

SubscriptionUpdateResult contains the result from method Subscription.Update.

type SubscriptionsDelegationSettingsProperties 

type SubscriptionsDelegationSettingsProperties struct {
	// Enable or disable delegation for subscriptions.
	Enabled *bool `json:"enabled,omitempty"`
}

SubscriptionsDelegationSettingsProperties - Subscriptions delegation settings properties.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TagAssignToAPIOptions 

type TagAssignToAPIOptions struct {
}

TagAssignToAPIOptions contains the optional parameters for the Tag.AssignToAPI method.

type TagAssignToAPIResponse 

type TagAssignToAPIResponse struct {
	TagAssignToAPIResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagAssignToAPIResponse contains the response from method Tag.AssignToAPI.

type TagAssignToAPIResult 

type TagAssignToAPIResult struct {
	TagContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TagAssignToAPIResult contains the result from method Tag.AssignToAPI.

type TagAssignToOperationOptions 

type TagAssignToOperationOptions struct {
}

TagAssignToOperationOptions contains the optional parameters for the Tag.AssignToOperation method.

type TagAssignToOperationResponse 

type TagAssignToOperationResponse struct {
	TagAssignToOperationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagAssignToOperationResponse contains the response from method Tag.AssignToOperation.

type TagAssignToOperationResult 

type TagAssignToOperationResult struct {
	TagContract
}

TagAssignToOperationResult contains the result from method Tag.AssignToOperation.

type TagAssignToProductOptions 

type TagAssignToProductOptions struct {
}

TagAssignToProductOptions contains the optional parameters for the Tag.AssignToProduct method.

type TagAssignToProductResponse 

type TagAssignToProductResponse struct {
	TagAssignToProductResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagAssignToProductResponse contains the response from method Tag.AssignToProduct.

type TagAssignToProductResult 

type TagAssignToProductResult struct {
	TagContract
}

TagAssignToProductResult contains the result from method Tag.AssignToProduct.

type TagClient 

type TagClient struct {
	// contains filtered or unexported fields
}

TagClient contains the methods for the Tag group. Don't use this type directly, use NewTagClient() instead.

func NewTagClient 

func NewTagClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *TagClient

NewTagClient creates a new instance of TagClient with the specified values.

func (*TagClient) AssignToAPI 

func (client *TagClient) AssignToAPI(ctx context.Context, resourceGroupName string, serviceName string, apiID string, tagID string, options *TagAssignToAPIOptions) (TagAssignToAPIResponse, error)

AssignToAPI - Assign tag to the Api. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) AssignToOperation 

func (client *TagClient) AssignToOperation(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, tagID string, options *TagAssignToOperationOptions) (TagAssignToOperationResponse, error)

AssignToOperation - Assign tag to the Operation. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) AssignToProduct 

func (client *TagClient) AssignToProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, options *TagAssignToProductOptions) (TagAssignToProductResponse, error)

AssignToProduct - Assign tag to the Product. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) CreateOrUpdate 

func (client *TagClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, tagID string, parameters TagCreateUpdateParameters, options *TagCreateOrUpdateOptions) (TagCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a tag. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) Delete 

func (client *TagClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, tagID string, ifMatch string, options *TagDeleteOptions) (TagDeleteResponse, error)

Delete - Deletes specific tag of the API Management service instance. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) DetachFromAPI 

func (client *TagClient) DetachFromAPI(ctx context.Context, resourceGroupName string, serviceName string, apiID string, tagID string, options *TagDetachFromAPIOptions) (TagDetachFromAPIResponse, error)

DetachFromAPI - Detach the tag from the Api. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) DetachFromOperation 

func (client *TagClient) DetachFromOperation(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, tagID string, options *TagDetachFromOperationOptions) (TagDetachFromOperationResponse, error)

DetachFromOperation - Detach the tag from the Operation. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) DetachFromProduct 

func (client *TagClient) DetachFromProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, options *TagDetachFromProductOptions) (TagDetachFromProductResponse, error)

DetachFromProduct - Detach the tag from the Product. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) Get 

func (client *TagClient) Get(ctx context.Context, resourceGroupName string, serviceName string, tagID string, options *TagGetOptions) (TagGetResponse, error)

Get - Gets the details of the tag specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) GetByAPI 

func (client *TagClient) GetByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiID string, tagID string, options *TagGetByAPIOptions) (TagGetByAPIResponse, error)

GetByAPI - Get tag associated with the API. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) GetByOperation 

func (client *TagClient) GetByOperation(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, tagID string, options *TagGetByOperationOptions) (TagGetByOperationResponse, error)

GetByOperation - Get tag associated with the Operation. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) GetByProduct 

func (client *TagClient) GetByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, options *TagGetByProductOptions) (TagGetByProductResponse, error)

GetByProduct - Get tag associated with the Product. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) GetEntityState 

func (client *TagClient) GetEntityState(ctx context.Context, resourceGroupName string, serviceName string, tagID string, options *TagGetEntityStateOptions) (TagGetEntityStateResponse, error)

GetEntityState - Gets the entity state version of the tag specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) GetEntityStateByAPI 

func (client *TagClient) GetEntityStateByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiID string, tagID string, options *TagGetEntityStateByAPIOptions) (TagGetEntityStateByAPIResponse, error)

GetEntityStateByAPI - Gets the entity state version of the tag specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) GetEntityStateByOperation 

func (client *TagClient) GetEntityStateByOperation(ctx context.Context, resourceGroupName string, serviceName string, apiID string, operationID string, tagID string, options *TagGetEntityStateByOperationOptions) (TagGetEntityStateByOperationResponse, error)

GetEntityStateByOperation - Gets the entity state version of the tag specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) GetEntityStateByProduct 

func (client *TagClient) GetEntityStateByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, options *TagGetEntityStateByProductOptions) (TagGetEntityStateByProductResponse, error)

GetEntityStateByProduct - Gets the entity state version of the tag specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) ListByAPI 

func (client *TagClient) ListByAPI(resourceGroupName string, serviceName string, apiID string, options *TagListByAPIOptions) *TagListByAPIPager

ListByAPI - Lists all Tags associated with the API. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) ListByOperation 

func (client *TagClient) ListByOperation(resourceGroupName string, serviceName string, apiID string, operationID string, options *TagListByOperationOptions) *TagListByOperationPager

ListByOperation - Lists all Tags associated with the Operation. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) ListByProduct 

func (client *TagClient) ListByProduct(resourceGroupName string, serviceName string, productID string, options *TagListByProductOptions) *TagListByProductPager

ListByProduct - Lists all Tags associated with the Product. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) ListByService 

func (client *TagClient) ListByService(resourceGroupName string, serviceName string, options *TagListByServiceOptions) *TagListByServicePager

ListByService - Lists a collection of tags defined within a service instance. If the operation fails it returns the *ErrorResponse error type.

func (*TagClient) Update 

func (client *TagClient) Update(ctx context.Context, resourceGroupName string, serviceName string, tagID string, ifMatch string, parameters TagCreateUpdateParameters, options *TagUpdateOptions) (TagUpdateResponse, error)

Update - Updates the details of the tag specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type TagCollection 

type TagCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*TagContract `json:"value,omitempty"`
}

TagCollection - Paged Tag list representation.

func (TagCollection) MarshalJSON 

func (t TagCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagCollection.

type TagContract 

type TagContract struct {
	Resource
	// Tag entity contract properties.
	Properties *TagContractProperties `json:"properties,omitempty"`
}

TagContract - Tag Contract details.

func (TagContract) MarshalJSON 

func (t TagContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagContract.

type TagContractProperties 

type TagContractProperties struct {
	// REQUIRED; Tag name.
	DisplayName *string `json:"displayName,omitempty"`
}

TagContractProperties - Tag contract Properties.

type TagCreateOrUpdateOptions 

type TagCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
}

TagCreateOrUpdateOptions contains the optional parameters for the Tag.CreateOrUpdate method.

type TagCreateOrUpdateResponse 

type TagCreateOrUpdateResponse struct {
	TagCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagCreateOrUpdateResponse contains the response from method Tag.CreateOrUpdate.

type TagCreateOrUpdateResult 

type TagCreateOrUpdateResult struct {
	TagContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TagCreateOrUpdateResult contains the result from method Tag.CreateOrUpdate.

type TagCreateUpdateParameters 

type TagCreateUpdateParameters struct {
	// Properties supplied to Create Tag operation.
	Properties *TagContractProperties `json:"properties,omitempty"`
}

TagCreateUpdateParameters - Parameters supplied to Create/Update Tag operations.

func (TagCreateUpdateParameters) MarshalJSON 

func (t TagCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagCreateUpdateParameters.

type TagDeleteOptions 

type TagDeleteOptions struct {
}

TagDeleteOptions contains the optional parameters for the Tag.Delete method.

type TagDeleteResponse 

type TagDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagDeleteResponse contains the response from method Tag.Delete.

type TagDescriptionBaseProperties 

type TagDescriptionBaseProperties struct {
	// Description of the Tag.
	Description *string `json:"description,omitempty"`

	// Description of the external resources describing the tag.
	ExternalDocsDescription *string `json:"externalDocsDescription,omitempty"`

	// Absolute URL of external resources describing the tag.
	ExternalDocsURL *string `json:"externalDocsUrl,omitempty"`
}

TagDescriptionBaseProperties - Parameters supplied to the Create TagDescription operation.

type TagDescriptionCollection 

type TagDescriptionCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*TagDescriptionContract `json:"value,omitempty"`
}

TagDescriptionCollection - Paged TagDescription list representation.

func (TagDescriptionCollection) MarshalJSON 

func (t TagDescriptionCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagDescriptionCollection.

type TagDescriptionContract 

type TagDescriptionContract struct {
	Resource
	// TagDescription entity contract properties.
	Properties *TagDescriptionContractProperties `json:"properties,omitempty"`
}

TagDescriptionContract - Contract details.

func (TagDescriptionContract) MarshalJSON 

func (t TagDescriptionContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagDescriptionContract.

type TagDescriptionContractProperties 

type TagDescriptionContractProperties struct {
	TagDescriptionBaseProperties
	// Tag name.
	DisplayName *string `json:"displayName,omitempty"`

	// Identifier of the tag in the form of /tags/{tagId}
	TagID *string `json:"tagId,omitempty"`
}

TagDescriptionContractProperties - TagDescription contract Properties.

type TagDescriptionCreateParameters 

type TagDescriptionCreateParameters struct {
	// Properties supplied to Create TagDescription operation.
	Properties *TagDescriptionBaseProperties `json:"properties,omitempty"`
}

TagDescriptionCreateParameters - Parameters supplied to the Create TagDescription operation.

type TagDetachFromAPIOptions 

type TagDetachFromAPIOptions struct {
}

TagDetachFromAPIOptions contains the optional parameters for the Tag.DetachFromAPI method.

type TagDetachFromAPIResponse 

type TagDetachFromAPIResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagDetachFromAPIResponse contains the response from method Tag.DetachFromAPI.

type TagDetachFromOperationOptions 

type TagDetachFromOperationOptions struct {
}

TagDetachFromOperationOptions contains the optional parameters for the Tag.DetachFromOperation method.

type TagDetachFromOperationResponse 

type TagDetachFromOperationResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagDetachFromOperationResponse contains the response from method Tag.DetachFromOperation.

type TagDetachFromProductOptions 

type TagDetachFromProductOptions struct {
}

TagDetachFromProductOptions contains the optional parameters for the Tag.DetachFromProduct method.

type TagDetachFromProductResponse 

type TagDetachFromProductResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagDetachFromProductResponse contains the response from method Tag.DetachFromProduct.

type TagGetByAPIOptions 

type TagGetByAPIOptions struct {
}

TagGetByAPIOptions contains the optional parameters for the Tag.GetByAPI method.

type TagGetByAPIResponse 

type TagGetByAPIResponse struct {
	TagGetByAPIResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagGetByAPIResponse contains the response from method Tag.GetByAPI.

type TagGetByAPIResult 

type TagGetByAPIResult struct {
	TagContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TagGetByAPIResult contains the result from method Tag.GetByAPI.

type TagGetByOperationOptions 

type TagGetByOperationOptions struct {
}

TagGetByOperationOptions contains the optional parameters for the Tag.GetByOperation method.

type TagGetByOperationResponse 

type TagGetByOperationResponse struct {
	TagGetByOperationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagGetByOperationResponse contains the response from method Tag.GetByOperation.

type TagGetByOperationResult 

type TagGetByOperationResult struct {
	TagContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TagGetByOperationResult contains the result from method Tag.GetByOperation.

type TagGetByProductOptions 

type TagGetByProductOptions struct {
}

TagGetByProductOptions contains the optional parameters for the Tag.GetByProduct method.

type TagGetByProductResponse 

type TagGetByProductResponse struct {
	TagGetByProductResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagGetByProductResponse contains the response from method Tag.GetByProduct.

type TagGetByProductResult 

type TagGetByProductResult struct {
	TagContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TagGetByProductResult contains the result from method Tag.GetByProduct.

type TagGetEntityStateByAPIOptions 

type TagGetEntityStateByAPIOptions struct {
}

TagGetEntityStateByAPIOptions contains the optional parameters for the Tag.GetEntityStateByAPI method.

type TagGetEntityStateByAPIResponse 

type TagGetEntityStateByAPIResponse struct {
	TagGetEntityStateByAPIResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagGetEntityStateByAPIResponse contains the response from method Tag.GetEntityStateByAPI.

type TagGetEntityStateByAPIResult 

type TagGetEntityStateByAPIResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

TagGetEntityStateByAPIResult contains the result from method Tag.GetEntityStateByAPI.

type TagGetEntityStateByOperationOptions 

type TagGetEntityStateByOperationOptions struct {
}

TagGetEntityStateByOperationOptions contains the optional parameters for the Tag.GetEntityStateByOperation method.

type TagGetEntityStateByOperationResponse 

type TagGetEntityStateByOperationResponse struct {
	TagGetEntityStateByOperationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagGetEntityStateByOperationResponse contains the response from method Tag.GetEntityStateByOperation.

type TagGetEntityStateByOperationResult 

type TagGetEntityStateByOperationResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

TagGetEntityStateByOperationResult contains the result from method Tag.GetEntityStateByOperation.

type TagGetEntityStateByProductOptions 

type TagGetEntityStateByProductOptions struct {
}

TagGetEntityStateByProductOptions contains the optional parameters for the Tag.GetEntityStateByProduct method.

type TagGetEntityStateByProductResponse 

type TagGetEntityStateByProductResponse struct {
	TagGetEntityStateByProductResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagGetEntityStateByProductResponse contains the response from method Tag.GetEntityStateByProduct.

type TagGetEntityStateByProductResult 

type TagGetEntityStateByProductResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

TagGetEntityStateByProductResult contains the result from method Tag.GetEntityStateByProduct.

type TagGetEntityStateOptions 

type TagGetEntityStateOptions struct {
}

TagGetEntityStateOptions contains the optional parameters for the Tag.GetEntityState method.

type TagGetEntityStateResponse 

type TagGetEntityStateResponse struct {
	TagGetEntityStateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagGetEntityStateResponse contains the response from method Tag.GetEntityState.

type TagGetEntityStateResult 

type TagGetEntityStateResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

TagGetEntityStateResult contains the result from method Tag.GetEntityState.

type TagGetOptions 

type TagGetOptions struct {
}

TagGetOptions contains the optional parameters for the Tag.Get method.

type TagGetResponse 

type TagGetResponse struct {
	TagGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagGetResponse contains the response from method Tag.Get.

type TagGetResult 

type TagGetResult struct {
	TagContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TagGetResult contains the result from method Tag.Get.

type TagListByAPIOptions 

type TagListByAPIOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter
	// | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

TagListByAPIOptions contains the optional parameters for the Tag.ListByAPI method.

type TagListByAPIPager 

type TagListByAPIPager struct {
	// contains filtered or unexported fields
}

TagListByAPIPager provides operations for iterating over paged responses.

func (*TagListByAPIPager) Err 

func (p *TagListByAPIPager) Err() error

Err returns the last error encountered while paging.

func (*TagListByAPIPager) NextPage 

func (p *TagListByAPIPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*TagListByAPIPager) PageResponse 

func (p *TagListByAPIPager) PageResponse() TagListByAPIResponse

PageResponse returns the current TagListByAPIResponse page.

type TagListByAPIResponse 

type TagListByAPIResponse struct {
	TagListByAPIResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagListByAPIResponse contains the response from method Tag.ListByAPI.

type TagListByAPIResult 

type TagListByAPIResult struct {
	TagCollection
}

TagListByAPIResult contains the result from method Tag.ListByAPI.

type TagListByOperationOptions 

type TagListByOperationOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter
	// | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

TagListByOperationOptions contains the optional parameters for the Tag.ListByOperation method.

type TagListByOperationPager 

type TagListByOperationPager struct {
	// contains filtered or unexported fields
}

TagListByOperationPager provides operations for iterating over paged responses.

func (*TagListByOperationPager) Err 

func (p *TagListByOperationPager) Err() error

Err returns the last error encountered while paging.

func (*TagListByOperationPager) NextPage 

func (p *TagListByOperationPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*TagListByOperationPager) PageResponse 

func (p *TagListByOperationPager) PageResponse() TagListByOperationResponse

PageResponse returns the current TagListByOperationResponse page.

type TagListByOperationResponse 

type TagListByOperationResponse struct {
	TagListByOperationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagListByOperationResponse contains the response from method Tag.ListByOperation.

type TagListByOperationResult 

type TagListByOperationResult struct {
	TagCollection
}

TagListByOperationResult contains the result from method Tag.ListByOperation.

type TagListByProductOptions 

type TagListByProductOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter
	// | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

TagListByProductOptions contains the optional parameters for the Tag.ListByProduct method.

type TagListByProductPager 

type TagListByProductPager struct {
	// contains filtered or unexported fields
}

TagListByProductPager provides operations for iterating over paged responses.

func (*TagListByProductPager) Err 

func (p *TagListByProductPager) Err() error

Err returns the last error encountered while paging.

func (*TagListByProductPager) NextPage 

func (p *TagListByProductPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*TagListByProductPager) PageResponse 

func (p *TagListByProductPager) PageResponse() TagListByProductResponse

PageResponse returns the current TagListByProductResponse page.

type TagListByProductResponse 

type TagListByProductResponse struct {
	TagListByProductResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagListByProductResponse contains the response from method Tag.ListByProduct.

type TagListByProductResult 

type TagListByProductResult struct {
	TagCollection
}

TagListByProductResult contains the result from method Tag.ListByProduct.

type TagListByServiceOptions 

type TagListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>
	Filter *string
	// Scope like 'apis', 'products' or 'apis/{apiId}
	Scope *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

TagListByServiceOptions contains the optional parameters for the Tag.ListByService method.

type TagListByServicePager 

type TagListByServicePager struct {
	// contains filtered or unexported fields
}

TagListByServicePager provides operations for iterating over paged responses.

func (*TagListByServicePager) Err 

func (p *TagListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*TagListByServicePager) NextPage 

func (p *TagListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*TagListByServicePager) PageResponse 

func (p *TagListByServicePager) PageResponse() TagListByServiceResponse

PageResponse returns the current TagListByServiceResponse page.

type TagListByServiceResponse 

type TagListByServiceResponse struct {
	TagListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagListByServiceResponse contains the response from method Tag.ListByService.

type TagListByServiceResult 

type TagListByServiceResult struct {
	TagCollection
}

TagListByServiceResult contains the result from method Tag.ListByService.

type TagResourceClient 

type TagResourceClient struct {
	// contains filtered or unexported fields
}

TagResourceClient contains the methods for the TagResource group. Don't use this type directly, use NewTagResourceClient() instead.

func NewTagResourceClient 

func NewTagResourceClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *TagResourceClient

NewTagResourceClient creates a new instance of TagResourceClient with the specified values.

func (*TagResourceClient) ListByService 

func (client *TagResourceClient) ListByService(resourceGroupName string, serviceName string, options *TagResourceListByServiceOptions) *TagResourceListByServicePager

ListByService - Lists a collection of resources associated with tags. If the operation fails it returns the *ErrorResponse error type.

type TagResourceCollection 

type TagResourceCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*TagResourceContract `json:"value,omitempty"`
}

TagResourceCollection - Paged Tag list representation.

func (TagResourceCollection) MarshalJSON 

func (t TagResourceCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagResourceCollection.

type TagResourceContract 

type TagResourceContract struct {
	// REQUIRED; Tag associated with the resource.
	Tag *TagResourceContractProperties `json:"tag,omitempty"`

	// API associated with the tag.
	API *APITagResourceContractProperties `json:"api,omitempty"`

	// Operation associated with the tag.
	Operation *OperationTagResourceContractProperties `json:"operation,omitempty"`

	// Product associated with the tag.
	Product *ProductTagResourceContractProperties `json:"product,omitempty"`
}

TagResourceContract - TagResource contract properties.

type TagResourceContractProperties 

type TagResourceContractProperties struct {
	// Tag identifier
	ID *string `json:"id,omitempty"`

	// Tag Name
	Name *string `json:"name,omitempty"`
}

TagResourceContractProperties - Contract defining the Tag property in the Tag Resource Contract

type TagResourceListByServiceOptions 

type TagResourceListByServiceOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| aid | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| apiName | filter | ge, le, eq, ne,
	// gt, lt | substringof, contains, startswith, endswith |</br>| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith
	// |</br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt |
	// substringof, contains, startswith, endswith |</br>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|
	// method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof,
	// contains, startswith, endswith |</br>| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| state | filter |
	// eq | |</br>| isCurrent | filter | eq | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

TagResourceListByServiceOptions contains the optional parameters for the TagResource.ListByService method.

type TagResourceListByServicePager 

type TagResourceListByServicePager struct {
	// contains filtered or unexported fields
}

TagResourceListByServicePager provides operations for iterating over paged responses.

func (*TagResourceListByServicePager) Err 

func (p *TagResourceListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*TagResourceListByServicePager) NextPage 

func (p *TagResourceListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*TagResourceListByServicePager) PageResponse 

func (p *TagResourceListByServicePager) PageResponse() TagResourceListByServiceResponse

PageResponse returns the current TagResourceListByServiceResponse page.

type TagResourceListByServiceResponse 

type TagResourceListByServiceResponse struct {
	TagResourceListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagResourceListByServiceResponse contains the response from method TagResource.ListByService.

type TagResourceListByServiceResult 

type TagResourceListByServiceResult struct {
	TagResourceCollection
}

TagResourceListByServiceResult contains the result from method TagResource.ListByService.

type TagUpdateOptions 

type TagUpdateOptions struct {
}

TagUpdateOptions contains the optional parameters for the Tag.Update method.

type TagUpdateResponse 

type TagUpdateResponse struct {
	TagUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TagUpdateResponse contains the response from method Tag.Update.

type TagUpdateResult 

type TagUpdateResult struct {
	TagContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TagUpdateResult contains the result from method Tag.Update.

type TemplateName 

type TemplateName string
const (
	TemplateNameAccountClosedDeveloper                            TemplateName = "accountClosedDeveloper"
	TemplateNameApplicationApprovedNotificationMessage            TemplateName = "applicationApprovedNotificationMessage"
	TemplateNameConfirmSignUpIdentityDefault                      TemplateName = "confirmSignUpIdentityDefault"
	TemplateNameEmailChangeIdentityDefault                        TemplateName = "emailChangeIdentityDefault"
	TemplateNameInviteUserNotificationMessage                     TemplateName = "inviteUserNotificationMessage"
	TemplateNameNewCommentNotificationMessage                     TemplateName = "newCommentNotificationMessage"
	TemplateNameNewDeveloperNotificationMessage                   TemplateName = "newDeveloperNotificationMessage"
	TemplateNameNewIssueNotificationMessage                       TemplateName = "newIssueNotificationMessage"
	TemplateNamePasswordResetByAdminNotificationMessage           TemplateName = "passwordResetByAdminNotificationMessage"
	TemplateNamePasswordResetIdentityDefault                      TemplateName = "passwordResetIdentityDefault"
	TemplateNamePurchaseDeveloperNotificationMessage              TemplateName = "purchaseDeveloperNotificationMessage"
	TemplateNameQuotaLimitApproachingDeveloperNotificationMessage TemplateName = "quotaLimitApproachingDeveloperNotificationMessage"
	TemplateNameRejectDeveloperNotificationMessage                TemplateName = "rejectDeveloperNotificationMessage"
	TemplateNameRequestDeveloperNotificationMessage               TemplateName = "requestDeveloperNotificationMessage"
)

func PossibleTemplateNameValues 

func PossibleTemplateNameValues() []TemplateName

PossibleTemplateNameValues returns the possible values for the TemplateName const type.

func (TemplateName) ToPtr 

func (c TemplateName) ToPtr() *TemplateName

ToPtr returns a *TemplateName pointing to the current value.

type TenantAccessClient 

type TenantAccessClient struct {
	// contains filtered or unexported fields
}

TenantAccessClient contains the methods for the TenantAccess group. Don't use this type directly, use NewTenantAccessClient() instead.

func NewTenantAccessClient 

func NewTenantAccessClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *TenantAccessClient

NewTenantAccessClient creates a new instance of TenantAccessClient with the specified values.

func (*TenantAccessClient) Create 

func (client *TenantAccessClient) Create(ctx context.Context, resourceGroupName string, serviceName string, accessName AccessIDName, ifMatch string, parameters AccessInformationCreateParameters, options *TenantAccessCreateOptions) (TenantAccessCreateResponse, error)

Create - Update tenant access information details. If the operation fails it returns the *ErrorResponse error type.

func (*TenantAccessClient) Get 

func (client *TenantAccessClient) Get(ctx context.Context, resourceGroupName string, serviceName string, accessName AccessIDName, options *TenantAccessGetOptions) (TenantAccessGetResponse, error)

Get - Get tenant access information details without secrets. If the operation fails it returns the *ErrorResponse error type.

func (*TenantAccessClient) GetEntityTag 

func (client *TenantAccessClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, accessName AccessIDName, options *TenantAccessGetEntityTagOptions) (TenantAccessGetEntityTagResponse, error)

GetEntityTag - Tenant access metadata If the operation fails it returns the *ErrorResponse error type.

func (*TenantAccessClient) ListByService 

func (client *TenantAccessClient) ListByService(resourceGroupName string, serviceName string, options *TenantAccessListByServiceOptions) *TenantAccessListByServicePager

ListByService - Returns list of access infos - for Git and Management endpoints. If the operation fails it returns the *ErrorResponse error type.

func (*TenantAccessClient) ListSecrets 

func (client *TenantAccessClient) ListSecrets(ctx context.Context, resourceGroupName string, serviceName string, accessName AccessIDName, options *TenantAccessListSecretsOptions) (TenantAccessListSecretsResponse, error)

ListSecrets - Get tenant access information details. If the operation fails it returns the *ErrorResponse error type.

func (*TenantAccessClient) RegeneratePrimaryKey 

func (client *TenantAccessClient) RegeneratePrimaryKey(ctx context.Context, resourceGroupName string, serviceName string, accessName AccessIDName, options *TenantAccessRegeneratePrimaryKeyOptions) (TenantAccessRegeneratePrimaryKeyResponse, error)

RegeneratePrimaryKey - Regenerate primary access key If the operation fails it returns the *ErrorResponse error type.

func (*TenantAccessClient) RegenerateSecondaryKey 

func (client *TenantAccessClient) RegenerateSecondaryKey(ctx context.Context, resourceGroupName string, serviceName string, accessName AccessIDName, options *TenantAccessRegenerateSecondaryKeyOptions) (TenantAccessRegenerateSecondaryKeyResponse, error)

RegenerateSecondaryKey - Regenerate secondary access key If the operation fails it returns the *ErrorResponse error type.

func (*TenantAccessClient) Update 

func (client *TenantAccessClient) Update(ctx context.Context, resourceGroupName string, serviceName string, accessName AccessIDName, ifMatch string, parameters AccessInformationUpdateParameters, options *TenantAccessUpdateOptions) (TenantAccessUpdateResponse, error)

Update - Update tenant access information details. If the operation fails it returns the *ErrorResponse error type.

type TenantAccessCreateOptions 

type TenantAccessCreateOptions struct {
}

TenantAccessCreateOptions contains the optional parameters for the TenantAccess.Create method.

type TenantAccessCreateResponse 

type TenantAccessCreateResponse struct {
	TenantAccessCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantAccessCreateResponse contains the response from method TenantAccess.Create.

type TenantAccessCreateResult 

type TenantAccessCreateResult struct {
	AccessInformationContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TenantAccessCreateResult contains the result from method TenantAccess.Create.

type TenantAccessGetEntityTagOptions 

type TenantAccessGetEntityTagOptions struct {
}

TenantAccessGetEntityTagOptions contains the optional parameters for the TenantAccess.GetEntityTag method.

type TenantAccessGetEntityTagResponse 

type TenantAccessGetEntityTagResponse struct {
	TenantAccessGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantAccessGetEntityTagResponse contains the response from method TenantAccess.GetEntityTag.

type TenantAccessGetEntityTagResult 

type TenantAccessGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

TenantAccessGetEntityTagResult contains the result from method TenantAccess.GetEntityTag.

type TenantAccessGetOptions 

type TenantAccessGetOptions struct {
}

TenantAccessGetOptions contains the optional parameters for the TenantAccess.Get method.

type TenantAccessGetResponse 

type TenantAccessGetResponse struct {
	TenantAccessGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantAccessGetResponse contains the response from method TenantAccess.Get.

type TenantAccessGetResult 

type TenantAccessGetResult struct {
	AccessInformationContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TenantAccessGetResult contains the result from method TenantAccess.Get.

type TenantAccessGitClient 

type TenantAccessGitClient struct {
	// contains filtered or unexported fields
}

TenantAccessGitClient contains the methods for the TenantAccessGit group. Don't use this type directly, use NewTenantAccessGitClient() instead.

func NewTenantAccessGitClient 

func NewTenantAccessGitClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *TenantAccessGitClient

NewTenantAccessGitClient creates a new instance of TenantAccessGitClient with the specified values.

func (*TenantAccessGitClient) RegeneratePrimaryKey 

func (client *TenantAccessGitClient) RegeneratePrimaryKey(ctx context.Context, resourceGroupName string, serviceName string, accessName AccessIDName, options *TenantAccessGitRegeneratePrimaryKeyOptions) (TenantAccessGitRegeneratePrimaryKeyResponse, error)

RegeneratePrimaryKey - Regenerate primary access key for GIT. If the operation fails it returns the *ErrorResponse error type.

func (*TenantAccessGitClient) RegenerateSecondaryKey 

func (client *TenantAccessGitClient) RegenerateSecondaryKey(ctx context.Context, resourceGroupName string, serviceName string, accessName AccessIDName, options *TenantAccessGitRegenerateSecondaryKeyOptions) (TenantAccessGitRegenerateSecondaryKeyResponse, error)

RegenerateSecondaryKey - Regenerate secondary access key for GIT. If the operation fails it returns the *ErrorResponse error type.

type TenantAccessGitRegeneratePrimaryKeyOptions 

type TenantAccessGitRegeneratePrimaryKeyOptions struct {
}

TenantAccessGitRegeneratePrimaryKeyOptions contains the optional parameters for the TenantAccessGit.RegeneratePrimaryKey method.

type TenantAccessGitRegeneratePrimaryKeyResponse 

type TenantAccessGitRegeneratePrimaryKeyResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantAccessGitRegeneratePrimaryKeyResponse contains the response from method TenantAccessGit.RegeneratePrimaryKey.

type TenantAccessGitRegenerateSecondaryKeyOptions 

type TenantAccessGitRegenerateSecondaryKeyOptions struct {
}

TenantAccessGitRegenerateSecondaryKeyOptions contains the optional parameters for the TenantAccessGit.RegenerateSecondaryKey method.

type TenantAccessGitRegenerateSecondaryKeyResponse 

type TenantAccessGitRegenerateSecondaryKeyResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantAccessGitRegenerateSecondaryKeyResponse contains the response from method TenantAccessGit.RegenerateSecondaryKey.

type TenantAccessListByServiceOptions 

type TenantAccessListByServiceOptions struct {
	// Not used
	Filter *string
}

TenantAccessListByServiceOptions contains the optional parameters for the TenantAccess.ListByService method.

type TenantAccessListByServicePager 

type TenantAccessListByServicePager struct {
	// contains filtered or unexported fields
}

TenantAccessListByServicePager provides operations for iterating over paged responses.

func (*TenantAccessListByServicePager) Err 

func (p *TenantAccessListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*TenantAccessListByServicePager) NextPage 

func (p *TenantAccessListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*TenantAccessListByServicePager) PageResponse 

func (p *TenantAccessListByServicePager) PageResponse() TenantAccessListByServiceResponse

PageResponse returns the current TenantAccessListByServiceResponse page.

type TenantAccessListByServiceResponse 

type TenantAccessListByServiceResponse struct {
	TenantAccessListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantAccessListByServiceResponse contains the response from method TenantAccess.ListByService.

type TenantAccessListByServiceResult 

type TenantAccessListByServiceResult struct {
	AccessInformationCollection
}

TenantAccessListByServiceResult contains the result from method TenantAccess.ListByService.

type TenantAccessListSecretsOptions 

type TenantAccessListSecretsOptions struct {
}

TenantAccessListSecretsOptions contains the optional parameters for the TenantAccess.ListSecrets method.

type TenantAccessListSecretsResponse 

type TenantAccessListSecretsResponse struct {
	TenantAccessListSecretsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantAccessListSecretsResponse contains the response from method TenantAccess.ListSecrets.

type TenantAccessListSecretsResult 

type TenantAccessListSecretsResult struct {
	AccessInformationSecretsContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TenantAccessListSecretsResult contains the result from method TenantAccess.ListSecrets.

type TenantAccessRegeneratePrimaryKeyOptions 

type TenantAccessRegeneratePrimaryKeyOptions struct {
}

TenantAccessRegeneratePrimaryKeyOptions contains the optional parameters for the TenantAccess.RegeneratePrimaryKey method.

type TenantAccessRegeneratePrimaryKeyResponse 

type TenantAccessRegeneratePrimaryKeyResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantAccessRegeneratePrimaryKeyResponse contains the response from method TenantAccess.RegeneratePrimaryKey.

type TenantAccessRegenerateSecondaryKeyOptions 

type TenantAccessRegenerateSecondaryKeyOptions struct {
}

TenantAccessRegenerateSecondaryKeyOptions contains the optional parameters for the TenantAccess.RegenerateSecondaryKey method.

type TenantAccessRegenerateSecondaryKeyResponse 

type TenantAccessRegenerateSecondaryKeyResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantAccessRegenerateSecondaryKeyResponse contains the response from method TenantAccess.RegenerateSecondaryKey.

type TenantAccessUpdateOptions 

type TenantAccessUpdateOptions struct {
}

TenantAccessUpdateOptions contains the optional parameters for the TenantAccess.Update method.

type TenantAccessUpdateResponse 

type TenantAccessUpdateResponse struct {
	TenantAccessUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantAccessUpdateResponse contains the response from method TenantAccess.Update.

type TenantAccessUpdateResult 

type TenantAccessUpdateResult struct {
	AccessInformationContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TenantAccessUpdateResult contains the result from method TenantAccess.Update.

type TenantConfigurationBeginDeployOptions 

type TenantConfigurationBeginDeployOptions struct {
}

TenantConfigurationBeginDeployOptions contains the optional parameters for the TenantConfiguration.BeginDeploy method.

type TenantConfigurationBeginSaveOptions 

type TenantConfigurationBeginSaveOptions struct {
}

TenantConfigurationBeginSaveOptions contains the optional parameters for the TenantConfiguration.BeginSave method.

type TenantConfigurationBeginValidateOptions 

type TenantConfigurationBeginValidateOptions struct {
}

TenantConfigurationBeginValidateOptions contains the optional parameters for the TenantConfiguration.BeginValidate method.

type TenantConfigurationClient 

type TenantConfigurationClient struct {
	// contains filtered or unexported fields
}

TenantConfigurationClient contains the methods for the TenantConfiguration group. Don't use this type directly, use NewTenantConfigurationClient() instead.

func NewTenantConfigurationClient 

func NewTenantConfigurationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *TenantConfigurationClient

NewTenantConfigurationClient creates a new instance of TenantConfigurationClient with the specified values.

func (*TenantConfigurationClient) BeginDeploy 

func (client *TenantConfigurationClient) BeginDeploy(ctx context.Context, resourceGroupName string, serviceName string, configurationName ConfigurationIDName, parameters DeployConfigurationParameters, options *TenantConfigurationBeginDeployOptions) (TenantConfigurationDeployPollerResponse, error)

BeginDeploy - This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete. If the operation fails it returns the *ErrorResponse error type.

func (*TenantConfigurationClient) BeginSave 

func (client *TenantConfigurationClient) BeginSave(ctx context.Context, resourceGroupName string, serviceName string, configurationName ConfigurationIDName, parameters SaveConfigurationParameter, options *TenantConfigurationBeginSaveOptions) (TenantConfigurationSavePollerResponse, error)

BeginSave - This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete. If the operation fails it returns the *ErrorResponse error type.

func (*TenantConfigurationClient) BeginValidate 

func (client *TenantConfigurationClient) BeginValidate(ctx context.Context, resourceGroupName string, serviceName string, configurationName ConfigurationIDName, parameters DeployConfigurationParameters, options *TenantConfigurationBeginValidateOptions) (TenantConfigurationValidatePollerResponse, error)

BeginValidate - This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete. If the operation fails it returns the *ErrorResponse error type.

func (*TenantConfigurationClient) GetSyncState 

func (client *TenantConfigurationClient) GetSyncState(ctx context.Context, resourceGroupName string, serviceName string, configurationName ConfigurationIDName, options *TenantConfigurationGetSyncStateOptions) (TenantConfigurationGetSyncStateResponse, error)

GetSyncState - Gets the status of the most recent synchronization between the configuration database and the Git repository. If the operation fails it returns the *ErrorResponse error type.

type TenantConfigurationDeployPoller 

type TenantConfigurationDeployPoller struct {
	// contains filtered or unexported fields
}

TenantConfigurationDeployPoller provides polling facilities until the operation reaches a terminal state.

func (*TenantConfigurationDeployPoller) Done 

func (p *TenantConfigurationDeployPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*TenantConfigurationDeployPoller) FinalResponse 

func (p *TenantConfigurationDeployPoller) FinalResponse(ctx context.Context) (TenantConfigurationDeployResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final TenantConfigurationDeployResponse will be returned.

func (*TenantConfigurationDeployPoller) Poll 

func (p *TenantConfigurationDeployPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*TenantConfigurationDeployPoller) ResumeToken 

func (p *TenantConfigurationDeployPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type TenantConfigurationDeployPollerResponse 

type TenantConfigurationDeployPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *TenantConfigurationDeployPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantConfigurationDeployPollerResponse contains the response from method TenantConfiguration.Deploy.

func (TenantConfigurationDeployPollerResponse) PollUntilDone 

func (l TenantConfigurationDeployPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (TenantConfigurationDeployResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*TenantConfigurationDeployPollerResponse) Resume 

func (l *TenantConfigurationDeployPollerResponse) Resume(ctx context.Context, client *TenantConfigurationClient, token string) error

Resume rehydrates a TenantConfigurationDeployPollerResponse from the provided client and resume token.

type TenantConfigurationDeployResponse 

type TenantConfigurationDeployResponse struct {
	TenantConfigurationDeployResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantConfigurationDeployResponse contains the response from method TenantConfiguration.Deploy.

type TenantConfigurationDeployResult 

type TenantConfigurationDeployResult struct {
	OperationResultContract
}

TenantConfigurationDeployResult contains the result from method TenantConfiguration.Deploy.

type TenantConfigurationGetSyncStateOptions 

type TenantConfigurationGetSyncStateOptions struct {
}

TenantConfigurationGetSyncStateOptions contains the optional parameters for the TenantConfiguration.GetSyncState method.

type TenantConfigurationGetSyncStateResponse 

type TenantConfigurationGetSyncStateResponse struct {
	TenantConfigurationGetSyncStateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantConfigurationGetSyncStateResponse contains the response from method TenantConfiguration.GetSyncState.

type TenantConfigurationGetSyncStateResult 

type TenantConfigurationGetSyncStateResult struct {
	TenantConfigurationSyncStateContract
}

TenantConfigurationGetSyncStateResult contains the result from method TenantConfiguration.GetSyncState.

type TenantConfigurationSavePoller 

type TenantConfigurationSavePoller struct {
	// contains filtered or unexported fields
}

TenantConfigurationSavePoller provides polling facilities until the operation reaches a terminal state.

func (*TenantConfigurationSavePoller) Done 

func (p *TenantConfigurationSavePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*TenantConfigurationSavePoller) FinalResponse 

func (p *TenantConfigurationSavePoller) FinalResponse(ctx context.Context) (TenantConfigurationSaveResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final TenantConfigurationSaveResponse will be returned.

func (*TenantConfigurationSavePoller) Poll 

func (p *TenantConfigurationSavePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*TenantConfigurationSavePoller) ResumeToken 

func (p *TenantConfigurationSavePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type TenantConfigurationSavePollerResponse 

type TenantConfigurationSavePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *TenantConfigurationSavePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantConfigurationSavePollerResponse contains the response from method TenantConfiguration.Save.

func (TenantConfigurationSavePollerResponse) PollUntilDone 

func (l TenantConfigurationSavePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (TenantConfigurationSaveResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*TenantConfigurationSavePollerResponse) Resume 

func (l *TenantConfigurationSavePollerResponse) Resume(ctx context.Context, client *TenantConfigurationClient, token string) error

Resume rehydrates a TenantConfigurationSavePollerResponse from the provided client and resume token.

type TenantConfigurationSaveResponse 

type TenantConfigurationSaveResponse struct {
	TenantConfigurationSaveResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantConfigurationSaveResponse contains the response from method TenantConfiguration.Save.

type TenantConfigurationSaveResult 

type TenantConfigurationSaveResult struct {
	OperationResultContract
}

TenantConfigurationSaveResult contains the result from method TenantConfiguration.Save.

type TenantConfigurationSyncStateContract 

type TenantConfigurationSyncStateContract struct {
	Resource
	// Properties returned Tenant Configuration Sync State check.
	Properties *TenantConfigurationSyncStateContractProperties `json:"properties,omitempty"`
}

TenantConfigurationSyncStateContract - Result of Tenant Configuration Sync State.

func (TenantConfigurationSyncStateContract) MarshalJSON 

func (t TenantConfigurationSyncStateContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TenantConfigurationSyncStateContract.

type TenantConfigurationSyncStateContractProperties 

type TenantConfigurationSyncStateContractProperties struct {
	// The name of Git branch.
	Branch *string `json:"branch,omitempty"`

	// The latest commit Id.
	CommitID *string `json:"commitId,omitempty"`

	// The date of the latest configuration change. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	ConfigurationChangeDate *time.Time `json:"configurationChangeDate,omitempty"`

	// value indicating if last sync was save (true) or deploy (false) operation.
	IsExport *bool `json:"isExport,omitempty"`

	// value indicating whether Git configuration access is enabled.
	IsGitEnabled *bool `json:"isGitEnabled,omitempty"`

	// value indicating if last synchronization was later than the configuration change.
	IsSynced *bool `json:"isSynced,omitempty"`

	// Most recent tenant configuration operation identifier
	LastOperationID *string `json:"lastOperationId,omitempty"`

	// The date of the latest synchronization. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	SyncDate *time.Time `json:"syncDate,omitempty"`
}

TenantConfigurationSyncStateContractProperties - Tenant Configuration Synchronization State.

func (TenantConfigurationSyncStateContractProperties) MarshalJSON 

func (t TenantConfigurationSyncStateContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TenantConfigurationSyncStateContractProperties.

func (*TenantConfigurationSyncStateContractProperties) UnmarshalJSON 

func (t *TenantConfigurationSyncStateContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TenantConfigurationSyncStateContractProperties.

type TenantConfigurationValidatePoller 

type TenantConfigurationValidatePoller struct {
	// contains filtered or unexported fields
}

TenantConfigurationValidatePoller provides polling facilities until the operation reaches a terminal state.

func (*TenantConfigurationValidatePoller) Done 

func (p *TenantConfigurationValidatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*TenantConfigurationValidatePoller) FinalResponse 

func (p *TenantConfigurationValidatePoller) FinalResponse(ctx context.Context) (TenantConfigurationValidateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final TenantConfigurationValidateResponse will be returned.

func (*TenantConfigurationValidatePoller) Poll 

func (p *TenantConfigurationValidatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*TenantConfigurationValidatePoller) ResumeToken 

func (p *TenantConfigurationValidatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type TenantConfigurationValidatePollerResponse 

type TenantConfigurationValidatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *TenantConfigurationValidatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantConfigurationValidatePollerResponse contains the response from method TenantConfiguration.Validate.

func (TenantConfigurationValidatePollerResponse) PollUntilDone 

func (l TenantConfigurationValidatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (TenantConfigurationValidateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*TenantConfigurationValidatePollerResponse) Resume 

func (l *TenantConfigurationValidatePollerResponse) Resume(ctx context.Context, client *TenantConfigurationClient, token string) error

Resume rehydrates a TenantConfigurationValidatePollerResponse from the provided client and resume token.

type TenantConfigurationValidateResponse 

type TenantConfigurationValidateResponse struct {
	TenantConfigurationValidateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantConfigurationValidateResponse contains the response from method TenantConfiguration.Validate.

type TenantConfigurationValidateResult 

type TenantConfigurationValidateResult struct {
	OperationResultContract
}

TenantConfigurationValidateResult contains the result from method TenantConfiguration.Validate.

type TenantSettingsClient 

type TenantSettingsClient struct {
	// contains filtered or unexported fields
}

TenantSettingsClient contains the methods for the TenantSettings group. Don't use this type directly, use NewTenantSettingsClient() instead.

func NewTenantSettingsClient 

func NewTenantSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *TenantSettingsClient

NewTenantSettingsClient creates a new instance of TenantSettingsClient with the specified values.

func (*TenantSettingsClient) Get 

func (client *TenantSettingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, settingsType SettingsTypeName, options *TenantSettingsGetOptions) (TenantSettingsGetResponse, error)

Get - Get tenant settings. If the operation fails it returns the *ErrorResponse error type.

func (*TenantSettingsClient) ListByService 

func (client *TenantSettingsClient) ListByService(resourceGroupName string, serviceName string, options *TenantSettingsListByServiceOptions) *TenantSettingsListByServicePager

ListByService - Public settings. If the operation fails it returns the *ErrorResponse error type.

type TenantSettingsCollection 

type TenantSettingsCollection struct {
	// READ-ONLY; Next page link if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; Page values.
	Value []*TenantSettingsContract `json:"value,omitempty" azure:"ro"`
}

TenantSettingsCollection - Paged AccessInformation list representation.

func (TenantSettingsCollection) MarshalJSON 

func (t TenantSettingsCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TenantSettingsCollection.

type TenantSettingsContract 

type TenantSettingsContract struct {
	Resource
	// TenantSettings entity contract properties.
	Properties *TenantSettingsContractProperties `json:"properties,omitempty"`
}

TenantSettingsContract - Tenant Settings.

func (TenantSettingsContract) MarshalJSON 

func (t TenantSettingsContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TenantSettingsContract.

type TenantSettingsContractProperties 

type TenantSettingsContractProperties struct {
	// Tenant settings
	Settings map[string]*string `json:"settings,omitempty"`
}

TenantSettingsContractProperties - Tenant access information contract of the API Management service.

func (TenantSettingsContractProperties) MarshalJSON 

func (t TenantSettingsContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TenantSettingsContractProperties.

type TenantSettingsGetOptions 

type TenantSettingsGetOptions struct {
}

TenantSettingsGetOptions contains the optional parameters for the TenantSettings.Get method.

type TenantSettingsGetResponse 

type TenantSettingsGetResponse struct {
	TenantSettingsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantSettingsGetResponse contains the response from method TenantSettings.Get.

type TenantSettingsGetResult 

type TenantSettingsGetResult struct {
	TenantSettingsContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

TenantSettingsGetResult contains the result from method TenantSettings.Get.

type TenantSettingsListByServiceOptions 

type TenantSettingsListByServiceOptions struct {
	// Not used
	Filter *string
}

TenantSettingsListByServiceOptions contains the optional parameters for the TenantSettings.ListByService method.

type TenantSettingsListByServicePager 

type TenantSettingsListByServicePager struct {
	// contains filtered or unexported fields
}

TenantSettingsListByServicePager provides operations for iterating over paged responses.

func (*TenantSettingsListByServicePager) Err 

func (p *TenantSettingsListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*TenantSettingsListByServicePager) NextPage 

func (p *TenantSettingsListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*TenantSettingsListByServicePager) PageResponse 

func (p *TenantSettingsListByServicePager) PageResponse() TenantSettingsListByServiceResponse

PageResponse returns the current TenantSettingsListByServiceResponse page.

type TenantSettingsListByServiceResponse 

type TenantSettingsListByServiceResponse struct {
	TenantSettingsListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

TenantSettingsListByServiceResponse contains the response from method TenantSettings.ListByService.

type TenantSettingsListByServiceResult 

type TenantSettingsListByServiceResult struct {
	TenantSettingsCollection
}

TenantSettingsListByServiceResult contains the result from method TenantSettings.ListByService.

type TermsOfServiceProperties 

type TermsOfServiceProperties struct {
	// Ask user for consent to the terms of service.
	ConsentRequired *bool `json:"consentRequired,omitempty"`

	// Display terms of service during a sign-up process.
	Enabled *bool `json:"enabled,omitempty"`

	// A terms of service text.
	Text *string `json:"text,omitempty"`
}

TermsOfServiceProperties - Terms of service contract properties.

type TokenBodyParameterContract 

type TokenBodyParameterContract struct {
	// REQUIRED; body parameter name.
	Name *string `json:"name,omitempty"`

	// REQUIRED; body parameter value.
	Value *string `json:"value,omitempty"`
}

TokenBodyParameterContract - OAuth acquire token request body parameter (www-url-form-encoded).

type UserClient 

type UserClient struct {
	// contains filtered or unexported fields
}

UserClient contains the methods for the User group. Don't use this type directly, use NewUserClient() instead.

func NewUserClient 

func NewUserClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *UserClient

NewUserClient creates a new instance of UserClient with the specified values.

func (*UserClient) CreateOrUpdate 

func (client *UserClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, userID string, parameters UserCreateParameters, options *UserCreateOrUpdateOptions) (UserCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or Updates a user. If the operation fails it returns the *ErrorResponse error type.

func (*UserClient) Delete 

func (client *UserClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, userID string, ifMatch string, options *UserDeleteOptions) (UserDeleteResponse, error)

Delete - Deletes specific user. If the operation fails it returns the *ErrorResponse error type.

func (*UserClient) GenerateSsoURL 

func (client *UserClient) GenerateSsoURL(ctx context.Context, resourceGroupName string, serviceName string, userID string, options *UserGenerateSsoURLOptions) (UserGenerateSsoURLResponse, error)

GenerateSsoURL - Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal. If the operation fails it returns the *ErrorResponse error type.

func (*UserClient) Get 

func (client *UserClient) Get(ctx context.Context, resourceGroupName string, serviceName string, userID string, options *UserGetOptions) (UserGetResponse, error)

Get - Gets the details of the user specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*UserClient) GetEntityTag 

func (client *UserClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, userID string, options *UserGetEntityTagOptions) (UserGetEntityTagResponse, error)

GetEntityTag - Gets the entity state (Etag) version of the user specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

func (*UserClient) GetSharedAccessToken 

func (client *UserClient) GetSharedAccessToken(ctx context.Context, resourceGroupName string, serviceName string, userID string, parameters UserTokenParameters, options *UserGetSharedAccessTokenOptions) (UserGetSharedAccessTokenResponse, error)

GetSharedAccessToken - Gets the Shared Access Authorization Token for the User. If the operation fails it returns the *ErrorResponse error type.

func (*UserClient) ListByService 

func (client *UserClient) ListByService(resourceGroupName string, serviceName string, options *UserListByServiceOptions) *UserListByServicePager

ListByService - Lists a collection of registered users in the specified service instance. If the operation fails it returns the *ErrorResponse error type.

func (*UserClient) Update 

func (client *UserClient) Update(ctx context.Context, resourceGroupName string, serviceName string, userID string, ifMatch string, parameters UserUpdateParameters, options *UserUpdateOptions) (UserUpdateResponse, error)

Update - Updates the details of the user specified by its identifier. If the operation fails it returns the *ErrorResponse error type.

type UserCollection 

type UserCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// Page values.
	Value []*UserContract `json:"value,omitempty"`
}

UserCollection - Paged Users list representation.

func (UserCollection) MarshalJSON 

func (u UserCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserCollection.

type UserConfirmationPasswordClient 

type UserConfirmationPasswordClient struct {
	// contains filtered or unexported fields
}

UserConfirmationPasswordClient contains the methods for the UserConfirmationPassword group. Don't use this type directly, use NewUserConfirmationPasswordClient() instead.

func NewUserConfirmationPasswordClient 

func NewUserConfirmationPasswordClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *UserConfirmationPasswordClient

NewUserConfirmationPasswordClient creates a new instance of UserConfirmationPasswordClient with the specified values.

func (*UserConfirmationPasswordClient) Send 

func (client *UserConfirmationPasswordClient) Send(ctx context.Context, resourceGroupName string, serviceName string, userID string, options *UserConfirmationPasswordSendOptions) (UserConfirmationPasswordSendResponse, error)

Send - Sends confirmation If the operation fails it returns the *ErrorResponse error type.

type UserConfirmationPasswordSendOptions 

type UserConfirmationPasswordSendOptions struct {
	// Determines the type of application which send the create user request. Default is legacy publisher portal.
	AppType *AppType
}

UserConfirmationPasswordSendOptions contains the optional parameters for the UserConfirmationPassword.Send method.

type UserConfirmationPasswordSendResponse 

type UserConfirmationPasswordSendResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserConfirmationPasswordSendResponse contains the response from method UserConfirmationPassword.Send.

type UserContract 

type UserContract struct {
	Resource
	// User entity contract properties.
	Properties *UserContractProperties `json:"properties,omitempty"`
}

UserContract - User details.

func (UserContract) MarshalJSON 

func (u UserContract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserContract.

type UserContractProperties 

type UserContractProperties struct {
	UserEntityBaseParameters
	// Email address.
	Email *string `json:"email,omitempty"`

	// First name.
	FirstName *string `json:"firstName,omitempty"`

	// Last name.
	LastName *string `json:"lastName,omitempty"`

	// Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	RegistrationDate *time.Time `json:"registrationDate,omitempty"`

	// READ-ONLY; Collection of groups user is part of.
	Groups []*GroupContractProperties `json:"groups,omitempty" azure:"ro"`
}

UserContractProperties - User profile.

func (UserContractProperties) MarshalJSON 

func (u UserContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserContractProperties.

func (*UserContractProperties) UnmarshalJSON 

func (u *UserContractProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserContractProperties.

type UserCreateOrUpdateOptions 

type UserCreateOrUpdateOptions struct {
	// ETag of the Entity. Not required when creating an entity, but required when updating an entity.
	IfMatch *string
	// Send an Email notification to the User.
	Notify *bool
}

UserCreateOrUpdateOptions contains the optional parameters for the User.CreateOrUpdate method.

type UserCreateOrUpdateResponse 

type UserCreateOrUpdateResponse struct {
	UserCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserCreateOrUpdateResponse contains the response from method User.CreateOrUpdate.

type UserCreateOrUpdateResult 

type UserCreateOrUpdateResult struct {
	UserContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

UserCreateOrUpdateResult contains the result from method User.CreateOrUpdate.

type UserCreateParameterProperties 

type UserCreateParameterProperties struct {
	UserEntityBaseParameters
	// REQUIRED; Email address. Must not be empty and must be unique within the service instance.
	Email *string `json:"email,omitempty"`

	// REQUIRED; First name.
	FirstName *string `json:"firstName,omitempty"`

	// REQUIRED; Last name.
	LastName *string `json:"lastName,omitempty"`

	// Determines the type of application which send the create user request. Default is legacy portal.
	AppType *AppType `json:"appType,omitempty"`

	// Determines the type of confirmation e-mail that will be sent to the newly created user.
	Confirmation *Confirmation `json:"confirmation,omitempty"`

	// User Password. If no value is provided, a default password is generated.
	Password *string `json:"password,omitempty"`
}

UserCreateParameterProperties - Parameters supplied to the Create User operation.

func (UserCreateParameterProperties) MarshalJSON 

func (u UserCreateParameterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserCreateParameterProperties.

func (*UserCreateParameterProperties) UnmarshalJSON 

func (u *UserCreateParameterProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserCreateParameterProperties.

type UserCreateParameters 

type UserCreateParameters struct {
	// User entity create contract properties.
	Properties *UserCreateParameterProperties `json:"properties,omitempty"`
}

UserCreateParameters - User create details.

type UserDeleteOptions 

type UserDeleteOptions struct {
	// Determines the type of application which send the create user request. Default is legacy publisher portal.
	AppType *AppType
	// Whether to delete user's subscription or not.
	DeleteSubscriptions *bool
	// Send an Account Closed Email notification to the User.
	Notify *bool
}

UserDeleteOptions contains the optional parameters for the User.Delete method.

type UserDeleteResponse 

type UserDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserDeleteResponse contains the response from method User.Delete.

type UserEntityBaseParameters 

type UserEntityBaseParameters struct {
	// Collection of user identities.
	Identities []*UserIdentityContract `json:"identities,omitempty"`

	// Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`

	// Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed
	// products. Default state is Active.
	State *UserState `json:"state,omitempty"`
}

UserEntityBaseParameters - User Entity Base Parameters set.

func (UserEntityBaseParameters) MarshalJSON 

func (u UserEntityBaseParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserEntityBaseParameters.

func (*UserEntityBaseParameters) UnmarshalJSON 

func (u *UserEntityBaseParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserEntityBaseParameters.

type UserGenerateSsoURLOptions 

type UserGenerateSsoURLOptions struct {
}

UserGenerateSsoURLOptions contains the optional parameters for the User.GenerateSsoURL method.

type UserGenerateSsoURLResponse 

type UserGenerateSsoURLResponse struct {
	UserGenerateSsoURLResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserGenerateSsoURLResponse contains the response from method User.GenerateSsoURL.

type UserGenerateSsoURLResult 

type UserGenerateSsoURLResult struct {
	GenerateSsoURLResult
}

UserGenerateSsoURLResult contains the result from method User.GenerateSsoURL.

type UserGetEntityTagOptions 

type UserGetEntityTagOptions struct {
}

UserGetEntityTagOptions contains the optional parameters for the User.GetEntityTag method.

type UserGetEntityTagResponse 

type UserGetEntityTagResponse struct {
	UserGetEntityTagResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserGetEntityTagResponse contains the response from method User.GetEntityTag.

type UserGetEntityTagResult 

type UserGetEntityTagResult struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Success indicates if the operation succeeded or failed.
	Success bool
}

UserGetEntityTagResult contains the result from method User.GetEntityTag.

type UserGetOptions 

type UserGetOptions struct {
}

UserGetOptions contains the optional parameters for the User.Get method.

type UserGetResponse 

type UserGetResponse struct {
	UserGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserGetResponse contains the response from method User.Get.

type UserGetResult 

type UserGetResult struct {
	UserContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

UserGetResult contains the result from method User.Get.

type UserGetSharedAccessTokenOptions 

type UserGetSharedAccessTokenOptions struct {
}

UserGetSharedAccessTokenOptions contains the optional parameters for the User.GetSharedAccessToken method.

type UserGetSharedAccessTokenResponse 

type UserGetSharedAccessTokenResponse struct {
	UserGetSharedAccessTokenResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserGetSharedAccessTokenResponse contains the response from method User.GetSharedAccessToken.

type UserGetSharedAccessTokenResult 

type UserGetSharedAccessTokenResult struct {
	UserTokenResult
}

UserGetSharedAccessTokenResult contains the result from method User.GetSharedAccessToken.

type UserGroupClient 

type UserGroupClient struct {
	// contains filtered or unexported fields
}

UserGroupClient contains the methods for the UserGroup group. Don't use this type directly, use NewUserGroupClient() instead.

func NewUserGroupClient 

func NewUserGroupClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *UserGroupClient

NewUserGroupClient creates a new instance of UserGroupClient with the specified values.

func (*UserGroupClient) List 

func (client *UserGroupClient) List(resourceGroupName string, serviceName string, userID string, options *UserGroupListOptions) *UserGroupListPager

List - Lists all user groups. If the operation fails it returns the *ErrorResponse error type.

type UserGroupListOptions 

type UserGroupListOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|------------------------|-----------------------------------|</br>|
	// name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof,
	// contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

UserGroupListOptions contains the optional parameters for the UserGroup.List method.

type UserGroupListPager 

type UserGroupListPager struct {
	// contains filtered or unexported fields
}

UserGroupListPager provides operations for iterating over paged responses.

func (*UserGroupListPager) Err 

func (p *UserGroupListPager) Err() error

Err returns the last error encountered while paging.

func (*UserGroupListPager) NextPage 

func (p *UserGroupListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*UserGroupListPager) PageResponse 

func (p *UserGroupListPager) PageResponse() UserGroupListResponse

PageResponse returns the current UserGroupListResponse page.

type UserGroupListResponse 

type UserGroupListResponse struct {
	UserGroupListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserGroupListResponse contains the response from method UserGroup.List.

type UserGroupListResult 

type UserGroupListResult struct {
	GroupCollection
}

UserGroupListResult contains the result from method UserGroup.List.

type UserIdentitiesClient 

type UserIdentitiesClient struct {
	// contains filtered or unexported fields
}

UserIdentitiesClient contains the methods for the UserIdentities group. Don't use this type directly, use NewUserIdentitiesClient() instead.

func NewUserIdentitiesClient 

func NewUserIdentitiesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *UserIdentitiesClient

NewUserIdentitiesClient creates a new instance of UserIdentitiesClient with the specified values.

func (*UserIdentitiesClient) List 

func (client *UserIdentitiesClient) List(resourceGroupName string, serviceName string, userID string, options *UserIdentitiesListOptions) *UserIdentitiesListPager

List - List of all user identities. If the operation fails it returns the *ErrorResponse error type.

type UserIdentitiesListOptions 

type UserIdentitiesListOptions struct {
}

UserIdentitiesListOptions contains the optional parameters for the UserIdentities.List method.

type UserIdentitiesListPager 

type UserIdentitiesListPager struct {
	// contains filtered or unexported fields
}

UserIdentitiesListPager provides operations for iterating over paged responses.

func (*UserIdentitiesListPager) Err 

func (p *UserIdentitiesListPager) Err() error

Err returns the last error encountered while paging.

func (*UserIdentitiesListPager) NextPage 

func (p *UserIdentitiesListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*UserIdentitiesListPager) PageResponse 

func (p *UserIdentitiesListPager) PageResponse() UserIdentitiesListResponse

PageResponse returns the current UserIdentitiesListResponse page.

type UserIdentitiesListResponse 

type UserIdentitiesListResponse struct {
	UserIdentitiesListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserIdentitiesListResponse contains the response from method UserIdentities.List.

type UserIdentitiesListResult 

type UserIdentitiesListResult struct {
	UserIdentityCollection
}

UserIdentitiesListResult contains the result from method UserIdentities.List.

type UserIdentityCollection 

type UserIdentityCollection struct {
	// Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`

	// Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`

	// User Identity values.
	Value []*UserIdentityContract `json:"value,omitempty"`
}

UserIdentityCollection - List of Users Identity list representation.

func (UserIdentityCollection) MarshalJSON 

func (u UserIdentityCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserIdentityCollection.

type UserIdentityContract 

type UserIdentityContract struct {
	// Identifier value within provider.
	ID *string `json:"id,omitempty"`

	// Identity provider name.
	Provider *string `json:"provider,omitempty"`
}

UserIdentityContract - User identity details.

type UserIdentityProperties 

type UserIdentityProperties struct {
	// The client id of user assigned identity.
	ClientID *string `json:"clientId,omitempty"`

	// The principal id of user assigned identity.
	PrincipalID *string `json:"principalId,omitempty"`
}

type UserListByServiceOptions 

type UserListByServiceOptions struct {
	// Detailed Group in response.
	ExpandGroups *bool
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| email | filter | ge, le, eq, ne, gt,
	// lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | |</br>| registrationDate | filter | ge, le, eq, ne, gt, lt | |</br>| note
	// | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| groups | expand | | |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

UserListByServiceOptions contains the optional parameters for the User.ListByService method.

type UserListByServicePager 

type UserListByServicePager struct {
	// contains filtered or unexported fields
}

UserListByServicePager provides operations for iterating over paged responses.

func (*UserListByServicePager) Err 

func (p *UserListByServicePager) Err() error

Err returns the last error encountered while paging.

func (*UserListByServicePager) NextPage 

func (p *UserListByServicePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*UserListByServicePager) PageResponse 

func (p *UserListByServicePager) PageResponse() UserListByServiceResponse

PageResponse returns the current UserListByServiceResponse page.

type UserListByServiceResponse 

type UserListByServiceResponse struct {
	UserListByServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserListByServiceResponse contains the response from method User.ListByService.

type UserListByServiceResult 

type UserListByServiceResult struct {
	UserCollection
}

UserListByServiceResult contains the result from method User.ListByService.

type UserState 

type UserState string

UserState - Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. 

const (
	// UserStateActive - User state is active.
	UserStateActive UserState = "active"
	// UserStateBlocked - User is blocked. Blocked users cannot authenticate at developer portal or call API.
	UserStateBlocked UserState = "blocked"
	// UserStateDeleted - User account is closed. All identities and related entities are removed.
	UserStateDeleted UserState = "deleted"
	// UserStatePending - User account is pending. Requires identity confirmation before it can be made active.
	UserStatePending UserState = "pending"
)

func PossibleUserStateValues 

func PossibleUserStateValues() []UserState

PossibleUserStateValues returns the possible values for the UserState const type.

func (UserState) ToPtr 

func (c UserState) ToPtr() *UserState

ToPtr returns a *UserState pointing to the current value.

type UserSubscriptionClient 

type UserSubscriptionClient struct {
	// contains filtered or unexported fields
}

UserSubscriptionClient contains the methods for the UserSubscription group. Don't use this type directly, use NewUserSubscriptionClient() instead.

func NewUserSubscriptionClient 

func NewUserSubscriptionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *UserSubscriptionClient

NewUserSubscriptionClient creates a new instance of UserSubscriptionClient with the specified values.

func (*UserSubscriptionClient) Get 

func (client *UserSubscriptionClient) Get(ctx context.Context, resourceGroupName string, serviceName string, userID string, sid string, options *UserSubscriptionGetOptions) (UserSubscriptionGetResponse, error)

Get - Gets the specified Subscription entity associated with a particular user. If the operation fails it returns the *ErrorResponse error type.

func (*UserSubscriptionClient) List 

func (client *UserSubscriptionClient) List(resourceGroupName string, serviceName string, userID string, options *UserSubscriptionListOptions) *UserSubscriptionListPager

List - Lists the collection of subscriptions of the specified user. If the operation fails it returns the *ErrorResponse error type.

type UserSubscriptionGetOptions 

type UserSubscriptionGetOptions struct {
}

UserSubscriptionGetOptions contains the optional parameters for the UserSubscription.Get method.

type UserSubscriptionGetResponse 

type UserSubscriptionGetResponse struct {
	UserSubscriptionGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserSubscriptionGetResponse contains the response from method UserSubscription.Get.

type UserSubscriptionGetResult 

type UserSubscriptionGetResult struct {
	SubscriptionContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

UserSubscriptionGetResult contains the result from method UserSubscription.Get.

type UserSubscriptionListOptions 

type UserSubscriptionListOptions struct {
	// | Field | Usage | Supported operators | Supported functions |</br>|-------------|------------------------|-----------------------------------|</br>|name
	// | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains,
	// startswith, endswith |</br>|stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|ownerId | filter | ge,
	// le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith,
	// endswith |</br>|userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|productId | filter | ge, le, eq, ne, gt,
	// lt | substringof, contains, startswith, endswith |</br>
	Filter *string
	// Number of records to skip.
	Skip *int32
	// Number of records to return.
	Top *int32
}

UserSubscriptionListOptions contains the optional parameters for the UserSubscription.List method.

type UserSubscriptionListPager 

type UserSubscriptionListPager struct {
	// contains filtered or unexported fields
}

UserSubscriptionListPager provides operations for iterating over paged responses.

func (*UserSubscriptionListPager) Err 

func (p *UserSubscriptionListPager) Err() error

Err returns the last error encountered while paging.

func (*UserSubscriptionListPager) NextPage 

func (p *UserSubscriptionListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*UserSubscriptionListPager) PageResponse 

func (p *UserSubscriptionListPager) PageResponse() UserSubscriptionListResponse

PageResponse returns the current UserSubscriptionListResponse page.

type UserSubscriptionListResponse 

type UserSubscriptionListResponse struct {
	UserSubscriptionListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserSubscriptionListResponse contains the response from method UserSubscription.List.

type UserSubscriptionListResult 

type UserSubscriptionListResult struct {
	SubscriptionCollection
}

UserSubscriptionListResult contains the result from method UserSubscription.List.

type UserTokenParameterProperties 

type UserTokenParameterProperties struct {
	// REQUIRED; The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ
	// as specified by the ISO 8601 standard.
	Expiry *time.Time `json:"expiry,omitempty"`

	// REQUIRED; The Key to be used to generate token for user.
	KeyType *KeyType `json:"keyType,omitempty"`
}

UserTokenParameterProperties - Parameters supplied to the Get User Token operation.

func (UserTokenParameterProperties) MarshalJSON 

func (u UserTokenParameterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserTokenParameterProperties.

func (*UserTokenParameterProperties) UnmarshalJSON 

func (u *UserTokenParameterProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserTokenParameterProperties.

type UserTokenParameters 

type UserTokenParameters struct {
	// User Token Parameter contract properties.
	Properties *UserTokenParameterProperties `json:"properties,omitempty"`
}

UserTokenParameters - Get User Token parameters.

type UserTokenResult 

type UserTokenResult struct {
	// Shared Access Authorization token for the User.
	Value *string `json:"value,omitempty"`
}

UserTokenResult - Get User Token response details.

type UserUpdateOptions 

type UserUpdateOptions struct {
}

UserUpdateOptions contains the optional parameters for the User.Update method.

type UserUpdateParameters 

type UserUpdateParameters struct {
	// User entity update contract properties.
	Properties *UserUpdateParametersProperties `json:"properties,omitempty"`
}

UserUpdateParameters - User update parameters.

func (UserUpdateParameters) MarshalJSON 

func (u UserUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserUpdateParameters.

type UserUpdateParametersProperties 

type UserUpdateParametersProperties struct {
	UserEntityBaseParameters
	// Email address. Must not be empty and must be unique within the service instance.
	Email *string `json:"email,omitempty"`

	// First name.
	FirstName *string `json:"firstName,omitempty"`

	// Last name.
	LastName *string `json:"lastName,omitempty"`

	// User Password.
	Password *string `json:"password,omitempty"`
}

UserUpdateParametersProperties - Parameters supplied to the Update User operation.

func (UserUpdateParametersProperties) MarshalJSON 

func (u UserUpdateParametersProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserUpdateParametersProperties.

func (*UserUpdateParametersProperties) UnmarshalJSON 

func (u *UserUpdateParametersProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserUpdateParametersProperties.

type UserUpdateResponse 

type UserUpdateResponse struct {
	UserUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UserUpdateResponse contains the response from method User.Update.

type UserUpdateResult 

type UserUpdateResult struct {
	UserContract
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

UserUpdateResult contains the result from method User.Update.

type Verbosity 

type Verbosity string

Verbosity - The verbosity level applied to traces emitted by trace policies. 

const (
	// VerbosityError - Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.
	VerbosityError Verbosity = "error"
	// VerbosityInformation - Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.
	VerbosityInformation Verbosity = "information"
	// VerbosityVerbose - All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.
	VerbosityVerbose Verbosity = "verbose"
)

func PossibleVerbosityValues 

func PossibleVerbosityValues() []Verbosity

PossibleVerbosityValues returns the possible values for the Verbosity const type.

func (Verbosity) ToPtr 

func (c Verbosity) ToPtr() *Verbosity

ToPtr returns a *Verbosity pointing to the current value.

type VersioningScheme 

type VersioningScheme string

VersioningScheme - An value that determines where the API Version identifier will be located in a HTTP request. 

const (
	// VersioningSchemeHeader - The API Version is passed in a HTTP header.
	VersioningSchemeHeader VersioningScheme = "Header"
	// VersioningSchemeQuery - The API Version is passed in a query parameter.
	VersioningSchemeQuery VersioningScheme = "Query"
	// VersioningSchemeSegment - The API Version is passed in a path segment.
	VersioningSchemeSegment VersioningScheme = "Segment"
)

func PossibleVersioningSchemeValues 

func PossibleVersioningSchemeValues() []VersioningScheme

PossibleVersioningSchemeValues returns the possible values for the VersioningScheme const type.

func (VersioningScheme) ToPtr 

func (c VersioningScheme) ToPtr() *VersioningScheme

ToPtr returns a *VersioningScheme pointing to the current value.

type VirtualNetworkConfiguration 

type VirtualNetworkConfiguration struct {
	// The full resource ID of a subnet in a virtual network to deploy the API Management service in.
	SubnetResourceID *string `json:"subnetResourceId,omitempty"`

	// READ-ONLY; The name of the subnet.
	Subnetname *string `json:"subnetname,omitempty" azure:"ro"`

	// READ-ONLY; The virtual network ID. This is typically a GUID. Expect a null GUID by default.
	Vnetid *string `json:"vnetid,omitempty" azure:"ro"`
}

VirtualNetworkConfiguration - Configuration of a virtual network to which API Management service is deployed.

type VirtualNetworkType 

type VirtualNetworkType string

VirtualNetworkType - The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. 

const (
	// VirtualNetworkTypeExternal - The service is part of Virtual Network and it is accessible from Internet.
	VirtualNetworkTypeExternal VirtualNetworkType = "External"
	// VirtualNetworkTypeInternal - The service is part of Virtual Network and it is only accessible from within the virtual network.
	VirtualNetworkTypeInternal VirtualNetworkType = "Internal"
	// VirtualNetworkTypeNone - The service is not part of any Virtual Network.
	VirtualNetworkTypeNone VirtualNetworkType = "None"
)

func PossibleVirtualNetworkTypeValues 

func PossibleVirtualNetworkTypeValues() []VirtualNetworkType

PossibleVirtualNetworkTypeValues returns the possible values for the VirtualNetworkType const type.

func (VirtualNetworkType) ToPtr 

func (c VirtualNetworkType) ToPtr() *VirtualNetworkType

ToPtr returns a *VirtualNetworkType pointing to the current value.

type X509CertificateName 

type X509CertificateName struct {
	// Thumbprint for the Issuer of the Certificate.
	IssuerCertificateThumbprint *string `json:"issuerCertificateThumbprint,omitempty"`

	// Common Name of the Certificate.
	Name *string `json:"name,omitempty"`
}

X509CertificateName - Properties of server X509Names.

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.