apimanagement

package
v15.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package apimanagement implements the Azure ARM Apimanagement service API version 2017-03-01.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type APIClient 

type APIClient struct {
	BaseClient
}

APIClient is the client for the API methods of the Apimanagement service.

func NewAPIClient 

func NewAPIClient() APIClient

NewAPIClient creates an instance of the APIClient client.

func (APIClient) CreateOrUpdate 

func (client APIClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, apiid string, parameters APICreateOrUpdateParameter, ifMatch string) (result APIContract, err error)

CreateOrUpdate creates new or updates existing specified API of the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. parameters is create or update parameters. ifMatch is eTag of the Api Entity. For Create Api Etag should not be specified. For Update Etag should match the existing Entity or it can be * for unconditional update.

func (APIClient) CreateOrUpdatePreparer 

func (client APIClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, apiid string, parameters APICreateOrUpdateParameter, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIClient) CreateOrUpdateResponder 

func (client APIClient) CreateOrUpdateResponder(resp *http.Response) (result APIContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (APIClient) CreateOrUpdateSender 

func (client APIClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (APIClient) Delete 

func (client APIClient) Delete(ctx context.Context, apimBaseURL string, apiid string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified API of the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. ifMatch is eTag of the API Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIClient) DeletePreparer 

func (client APIClient) DeletePreparer(ctx context.Context, apimBaseURL string, apiid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (APIClient) DeleteResponder 

func (client APIClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (APIClient) DeleteSender 

func (client APIClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (APIClient) Get 

func (client APIClient) Get(ctx context.Context, apimBaseURL string, apiid string) (result APIContract, err error)

Get gets the details of the API specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance.

func (APIClient) GetPreparer 

func (client APIClient) GetPreparer(ctx context.Context, apimBaseURL string, apiid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (APIClient) GetResponder 

func (client APIClient) GetResponder(resp *http.Response) (result APIContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (APIClient) GetSender 

func (client APIClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (APIClient) List 

func (client APIClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result APICollectionPage, err error)

List lists all APIs of the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (APIClient) ListComplete 

func (client APIClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result APICollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (APIClient) ListPreparer 

func (client APIClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (APIClient) ListResponder 

func (client APIClient) ListResponder(resp *http.Response) (result APICollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (APIClient) ListSender 

func (client APIClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (APIClient) Update 

func (client APIClient) Update(ctx context.Context, apimBaseURL string, apiid string, parameters APIUpdateContract, ifMatch string) (result autorest.Response, err error)

Update updates the specified API of the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. parameters is API Update Contract parameters. ifMatch is eTag of the API entity. ETag should match the current entity state in the header response of the GET request or it should be * for unconditional update.

func (APIClient) UpdatePreparer 

func (client APIClient) UpdatePreparer(ctx context.Context, apimBaseURL string, apiid string, parameters APIUpdateContract, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (APIClient) UpdateResponder 

func (client APIClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (APIClient) UpdateSender 

func (client APIClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type APICollection 

type APICollection struct {
	autorest.Response `json:"-"`
	Value             *[]APIContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

APICollection paged Api list representation.

func (APICollection) IsEmpty 

func (ac APICollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type APICollectionIterator 

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

APICollectionIterator provides access to a complete listing of APIContract values.

func (*APICollectionIterator) Next 

func (iter *APICollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (APICollectionIterator) NotDone 

func (iter APICollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (APICollectionIterator) Response 

func (iter APICollectionIterator) Response() APICollection

Response returns the raw server response from the last page request.

func (APICollectionIterator) Value 

func (iter APICollectionIterator) Value() APIContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type APICollectionPage 

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

APICollectionPage contains a page of APIContract values.

func (*APICollectionPage) Next 

func (page *APICollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (APICollectionPage) NotDone 

func (page APICollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (APICollectionPage) Response 

func (page APICollectionPage) Response() APICollection

Response returns the raw server response from the last page request.

func (APICollectionPage) Values 

func (page APICollectionPage) Values() []APIContract

Values returns the slice of values for the current page or nil if there are no values.

type APIContract 

type APIContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Entity
	ID *string `json:"id,omitempty"`
	// Name - API name.
	Name *string `json:"name,omitempty"`
	// ServiceURL - Absolute URL of the backend service implementing this API.
	ServiceURL *string `json:"serviceUrl,omitempty"`
	// Path - 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"`
	// Protocols - Describes on which protocols the operations in this API can be invoked.
	Protocols *[]Protocol `json:"protocols,omitempty"`
	// Description - Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthenticationSettings - Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
	// SubscriptionKeyParameterNames - Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
	APIType APIType `json:"type,omitempty"`
	// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`
	// IsCurrent - Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`
	// IsOnline - Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty"`
}

APIContract api Contract Details

type APIContractProperties 

type APIContractProperties struct {
	// Name - API name.
	Name *string `json:"name,omitempty"`
	// ServiceURL - Absolute URL of the backend service implementing this API.
	ServiceURL *string `json:"serviceUrl,omitempty"`
	// Path - 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"`
	// Protocols - Describes on which protocols the operations in this API can be invoked.
	Protocols *[]Protocol `json:"protocols,omitempty"`
	// Description - Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthenticationSettings - Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
	// SubscriptionKeyParameterNames - Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
	APIType APIType `json:"type,omitempty"`
	// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`
	// IsCurrent - Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`
	// IsOnline - Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty"`
}

APIContractProperties api Entity Properties

type APICreateOrUpdateParameter 

type APICreateOrUpdateParameter struct {
	// ID - Identifier of the entity
	ID *string `json:"id,omitempty"`
	// ContentValue - Content value when Importing an API.
	ContentValue *string `json:"contentValue,omitempty"`
	// ContentFormat - Format of the Content in which the API is getting imported. Possible values include: 'WadlXML', 'WadlLinkJSON', 'SwaggerJSON', 'SwaggerLinkJSON', 'Wsdl', 'WsdlLink'
	ContentFormat ContentFormat `json:"contentFormat,omitempty"`
	// WsdlSelector - Criteria to limit import of WSDL to a subset of the document.
	WsdlSelector *APICreateOrUpdateParameterWsdlSelector `json:"wsdlSelector,omitempty"`
	// Name - API name.
	Name *string `json:"name,omitempty"`
	// ServiceURL - Absolute URL of the backend service implementing this API.
	ServiceURL *string `json:"serviceUrl,omitempty"`
	// Path - 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"`
	// Protocols - Describes on which protocols the operations in this API can be invoked.
	Protocols *[]Protocol `json:"protocols,omitempty"`
	// Description - Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthenticationSettings - Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
	// SubscriptionKeyParameterNames - Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
	APIType APIType `json:"type,omitempty"`
	// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`
	// IsCurrent - Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`
	// IsOnline - Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty"`
}

APICreateOrUpdateParameter api Create or Update Properties.

type APICreateOrUpdateParameterWsdlSelector 

type APICreateOrUpdateParameterWsdlSelector struct {
	// WsdlServiceName - Name of service to import from WSDL
	WsdlServiceName *string `json:"wsdlServiceName,omitempty"`
	// WsdlEndpointName - Name of endpoint(port) to import from WSDL
	WsdlEndpointName *string `json:"wsdlEndpointName,omitempty"`
}

APICreateOrUpdateParameterWsdlSelector criteria to limit import of WSDL to a subset of the document.

type APIEntityBaseContract 

type APIEntityBaseContract struct {
	// Description - Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthenticationSettings - Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
	// SubscriptionKeyParameterNames - Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
	APIType APIType `json:"type,omitempty"`
	// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`
	// IsCurrent - Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`
	// IsOnline - Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty"`
}

APIEntityBaseContract API base contract details.

type APIExportClient 

type APIExportClient struct {
	BaseClient
}

APIExportClient is the client for the APIExport methods of the Apimanagement service.

func NewAPIExportClient 

func NewAPIExportClient() APIExportClient

NewAPIExportClient creates an instance of the APIExportClient client.

func (APIExportClient) Get 

func (client APIExportClient) Get(ctx context.Context, apimBaseURL string, apiid string) (result APIExportResult, err 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.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance.

func (APIExportClient) GetPreparer 

func (client APIExportClient) GetPreparer(ctx context.Context, apimBaseURL string, apiid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (APIExportClient) GetResponder 

func (client APIExportClient) GetResponder(resp *http.Response) (result APIExportResult, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (APIExportClient) GetSender 

func (client APIExportClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

type APIExportResult 

type APIExportResult struct {
	autorest.Response `json:"-"`
	// Link - 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"`
}

APIExportResult API Export result Blob Uri.

type APIOperationClient 

type APIOperationClient struct {
	BaseClient
}

APIOperationClient is the client for the APIOperation methods of the Apimanagement service.

func NewAPIOperationClient 

func NewAPIOperationClient() APIOperationClient

NewAPIOperationClient creates an instance of the APIOperationClient client.

func (APIOperationClient) CreateOrUpdate 

func (client APIOperationClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, apiid string, operationID string, parameters OperationContract) (result OperationContract, err error)

CreateOrUpdate creates a new operation in the API or updates an existing one.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance. parameters is create parameters.

func (APIOperationClient) CreateOrUpdatePreparer 

func (client APIOperationClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, apiid string, operationID string, parameters OperationContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationClient) CreateOrUpdateResponder 

func (client APIOperationClient) CreateOrUpdateResponder(resp *http.Response) (result OperationContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (APIOperationClient) CreateOrUpdateSender 

func (client APIOperationClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (APIOperationClient) Delete 

func (client APIOperationClient) Delete(ctx context.Context, apimBaseURL string, apiid string, operationID string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified operation in the API.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance. ifMatch is eTag of the API Operation Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIOperationClient) DeletePreparer 

func (client APIOperationClient) DeletePreparer(ctx context.Context, apimBaseURL string, apiid string, operationID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (APIOperationClient) DeleteResponder 

func (client APIOperationClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (APIOperationClient) DeleteSender 

func (client APIOperationClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (APIOperationClient) Get 

func (client APIOperationClient) Get(ctx context.Context, apimBaseURL string, apiid string, operationID string) (result OperationContract, err error)

Get gets the details of the API Operation specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance.

func (APIOperationClient) GetPreparer 

func (client APIOperationClient) GetPreparer(ctx context.Context, apimBaseURL string, apiid string, operationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (APIOperationClient) GetResponder 

func (client APIOperationClient) GetResponder(resp *http.Response) (result OperationContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (APIOperationClient) GetSender 

func (client APIOperationClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (APIOperationClient) ListByAPI 

func (client APIOperationClient) ListByAPI(ctx context.Context, apimBaseURL string, apiid string, filter string, top *int32, skip *int32) (result OperationCollectionPage, err error)

ListByAPI lists a collection of the operations for the specified API.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | method | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (APIOperationClient) ListByAPIComplete 

func (client APIOperationClient) ListByAPIComplete(ctx context.Context, apimBaseURL string, apiid string, filter string, top *int32, skip *int32) (result OperationCollectionIterator, err error)

ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.

func (APIOperationClient) ListByAPIPreparer 

func (client APIOperationClient) ListByAPIPreparer(ctx context.Context, apimBaseURL string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByAPIPreparer prepares the ListByAPI request.

func (APIOperationClient) ListByAPIResponder 

func (client APIOperationClient) ListByAPIResponder(resp *http.Response) (result OperationCollection, err error)

ListByAPIResponder handles the response to the ListByAPI request. The method always closes the http.Response Body.

func (APIOperationClient) ListByAPISender 

func (client APIOperationClient) ListByAPISender(req *http.Request) (*http.Response, error)

ListByAPISender sends the ListByAPI request. The method will close the http.Response Body if it receives an error.

func (APIOperationClient) Update 

func (client APIOperationClient) Update(ctx context.Context, apimBaseURL string, apiid string, operationID string, parameters OperationUpdateContract, ifMatch string) (result autorest.Response, err error)

Update updates the details of the operation in the API specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance. parameters is API Operation Update parameters. ifMatch is eTag of the API Operation Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIOperationClient) UpdatePreparer 

func (client APIOperationClient) UpdatePreparer(ctx context.Context, apimBaseURL string, apiid string, operationID string, parameters OperationUpdateContract, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (APIOperationClient) UpdateResponder 

func (client APIOperationClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (APIOperationClient) UpdateSender 

func (client APIOperationClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type APIOperationPolicyClient 

type APIOperationPolicyClient struct {
	BaseClient
}

APIOperationPolicyClient is the client for the APIOperationPolicy methods of the Apimanagement service.

func NewAPIOperationPolicyClient 

func NewAPIOperationPolicyClient() APIOperationPolicyClient

NewAPIOperationPolicyClient creates an instance of the APIOperationPolicyClient client.

func (APIOperationPolicyClient) CreateOrUpdate 

func (client APIOperationPolicyClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, apiid string, operationID string, parameters PolicyContract, ifMatch string) (result PolicyContract, err error)

CreateOrUpdate creates or updates policy configuration for the API Operation level.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance. parameters is the policy contents to apply. ifMatch is the entity state (Etag) version of the Api Operation policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (APIOperationPolicyClient) CreateOrUpdatePreparer 

func (client APIOperationPolicyClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, apiid string, operationID string, parameters PolicyContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationPolicyClient) CreateOrUpdateResponder 

func (client APIOperationPolicyClient) CreateOrUpdateResponder(resp *http.Response) (result PolicyContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (APIOperationPolicyClient) CreateOrUpdateSender 

func (client APIOperationPolicyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (APIOperationPolicyClient) Delete 

func (client APIOperationPolicyClient) Delete(ctx context.Context, apimBaseURL string, apiid string, operationID string, ifMatch string) (result autorest.Response, err error)

Delete deletes the policy configuration at the Api Operation.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance. ifMatch is the entity state (Etag) version of the Api Operation Policy to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (APIOperationPolicyClient) DeletePreparer 

func (client APIOperationPolicyClient) DeletePreparer(ctx context.Context, apimBaseURL string, apiid string, operationID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (APIOperationPolicyClient) DeleteResponder 

func (client APIOperationPolicyClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (APIOperationPolicyClient) DeleteSender 

func (client APIOperationPolicyClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (APIOperationPolicyClient) Get 

func (client APIOperationPolicyClient) Get(ctx context.Context, apimBaseURL string, apiid string, operationID string) (result PolicyContract, err error)

Get get the policy configuration at the API Operation level.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance.

func (APIOperationPolicyClient) GetPreparer 

func (client APIOperationPolicyClient) GetPreparer(ctx context.Context, apimBaseURL string, apiid string, operationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (APIOperationPolicyClient) GetResponder 

func (client APIOperationPolicyClient) GetResponder(resp *http.Response) (result PolicyContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (APIOperationPolicyClient) GetSender 

func (client APIOperationPolicyClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (APIOperationPolicyClient) ListByOperation 

func (client APIOperationPolicyClient) ListByOperation(ctx context.Context, apimBaseURL string, apiid string, operationID string) (result PolicyCollection, err error)

ListByOperation get the list of policy configuration at the API Operation level.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance.

func (APIOperationPolicyClient) ListByOperationPreparer 

func (client APIOperationPolicyClient) ListByOperationPreparer(ctx context.Context, apimBaseURL string, apiid string, operationID string) (*http.Request, error)

ListByOperationPreparer prepares the ListByOperation request.

func (APIOperationPolicyClient) ListByOperationResponder 

func (client APIOperationPolicyClient) ListByOperationResponder(resp *http.Response) (result PolicyCollection, err error)

ListByOperationResponder handles the response to the ListByOperation request. The method always closes the http.Response Body.

func (APIOperationPolicyClient) ListByOperationSender 

func (client APIOperationPolicyClient) ListByOperationSender(req *http.Request) (*http.Response, error)

ListByOperationSender sends the ListByOperation request. The method will close the http.Response Body if it receives an error.

type APIPolicyClient 

type APIPolicyClient struct {
	BaseClient
}

APIPolicyClient is the client for the APIPolicy methods of the Apimanagement service.

func NewAPIPolicyClient 

func NewAPIPolicyClient() APIPolicyClient

NewAPIPolicyClient creates an instance of the APIPolicyClient client.

func (APIPolicyClient) CreateOrUpdate 

func (client APIPolicyClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, apiid string, parameters PolicyContract, ifMatch string) (result PolicyContract, err error)

CreateOrUpdate creates or updates policy configuration for the API.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. parameters is the policy contents to apply. ifMatch is the entity state (Etag) version of the Api Policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (APIPolicyClient) CreateOrUpdatePreparer 

func (client APIPolicyClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, apiid string, parameters PolicyContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIPolicyClient) CreateOrUpdateResponder 

func (client APIPolicyClient) CreateOrUpdateResponder(resp *http.Response) (result PolicyContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (APIPolicyClient) CreateOrUpdateSender 

func (client APIPolicyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (APIPolicyClient) Delete 

func (client APIPolicyClient) Delete(ctx context.Context, apimBaseURL string, apiid string, ifMatch string) (result autorest.Response, err error)

Delete deletes the policy configuration at the Api.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. ifMatch is the entity state (Etag) version of the Api policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (APIPolicyClient) DeletePreparer 

func (client APIPolicyClient) DeletePreparer(ctx context.Context, apimBaseURL string, apiid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (APIPolicyClient) DeleteResponder 

func (client APIPolicyClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (APIPolicyClient) DeleteSender 

func (client APIPolicyClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (APIPolicyClient) Get 

func (client APIPolicyClient) Get(ctx context.Context, apimBaseURL string, apiid string) (result PolicyContract, err error)

Get get the policy configuration at the API level.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance.

func (APIPolicyClient) GetPreparer 

func (client APIPolicyClient) GetPreparer(ctx context.Context, apimBaseURL string, apiid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (APIPolicyClient) GetResponder 

func (client APIPolicyClient) GetResponder(resp *http.Response) (result PolicyContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (APIPolicyClient) GetSender 

func (client APIPolicyClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (APIPolicyClient) ListByAPI 

func (client APIPolicyClient) ListByAPI(ctx context.Context, apimBaseURL string, apiid string) (result PolicyCollection, err error)

ListByAPI get the policy configuration at the API level.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance.

func (APIPolicyClient) ListByAPIPreparer 

func (client APIPolicyClient) ListByAPIPreparer(ctx context.Context, apimBaseURL string, apiid string) (*http.Request, error)

ListByAPIPreparer prepares the ListByAPI request.

func (APIPolicyClient) ListByAPIResponder 

func (client APIPolicyClient) ListByAPIResponder(resp *http.Response) (result PolicyCollection, err error)

ListByAPIResponder handles the response to the ListByAPI request. The method always closes the http.Response Body.

func (APIPolicyClient) ListByAPISender 

func (client APIPolicyClient) ListByAPISender(req *http.Request) (*http.Response, error)

ListByAPISender sends the ListByAPI request. The method will close the http.Response Body if it receives an error.

type APIProductClient 

type APIProductClient struct {
	BaseClient
}

APIProductClient is the client for the APIProduct methods of the Apimanagement service.

func NewAPIProductClient 

func NewAPIProductClient() APIProductClient

NewAPIProductClient creates an instance of the APIProductClient client.

func (APIProductClient) ListByApis 

func (client APIProductClient) ListByApis(ctx context.Context, apimBaseURL string, apiid string, filter string, top *int32, skip *int32) (result ProductCollectionPage, err error)

ListByApis lists all Products, which the API is part of.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (APIProductClient) ListByApisComplete 

func (client APIProductClient) ListByApisComplete(ctx context.Context, apimBaseURL string, apiid string, filter string, top *int32, skip *int32) (result ProductCollectionIterator, err error)

ListByApisComplete enumerates all values, automatically crossing page boundaries as required.

func (APIProductClient) ListByApisPreparer 

func (client APIProductClient) ListByApisPreparer(ctx context.Context, apimBaseURL string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByApisPreparer prepares the ListByApis request.

func (APIProductClient) ListByApisResponder 

func (client APIProductClient) ListByApisResponder(resp *http.Response) (result ProductCollection, err error)

ListByApisResponder handles the response to the ListByApis request. The method always closes the http.Response Body.

func (APIProductClient) ListByApisSender 

func (client APIProductClient) ListByApisSender(req *http.Request) (*http.Response, error)

ListByApisSender sends the ListByApis request. The method will close the http.Response Body if it receives an error.

type APISchemaClient 

type APISchemaClient struct {
	BaseClient
}

APISchemaClient is the client for the APISchema methods of the Apimanagement service.

func NewAPISchemaClient 

func NewAPISchemaClient() APISchemaClient

NewAPISchemaClient creates an instance of the APISchemaClient client.

func (APISchemaClient) CreateOrUpdate 

func (client APISchemaClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, apiid string, schemaID string, parameters SchemaContract, ifMatch string) (result SchemaContract, err error)

CreateOrUpdate creates or updates schema configuration for the API.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. schemaID is schema identifier within an API. Must be unique in the current API Management service instance. parameters is the schema contents to apply. ifMatch is the entity state (Etag) version of the Api Schema to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (APISchemaClient) CreateOrUpdatePreparer 

func (client APISchemaClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, apiid string, schemaID string, parameters SchemaContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APISchemaClient) CreateOrUpdateResponder 

func (client APISchemaClient) CreateOrUpdateResponder(resp *http.Response) (result SchemaContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (APISchemaClient) CreateOrUpdateSender 

func (client APISchemaClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (APISchemaClient) Delete 

func (client APISchemaClient) Delete(ctx context.Context, apimBaseURL string, apiid string, schemaID string, ifMatch string) (result autorest.Response, err error)

Delete deletes the schema configuration at the Api.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. schemaID is schema identifier within an API. Must be unique in the current API Management service instance. ifMatch is the entity state (Etag) version of the Api schema to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (APISchemaClient) DeletePreparer 

func (client APISchemaClient) DeletePreparer(ctx context.Context, apimBaseURL string, apiid string, schemaID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (APISchemaClient) DeleteResponder 

func (client APISchemaClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (APISchemaClient) DeleteSender 

func (client APISchemaClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (APISchemaClient) Get 

func (client APISchemaClient) Get(ctx context.Context, apimBaseURL string, apiid string, schemaID string) (result SchemaContract, err error)

Get get the schema configuration at the API level.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance. schemaID is schema identifier within an API. Must be unique in the current API Management service instance.

func (APISchemaClient) GetPreparer 

func (client APISchemaClient) GetPreparer(ctx context.Context, apimBaseURL string, apiid string, schemaID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (APISchemaClient) GetResponder 

func (client APISchemaClient) GetResponder(resp *http.Response) (result SchemaContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (APISchemaClient) GetSender 

func (client APISchemaClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (APISchemaClient) ListByAPI 

func (client APISchemaClient) ListByAPI(ctx context.Context, apimBaseURL string, apiid string) (result SchemaCollectionPage, err error)

ListByAPI get the schema configuration at the API level.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid is API identifier. Must be unique in the current API Management service instance.

func (APISchemaClient) ListByAPIComplete 

func (client APISchemaClient) ListByAPIComplete(ctx context.Context, apimBaseURL string, apiid string) (result SchemaCollectionIterator, err error)

ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.

func (APISchemaClient) ListByAPIPreparer 

func (client APISchemaClient) ListByAPIPreparer(ctx context.Context, apimBaseURL string, apiid string) (*http.Request, error)

ListByAPIPreparer prepares the ListByAPI request.

func (APISchemaClient) ListByAPIResponder 

func (client APISchemaClient) ListByAPIResponder(resp *http.Response) (result SchemaCollection, err error)

ListByAPIResponder handles the response to the ListByAPI request. The method always closes the http.Response Body.

func (APISchemaClient) ListByAPISender 

func (client APISchemaClient) ListByAPISender(req *http.Request) (*http.Response, error)

ListByAPISender sends the ListByAPI request. The method will close the http.Response Body if it receives an error.

type APIType 

type APIType string

APIType enumerates the values for api type. 

const (
	// HTTP ...
	HTTP APIType = "http"
	// Soap ...
	Soap APIType = "soap"
)

func PossibleAPITypeValues 

func PossibleAPITypeValues() []APIType

PossibleAPITypeValues returns an array of possible values for the APIType const type.

type APIUpdateContract 

type APIUpdateContract struct {
	// Name - API name.
	Name *string `json:"name,omitempty"`
	// ServiceURL - Absolute URL of the backend service implementing this API.
	ServiceURL *string `json:"serviceUrl,omitempty"`
	// Path - 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"`
	// Protocols - Describes on which protocols the operations in this API can be invoked.
	Protocols *[]Protocol `json:"protocols,omitempty"`
	// Description - Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthenticationSettings - Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
	// SubscriptionKeyParameterNames - Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
	APIType APIType `json:"type,omitempty"`
	// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`
	// IsCurrent - Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`
	// IsOnline - Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty"`
}

APIUpdateContract API update contract properties.

type AccessInformationContract 

type AccessInformationContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier.
	ID *string `json:"id,omitempty"`
	// PrimaryKey - Primary access key.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - Secondary access key.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
	// Enabled - Tenant access information of the API Management service.
	Enabled *bool `json:"enabled,omitempty"`
}

AccessInformationContract tenant access information contract of the API Management service.

type AccessInformationUpdateParameters 

type AccessInformationUpdateParameters struct {
	// Enabled - Tenant access information of the API Management service.
	Enabled *bool `json:"enabled,omitempty"`
}

AccessInformationUpdateParameters tenant access information update parameters of the API Management service.

type AsyncOperationStatus 

type AsyncOperationStatus string

AsyncOperationStatus enumerates the values for async operation status. 

const (
	// Failed ...
	Failed AsyncOperationStatus = "Failed"
	// InProgress ...
	InProgress AsyncOperationStatus = "InProgress"
	// Started ...
	Started AsyncOperationStatus = "Started"
	// Succeeded ...
	Succeeded AsyncOperationStatus = "Succeeded"
)

func PossibleAsyncOperationStatusValues 

func PossibleAsyncOperationStatusValues() []AsyncOperationStatus

PossibleAsyncOperationStatusValues returns an array of possible values for the AsyncOperationStatus const type.

type AuthenticationSettingsContract 

type AuthenticationSettingsContract struct {
	// OAuth2 - OAuth2 Authentication settings
	OAuth2 *OAuth2AuthenticationSettingsContract `json:"oAuth2,omitempty"`
}

AuthenticationSettingsContract API Authentication Settings.

type AuthorizationMethod 

type AuthorizationMethod string

AuthorizationMethod enumerates the values for authorization method. 

const (
	// DELETE ...
	DELETE AuthorizationMethod = "DELETE"
	// GET ...
	GET AuthorizationMethod = "GET"
	// HEAD ...
	HEAD AuthorizationMethod = "HEAD"
	// OPTIONS ...
	OPTIONS AuthorizationMethod = "OPTIONS"
	// PATCH ...
	PATCH AuthorizationMethod = "PATCH"
	// POST ...
	POST AuthorizationMethod = "POST"
	// PUT ...
	PUT AuthorizationMethod = "PUT"
	// TRACE ...
	TRACE AuthorizationMethod = "TRACE"
)

func PossibleAuthorizationMethodValues 

func PossibleAuthorizationMethodValues() []AuthorizationMethod

PossibleAuthorizationMethodValues returns an array of possible values for the AuthorizationMethod const type.

type AuthorizationServerClient 

type AuthorizationServerClient struct {
	BaseClient
}

AuthorizationServerClient is the client for the AuthorizationServer methods of the Apimanagement service.

func NewAuthorizationServerClient 

func NewAuthorizationServerClient() AuthorizationServerClient

NewAuthorizationServerClient creates an instance of the AuthorizationServerClient client.

func (AuthorizationServerClient) CreateOrUpdate 

func (client AuthorizationServerClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, authsid string, parameters AuthorizationServerContract) (result AuthorizationServerContract, err error)

CreateOrUpdate creates new authorization server or updates an existing authorization server.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. authsid is identifier of the authorization server. parameters is create or update parameters.

func (AuthorizationServerClient) CreateOrUpdatePreparer 

func (client AuthorizationServerClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, authsid string, parameters AuthorizationServerContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AuthorizationServerClient) CreateOrUpdateResponder 

func (client AuthorizationServerClient) CreateOrUpdateResponder(resp *http.Response) (result AuthorizationServerContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (AuthorizationServerClient) CreateOrUpdateSender 

func (client AuthorizationServerClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (AuthorizationServerClient) Delete 

func (client AuthorizationServerClient) Delete(ctx context.Context, apimBaseURL string, authsid string, ifMatch string) (result autorest.Response, err error)

Delete deletes specific authorization server instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. authsid is identifier of the authorization server. ifMatch is the entity state (Etag) version of the authentication server to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (AuthorizationServerClient) DeletePreparer 

func (client AuthorizationServerClient) DeletePreparer(ctx context.Context, apimBaseURL string, authsid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AuthorizationServerClient) DeleteResponder 

func (client AuthorizationServerClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (AuthorizationServerClient) DeleteSender 

func (client AuthorizationServerClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (AuthorizationServerClient) Get 

func (client AuthorizationServerClient) Get(ctx context.Context, apimBaseURL string, authsid string) (result AuthorizationServerContract, err error)

Get gets the details of the authorization server specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. authsid is identifier of the authorization server.

func (AuthorizationServerClient) GetPreparer 

func (client AuthorizationServerClient) GetPreparer(ctx context.Context, apimBaseURL string, authsid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AuthorizationServerClient) GetResponder 

func (client AuthorizationServerClient) GetResponder(resp *http.Response) (result AuthorizationServerContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (AuthorizationServerClient) GetSender 

func (client AuthorizationServerClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (AuthorizationServerClient) List 

func (client AuthorizationServerClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result AuthorizationServerCollectionPage, err error)

List lists a collection of authorization servers defined within a service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (AuthorizationServerClient) ListComplete 

func (client AuthorizationServerClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result AuthorizationServerCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (AuthorizationServerClient) ListPreparer 

func (client AuthorizationServerClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (AuthorizationServerClient) ListResponder 

func (client AuthorizationServerClient) ListResponder(resp *http.Response) (result AuthorizationServerCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AuthorizationServerClient) ListSender 

func (client AuthorizationServerClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (AuthorizationServerClient) Update 

func (client AuthorizationServerClient) Update(ctx context.Context, apimBaseURL string, authsid string, parameters AuthorizationServerUpdateContract, ifMatch string) (result autorest.Response, err error)

Update updates the details of the authorization server specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. authsid is identifier of the authorization server. parameters is oAuth2 Server settings Update parameters. ifMatch is the entity state (Etag) version of the authorization server to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (AuthorizationServerClient) UpdatePreparer 

func (client AuthorizationServerClient) UpdatePreparer(ctx context.Context, apimBaseURL string, authsid string, parameters AuthorizationServerUpdateContract, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AuthorizationServerClient) UpdateResponder 

func (client AuthorizationServerClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (AuthorizationServerClient) UpdateSender 

func (client AuthorizationServerClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type AuthorizationServerCollection 

type AuthorizationServerCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]AuthorizationServerContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

AuthorizationServerCollection paged OAuth2 Authorization Servers list representation.

func (AuthorizationServerCollection) IsEmpty 

func (asc AuthorizationServerCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AuthorizationServerCollectionIterator 

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

AuthorizationServerCollectionIterator provides access to a complete listing of AuthorizationServerContract values.

func (*AuthorizationServerCollectionIterator) Next 

func (iter *AuthorizationServerCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AuthorizationServerCollectionIterator) NotDone 

func (iter AuthorizationServerCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AuthorizationServerCollectionIterator) Response 

func (iter AuthorizationServerCollectionIterator) Response() AuthorizationServerCollection

Response returns the raw server response from the last page request.

func (AuthorizationServerCollectionIterator) Value 

func (iter AuthorizationServerCollectionIterator) Value() AuthorizationServerContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AuthorizationServerCollectionPage 

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

AuthorizationServerCollectionPage contains a page of AuthorizationServerContract values.

func (*AuthorizationServerCollectionPage) Next 

func (page *AuthorizationServerCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AuthorizationServerCollectionPage) NotDone 

func (page AuthorizationServerCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AuthorizationServerCollectionPage) Response 

func (page AuthorizationServerCollectionPage) Response() AuthorizationServerCollection

Response returns the raw server response from the last page request.

func (AuthorizationServerCollectionPage) Values 

func (page AuthorizationServerCollectionPage) Values() []AuthorizationServerContract

Values returns the slice of values for the current page or nil if there are no values.

type AuthorizationServerContract 

type AuthorizationServerContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Authorization Server entity.
	ID *string `json:"id,omitempty"`
	// Name - User-friendly authorization server name.
	Name *string `json:"name,omitempty"`
	// ClientRegistrationEndpoint - 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"`
	// AuthorizationEndpoint - OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
	AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`
	// GrantTypes - Form of an authorization grant, which the client uses to request the access token.
	GrantTypes *[]GrantType `json:"grantTypes,omitempty"`
	// ClientID - Client or app id registered with this authorization server.
	ClientID *string `json:"clientId,omitempty"`
	// Description - Description of the authorization server. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
	AuthorizationMethods *[]AuthorizationMethod `json:"authorizationMethods,omitempty"`
	// ClientAuthenticationMethod - 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"`
	// TokenBodyParameters - 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"`
	// TokenEndpoint - OAuth token endpoint. Contains absolute URI to entity being referenced.
	TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
	// SupportState - 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"`
	// DefaultScope - 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"`
	// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
	BearerTokenSendingMethods *[]BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`
	// ClientSecret - Client or app secret registered with this authorization server.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// ResourceOwnerUsername - 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"`
	// ResourceOwnerPassword - 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"`
}

AuthorizationServerContract external OAuth authorization server settings.

type AuthorizationServerContractBaseProperties 

type AuthorizationServerContractBaseProperties struct {
	// Description - Description of the authorization server. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
	AuthorizationMethods *[]AuthorizationMethod `json:"authorizationMethods,omitempty"`
	// ClientAuthenticationMethod - 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"`
	// TokenBodyParameters - 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"`
	// TokenEndpoint - OAuth token endpoint. Contains absolute URI to entity being referenced.
	TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
	// SupportState - 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"`
	// DefaultScope - 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"`
	// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
	BearerTokenSendingMethods *[]BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`
	// ClientSecret - Client or app secret registered with this authorization server.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// ResourceOwnerUsername - 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"`
	// ResourceOwnerPassword - 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"`
}

AuthorizationServerContractBaseProperties external OAuth authorization server Update settings contract.

type AuthorizationServerContractProperties 

type AuthorizationServerContractProperties struct {
	// Name - User-friendly authorization server name.
	Name *string `json:"name,omitempty"`
	// ClientRegistrationEndpoint - 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"`
	// AuthorizationEndpoint - OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
	AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`
	// GrantTypes - Form of an authorization grant, which the client uses to request the access token.
	GrantTypes *[]GrantType `json:"grantTypes,omitempty"`
	// ClientID - Client or app id registered with this authorization server.
	ClientID *string `json:"clientId,omitempty"`
	// Description - Description of the authorization server. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
	AuthorizationMethods *[]AuthorizationMethod `json:"authorizationMethods,omitempty"`
	// ClientAuthenticationMethod - 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"`
	// TokenBodyParameters - 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"`
	// TokenEndpoint - OAuth token endpoint. Contains absolute URI to entity being referenced.
	TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
	// SupportState - 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"`
	// DefaultScope - 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"`
	// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
	BearerTokenSendingMethods *[]BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`
	// ClientSecret - Client or app secret registered with this authorization server.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// ResourceOwnerUsername - 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"`
	// ResourceOwnerPassword - 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"`
}

AuthorizationServerContractProperties external OAuth authorization server settings Properties.

type AuthorizationServerUpdateContract 

type AuthorizationServerUpdateContract struct {
	// Name - User-friendly authorization server name.
	Name *string `json:"name,omitempty"`
	// ClientRegistrationEndpoint - 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"`
	// AuthorizationEndpoint - OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
	AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`
	// GrantTypes - Form of an authorization grant, which the client uses to request the access token.
	GrantTypes *[]GrantType `json:"grantTypes,omitempty"`
	// ClientID - Client or app id registered with this authorization server.
	ClientID *string `json:"clientId,omitempty"`
	// Description - Description of the authorization server. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
	AuthorizationMethods *[]AuthorizationMethod `json:"authorizationMethods,omitempty"`
	// ClientAuthenticationMethod - 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"`
	// TokenBodyParameters - 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"`
	// TokenEndpoint - OAuth token endpoint. Contains absolute URI to entity being referenced.
	TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
	// SupportState - 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"`
	// DefaultScope - 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"`
	// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
	BearerTokenSendingMethods *[]BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`
	// ClientSecret - Client or app secret registered with this authorization server.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// ResourceOwnerUsername - 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"`
	// ResourceOwnerPassword - 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"`
}

AuthorizationServerUpdateContract external OAuth authorization server Update settings contract.

type BackendAuthorizationHeaderCredentials 

type BackendAuthorizationHeaderCredentials struct {
	// Scheme - Authentication Scheme name.
	Scheme *string `json:"scheme,omitempty"`
	// Parameter - Authentication Parameter value.
	Parameter *string `json:"parameter,omitempty"`
}

BackendAuthorizationHeaderCredentials authorization header information.

type BackendBaseParameters 

type BackendBaseParameters struct {
	// Title - Backend Title.
	Title *string `json:"title,omitempty"`
	// Description - Backend Description.
	Description *string `json:"description,omitempty"`
	// ResourceID - 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"`
	// Properties - Backend Properties contract
	Properties *BackendProperties `json:"properties,omitempty"`
	// Credentials - Backend Credentials Contract Properties
	Credentials *BackendCredentialsContract `json:"credentials,omitempty"`
	// Proxy - Backend Proxy Contract Properties
	Proxy *BackendProxyContract `json:"proxy,omitempty"`
	// TLS - Backend TLS Properties
	TLS *BackendTLSProperties `json:"tls,omitempty"`
}

BackendBaseParameters backend entity base Parameter set.

type BackendClient 

type BackendClient struct {
	BaseClient
}

BackendClient is the client for the Backend methods of the Apimanagement service.

func NewBackendClient 

func NewBackendClient() BackendClient

NewBackendClient creates an instance of the BackendClient client.

func (BackendClient) CreateOrUpdate 

func (client BackendClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, backendid string, parameters BackendContract) (result BackendContract, err error)

CreateOrUpdate creates or Updates a backend.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. backendid is identifier of the Backend entity. Must be unique in the current API Management service instance. parameters is create parameters.

func (BackendClient) CreateOrUpdatePreparer 

func (client BackendClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, backendid string, parameters BackendContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BackendClient) CreateOrUpdateResponder 

func (client BackendClient) CreateOrUpdateResponder(resp *http.Response) (result BackendContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (BackendClient) CreateOrUpdateSender 

func (client BackendClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (BackendClient) Delete 

func (client BackendClient) Delete(ctx context.Context, apimBaseURL string, backendid string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified backend.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. backendid is identifier of the Backend entity. Must be unique in the current API Management service instance. ifMatch is the entity state (Etag) version of the backend to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (BackendClient) DeletePreparer 

func (client BackendClient) DeletePreparer(ctx context.Context, apimBaseURL string, backendid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (BackendClient) DeleteResponder 

func (client BackendClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (BackendClient) DeleteSender 

func (client BackendClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (BackendClient) Get 

func (client BackendClient) Get(ctx context.Context, apimBaseURL string, backendid string) (result BackendContract, err error)

Get gets the details of the backend specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. backendid is identifier of the Backend entity. Must be unique in the current API Management service instance.

func (BackendClient) GetPreparer 

func (client BackendClient) GetPreparer(ctx context.Context, apimBaseURL string, backendid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (BackendClient) GetResponder 

func (client BackendClient) GetResponder(resp *http.Response) (result BackendContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (BackendClient) GetSender 

func (client BackendClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (BackendClient) List 

func (client BackendClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result BackendCollectionPage, err error)

List lists a collection of backends in the specified service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | host | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (BackendClient) ListComplete 

func (client BackendClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result BackendCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (BackendClient) ListPreparer 

func (client BackendClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (BackendClient) ListResponder 

func (client BackendClient) ListResponder(resp *http.Response) (result BackendCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (BackendClient) ListSender 

func (client BackendClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (BackendClient) Update 

func (client BackendClient) Update(ctx context.Context, apimBaseURL string, backendid string, parameters BackendUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates an existing backend.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. backendid is identifier of the Backend entity. Must be unique in the current API Management service instance. parameters is update parameters. ifMatch is the entity state (Etag) version of the backend to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (BackendClient) UpdatePreparer 

func (client BackendClient) UpdatePreparer(ctx context.Context, apimBaseURL string, backendid string, parameters BackendUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (BackendClient) UpdateResponder 

func (client BackendClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (BackendClient) UpdateSender 

func (client BackendClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type BackendCollection 

type BackendCollection struct {
	autorest.Response `json:"-"`
	// Value - Backend values.
	Value *[]BackendContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

BackendCollection paged Backend list representation.

func (BackendCollection) IsEmpty 

func (bc BackendCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type BackendCollectionIterator 

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

BackendCollectionIterator provides access to a complete listing of BackendContract values.

func (*BackendCollectionIterator) Next 

func (iter *BackendCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (BackendCollectionIterator) NotDone 

func (iter BackendCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (BackendCollectionIterator) Response 

func (iter BackendCollectionIterator) Response() BackendCollection

Response returns the raw server response from the last page request.

func (BackendCollectionIterator) Value 

func (iter BackendCollectionIterator) Value() BackendContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type BackendCollectionPage 

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

BackendCollectionPage contains a page of BackendContract values.

func (*BackendCollectionPage) Next 

func (page *BackendCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (BackendCollectionPage) NotDone 

func (page BackendCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (BackendCollectionPage) Response 

func (page BackendCollectionPage) Response() BackendCollection

Response returns the raw server response from the last page request.

func (BackendCollectionPage) Values 

func (page BackendCollectionPage) Values() []BackendContract

Values returns the slice of values for the current page or nil if there are no values.

type BackendContract 

type BackendContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Backend entity.
	ID *string `json:"id,omitempty"`
	// URL - Runtime Url of the Backend.
	URL *string `json:"url,omitempty"`
	// Protocol - Backend communication protocol. Possible values include: 'BackendProtocolHTTP', 'BackendProtocolSoap'
	Protocol BackendProtocol `json:"protocol,omitempty"`
	// Title - Backend Title.
	Title *string `json:"title,omitempty"`
	// Description - Backend Description.
	Description *string `json:"description,omitempty"`
	// ResourceID - 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"`
	// Properties - Backend Properties contract
	Properties *BackendProperties `json:"properties,omitempty"`
	// Credentials - Backend Credentials Contract Properties
	Credentials *BackendCredentialsContract `json:"credentials,omitempty"`
	// Proxy - Backend Proxy Contract Properties
	Proxy *BackendProxyContract `json:"proxy,omitempty"`
	// TLS - Backend TLS Properties
	TLS *BackendTLSProperties `json:"tls,omitempty"`
}

BackendContract backend details.

type BackendContractProperties 

type BackendContractProperties struct {
	// URL - Runtime Url of the Backend.
	URL *string `json:"url,omitempty"`
	// Protocol - Backend communication protocol. Possible values include: 'BackendProtocolHTTP', 'BackendProtocolSoap'
	Protocol BackendProtocol `json:"protocol,omitempty"`
	// Title - Backend Title.
	Title *string `json:"title,omitempty"`
	// Description - Backend Description.
	Description *string `json:"description,omitempty"`
	// ResourceID - 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"`
	// Properties - Backend Properties contract
	Properties *BackendProperties `json:"properties,omitempty"`
	// Credentials - Backend Credentials Contract Properties
	Credentials *BackendCredentialsContract `json:"credentials,omitempty"`
	// Proxy - Backend Proxy Contract Properties
	Proxy *BackendProxyContract `json:"proxy,omitempty"`
	// TLS - Backend TLS Properties
	TLS *BackendTLSProperties `json:"tls,omitempty"`
}

BackendContractProperties parameters supplied to the Create Backend operation.

type BackendCredentialsContract 

type BackendCredentialsContract struct {
	// Certificate - List of Client Certificate Thumbprint.
	Certificate *[]string `json:"certificate,omitempty"`
	// Query - Query Parameter description.
	Query map[string][]string `json:"query"`
	// Header - Header Parameter description.
	Header map[string][]string `json:"header"`
	// Authorization - Authorization header authentication
	Authorization *BackendAuthorizationHeaderCredentials `json:"authorization,omitempty"`
}

BackendCredentialsContract details of the Credentials used to connect to Backend.

func (BackendCredentialsContract) MarshalJSON 

func (bcc BackendCredentialsContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BackendCredentialsContract.

type BackendProperties 

type BackendProperties struct {
	// ServiceFabricCluster - Backend Service Fabric Cluster Properties
	ServiceFabricCluster *BackendServiceFabricClusterProperties `json:"serviceFabricCluster,omitempty"`
}

BackendProperties properties specific to the Backend Type.

type BackendProtocol 

type BackendProtocol string

BackendProtocol enumerates the values for backend 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 an array of possible values for the BackendProtocol const type.

type BackendProxyContract 

type BackendProxyContract struct {
	// URL - 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"`
	// Username - Username to connect to the WebProxy server
	Username *string `json:"username,omitempty"`
	// Password - Password to connect to the WebProxy Server
	Password *string `json:"password,omitempty"`
}

BackendProxyContract details of the Backend WebProxy Server to use in the Request to Backend.

type BackendServiceFabricClusterProperties 

type BackendServiceFabricClusterProperties struct {
	// ClientCertificateThumbprint - The client certificate thumbprint for the management endpoint.
	ClientCertificateThumbprint *string `json:"clientCertificateThumbprint,omitempty"`
	// MaxPartitionResolutionRetries - Maximum number of retries while attempting resolve the parition.
	MaxPartitionResolutionRetries *int32 `json:"maxPartitionResolutionRetries,omitempty"`
	// PartitionResolutionRequestTimeout - Maximum time allowed to update partition resolution data. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601
	PartitionResolutionRequestTimeout *string `json:"partitionResolutionRequestTimeout,omitempty"`
	// ManagementEndpoints - The cluster management endpoint.
	ManagementEndpoints *[]string `json:"managementEndpoints,omitempty"`
	// ServerCertificateThumbprints - Thumbprints of certificates cluster management service uses for tls communication
	ServerCertificateThumbprints *[]string `json:"serverCertificateThumbprints,omitempty"`
	// ServerX509Names - Server X509 Certificate Names Collection
	ServerX509Names *[]X509CertificateName `json:"serverX509Names,omitempty"`
}

BackendServiceFabricClusterProperties properties of the Service Fabric Type Backend.

type BackendTLSProperties 

type BackendTLSProperties struct {
	// ValidateCertificateChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
	ValidateCertificateChain *bool `json:"validateCertificateChain,omitempty"`
	// ValidateCertificateName - 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 BackendUpdateParameters 

type BackendUpdateParameters struct {
	// URL - Runtime Url of the Backend.
	URL *string `json:"url,omitempty"`
	// Protocol - Backend communication protocol. Possible values include: 'BackendProtocolHTTP', 'BackendProtocolSoap'
	Protocol BackendProtocol `json:"protocol,omitempty"`
	// Title - Backend Title.
	Title *string `json:"title,omitempty"`
	// Description - Backend Description.
	Description *string `json:"description,omitempty"`
	// ResourceID - 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"`
	// Properties - Backend Properties contract
	Properties *BackendProperties `json:"properties,omitempty"`
	// Credentials - Backend Credentials Contract Properties
	Credentials *BackendCredentialsContract `json:"credentials,omitempty"`
	// Proxy - Backend Proxy Contract Properties
	Proxy *BackendProxyContract `json:"proxy,omitempty"`
	// TLS - Backend TLS Properties
	TLS *BackendTLSProperties `json:"tls,omitempty"`
}

BackendUpdateParameters parameters supplied to the Update Backend operation.

type BaseClient 

type BaseClient struct {
	autorest.Client
}

BaseClient is the base client for Apimanagement.

func New 

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults 

func NewWithoutDefaults() BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

type BearerTokenSendingMethod 

type BearerTokenSendingMethod string

BearerTokenSendingMethod enumerates the values for bearer token sending method. 

const (
	// AuthorizationHeader ...
	AuthorizationHeader BearerTokenSendingMethod = "authorizationHeader"
	// Query ...
	Query BearerTokenSendingMethod = "query"
)

func PossibleBearerTokenSendingMethodValues 

func PossibleBearerTokenSendingMethodValues() []BearerTokenSendingMethod

PossibleBearerTokenSendingMethodValues returns an array of possible values for the BearerTokenSendingMethod const type.

type CertificateClient 

type CertificateClient struct {
	BaseClient
}

CertificateClient is the client for the Certificate methods of the Apimanagement service.

func NewCertificateClient 

func NewCertificateClient() CertificateClient

NewCertificateClient creates an instance of the CertificateClient client.

func (CertificateClient) CreateOrUpdate 

func (client CertificateClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, certificateID string, parameters CertificateCreateOrUpdateParameters, ifMatch string) (result CertificateContract, err error)

CreateOrUpdate creates or updates the certificate being used for authentication with the backend.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. certificateID is identifier of the certificate entity. Must be unique in the current API Management service instance. parameters is create or Update parameters. ifMatch is the entity state (Etag) version of the certificate to update. A value of "*" can be used for If-Match to unconditionally apply the operation..

func (CertificateClient) CreateOrUpdatePreparer 

func (client CertificateClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, certificateID string, parameters CertificateCreateOrUpdateParameters, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CertificateClient) CreateOrUpdateResponder 

func (client CertificateClient) CreateOrUpdateResponder(resp *http.Response) (result CertificateContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (CertificateClient) CreateOrUpdateSender 

func (client CertificateClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (CertificateClient) Delete 

func (client CertificateClient) Delete(ctx context.Context, apimBaseURL string, certificateID string, ifMatch string) (result autorest.Response, err error)

Delete deletes specific certificate.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. certificateID is identifier of the certificate entity. Must be unique in the current API Management service instance. ifMatch is the entity state (Etag) version of the certificate to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (CertificateClient) DeletePreparer 

func (client CertificateClient) DeletePreparer(ctx context.Context, apimBaseURL string, certificateID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (CertificateClient) DeleteResponder 

func (client CertificateClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (CertificateClient) DeleteSender 

func (client CertificateClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (CertificateClient) Get 

func (client CertificateClient) Get(ctx context.Context, apimBaseURL string, certificateID string) (result CertificateContract, err error)

Get gets the details of the certificate specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. certificateID is identifier of the certificate entity. Must be unique in the current API Management service instance.

func (CertificateClient) GetPreparer 

func (client CertificateClient) GetPreparer(ctx context.Context, apimBaseURL string, certificateID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (CertificateClient) GetResponder 

func (client CertificateClient) GetResponder(resp *http.Response) (result CertificateContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (CertificateClient) GetSender 

func (client CertificateClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (CertificateClient) List 

func (client CertificateClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result CertificateCollectionPage, err error)

List lists a collection of all certificates in the specified service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |----------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | subject | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | thumbprint | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | expirationDate | ge, le, eq, ne, gt, lt | N/A | top is number of records to return. skip is number of records to skip.

func (CertificateClient) ListComplete 

func (client CertificateClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result CertificateCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (CertificateClient) ListPreparer 

func (client CertificateClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (CertificateClient) ListResponder 

func (client CertificateClient) ListResponder(resp *http.Response) (result CertificateCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (CertificateClient) ListSender 

func (client CertificateClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type CertificateCollection 

type CertificateCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]CertificateContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

CertificateCollection paged Certificates list representation.

func (CertificateCollection) IsEmpty 

func (cc CertificateCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CertificateCollectionIterator 

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

CertificateCollectionIterator provides access to a complete listing of CertificateContract values.

func (*CertificateCollectionIterator) Next 

func (iter *CertificateCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (CertificateCollectionIterator) NotDone 

func (iter CertificateCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (CertificateCollectionIterator) Response 

func (iter CertificateCollectionIterator) Response() CertificateCollection

Response returns the raw server response from the last page request.

func (CertificateCollectionIterator) Value 

func (iter CertificateCollectionIterator) Value() CertificateContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type CertificateCollectionPage 

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

CertificateCollectionPage contains a page of CertificateContract values.

func (*CertificateCollectionPage) Next 

func (page *CertificateCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (CertificateCollectionPage) NotDone 

func (page CertificateCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (CertificateCollectionPage) Response 

func (page CertificateCollectionPage) Response() CertificateCollection

Response returns the raw server response from the last page request.

func (CertificateCollectionPage) Values 

func (page CertificateCollectionPage) Values() []CertificateContract

Values returns the slice of values for the current page or nil if there are no values.

type CertificateContract 

type CertificateContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Certificate entity.
	ID *string `json:"id,omitempty"`
	// Subject - Subject attribute of the certificate.
	Subject *string `json:"subject,omitempty"`
	// Thumbprint - Thumbprint of the certificate.
	Thumbprint *string `json:"thumbprint,omitempty"`
	// ExpirationDate - 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 *date.Time `json:"expirationDate,omitempty"`
}

CertificateContract certificate details.

type CertificateContractProperties 

type CertificateContractProperties struct {
	// Subject - Subject attribute of the certificate.
	Subject *string `json:"subject,omitempty"`
	// Thumbprint - Thumbprint of the certificate.
	Thumbprint *string `json:"thumbprint,omitempty"`
	// ExpirationDate - 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 *date.Time `json:"expirationDate,omitempty"`
}

CertificateContractProperties properties of the Certificate contract.

type CertificateCreateOrUpdateParameters 

type CertificateCreateOrUpdateParameters struct {
	// Data - Base 64 encoded certificate using the application/x-pkcs12 representation.
	Data *string `json:"data,omitempty"`
	// Password - Password for the Certificate
	Password *string `json:"password,omitempty"`
}

CertificateCreateOrUpdateParameters parameters supplied to the CreateOrUpdate certificate operation.

type ClientAuthenticationMethod 

type ClientAuthenticationMethod string

ClientAuthenticationMethod enumerates the values for client authentication method. 

const (
	// Basic Basic Client Authentication method.
	Basic ClientAuthenticationMethod = "Basic"
	// Body Body based Authentication method.
	Body ClientAuthenticationMethod = "Body"
)

func PossibleClientAuthenticationMethodValues 

func PossibleClientAuthenticationMethodValues() []ClientAuthenticationMethod

PossibleClientAuthenticationMethodValues returns an array of possible values for the ClientAuthenticationMethod const type.

type ContentFormat 

type ContentFormat string

ContentFormat enumerates the values for content format. 

const (
	// SwaggerJSON The contents are inline and Content Type if a OpenApi 2.0 Document.
	SwaggerJSON ContentFormat = "swagger-json"
	// SwaggerLinkJSON The Open Api 2.0 document is hosted on a publicly accessible internet address.
	SwaggerLinkJSON ContentFormat = "swagger-link-json"
	// WadlLinkJSON The WADL document is hosted on a publicly accessible internet address.
	WadlLinkJSON ContentFormat = "wadl-link-json"
	// WadlXML The contents are inline and Content type is a WADL document.
	WadlXML ContentFormat = "wadl-xml"
	// Wsdl The contents are inline and the document is a WSDL/Soap document.
	Wsdl ContentFormat = "wsdl"
	// WsdlLink The WSDL document is hosted on a publicly accessible internet address.
	WsdlLink ContentFormat = "wsdl-link"
)

func PossibleContentFormatValues 

func PossibleContentFormatValues() []ContentFormat

PossibleContentFormatValues returns an array of possible values for the ContentFormat const type.

type DelegationSettingsClient 

type DelegationSettingsClient struct {
	BaseClient
}

DelegationSettingsClient is the client for the DelegationSettings methods of the Apimanagement service.

func NewDelegationSettingsClient 

func NewDelegationSettingsClient() DelegationSettingsClient

NewDelegationSettingsClient creates an instance of the DelegationSettingsClient client.

func (DelegationSettingsClient) CreateOrUpdate 

func (client DelegationSettingsClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, parameters PortalDelegationSettings) (result PortalDelegationSettings, err error)

CreateOrUpdate create or Update Delegation settings.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is create or update parameters.

func (DelegationSettingsClient) CreateOrUpdatePreparer 

func (client DelegationSettingsClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, parameters PortalDelegationSettings) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DelegationSettingsClient) CreateOrUpdateResponder 

func (client DelegationSettingsClient) CreateOrUpdateResponder(resp *http.Response) (result PortalDelegationSettings, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (DelegationSettingsClient) CreateOrUpdateSender 

func (client DelegationSettingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (DelegationSettingsClient) Get 

func (client DelegationSettingsClient) Get(ctx context.Context, apimBaseURL string) (result PortalDelegationSettings, err error)

Get get Delegation settings.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (DelegationSettingsClient) GetPreparer 

func (client DelegationSettingsClient) GetPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DelegationSettingsClient) GetResponder 

func (client DelegationSettingsClient) GetResponder(resp *http.Response) (result PortalDelegationSettings, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (DelegationSettingsClient) GetSender 

func (client DelegationSettingsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (DelegationSettingsClient) Update 

func (client DelegationSettingsClient) Update(ctx context.Context, apimBaseURL string, parameters PortalDelegationSettings, ifMatch string) (result autorest.Response, err error)

Update update Delegation settings.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is update Delegation settings. ifMatch is the entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (DelegationSettingsClient) UpdatePreparer 

func (client DelegationSettingsClient) UpdatePreparer(ctx context.Context, apimBaseURL string, parameters PortalDelegationSettings, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DelegationSettingsClient) UpdateResponder 

func (client DelegationSettingsClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (DelegationSettingsClient) UpdateSender 

func (client DelegationSettingsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type DeployConfigurationParameters 

type DeployConfigurationParameters struct {
	// Branch - The name of the Git branch from which the configuration is to be deployed to the configuration database.
	Branch *string `json:"branch,omitempty"`
	// Force - The value enforcing deleting subscriptions to products that are deleted in this update.
	Force *bool `json:"force,omitempty"`
}

DeployConfigurationParameters parameters supplied to the Deploy Configuration operation.

type EmailTemplateClient 

type EmailTemplateClient struct {
	BaseClient
}

EmailTemplateClient is the client for the EmailTemplate methods of the Apimanagement service.

func NewEmailTemplateClient 

func NewEmailTemplateClient() EmailTemplateClient

NewEmailTemplateClient creates an instance of the EmailTemplateClient client.

func (EmailTemplateClient) CreateOrUpdate 

func (client EmailTemplateClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, templateName TemplateName, parameters EmailTemplateUpdateParameters) (result EmailTemplateContract, err error)

CreateOrUpdate updates an Email Template.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. templateName is email Template Name Identifier. parameters is email Template update parameters.

func (EmailTemplateClient) CreateOrUpdatePreparer 

func (client EmailTemplateClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, templateName TemplateName, parameters EmailTemplateUpdateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (EmailTemplateClient) CreateOrUpdateResponder 

func (client EmailTemplateClient) CreateOrUpdateResponder(resp *http.Response) (result EmailTemplateContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (EmailTemplateClient) CreateOrUpdateSender 

func (client EmailTemplateClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (EmailTemplateClient) Delete 

func (client EmailTemplateClient) Delete(ctx context.Context, apimBaseURL string, templateName TemplateName, ifMatch string) (result autorest.Response, err error)

Delete reset the Email Template to default template provided by the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. templateName is email Template Name Identifier. ifMatch is the entity state (Etag) version of the Email Template to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (EmailTemplateClient) DeletePreparer 

func (client EmailTemplateClient) DeletePreparer(ctx context.Context, apimBaseURL string, templateName TemplateName, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (EmailTemplateClient) DeleteResponder 

func (client EmailTemplateClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (EmailTemplateClient) DeleteSender 

func (client EmailTemplateClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (EmailTemplateClient) Get 

func (client EmailTemplateClient) Get(ctx context.Context, apimBaseURL string, templateName TemplateName) (result EmailTemplateContract, err error)

Get gets the details of the email template specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. templateName is email Template Name Identifier.

func (EmailTemplateClient) GetPreparer 

func (client EmailTemplateClient) GetPreparer(ctx context.Context, apimBaseURL string, templateName TemplateName) (*http.Request, error)

GetPreparer prepares the Get request.

func (EmailTemplateClient) GetResponder 

func (client EmailTemplateClient) GetResponder(resp *http.Response) (result EmailTemplateContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (EmailTemplateClient) GetSender 

func (client EmailTemplateClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (EmailTemplateClient) List 

func (client EmailTemplateClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result EmailTemplateCollectionPage, err error)

List lists a collection of properties defined within a service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |----------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (EmailTemplateClient) ListComplete 

func (client EmailTemplateClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result EmailTemplateCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (EmailTemplateClient) ListPreparer 

func (client EmailTemplateClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (EmailTemplateClient) ListResponder 

func (client EmailTemplateClient) ListResponder(resp *http.Response) (result EmailTemplateCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (EmailTemplateClient) ListSender 

func (client EmailTemplateClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (EmailTemplateClient) Update 

func (client EmailTemplateClient) Update(ctx context.Context, apimBaseURL string, templateName TemplateName, parameters EmailTemplateUpdateParameters) (result autorest.Response, err error)

Update updates the specific Email Template.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. templateName is email Template Name Identifier. parameters is update parameters.

func (EmailTemplateClient) UpdatePreparer 

func (client EmailTemplateClient) UpdatePreparer(ctx context.Context, apimBaseURL string, templateName TemplateName, parameters EmailTemplateUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (EmailTemplateClient) UpdateResponder 

func (client EmailTemplateClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (EmailTemplateClient) UpdateSender 

func (client EmailTemplateClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type EmailTemplateCollection 

type EmailTemplateCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]EmailTemplateContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

EmailTemplateCollection paged email template list representation.

func (EmailTemplateCollection) IsEmpty 

func (etc EmailTemplateCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EmailTemplateCollectionIterator 

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

EmailTemplateCollectionIterator provides access to a complete listing of EmailTemplateContract values.

func (*EmailTemplateCollectionIterator) Next 

func (iter *EmailTemplateCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (EmailTemplateCollectionIterator) NotDone 

func (iter EmailTemplateCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (EmailTemplateCollectionIterator) Response 

func (iter EmailTemplateCollectionIterator) Response() EmailTemplateCollection

Response returns the raw server response from the last page request.

func (EmailTemplateCollectionIterator) Value 

func (iter EmailTemplateCollectionIterator) Value() EmailTemplateContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type EmailTemplateCollectionPage 

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

EmailTemplateCollectionPage contains a page of EmailTemplateContract values.

func (*EmailTemplateCollectionPage) Next 

func (page *EmailTemplateCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (EmailTemplateCollectionPage) NotDone 

func (page EmailTemplateCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (EmailTemplateCollectionPage) Response 

func (page EmailTemplateCollectionPage) Response() EmailTemplateCollection

Response returns the raw server response from the last page request.

func (EmailTemplateCollectionPage) Values 

func (page EmailTemplateCollectionPage) Values() []EmailTemplateContract

Values returns the slice of values for the current page or nil if there are no values.

type EmailTemplateContract 

type EmailTemplateContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Template Contract.
	ID *string `json:"id,omitempty"`
	// Subject - Subject of the Template.
	Subject *string `json:"subject,omitempty"`
	// Body - Email Template Body. This should be a valid XDocument
	Body *string `json:"body,omitempty"`
	// Title - Title of the Template.
	Title *string `json:"title,omitempty"`
	// Description - Description of the Email Template.
	Description *string `json:"description,omitempty"`
	// IsDefault - Whether the template is the default template provided by Api Management or has been edited.
	IsDefault *bool `json:"isDefault,omitempty"`
	// Parameters - Email Template Parameter values.
	Parameters *[]EmailTemplateParametersContractProperties `json:"parameters,omitempty"`
}

EmailTemplateContract email Template details.

type EmailTemplateContractProperties 

type EmailTemplateContractProperties struct {
	// Subject - Subject of the Template.
	Subject *string `json:"subject,omitempty"`
	// Body - Email Template Body. This should be a valid XDocument
	Body *string `json:"body,omitempty"`
	// Title - Title of the Template.
	Title *string `json:"title,omitempty"`
	// Description - Description of the Email Template.
	Description *string `json:"description,omitempty"`
	// IsDefault - Whether the template is the default template provided by Api Management or has been edited.
	IsDefault *bool `json:"isDefault,omitempty"`
	// Parameters - Email Template Parameter values.
	Parameters *[]EmailTemplateParametersContractProperties `json:"parameters,omitempty"`
}

EmailTemplateContractProperties email Template Contract properties.

type EmailTemplateParametersContractProperties 

type EmailTemplateParametersContractProperties struct {
	// Name - Template parameter name.
	Name *string `json:"name,omitempty"`
	// Title - Template parameter title.
	Title *string `json:"title,omitempty"`
	// Description - Template parameter description.
	Description *string `json:"description,omitempty"`
}

EmailTemplateParametersContractProperties email Template Parameter contract.

type EmailTemplateUpdateParameters 

type EmailTemplateUpdateParameters struct {
	// Subject - Subject of the Template.
	Subject *string `json:"subject,omitempty"`
	// Title - Title of the Template.
	Title *string `json:"title,omitempty"`
	// Description - Description of the Email Template.
	Description *string `json:"description,omitempty"`
	// Body - Email Template Body. This should be a valid XDocument
	Body *string `json:"body,omitempty"`
	// Parameters - Email Template Parameter values.
	Parameters *[]EmailTemplateParametersContractProperties `json:"parameters,omitempty"`
}

EmailTemplateUpdateParameters email Template Update Contract properties.

type ErrorFieldContract 

type ErrorFieldContract struct {
	// Code - Property level error code.
	Code *string `json:"code,omitempty"`
	// Message - Human-readable representation of property-level error.
	Message *string `json:"message,omitempty"`
	// Target - Property name.
	Target *string `json:"target,omitempty"`
}

ErrorFieldContract error Field contract.

type ErrorResponse 

type ErrorResponse struct {
	// Code - 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"`
	// Message - Human-readable representation of the error.
	Message *string `json:"message,omitempty"`
	// Details - The list of invalid fields send in request, in case of validation error.
	Details *[]ErrorFieldContract `json:"details,omitempty"`
}

ErrorResponse error Body contract.

type GenerateSsoURLResult 

type GenerateSsoURLResult struct {
	autorest.Response `json:"-"`
	// Value - Redirect Url containing the SSO URL value.
	Value *string `json:"value,omitempty"`
}

GenerateSsoURLResult generate SSO Url operations response details.

type GrantType 

type GrantType string

GrantType enumerates the values for grant type. 

const (
	// AuthorizationCode Authorization Code Grant flow as described
	// https://tools.ietf.org/html/rfc6749#section-4.1.
	AuthorizationCode GrantType = "authorizationCode"
	// ClientCredentials Client Credentials Grant flow as described
	// https://tools.ietf.org/html/rfc6749#section-4.4.
	ClientCredentials GrantType = "clientCredentials"
	// Implicit Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
	Implicit GrantType = "implicit"
	// ResourceOwnerPassword Resource Owner Password Grant flow as described
	// https://tools.ietf.org/html/rfc6749#section-4.3.
	ResourceOwnerPassword GrantType = "resourceOwnerPassword"
)

func PossibleGrantTypeValues 

func PossibleGrantTypeValues() []GrantType

PossibleGrantTypeValues returns an array of possible values for the GrantType const type.

type GroupClient 

type GroupClient struct {
	BaseClient
}

GroupClient is the client for the Group methods of the Apimanagement service.

func NewGroupClient 

func NewGroupClient() GroupClient

NewGroupClient creates an instance of the GroupClient client.

func (GroupClient) CreateOrUpdate 

func (client GroupClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, groupID string, parameters GroupCreateParameters) (result GroupContract, err error)

CreateOrUpdate creates or Updates a group.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. groupID is group identifier. Must be unique in the current API Management service instance. parameters is create parameters.

func (GroupClient) CreateOrUpdatePreparer 

func (client GroupClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, groupID string, parameters GroupCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupClient) CreateOrUpdateResponder 

func (client GroupClient) CreateOrUpdateResponder(resp *http.Response) (result GroupContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (GroupClient) CreateOrUpdateSender 

func (client GroupClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Delete 

func (client GroupClient) Delete(ctx context.Context, apimBaseURL string, groupID string, ifMatch string) (result autorest.Response, err error)

Delete deletes specific group of the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. groupID is group identifier. Must be unique in the current API Management service instance. ifMatch is eTag of the Group Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (GroupClient) DeletePreparer 

func (client GroupClient) DeletePreparer(ctx context.Context, apimBaseURL string, groupID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GroupClient) DeleteResponder 

func (client GroupClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (GroupClient) DeleteSender 

func (client GroupClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Get 

func (client GroupClient) Get(ctx context.Context, apimBaseURL string, groupID string) (result GroupContract, err error)

Get gets the details of the group specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. groupID is group identifier. Must be unique in the current API Management service instance.

func (GroupClient) GetPreparer 

func (client GroupClient) GetPreparer(ctx context.Context, apimBaseURL string, groupID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (GroupClient) GetResponder 

func (client GroupClient) GetResponder(resp *http.Response) (result GroupContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (GroupClient) GetSender 

func (client GroupClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (GroupClient) List 

func (client GroupClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)

List lists a collection of groups defined within a service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq, ne | N/A | top is number of records to return. skip is number of records to skip.

func (GroupClient) ListComplete 

func (client GroupClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (GroupClient) ListPreparer 

func (client GroupClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (GroupClient) ListResponder 

func (client GroupClient) ListResponder(resp *http.Response) (result GroupCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (GroupClient) ListSender 

func (client GroupClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Update 

func (client GroupClient) Update(ctx context.Context, apimBaseURL string, groupID string, parameters GroupUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates the details of the group specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. groupID is group identifier. Must be unique in the current API Management service instance. parameters is update parameters. ifMatch is eTag of the Group Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (GroupClient) UpdatePreparer 

func (client GroupClient) UpdatePreparer(ctx context.Context, apimBaseURL string, groupID string, parameters GroupUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (GroupClient) UpdateResponder 

func (client GroupClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (GroupClient) UpdateSender 

func (client GroupClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type GroupCollection 

type GroupCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]GroupContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

GroupCollection paged Group list representation.

func (GroupCollection) IsEmpty 

func (gc GroupCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type GroupCollectionIterator 

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

GroupCollectionIterator provides access to a complete listing of GroupContract values.

func (*GroupCollectionIterator) Next 

func (iter *GroupCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (GroupCollectionIterator) NotDone 

func (iter GroupCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (GroupCollectionIterator) Response 

func (iter GroupCollectionIterator) Response() GroupCollection

Response returns the raw server response from the last page request.

func (GroupCollectionIterator) Value 

func (iter GroupCollectionIterator) Value() GroupContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type GroupCollectionPage 

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

GroupCollectionPage contains a page of GroupContract values.

func (*GroupCollectionPage) Next 

func (page *GroupCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (GroupCollectionPage) NotDone 

func (page GroupCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (GroupCollectionPage) Response 

func (page GroupCollectionPage) Response() GroupCollection

Response returns the raw server response from the last page request.

func (GroupCollectionPage) Values 

func (page GroupCollectionPage) Values() []GroupContract

Values returns the slice of values for the current page or nil if there are no values.

type GroupContract 

type GroupContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Group entity.
	ID *string `json:"id,omitempty"`
	// Name - Group name.
	Name *string `json:"name,omitempty"`
	// Description - Group description. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// BuiltIn - true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
	BuiltIn *bool `json:"builtIn,omitempty"`
	// Type - Group type. Possible values include: 'Custom', 'System', 'External'
	Type GroupType `json:"type,omitempty"`
	// ExternalID - 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"`
}

GroupContract contract details.

type GroupContractProperties 

type GroupContractProperties struct {
	// Name - Group name.
	Name *string `json:"name,omitempty"`
	// Description - Group description. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// BuiltIn - true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
	BuiltIn *bool `json:"builtIn,omitempty"`
	// Type - Group type. Possible values include: 'Custom', 'System', 'External'
	Type GroupType `json:"type,omitempty"`
	// ExternalID - 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"`
}

GroupContractProperties developer group.

type GroupCreateParameters 

type GroupCreateParameters struct {
	// Name - Group name.
	Name *string `json:"name,omitempty"`
	// Description - Group description.
	Description *string `json:"description,omitempty"`
	// Type - Group type. Possible values include: 'Custom', 'System', 'External'
	Type GroupType `json:"type,omitempty"`
	// ExternalID - 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"`
}

GroupCreateParameters parameters supplied to the Create Group operation.

type GroupType 

type GroupType string

GroupType enumerates the values for group type. 

const (
	// Custom ...
	Custom GroupType = "custom"
	// External ...
	External GroupType = "external"
	// System ...
	System GroupType = "system"
)

func PossibleGroupTypeValues 

func PossibleGroupTypeValues() []GroupType

PossibleGroupTypeValues returns an array of possible values for the GroupType const type.

type GroupUpdateParameters 

type GroupUpdateParameters struct {
	// Name - Group name.
	Name *string `json:"name,omitempty"`
	// Description - Group description.
	Description *string `json:"description,omitempty"`
	// Type - Group type. Possible values include: 'Custom', 'System', 'External'
	Type GroupType `json:"type,omitempty"`
	// ExternalID - 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"`
}

GroupUpdateParameters parameters supplied to the Update Group operation.

type GroupUserClient 

type GroupUserClient struct {
	BaseClient
}

GroupUserClient is the client for the GroupUser methods of the Apimanagement service.

func NewGroupUserClient 

func NewGroupUserClient() GroupUserClient

NewGroupUserClient creates an instance of the GroupUserClient client.

func (GroupUserClient) Create 

func (client GroupUserClient) Create(ctx context.Context, apimBaseURL string, groupID string, UID string) (result UserContract, err error)

Create adds a user to the specified group.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. groupID is group identifier. Must be unique in the current API Management service instance. UID is user identifier. Must be unique in the current API Management service instance.

func (GroupUserClient) CreatePreparer 

func (client GroupUserClient) CreatePreparer(ctx context.Context, apimBaseURL string, groupID string, UID string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (GroupUserClient) CreateResponder 

func (client GroupUserClient) CreateResponder(resp *http.Response) (result UserContract, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (GroupUserClient) CreateSender 

func (client GroupUserClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (GroupUserClient) Delete 

func (client GroupUserClient) Delete(ctx context.Context, apimBaseURL string, groupID string, UID string) (result autorest.Response, err error)

Delete remove existing user from existing group.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. groupID is group identifier. Must be unique in the current API Management service instance. UID is user identifier. Must be unique in the current API Management service instance.

func (GroupUserClient) DeletePreparer 

func (client GroupUserClient) DeletePreparer(ctx context.Context, apimBaseURL string, groupID string, UID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GroupUserClient) DeleteResponder 

func (client GroupUserClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (GroupUserClient) DeleteSender 

func (client GroupUserClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (GroupUserClient) List 

func (client GroupUserClient) List(ctx context.Context, apimBaseURL string, groupID string, filter string, top *int32, skip *int32) (result UserCollectionPage, err error)

List lists a collection of the members of the group, specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. groupID is group identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |------------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | N/A | | registrationDate | ge, le, eq, ne, gt, lt | N/A | | note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (GroupUserClient) ListComplete 

func (client GroupUserClient) ListComplete(ctx context.Context, apimBaseURL string, groupID string, filter string, top *int32, skip *int32) (result UserCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (GroupUserClient) ListPreparer 

func (client GroupUserClient) ListPreparer(ctx context.Context, apimBaseURL string, groupID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (GroupUserClient) ListResponder 

func (client GroupUserClient) ListResponder(resp *http.Response) (result UserCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (GroupUserClient) ListSender 

func (client GroupUserClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type IdentityProviderBaseParameters 

type IdentityProviderBaseParameters struct {
	// Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
	Type IdentityProviderType `json:"type,omitempty"`
	// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
	AllowedTenants *[]string `json:"allowedTenants,omitempty"`
	// SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
	SignupPolicyName *string `json:"signupPolicyName,omitempty"`
	// SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
	SigninPolicyName *string `json:"signinPolicyName,omitempty"`
	// ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
	ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
	// PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
	PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`
}

IdentityProviderBaseParameters identity Provider Base Parameter Properties.

type IdentityProviderClient 

type IdentityProviderClient struct {
	BaseClient
}

IdentityProviderClient is the client for the IdentityProvider methods of the Apimanagement service.

func NewIdentityProviderClient 

func NewIdentityProviderClient() IdentityProviderClient

NewIdentityProviderClient creates an instance of the IdentityProviderClient client.

func (IdentityProviderClient) CreateOrUpdate 

func (client IdentityProviderClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, identityProviderName IdentityProviderType, parameters IdentityProviderContract) (result IdentityProviderContract, err error)

CreateOrUpdate creates or Updates the IdentityProvider configuration.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. identityProviderName is identity Provider Type identifier. parameters is create parameters.

func (IdentityProviderClient) CreateOrUpdatePreparer 

func (client IdentityProviderClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, identityProviderName IdentityProviderType, parameters IdentityProviderContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (IdentityProviderClient) CreateOrUpdateResponder 

func (client IdentityProviderClient) CreateOrUpdateResponder(resp *http.Response) (result IdentityProviderContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (IdentityProviderClient) CreateOrUpdateSender 

func (client IdentityProviderClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (IdentityProviderClient) Delete 

func (client IdentityProviderClient) Delete(ctx context.Context, apimBaseURL string, identityProviderName IdentityProviderType, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified identity provider configuration.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. identityProviderName is identity Provider Type identifier. ifMatch is the entity state (Etag) version of the backend to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (IdentityProviderClient) DeletePreparer 

func (client IdentityProviderClient) DeletePreparer(ctx context.Context, apimBaseURL string, identityProviderName IdentityProviderType, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (IdentityProviderClient) DeleteResponder 

func (client IdentityProviderClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (IdentityProviderClient) DeleteSender 

func (client IdentityProviderClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (IdentityProviderClient) Get 

func (client IdentityProviderClient) Get(ctx context.Context, apimBaseURL string, identityProviderName IdentityProviderType) (result IdentityProviderContract, err error)

Get gets the configuration details of the identity Provider configured in specified service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. identityProviderName is identity Provider Type identifier.

func (IdentityProviderClient) GetPreparer 

func (client IdentityProviderClient) GetPreparer(ctx context.Context, apimBaseURL string, identityProviderName IdentityProviderType) (*http.Request, error)

GetPreparer prepares the Get request.

func (IdentityProviderClient) GetResponder 

func (client IdentityProviderClient) GetResponder(resp *http.Response) (result IdentityProviderContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (IdentityProviderClient) GetSender 

func (client IdentityProviderClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (IdentityProviderClient) List 

func (client IdentityProviderClient) List(ctx context.Context, apimBaseURL string) (result IdentityProviderList, err error)

List lists a collection of Identity Provider configured in the specified service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (IdentityProviderClient) ListPreparer 

func (client IdentityProviderClient) ListPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

ListPreparer prepares the List request.

func (IdentityProviderClient) ListResponder 

func (client IdentityProviderClient) ListResponder(resp *http.Response) (result IdentityProviderList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (IdentityProviderClient) ListSender 

func (client IdentityProviderClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (IdentityProviderClient) Update 

func (client IdentityProviderClient) Update(ctx context.Context, apimBaseURL string, identityProviderName IdentityProviderType, parameters IdentityProviderUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates an existing IdentityProvider configuration.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. identityProviderName is identity Provider Type identifier. parameters is update parameters. ifMatch is the entity state (Etag) version of the identity provider configuration to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (IdentityProviderClient) UpdatePreparer 

func (client IdentityProviderClient) UpdatePreparer(ctx context.Context, apimBaseURL string, identityProviderName IdentityProviderType, parameters IdentityProviderUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (IdentityProviderClient) UpdateResponder 

func (client IdentityProviderClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (IdentityProviderClient) UpdateSender 

func (client IdentityProviderClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type IdentityProviderContract 

type IdentityProviderContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the identity provider.
	ID *string `json:"id,omitempty"`
	// ClientID - 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"`
	// ClientSecret - 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"`
	// Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
	Type IdentityProviderType `json:"type,omitempty"`
	// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
	AllowedTenants *[]string `json:"allowedTenants,omitempty"`
	// SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
	SignupPolicyName *string `json:"signupPolicyName,omitempty"`
	// SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
	SigninPolicyName *string `json:"signinPolicyName,omitempty"`
	// ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
	ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
	// PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
	PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`
}

IdentityProviderContract identity Provider details.

type IdentityProviderContractProperties 

type IdentityProviderContractProperties struct {
	// ClientID - 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"`
	// ClientSecret - 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"`
	// Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
	Type IdentityProviderType `json:"type,omitempty"`
	// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
	AllowedTenants *[]string `json:"allowedTenants,omitempty"`
	// SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
	SignupPolicyName *string `json:"signupPolicyName,omitempty"`
	// SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
	SigninPolicyName *string `json:"signinPolicyName,omitempty"`
	// ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
	ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
	// PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
	PasswordResetPolicyName *string `json:"passwordResetPolicyName,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.

type IdentityProviderList 

type IdentityProviderList struct {
	autorest.Response `json:"-"`
	// Value - Identity Provider configuration values.
	Value *[]IdentityProviderContract `json:"value,omitempty"`
	// Count - Total number of identity providers
	Count *int32 `json:"count,omitempty"`
}

IdentityProviderList list of all the Identity Providers configured on the service instance.

type IdentityProviderType 

type IdentityProviderType string

IdentityProviderType enumerates the values for identity provider type. 

const (
	// Aad Azure Active Directory as Identity provider.
	Aad IdentityProviderType = "aad"
	// AadB2C Azure Active Directory B2C as Identity provider.
	AadB2C IdentityProviderType = "aadB2C"
	// Facebook Facebook as Identity provider.
	Facebook IdentityProviderType = "facebook"
	// Google Google as Identity provider.
	Google IdentityProviderType = "google"
	// Microsoft Microsoft Live as Identity provider.
	Microsoft IdentityProviderType = "microsoft"
	// Twitter Twitter as Identity provider.
	Twitter IdentityProviderType = "twitter"
)

func PossibleIdentityProviderTypeValues 

func PossibleIdentityProviderTypeValues() []IdentityProviderType

PossibleIdentityProviderTypeValues returns an array of possible values for the IdentityProviderType const type.

type IdentityProviderUpdateParameters 

type IdentityProviderUpdateParameters struct {
	// ClientID - 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"`
	// ClientSecret - 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"`
	// Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
	Type IdentityProviderType `json:"type,omitempty"`
	// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
	AllowedTenants *[]string `json:"allowedTenants,omitempty"`
	// SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
	SignupPolicyName *string `json:"signupPolicyName,omitempty"`
	// SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
	SigninPolicyName *string `json:"signinPolicyName,omitempty"`
	// ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
	ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
	// PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
	PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`
}

IdentityProviderUpdateParameters parameters supplied to the Update Identity Provider operation.

type KeyType 

type KeyType string

KeyType enumerates the values for key type. 

const (
	// Primary ...
	Primary KeyType = "primary"
	// Secondary ...
	Secondary KeyType = "secondary"
)

func PossibleKeyTypeValues 

func PossibleKeyTypeValues() []KeyType

PossibleKeyTypeValues returns an array of possible values for the KeyType const type.

type LoggerClient 

type LoggerClient struct {
	BaseClient
}

LoggerClient is the client for the Logger methods of the Apimanagement service.

func NewLoggerClient 

func NewLoggerClient() LoggerClient

NewLoggerClient creates an instance of the LoggerClient client.

func (LoggerClient) CreateOrUpdate 

func (client LoggerClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, loggerid string, parameters LoggerContract) (result LoggerContract, err error)

CreateOrUpdate creates or Updates a logger.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. loggerid is logger identifier. Must be unique in the API Management service instance. parameters is create parameters.

func (LoggerClient) CreateOrUpdatePreparer 

func (client LoggerClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, loggerid string, parameters LoggerContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (LoggerClient) CreateOrUpdateResponder 

func (client LoggerClient) CreateOrUpdateResponder(resp *http.Response) (result LoggerContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (LoggerClient) CreateOrUpdateSender 

func (client LoggerClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (LoggerClient) Delete 

func (client LoggerClient) Delete(ctx context.Context, apimBaseURL string, loggerid string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified logger.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. loggerid is logger identifier. Must be unique in the API Management service instance. ifMatch is the entity state (Etag) version of the logger to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (LoggerClient) DeletePreparer 

func (client LoggerClient) DeletePreparer(ctx context.Context, apimBaseURL string, loggerid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (LoggerClient) DeleteResponder 

func (client LoggerClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (LoggerClient) DeleteSender 

func (client LoggerClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (LoggerClient) Get 

func (client LoggerClient) Get(ctx context.Context, apimBaseURL string, loggerid string) (result LoggerContract, err error)

Get gets the details of the logger specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. loggerid is logger identifier. Must be unique in the API Management service instance.

func (LoggerClient) GetPreparer 

func (client LoggerClient) GetPreparer(ctx context.Context, apimBaseURL string, loggerid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (LoggerClient) GetResponder 

func (client LoggerClient) GetResponder(resp *http.Response) (result LoggerContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (LoggerClient) GetSender 

func (client LoggerClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (LoggerClient) List 

func (client LoggerClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result LoggerCollectionPage, err error)

List lists a collection of loggers in the specified service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq | | top is number of records to return. skip is number of records to skip.

func (LoggerClient) ListComplete 

func (client LoggerClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result LoggerCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (LoggerClient) ListPreparer 

func (client LoggerClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (LoggerClient) ListResponder 

func (client LoggerClient) ListResponder(resp *http.Response) (result LoggerCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (LoggerClient) ListSender 

func (client LoggerClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (LoggerClient) Update 

func (client LoggerClient) Update(ctx context.Context, apimBaseURL string, loggerid string, parameters LoggerUpdateContract, ifMatch string) (result autorest.Response, err error)

Update updates an existing logger.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. loggerid is logger identifier. Must be unique in the API Management service instance. parameters is update parameters. ifMatch is the entity state (Etag) version of the logger to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (LoggerClient) UpdatePreparer 

func (client LoggerClient) UpdatePreparer(ctx context.Context, apimBaseURL string, loggerid string, parameters LoggerUpdateContract, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (LoggerClient) UpdateResponder 

func (client LoggerClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (LoggerClient) UpdateSender 

func (client LoggerClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type LoggerCollection 

type LoggerCollection struct {
	autorest.Response `json:"-"`
	// Value - Logger values.
	Value *[]LoggerContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

LoggerCollection paged Logger list representation.

func (LoggerCollection) IsEmpty 

func (lc LoggerCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type LoggerCollectionIterator 

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

LoggerCollectionIterator provides access to a complete listing of LoggerContract values.

func (*LoggerCollectionIterator) Next 

func (iter *LoggerCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (LoggerCollectionIterator) NotDone 

func (iter LoggerCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (LoggerCollectionIterator) Response 

func (iter LoggerCollectionIterator) Response() LoggerCollection

Response returns the raw server response from the last page request.

func (LoggerCollectionIterator) Value 

func (iter LoggerCollectionIterator) Value() LoggerContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type LoggerCollectionPage 

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

LoggerCollectionPage contains a page of LoggerContract values.

func (*LoggerCollectionPage) Next 

func (page *LoggerCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (LoggerCollectionPage) NotDone 

func (page LoggerCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (LoggerCollectionPage) Response 

func (page LoggerCollectionPage) Response() LoggerCollection

Response returns the raw server response from the last page request.

func (LoggerCollectionPage) Values 

func (page LoggerCollectionPage) Values() []LoggerContract

Values returns the slice of values for the current page or nil if there are no values.

type LoggerContract 

type LoggerContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Logger Entity.
	ID *string `json:"id,omitempty"`
	// LoggerType - Logger type.
	LoggerType *string `json:"loggerType,omitempty"`
	// Description - Logger description.
	Description *string `json:"description,omitempty"`
	// Credentials - The name and SendRule connection string of the event hub.
	Credentials map[string]*string `json:"credentials"`
	// IsBuffered - Whether records are buffered in the logger before publishing. Default is assumed to be true.
	IsBuffered *bool `json:"isBuffered,omitempty"`
}

LoggerContract logger details.

func (LoggerContract) MarshalJSON 

func (lc LoggerContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LoggerContract.

type LoggerContractProperties 

type LoggerContractProperties struct {
	// LoggerType - Logger type.
	LoggerType *string `json:"loggerType,omitempty"`
	// Description - Logger description.
	Description *string `json:"description,omitempty"`
	// Credentials - The name and SendRule connection string of the event hub.
	Credentials map[string]*string `json:"credentials"`
	// IsBuffered - Whether records are buffered in the logger before publishing. Default is assumed to be true.
	IsBuffered *bool `json:"isBuffered,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 (lcp LoggerContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LoggerContractProperties.

type LoggerType 

type LoggerType string

LoggerType enumerates the values for logger type. 

const (
	// AzureEventHub Azure Event Hub as log destination.
	AzureEventHub LoggerType = "azureEventHub"
)

func PossibleLoggerTypeValues 

func PossibleLoggerTypeValues() []LoggerType

PossibleLoggerTypeValues returns an array of possible values for the LoggerType const type.

type LoggerUpdateContract 

type LoggerUpdateContract struct {
	// LoggerType - Logger type. Possible values include: 'AzureEventHub'
	LoggerType LoggerType `json:"loggerType,omitempty"`
	// Description - Logger description.
	Description *string `json:"description,omitempty"`
	// Credentials - Logger credentials.
	Credentials map[string]*string `json:"credentials"`
	// IsBuffered - Whether records are buffered in the logger before publishing. Default is assumed to be true.
	IsBuffered *bool `json:"isBuffered,omitempty"`
}

LoggerUpdateContract parameters supplied to the Update Logger operation.

func (LoggerUpdateContract) MarshalJSON 

func (luc LoggerUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LoggerUpdateContract.

type OAuth2AuthenticationSettingsContract 

type OAuth2AuthenticationSettingsContract struct {
	// AuthorizationServerID - OAuth authorization server identifier.
	AuthorizationServerID *string `json:"authorizationServerId,omitempty"`
	// Scope - operations scope.
	Scope *string `json:"scope,omitempty"`
}

OAuth2AuthenticationSettingsContract API OAuth2 Authentication settings details.

type OpenIDConnectProviderClient 

type OpenIDConnectProviderClient struct {
	BaseClient
}

OpenIDConnectProviderClient is the client for the OpenIDConnectProvider methods of the Apimanagement service.

func NewOpenIDConnectProviderClient 

func NewOpenIDConnectProviderClient() OpenIDConnectProviderClient

NewOpenIDConnectProviderClient creates an instance of the OpenIDConnectProviderClient client.

func (OpenIDConnectProviderClient) CreateOrUpdate 

func (client OpenIDConnectProviderClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, opid string, parameters OpenidConnectProviderContract) (result OpenidConnectProviderContract, err error)

CreateOrUpdate creates or updates the OpenID Connect Provider.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. opid is identifier of the OpenID Connect Provider. parameters is create parameters.

func (OpenIDConnectProviderClient) CreateOrUpdatePreparer 

func (client OpenIDConnectProviderClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, opid string, parameters OpenidConnectProviderContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (OpenIDConnectProviderClient) CreateOrUpdateResponder 

func (client OpenIDConnectProviderClient) CreateOrUpdateResponder(resp *http.Response) (result OpenidConnectProviderContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (OpenIDConnectProviderClient) CreateOrUpdateSender 

func (client OpenIDConnectProviderClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (OpenIDConnectProviderClient) Delete 

func (client OpenIDConnectProviderClient) Delete(ctx context.Context, apimBaseURL string, opid string, ifMatch string) (result autorest.Response, err error)

Delete deletes specific OpenID Connect Provider of the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. opid is identifier of the OpenID Connect Provider. ifMatch is the entity state (Etag) version of the OpenID Connect Provider to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (OpenIDConnectProviderClient) DeletePreparer 

func (client OpenIDConnectProviderClient) DeletePreparer(ctx context.Context, apimBaseURL string, opid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (OpenIDConnectProviderClient) DeleteResponder 

func (client OpenIDConnectProviderClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (OpenIDConnectProviderClient) DeleteSender 

func (client OpenIDConnectProviderClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (OpenIDConnectProviderClient) Get 

func (client OpenIDConnectProviderClient) Get(ctx context.Context, apimBaseURL string, opid string) (result OpenidConnectProviderContract, err error)

Get gets specific OpenID Connect Provider.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. opid is identifier of the OpenID Connect Provider.

func (OpenIDConnectProviderClient) GetPreparer 

func (client OpenIDConnectProviderClient) GetPreparer(ctx context.Context, apimBaseURL string, opid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (OpenIDConnectProviderClient) GetResponder 

func (client OpenIDConnectProviderClient) GetResponder(resp *http.Response) (result OpenidConnectProviderContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (OpenIDConnectProviderClient) GetSender 

func (client OpenIDConnectProviderClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (OpenIDConnectProviderClient) List 

func (client OpenIDConnectProviderClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result OpenIDConnectProviderCollectionPage, err error)

List lists all OpenID Connect Providers.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (OpenIDConnectProviderClient) ListComplete 

func (client OpenIDConnectProviderClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result OpenIDConnectProviderCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OpenIDConnectProviderClient) ListPreparer 

func (client OpenIDConnectProviderClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (OpenIDConnectProviderClient) ListResponder 

func (client OpenIDConnectProviderClient) ListResponder(resp *http.Response) (result OpenIDConnectProviderCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OpenIDConnectProviderClient) ListSender 

func (client OpenIDConnectProviderClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (OpenIDConnectProviderClient) Update 

func (client OpenIDConnectProviderClient) Update(ctx context.Context, apimBaseURL string, opid string, parameters OpenidConnectProviderUpdateContract, ifMatch string) (result autorest.Response, err error)

Update updates the specific OpenID Connect Provider.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. opid is identifier of the OpenID Connect Provider. parameters is update parameters. ifMatch is the entity state (Etag) version of the OpenID Connect Provider to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (OpenIDConnectProviderClient) UpdatePreparer 

func (client OpenIDConnectProviderClient) UpdatePreparer(ctx context.Context, apimBaseURL string, opid string, parameters OpenidConnectProviderUpdateContract, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (OpenIDConnectProviderClient) UpdateResponder 

func (client OpenIDConnectProviderClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (OpenIDConnectProviderClient) UpdateSender 

func (client OpenIDConnectProviderClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type OpenIDConnectProviderCollection 

type OpenIDConnectProviderCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]OpenidConnectProviderContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

OpenIDConnectProviderCollection paged OpenIdProviders list representation.

func (OpenIDConnectProviderCollection) IsEmpty 

func (oicpc OpenIDConnectProviderCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OpenIDConnectProviderCollectionIterator 

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

OpenIDConnectProviderCollectionIterator provides access to a complete listing of OpenidConnectProviderContract values.

func (*OpenIDConnectProviderCollectionIterator) Next 

func (iter *OpenIDConnectProviderCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OpenIDConnectProviderCollectionIterator) NotDone 

func (iter OpenIDConnectProviderCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OpenIDConnectProviderCollectionIterator) Response 

func (iter OpenIDConnectProviderCollectionIterator) Response() OpenIDConnectProviderCollection

Response returns the raw server response from the last page request.

func (OpenIDConnectProviderCollectionIterator) Value 

func (iter OpenIDConnectProviderCollectionIterator) Value() OpenidConnectProviderContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OpenIDConnectProviderCollectionPage 

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

OpenIDConnectProviderCollectionPage contains a page of OpenidConnectProviderContract values.

func (*OpenIDConnectProviderCollectionPage) Next 

func (page *OpenIDConnectProviderCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OpenIDConnectProviderCollectionPage) NotDone 

func (page OpenIDConnectProviderCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OpenIDConnectProviderCollectionPage) Response 

func (page OpenIDConnectProviderCollectionPage) Response() OpenIDConnectProviderCollection

Response returns the raw server response from the last page request.

func (OpenIDConnectProviderCollectionPage) Values 

func (page OpenIDConnectProviderCollectionPage) Values() []OpenidConnectProviderContract

Values returns the slice of values for the current page or nil if there are no values.

type OpenidConnectProviderContract 

type OpenidConnectProviderContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the OpenId Connect Provider.
	ID *string `json:"id,omitempty"`
	// Name - User-friendly OpenID Connect Provider name.
	Name *string `json:"name,omitempty"`
	// Description - User-friendly description of OpenID Connect Provider.
	Description *string `json:"description,omitempty"`
	// MetadataEndpoint - Metadata endpoint URI.
	MetadataEndpoint *string `json:"metadataEndpoint,omitempty"`
	// ClientID - Client ID of developer console which is the client application.
	ClientID *string `json:"clientId,omitempty"`
	// ClientSecret - Client Secret of developer console which is the client application.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

OpenidConnectProviderContract openId Connect Provider details.

type OpenidConnectProviderContractProperties 

type OpenidConnectProviderContractProperties struct {
	// Name - User-friendly OpenID Connect Provider name.
	Name *string `json:"name,omitempty"`
	// Description - User-friendly description of OpenID Connect Provider.
	Description *string `json:"description,omitempty"`
	// MetadataEndpoint - Metadata endpoint URI.
	MetadataEndpoint *string `json:"metadataEndpoint,omitempty"`
	// ClientID - Client ID of developer console which is the client application.
	ClientID *string `json:"clientId,omitempty"`
	// ClientSecret - Client Secret of developer console which is the client application.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

OpenidConnectProviderContractProperties openID Connect Providers Contract.

type OpenidConnectProviderUpdateContract 

type OpenidConnectProviderUpdateContract struct {
	// Name - User-friendly OpenID Connect Provider name.
	Name *string `json:"name,omitempty"`
	// Description - User-friendly description of OpenID Connect Provider.
	Description *string `json:"description,omitempty"`
	// MetadataEndpoint - Metadata endpoint URI.
	MetadataEndpoint *string `json:"metadataEndpoint,omitempty"`
	// ClientID - Client ID of developer console which is the client application.
	ClientID *string `json:"clientId,omitempty"`
	// ClientSecret - Client Secret of developer console which is the client application.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

OpenidConnectProviderUpdateContract parameters supplied to the Update OpenID Connect Provider operation.

type OperationCollection 

type OperationCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]OperationContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationCollection paged Operation list representation.

func (OperationCollection) IsEmpty 

func (oc OperationCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationCollectionIterator 

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

OperationCollectionIterator provides access to a complete listing of OperationContract values.

func (*OperationCollectionIterator) Next 

func (iter *OperationCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationCollectionIterator) NotDone 

func (iter OperationCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationCollectionIterator) Response 

func (iter OperationCollectionIterator) Response() OperationCollection

Response returns the raw server response from the last page request.

func (OperationCollectionIterator) Value 

func (iter OperationCollectionIterator) Value() OperationContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationCollectionPage 

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

OperationCollectionPage contains a page of OperationContract values.

func (*OperationCollectionPage) Next 

func (page *OperationCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationCollectionPage) NotDone 

func (page OperationCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationCollectionPage) Response 

func (page OperationCollectionPage) Response() OperationCollection

Response returns the raw server response from the last page request.

func (OperationCollectionPage) Values 

func (page OperationCollectionPage) Values() []OperationContract

Values returns the slice of values for the current page or nil if there are no values.

type OperationContract 

type OperationContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Operation.
	ID *string `json:"id,omitempty"`
	// Name - Operation Name.
	Name *string `json:"name,omitempty"`
	// Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
	Method *string `json:"method,omitempty"`
	// URLTemplate - 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"`
	// TemplateParameters - Collection of URL template parameters.
	TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
	// Description - Description of the operation. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Request - An entity containing request details.
	Request *RequestContract `json:"request,omitempty"`
	// Responses - Array of Operation responses.
	Responses *[]ResponseContract `json:"responses,omitempty"`
	// Policies - Operation Policies
	Policies *string `json:"policies,omitempty"`
}

OperationContract api Operation details.

type OperationContractProperties 

type OperationContractProperties struct {
	// Name - Operation Name.
	Name *string `json:"name,omitempty"`
	// Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
	Method *string `json:"method,omitempty"`
	// URLTemplate - 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"`
	// TemplateParameters - Collection of URL template parameters.
	TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
	// Description - Description of the operation. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Request - An entity containing request details.
	Request *RequestContract `json:"request,omitempty"`
	// Responses - Array of Operation responses.
	Responses *[]ResponseContract `json:"responses,omitempty"`
	// Policies - Operation Policies
	Policies *string `json:"policies,omitempty"`
}

OperationContractProperties operation Contract Properties

type OperationEntityBaseContract 

type OperationEntityBaseContract struct {
	// TemplateParameters - Collection of URL template parameters.
	TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
	// Description - Description of the operation. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Request - An entity containing request details.
	Request *RequestContract `json:"request,omitempty"`
	// Responses - Array of Operation responses.
	Responses *[]ResponseContract `json:"responses,omitempty"`
	// Policies - Operation Policies
	Policies *string `json:"policies,omitempty"`
}

OperationEntityBaseContract api Operation Entity Base Contract details.

type OperationResultContract 

type OperationResultContract struct {
	autorest.Response `json:"-"`
	// ID - Operation result identifier.
	ID *string `json:"id,omitempty"`
	// Status - Status of an async operation. Possible values include: 'Started', 'InProgress', 'Succeeded', 'Failed'
	Status AsyncOperationStatus `json:"status,omitempty"`
	// Started - 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 *date.Time `json:"started,omitempty"`
	// Updated - 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 *date.Time `json:"updated,omitempty"`
	// ResultInfo - Optional result info.
	ResultInfo *string `json:"resultInfo,omitempty"`
	// Error - Error Body Contract
	Error *ErrorResponse `json:"error,omitempty"`
	// ActionLog - This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation.
	ActionLog *[]OperationResultLogItemContract `json:"actionLog,omitempty"`
}

OperationResultContract operation Result.

type OperationResultLogItemContract 

type OperationResultLogItemContract struct {
	// ObjectType - The type of entity contract.
	ObjectType *string `json:"objectType,omitempty"`
	// Action - Action like create/update/delete.
	Action *string `json:"action,omitempty"`
	// ObjectKey - Identifier of the entity being created/updated/deleted.
	ObjectKey *string `json:"objectKey,omitempty"`
}

OperationResultLogItemContract log of the entity being created, updated or deleted.

type OperationUpdateContract 

type OperationUpdateContract struct {
	// Name - Operation Name.
	Name *string `json:"name,omitempty"`
	// Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
	Method *string `json:"method,omitempty"`
	// URLTemplate - 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"`
	// TemplateParameters - Collection of URL template parameters.
	TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
	// Description - Description of the operation. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Request - An entity containing request details.
	Request *RequestContract `json:"request,omitempty"`
	// Responses - Array of Operation responses.
	Responses *[]ResponseContract `json:"responses,omitempty"`
	// Policies - Operation Policies
	Policies *string `json:"policies,omitempty"`
}

OperationUpdateContract operation Update Contract Properties.

type ParameterContract 

type ParameterContract struct {
	// Name - Parameter name.
	Name *string `json:"name,omitempty"`
	// Description - Parameter description.
	Description *string `json:"description,omitempty"`
	// Type - Parameter type.
	Type *string `json:"type,omitempty"`
	// DefaultValue - Default parameter value.
	DefaultValue *string `json:"defaultValue,omitempty"`
	// Required - whether parameter is required or not.
	Required *bool `json:"required,omitempty"`
	// Values - Parameter values.
	Values *[]string `json:"values,omitempty"`
}

ParameterContract operation parameters details.

type PolicyClient 

type PolicyClient struct {
	BaseClient
}

PolicyClient is the client for the Policy methods of the Apimanagement service.

func NewPolicyClient 

func NewPolicyClient() PolicyClient

NewPolicyClient creates an instance of the PolicyClient client.

func (PolicyClient) CreateOrUpdate 

func (client PolicyClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, parameters PolicyContract) (result PolicyContract, err error)

CreateOrUpdate creates or updates the global policy configuration of the Api Management service.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is the policy contents to apply.

func (PolicyClient) CreateOrUpdatePreparer 

func (client PolicyClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, parameters PolicyContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PolicyClient) CreateOrUpdateResponder 

func (client PolicyClient) CreateOrUpdateResponder(resp *http.Response) (result PolicyContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (PolicyClient) CreateOrUpdateSender 

func (client PolicyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (PolicyClient) Delete 

func (client PolicyClient) Delete(ctx context.Context, apimBaseURL string, ifMatch string) (result autorest.Response, err error)

Delete deletes the global policy configuration of the Api Management Service.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. ifMatch is the entity state (Etag) version of the policy to be deleted. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (PolicyClient) DeletePreparer 

func (client PolicyClient) DeletePreparer(ctx context.Context, apimBaseURL string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PolicyClient) DeleteResponder 

func (client PolicyClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (PolicyClient) DeleteSender 

func (client PolicyClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (PolicyClient) Get 

func (client PolicyClient) Get(ctx context.Context, apimBaseURL string) (result PolicyContract, err error)

Get get the Global policy definition of the Api Management service.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (PolicyClient) GetPreparer 

func (client PolicyClient) GetPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PolicyClient) GetResponder 

func (client PolicyClient) GetResponder(resp *http.Response) (result PolicyContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PolicyClient) GetSender 

func (client PolicyClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (PolicyClient) List 

func (client PolicyClient) List(ctx context.Context, apimBaseURL string, scope PolicyScopeContract) (result PolicyCollection, err error)

List lists all the Global Policy definitions of the Api Management service.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. scope is policy scope.

func (PolicyClient) ListPreparer 

func (client PolicyClient) ListPreparer(ctx context.Context, apimBaseURL string, scope PolicyScopeContract) (*http.Request, error)

ListPreparer prepares the List request.

func (PolicyClient) ListResponder 

func (client PolicyClient) ListResponder(resp *http.Response) (result PolicyCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (PolicyClient) ListSender 

func (client PolicyClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type PolicyCollection 

type PolicyCollection struct {
	autorest.Response `json:"-"`
	// Value - Policy Contract value.
	Value *[]PolicyContract `json:"value,omitempty"`
	// Count - Total number of records
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

PolicyCollection the response of the list policy operation.

type PolicyContract 

type PolicyContract struct {
	autorest.Response `json:"-"`
	// ID - Policy identifier.
	ID *string `json:"id,omitempty"`
	// PolicyContent - Json escaped Xml Encoded contents of the Policy.
	PolicyContent *string `json:"policyContent,omitempty"`
}

PolicyContract policy contract Properties.

type PolicyScopeContract 

type PolicyScopeContract string

PolicyScopeContract enumerates the values for policy scope contract. 

const (
	// All ...
	All PolicyScopeContract = "All"
	// API ...
	API PolicyScopeContract = "Api"
	// Operation ...
	Operation PolicyScopeContract = "Operation"
	// Product ...
	Product PolicyScopeContract = "Product"
	// Tenant ...
	Tenant PolicyScopeContract = "Tenant"
)

func PossiblePolicyScopeContractValues 

func PossiblePolicyScopeContractValues() []PolicyScopeContract

PossiblePolicyScopeContractValues returns an array of possible values for the PolicyScopeContract const type.

type PolicySnippetContract 

type PolicySnippetContract struct {
	// Name - Snippet name.
	Name *string `json:"name,omitempty"`
	// Content - Snippet content.
	Content *string `json:"content,omitempty"`
	// ToolTip - Snippet toolTip.
	ToolTip *string `json:"toolTip,omitempty"`
	// Scope - Binary OR value of the Snippet scope.
	Scope *int32 `json:"scope,omitempty"`
}

PolicySnippetContract policy snippet.

type PolicySnippetsClient 

type PolicySnippetsClient struct {
	BaseClient
}

PolicySnippetsClient is the client for the PolicySnippets methods of the Apimanagement service.

func NewPolicySnippetsClient 

func NewPolicySnippetsClient() PolicySnippetsClient

NewPolicySnippetsClient creates an instance of the PolicySnippetsClient client.

func (PolicySnippetsClient) List 

func (client PolicySnippetsClient) List(ctx context.Context, apimBaseURL string, scope PolicyScopeContract) (result PolicySnippetsCollection, err error)

List lists all policy snippets.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. scope is policy scope.

func (PolicySnippetsClient) ListPreparer 

func (client PolicySnippetsClient) ListPreparer(ctx context.Context, apimBaseURL string, scope PolicyScopeContract) (*http.Request, error)

ListPreparer prepares the List request.

func (PolicySnippetsClient) ListResponder 

func (client PolicySnippetsClient) ListResponder(resp *http.Response) (result PolicySnippetsCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (PolicySnippetsClient) ListSender 

func (client PolicySnippetsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type PolicySnippetsCollection 

type PolicySnippetsCollection struct {
	autorest.Response `json:"-"`
	// Value - Policy snippet value.
	Value *[]PolicySnippetContract `json:"value,omitempty"`
}

PolicySnippetsCollection the response of the list policy snippets operation.

type PortalDelegationSettings 

type PortalDelegationSettings struct {
	autorest.Response `json:"-"`
	// URL - A delegation Url.
	URL *string `json:"url,omitempty"`
	// ValidationKey - A base64-encoded validation key to validate, that a request is coming from Azure API Management.
	ValidationKey *string `json:"validationKey,omitempty"`
	// Subscriptions - Subscriptions delegation settings.
	Subscriptions *SubscriptionsDelegationSettingsProperties `json:"subscriptions,omitempty"`
	// UserRegistration - User registration delegation settings.
	UserRegistration *RegistrationDelegationSettingsProperties `json:"userRegistration,omitempty"`
}

PortalDelegationSettings delegation settings for a developer portal.

type PortalSigninSettings 

type PortalSigninSettings struct {
	autorest.Response `json:"-"`
	// Enabled - Redirect Anonymous users to the Sign-In page.
	Enabled *bool `json:"enabled,omitempty"`
}

PortalSigninSettings sign-In settings for the Developer Portal.

type PortalSignupSettings 

type PortalSignupSettings struct {
	autorest.Response `json:"-"`
	// Enabled - Allow users to sign up on a developer portal.
	Enabled *bool `json:"enabled,omitempty"`
	// TermsOfService - Terms of service contract properties.
	TermsOfService *TermsOfServiceProperties `json:"termsOfService,omitempty"`
}

PortalSignupSettings sign-up settings contract properties.

type ProductAPIClient 

type ProductAPIClient struct {
	BaseClient
}

ProductAPIClient is the client for the ProductAPI methods of the Apimanagement service.

func NewProductAPIClient 

func NewProductAPIClient() ProductAPIClient

NewProductAPIClient creates an instance of the ProductAPIClient client.

func (ProductAPIClient) CreateOrUpdate 

func (client ProductAPIClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, productID string, apiid string) (result APIContract, err error)

CreateOrUpdate adds an API to the specified product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. apiid is API identifier. Must be unique in the current API Management service instance.

func (ProductAPIClient) CreateOrUpdatePreparer 

func (client ProductAPIClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, productID string, apiid string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductAPIClient) CreateOrUpdateResponder 

func (client ProductAPIClient) CreateOrUpdateResponder(resp *http.Response) (result APIContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ProductAPIClient) CreateOrUpdateSender 

func (client ProductAPIClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ProductAPIClient) Delete 

func (client ProductAPIClient) Delete(ctx context.Context, apimBaseURL string, productID string, apiid string) (result autorest.Response, err error)

Delete deletes the specified API from the specified product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. apiid is API identifier. Must be unique in the current API Management service instance.

func (ProductAPIClient) DeletePreparer 

func (client ProductAPIClient) DeletePreparer(ctx context.Context, apimBaseURL string, productID string, apiid string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProductAPIClient) DeleteResponder 

func (client ProductAPIClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ProductAPIClient) DeleteSender 

func (client ProductAPIClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ProductAPIClient) ListByProduct 

func (client ProductAPIClient) ListByProduct(ctx context.Context, apimBaseURL string, productID string, filter string, top *int32, skip *int32) (result APICollectionPage, err error)

ListByProduct lists a collection of the APIs associated with a product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (ProductAPIClient) ListByProductComplete 

func (client ProductAPIClient) ListByProductComplete(ctx context.Context, apimBaseURL string, productID string, filter string, top *int32, skip *int32) (result APICollectionIterator, err error)

ListByProductComplete enumerates all values, automatically crossing page boundaries as required.

func (ProductAPIClient) ListByProductPreparer 

func (client ProductAPIClient) ListByProductPreparer(ctx context.Context, apimBaseURL string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ProductAPIClient) ListByProductResponder 

func (client ProductAPIClient) ListByProductResponder(resp *http.Response) (result APICollection, err error)

ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.

func (ProductAPIClient) ListByProductSender 

func (client ProductAPIClient) ListByProductSender(req *http.Request) (*http.Response, error)

ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.

type ProductClient 

type ProductClient struct {
	BaseClient
}

ProductClient is the client for the Product methods of the Apimanagement service.

func NewProductClient 

func NewProductClient() ProductClient

NewProductClient creates an instance of the ProductClient client.

func (ProductClient) CreateOrUpdate 

func (client ProductClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, productID string, parameters ProductContract) (result ProductContract, err error)

CreateOrUpdate creates or Updates a product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. parameters is create or update parameters.

func (ProductClient) CreateOrUpdatePreparer 

func (client ProductClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, productID string, parameters ProductContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductClient) CreateOrUpdateResponder 

func (client ProductClient) CreateOrUpdateResponder(resp *http.Response) (result ProductContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ProductClient) CreateOrUpdateSender 

func (client ProductClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ProductClient) Delete 

func (client ProductClient) Delete(ctx context.Context, apimBaseURL string, productID string, ifMatch string, deleteSubscriptions *bool) (result autorest.Response, err error)

Delete delete product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. ifMatch is eTag of the Product Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. deleteSubscriptions is delete existing subscriptions to the product or not.

func (ProductClient) DeletePreparer 

func (client ProductClient) DeletePreparer(ctx context.Context, apimBaseURL string, productID string, ifMatch string, deleteSubscriptions *bool) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProductClient) DeleteResponder 

func (client ProductClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ProductClient) DeleteSender 

func (client ProductClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ProductClient) Get 

func (client ProductClient) Get(ctx context.Context, apimBaseURL string, productID string) (result ProductContract, err error)

Get gets the details of the product specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance.

func (ProductClient) GetPreparer 

func (client ProductClient) GetPreparer(ctx context.Context, apimBaseURL string, productID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProductClient) GetResponder 

func (client ProductClient) GetResponder(resp *http.Response) (result ProductContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ProductClient) GetSender 

func (client ProductClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ProductClient) List 

func (client ProductClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32, expandGroups *bool) (result ProductCollectionPage, err error)

List lists a collection of products in the specified service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top is number of records to return. skip is number of records to skip. expandGroups is when set to true, the response contains an array of groups that have visibility to the product. The default is false.

func (ProductClient) ListComplete 

func (client ProductClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32, expandGroups *bool) (result ProductCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ProductClient) ListPreparer 

func (client ProductClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32, expandGroups *bool) (*http.Request, error)

ListPreparer prepares the List request.

func (ProductClient) ListResponder 

func (client ProductClient) ListResponder(resp *http.Response) (result ProductCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ProductClient) ListSender 

func (client ProductClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (ProductClient) Update 

func (client ProductClient) Update(ctx context.Context, apimBaseURL string, productID string, parameters ProductUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update update product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. parameters is update parameters. ifMatch is eTag of the Product Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (ProductClient) UpdatePreparer 

func (client ProductClient) UpdatePreparer(ctx context.Context, apimBaseURL string, productID string, parameters ProductUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ProductClient) UpdateResponder 

func (client ProductClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ProductClient) UpdateSender 

func (client ProductClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type ProductCollection 

type ProductCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]ProductContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

ProductCollection paged Products list representation.

func (ProductCollection) IsEmpty 

func (pc ProductCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ProductCollectionIterator 

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

ProductCollectionIterator provides access to a complete listing of ProductContract values.

func (*ProductCollectionIterator) Next 

func (iter *ProductCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ProductCollectionIterator) NotDone 

func (iter ProductCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ProductCollectionIterator) Response 

func (iter ProductCollectionIterator) Response() ProductCollection

Response returns the raw server response from the last page request.

func (ProductCollectionIterator) Value 

func (iter ProductCollectionIterator) Value() ProductContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ProductCollectionPage 

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

ProductCollectionPage contains a page of ProductContract values.

func (*ProductCollectionPage) Next 

func (page *ProductCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ProductCollectionPage) NotDone 

func (page ProductCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ProductCollectionPage) Response 

func (page ProductCollectionPage) Response() ProductCollection

Response returns the raw server response from the last page request.

func (ProductCollectionPage) Values 

func (page ProductCollectionPage) Values() []ProductContract

Values returns the slice of values for the current page or nil if there are no values.

type ProductContract 

type ProductContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Product entity.
	ID *string `json:"id,omitempty"`
	// Name - Product name.
	Name *string `json:"name,omitempty"`
	// Description - Product description. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Terms - 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"`
	// SubscriptionRequired - 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"`
	// ApprovalRequired - 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"`
	// SubscriptionsLimit - 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"`
	// State - 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. Possible values include: 'NotPublished', 'Published'
	State ProductState `json:"state,omitempty"`
}

ProductContract product details.

type ProductContractProperties 

type ProductContractProperties struct {
	// Name - Product name.
	Name *string `json:"name,omitempty"`
	// Description - Product description. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Terms - 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"`
	// SubscriptionRequired - 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"`
	// ApprovalRequired - 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"`
	// SubscriptionsLimit - 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"`
	// State - 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. Possible values include: 'NotPublished', 'Published'
	State ProductState `json:"state,omitempty"`
}

ProductContractProperties product profile.

type ProductEntityBaseParameters 

type ProductEntityBaseParameters struct {
	// Description - Product description. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Terms - 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"`
	// SubscriptionRequired - 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"`
	// ApprovalRequired - 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"`
	// SubscriptionsLimit - 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"`
	// State - 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. Possible values include: 'NotPublished', 'Published'
	State ProductState `json:"state,omitempty"`
}

ProductEntityBaseParameters product Entity Base Parameters

type ProductGroupClient 

type ProductGroupClient struct {
	BaseClient
}

ProductGroupClient is the client for the ProductGroup methods of the Apimanagement service.

func NewProductGroupClient 

func NewProductGroupClient() ProductGroupClient

NewProductGroupClient creates an instance of the ProductGroupClient client.

func (ProductGroupClient) CreateOrUpdate 

func (client ProductGroupClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, productID string, groupID string) (result GroupContract, err error)

CreateOrUpdate adds the association between the specified developer group with the specified product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. groupID is group identifier. Must be unique in the current API Management service instance.

func (ProductGroupClient) CreateOrUpdatePreparer 

func (client ProductGroupClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, productID string, groupID string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductGroupClient) CreateOrUpdateResponder 

func (client ProductGroupClient) CreateOrUpdateResponder(resp *http.Response) (result GroupContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ProductGroupClient) CreateOrUpdateSender 

func (client ProductGroupClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ProductGroupClient) Delete 

func (client ProductGroupClient) Delete(ctx context.Context, apimBaseURL string, productID string, groupID string) (result autorest.Response, err error)

Delete deletes the association between the specified group and product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. groupID is group identifier. Must be unique in the current API Management service instance.

func (ProductGroupClient) DeletePreparer 

func (client ProductGroupClient) DeletePreparer(ctx context.Context, apimBaseURL string, productID string, groupID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProductGroupClient) DeleteResponder 

func (client ProductGroupClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ProductGroupClient) DeleteSender 

func (client ProductGroupClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ProductGroupClient) ListByProduct 

func (client ProductGroupClient) ListByProduct(ctx context.Context, apimBaseURL string, productID string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)

ListByProduct lists the collection of developer groups associated with the specified product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq, ne | N/A | top is number of records to return. skip is number of records to skip.

func (ProductGroupClient) ListByProductComplete 

func (client ProductGroupClient) ListByProductComplete(ctx context.Context, apimBaseURL string, productID string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)

ListByProductComplete enumerates all values, automatically crossing page boundaries as required.

func (ProductGroupClient) ListByProductPreparer 

func (client ProductGroupClient) ListByProductPreparer(ctx context.Context, apimBaseURL string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ProductGroupClient) ListByProductResponder 

func (client ProductGroupClient) ListByProductResponder(resp *http.Response) (result GroupCollection, err error)

ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.

func (ProductGroupClient) ListByProductSender 

func (client ProductGroupClient) ListByProductSender(req *http.Request) (*http.Response, error)

ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.

type ProductPolicyClient 

type ProductPolicyClient struct {
	BaseClient
}

ProductPolicyClient is the client for the ProductPolicy methods of the Apimanagement service.

func NewProductPolicyClient 

func NewProductPolicyClient() ProductPolicyClient

NewProductPolicyClient creates an instance of the ProductPolicyClient client.

func (ProductPolicyClient) CreateOrUpdate 

func (client ProductPolicyClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, productID string, parameters PolicyContract) (result PolicyContract, err error)

CreateOrUpdate creates or updates policy configuration for the Product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. parameters is the policy contents to apply.

func (ProductPolicyClient) CreateOrUpdatePreparer 

func (client ProductPolicyClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, productID string, parameters PolicyContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductPolicyClient) CreateOrUpdateResponder 

func (client ProductPolicyClient) CreateOrUpdateResponder(resp *http.Response) (result PolicyContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ProductPolicyClient) CreateOrUpdateSender 

func (client ProductPolicyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ProductPolicyClient) Delete 

func (client ProductPolicyClient) Delete(ctx context.Context, apimBaseURL string, productID string, ifMatch string) (result autorest.Response, err error)

Delete deletes the policy configuration at the Product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. ifMatch is the entity state (Etag) version of the product policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (ProductPolicyClient) DeletePreparer 

func (client ProductPolicyClient) DeletePreparer(ctx context.Context, apimBaseURL string, productID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProductPolicyClient) DeleteResponder 

func (client ProductPolicyClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ProductPolicyClient) DeleteSender 

func (client ProductPolicyClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ProductPolicyClient) Get 

func (client ProductPolicyClient) Get(ctx context.Context, apimBaseURL string, productID string) (result PolicyContract, err error)

Get get the policy configuration at the Product level.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance.

func (ProductPolicyClient) GetPreparer 

func (client ProductPolicyClient) GetPreparer(ctx context.Context, apimBaseURL string, productID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProductPolicyClient) GetResponder 

func (client ProductPolicyClient) GetResponder(resp *http.Response) (result PolicyContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ProductPolicyClient) GetSender 

func (client ProductPolicyClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ProductPolicyClient) ListByProduct 

func (client ProductPolicyClient) ListByProduct(ctx context.Context, apimBaseURL string, productID string) (result PolicyCollection, err error)

ListByProduct get the policy configuration at the Product level.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance.

func (ProductPolicyClient) ListByProductPreparer 

func (client ProductPolicyClient) ListByProductPreparer(ctx context.Context, apimBaseURL string, productID string) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ProductPolicyClient) ListByProductResponder 

func (client ProductPolicyClient) ListByProductResponder(resp *http.Response) (result PolicyCollection, err error)

ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.

func (ProductPolicyClient) ListByProductSender 

func (client ProductPolicyClient) ListByProductSender(req *http.Request) (*http.Response, error)

ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.

type ProductState 

type ProductState string

ProductState enumerates the values for product state. 

const (
	// NotPublished ...
	NotPublished ProductState = "notPublished"
	// Published ...
	Published ProductState = "published"
)

func PossibleProductStateValues 

func PossibleProductStateValues() []ProductState

PossibleProductStateValues returns an array of possible values for the ProductState const type.

type ProductSubscriptionsClient 

type ProductSubscriptionsClient struct {
	BaseClient
}

ProductSubscriptionsClient is the client for the ProductSubscriptions methods of the Apimanagement service.

func NewProductSubscriptionsClient 

func NewProductSubscriptionsClient() ProductSubscriptionsClient

NewProductSubscriptionsClient creates an instance of the ProductSubscriptionsClient client.

func (ProductSubscriptionsClient) List 

func (client ProductSubscriptionsClient) List(ctx context.Context, apimBaseURL string, productID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)

List lists the collection of subscriptions to the specified product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. productID is product identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |--------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top is number of records to return. skip is number of records to skip.

func (ProductSubscriptionsClient) ListComplete 

func (client ProductSubscriptionsClient) ListComplete(ctx context.Context, apimBaseURL string, productID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ProductSubscriptionsClient) ListPreparer 

func (client ProductSubscriptionsClient) ListPreparer(ctx context.Context, apimBaseURL string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (ProductSubscriptionsClient) ListResponder 

func (client ProductSubscriptionsClient) ListResponder(resp *http.Response) (result SubscriptionCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ProductSubscriptionsClient) ListSender 

func (client ProductSubscriptionsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ProductUpdateParameters 

type ProductUpdateParameters struct {
	// Name - Product name.
	Name *string `json:"name,omitempty"`
	// Description - Product description. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Terms - 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"`
	// SubscriptionRequired - 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"`
	// ApprovalRequired - 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"`
	// SubscriptionsLimit - 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"`
	// State - 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. Possible values include: 'NotPublished', 'Published'
	State ProductState `json:"state,omitempty"`
}

ProductUpdateParameters parameters supplied to the Update Product operation.

type PropertyClient 

type PropertyClient struct {
	BaseClient
}

PropertyClient is the client for the Property methods of the Apimanagement service.

func NewPropertyClient 

func NewPropertyClient() PropertyClient

NewPropertyClient creates an instance of the PropertyClient client.

func (PropertyClient) CreateOrUpdate 

func (client PropertyClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, propID string, parameters PropertyContract) (result PropertyContract, err error)

CreateOrUpdate creates or updates a property.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. propID is identifier of the property. parameters is create parameters.

func (PropertyClient) CreateOrUpdatePreparer 

func (client PropertyClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, propID string, parameters PropertyContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PropertyClient) CreateOrUpdateResponder 

func (client PropertyClient) CreateOrUpdateResponder(resp *http.Response) (result PropertyContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (PropertyClient) CreateOrUpdateSender 

func (client PropertyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (PropertyClient) Delete 

func (client PropertyClient) Delete(ctx context.Context, apimBaseURL string, propID string, ifMatch string) (result autorest.Response, err error)

Delete deletes specific property from the the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. propID is identifier of the property. ifMatch is the entity state (Etag) version of the property to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (PropertyClient) DeletePreparer 

func (client PropertyClient) DeletePreparer(ctx context.Context, apimBaseURL string, propID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PropertyClient) DeleteResponder 

func (client PropertyClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (PropertyClient) DeleteSender 

func (client PropertyClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (PropertyClient) Get 

func (client PropertyClient) Get(ctx context.Context, apimBaseURL string, propID string) (result PropertyContract, err error)

Get gets the details of the property specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. propID is identifier of the property.

func (PropertyClient) GetPreparer 

func (client PropertyClient) GetPreparer(ctx context.Context, apimBaseURL string, propID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PropertyClient) GetResponder 

func (client PropertyClient) GetResponder(resp *http.Response) (result PropertyContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PropertyClient) GetSender 

func (client PropertyClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (PropertyClient) List 

func (client PropertyClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result PropertyCollectionPage, err error)

List lists a collection of properties defined within a service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |-------|------------------------|-------------------------------------------------------| | tags | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (PropertyClient) ListComplete 

func (client PropertyClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result PropertyCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (PropertyClient) ListPreparer 

func (client PropertyClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (PropertyClient) ListResponder 

func (client PropertyClient) ListResponder(resp *http.Response) (result PropertyCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (PropertyClient) ListSender 

func (client PropertyClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (PropertyClient) Update 

func (client PropertyClient) Update(ctx context.Context, apimBaseURL string, propID string, parameters PropertyUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates the specific property.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. propID is identifier of the property. parameters is update parameters. ifMatch is the entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (PropertyClient) UpdatePreparer 

func (client PropertyClient) UpdatePreparer(ctx context.Context, apimBaseURL string, propID string, parameters PropertyUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (PropertyClient) UpdateResponder 

func (client PropertyClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (PropertyClient) UpdateSender 

func (client PropertyClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type PropertyCollection 

type PropertyCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]PropertyContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

PropertyCollection paged Property list representation.

func (PropertyCollection) IsEmpty 

func (pc PropertyCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PropertyCollectionIterator 

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

PropertyCollectionIterator provides access to a complete listing of PropertyContract values.

func (*PropertyCollectionIterator) Next 

func (iter *PropertyCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (PropertyCollectionIterator) NotDone 

func (iter PropertyCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (PropertyCollectionIterator) Response 

func (iter PropertyCollectionIterator) Response() PropertyCollection

Response returns the raw server response from the last page request.

func (PropertyCollectionIterator) Value 

func (iter PropertyCollectionIterator) Value() PropertyContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type PropertyCollectionPage 

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

PropertyCollectionPage contains a page of PropertyContract values.

func (*PropertyCollectionPage) Next 

func (page *PropertyCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (PropertyCollectionPage) NotDone 

func (page PropertyCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (PropertyCollectionPage) Response 

func (page PropertyCollectionPage) Response() PropertyCollection

Response returns the raw server response from the last page request.

func (PropertyCollectionPage) Values 

func (page PropertyCollectionPage) Values() []PropertyContract

Values returns the slice of values for the current page or nil if there are no values.

type PropertyContract 

type PropertyContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Property.
	ID *string `json:"id,omitempty"`
	// Name - Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
	Name *string `json:"name,omitempty"`
	// Value - Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
	Value *string `json:"value,omitempty"`
	// Tags - Optional tags that when provided can be used to filter the property list.
	Tags *[]string `json:"tags,omitempty"`
	// Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
	Secret *bool `json:"secret,omitempty"`
}

PropertyContract property details.

type PropertyContractProperties 

type PropertyContractProperties struct {
	// Name - Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
	Name *string `json:"name,omitempty"`
	// Value - Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
	Value *string `json:"value,omitempty"`
	// Tags - Optional tags that when provided can be used to filter the property list.
	Tags *[]string `json:"tags,omitempty"`
	// Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
	Secret *bool `json:"secret,omitempty"`
}

PropertyContractProperties property Contract properties.

type PropertyEntityBaseParameters 

type PropertyEntityBaseParameters struct {
	// Tags - Optional tags that when provided can be used to filter the property list.
	Tags *[]string `json:"tags,omitempty"`
	// Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
	Secret *bool `json:"secret,omitempty"`
}

PropertyEntityBaseParameters property Entity Base Parameters set.

type PropertyUpdateParameters 

type PropertyUpdateParameters struct {
	// Name - Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
	Name *string `json:"name,omitempty"`
	// Value - Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
	Value *string `json:"value,omitempty"`
	// Tags - Optional tags that when provided can be used to filter the property list.
	Tags *[]string `json:"tags,omitempty"`
	// Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
	Secret *bool `json:"secret,omitempty"`
}

PropertyUpdateParameters property Contract properties.

type Protocol 

type Protocol string

Protocol enumerates the values for protocol. 

const (
	// ProtocolHTTP ...
	ProtocolHTTP Protocol = "http"
	// ProtocolHTTPS ...
	ProtocolHTTPS Protocol = "https"
)

func PossibleProtocolValues 

func PossibleProtocolValues() []Protocol

PossibleProtocolValues returns an array of possible values for the Protocol const type.

type QuotaByCounterKeysClient 

type QuotaByCounterKeysClient struct {
	BaseClient
}

QuotaByCounterKeysClient is the client for the QuotaByCounterKeys methods of the Apimanagement service.

func NewQuotaByCounterKeysClient 

func NewQuotaByCounterKeysClient() QuotaByCounterKeysClient

NewQuotaByCounterKeysClient creates an instance of the QuotaByCounterKeysClient client.

func (QuotaByCounterKeysClient) List 

func (client QuotaByCounterKeysClient) List(ctx context.Context, apimBaseURL string, quotaCounterKey string) (result QuotaCounterCollection, err error)

List 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.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. quotaCounterKey is quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key

func (QuotaByCounterKeysClient) ListPreparer 

func (client QuotaByCounterKeysClient) ListPreparer(ctx context.Context, apimBaseURL string, quotaCounterKey string) (*http.Request, error)

ListPreparer prepares the List request.

func (QuotaByCounterKeysClient) ListResponder 

func (client QuotaByCounterKeysClient) ListResponder(resp *http.Response) (result QuotaCounterCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (QuotaByCounterKeysClient) ListSender 

func (client QuotaByCounterKeysClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (QuotaByCounterKeysClient) Update 

func (client QuotaByCounterKeysClient) Update(ctx context.Context, apimBaseURL string, quotaCounterKey string, parameters QuotaCounterValueContractProperties) (result autorest.Response, err 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.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. quotaCounterKey is quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key parameters is the value of the quota counter to be applied to all quota counter periods.

func (QuotaByCounterKeysClient) UpdatePreparer 

func (client QuotaByCounterKeysClient) UpdatePreparer(ctx context.Context, apimBaseURL string, quotaCounterKey string, parameters QuotaCounterValueContractProperties) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (QuotaByCounterKeysClient) UpdateResponder 

func (client QuotaByCounterKeysClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (QuotaByCounterKeysClient) UpdateSender 

func (client QuotaByCounterKeysClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type QuotaByPeriodKeysClient 

type QuotaByPeriodKeysClient struct {
	BaseClient
}

QuotaByPeriodKeysClient is the client for the QuotaByPeriodKeys methods of the Apimanagement service.

func NewQuotaByPeriodKeysClient 

func NewQuotaByPeriodKeysClient() QuotaByPeriodKeysClient

NewQuotaByPeriodKeysClient creates an instance of the QuotaByPeriodKeysClient client.

func (QuotaByPeriodKeysClient) Get 

func (client QuotaByPeriodKeysClient) Get(ctx context.Context, apimBaseURL string, quotaCounterKey string, quotaPeriodKey string) (result QuotaCounterContract, err error)

Get gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. quotaCounterKey is quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key quotaPeriodKey is quota period key identifier.

func (QuotaByPeriodKeysClient) GetPreparer 

func (client QuotaByPeriodKeysClient) GetPreparer(ctx context.Context, apimBaseURL string, quotaCounterKey string, quotaPeriodKey string) (*http.Request, error)

GetPreparer prepares the Get request.

func (QuotaByPeriodKeysClient) GetResponder 

func (client QuotaByPeriodKeysClient) GetResponder(resp *http.Response) (result QuotaCounterContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (QuotaByPeriodKeysClient) GetSender 

func (client QuotaByPeriodKeysClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (QuotaByPeriodKeysClient) Update 

func (client QuotaByPeriodKeysClient) Update(ctx context.Context, apimBaseURL string, quotaCounterKey string, quotaPeriodKey string, parameters QuotaCounterValueContractProperties) (result autorest.Response, err error)

Update updates an existing quota counter value in the specified service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. quotaCounterKey is quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key quotaPeriodKey is quota period key identifier. parameters is the value of the Quota counter to be applied on the specified period.

func (QuotaByPeriodKeysClient) UpdatePreparer 

func (client QuotaByPeriodKeysClient) UpdatePreparer(ctx context.Context, apimBaseURL string, quotaCounterKey string, quotaPeriodKey string, parameters QuotaCounterValueContractProperties) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (QuotaByPeriodKeysClient) UpdateResponder 

func (client QuotaByPeriodKeysClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (QuotaByPeriodKeysClient) UpdateSender 

func (client QuotaByPeriodKeysClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type QuotaCounterCollection 

type QuotaCounterCollection struct {
	autorest.Response `json:"-"`
	// Value - Quota counter values.
	Value *[]QuotaCounterContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

QuotaCounterCollection paged Quota Counter list representation.

type QuotaCounterContract 

type QuotaCounterContract struct {
	autorest.Response `json:"-"`
	// CounterKey - The Key value of the Counter. Must not be empty.
	CounterKey *string `json:"counterKey,omitempty"`
	// PeriodKey - Identifier of the Period for which the counter was collected. Must not be empty.
	PeriodKey *string `json:"periodKey,omitempty"`
	// PeriodStartTime - 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 *date.Time `json:"periodStartTime,omitempty"`
	// PeriodEndTime - 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 *date.Time `json:"periodEndTime,omitempty"`
	// Value - Quota Value Properties
	Value *QuotaCounterValueContractProperties `json:"Value,omitempty"`
}

QuotaCounterContract quota counter details.

type QuotaCounterValueContract 

type QuotaCounterValueContract struct {
	// QuotaCounterValueContractProperties - Quota counter Value Properties.
	*QuotaCounterValueContractProperties `json:"value,omitempty"`
}

QuotaCounterValueContract quota counter value details.

func (QuotaCounterValueContract) MarshalJSON 

func (qcvc QuotaCounterValueContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QuotaCounterValueContract.

func (*QuotaCounterValueContract) UnmarshalJSON 

func (qcvc *QuotaCounterValueContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for QuotaCounterValueContract struct.

type QuotaCounterValueContractProperties 

type QuotaCounterValueContractProperties struct {
	// CallsCount - Number of times Counter was called.
	CallsCount *int32 `json:"callsCount,omitempty"`
	// KbTransferred - Data Transferred in KiloBytes.
	KbTransferred *float64 `json:"kbTransferred,omitempty"`
}

QuotaCounterValueContractProperties quota counter value details.

type RegionContract 

type RegionContract struct {
	// Name - Region name.
	Name *string `json:"name,omitempty"`
	// IsMasterRegion - whether Region is the master region.
	IsMasterRegion *bool `json:"isMasterRegion,omitempty"`
	// IsDeleted - whether Region is deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`
}

RegionContract region profile.

type RegionListResult 

type RegionListResult struct {
	autorest.Response `json:"-"`
	// Value - Lists of Regions.
	Value *[]RegionContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

RegionListResult lists Regions operation response details.

type RegionsClient 

type RegionsClient struct {
	BaseClient
}

RegionsClient is the client for the Regions methods of the Apimanagement service.

func NewRegionsClient 

func NewRegionsClient() RegionsClient

NewRegionsClient creates an instance of the RegionsClient client.

func (RegionsClient) List 

func (client RegionsClient) List(ctx context.Context, apimBaseURL string) (result RegionListResult, err error)

List lists all azure regions in which the service exists.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (RegionsClient) ListPreparer 

func (client RegionsClient) ListPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

ListPreparer prepares the List request.

func (RegionsClient) ListResponder 

func (client RegionsClient) ListResponder(resp *http.Response) (result RegionListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (RegionsClient) ListSender 

func (client RegionsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type RegistrationDelegationSettingsProperties 

type RegistrationDelegationSettingsProperties struct {
	// Enabled - Enable or disable delegation for user registration.
	Enabled *bool `json:"enabled,omitempty"`
}

RegistrationDelegationSettingsProperties user registration delegation settings properties.

type ReportCollection 

type ReportCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]ReportRecordContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

ReportCollection paged Report records list representation.

func (ReportCollection) IsEmpty 

func (rc ReportCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ReportCollectionIterator 

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

ReportCollectionIterator provides access to a complete listing of ReportRecordContract values.

func (*ReportCollectionIterator) Next 

func (iter *ReportCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ReportCollectionIterator) NotDone 

func (iter ReportCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ReportCollectionIterator) Response 

func (iter ReportCollectionIterator) Response() ReportCollection

Response returns the raw server response from the last page request.

func (ReportCollectionIterator) Value 

func (iter ReportCollectionIterator) Value() ReportRecordContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ReportCollectionPage 

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

ReportCollectionPage contains a page of ReportRecordContract values.

func (*ReportCollectionPage) Next 

func (page *ReportCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ReportCollectionPage) NotDone 

func (page ReportCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ReportCollectionPage) Response 

func (page ReportCollectionPage) Response() ReportCollection

Response returns the raw server response from the last page request.

func (ReportCollectionPage) Values 

func (page ReportCollectionPage) Values() []ReportRecordContract

Values returns the slice of values for the current page or nil if there are no values.

type ReportRecordContract 

type ReportRecordContract struct {
	// Name - Name depending on report endpoint specifies product, API, operation or developer name.
	Name *string `json:"name,omitempty"`
	// Timestamp - Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// Interval - Length of agregation 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"`
	// Country - Country to which this record data is related.
	Country *string `json:"country,omitempty"`
	// Region - Country region to which this record data is related.
	Region *string `json:"region,omitempty"`
	// Zip - Zip code to which this record data is related.
	Zip *string `json:"zip,omitempty"`
	// UserID - User identifier path. /users/{userId}
	UserID *string `json:"userId,omitempty"`
	// ProductID - Product identifier path. /products/{productId}
	ProductID *string `json:"productId,omitempty"`
	// APIID - API identifier path. /apis/{apiId}
	APIID *string `json:"apiId,omitempty"`
	// OperationID - Operation identifier path. /apis/{apiId}/operations/{operationId}
	OperationID *string `json:"operationId,omitempty"`
	// APIRegion - API region identifier.
	APIRegion *string `json:"apiRegion,omitempty"`
	// SubscriptionID - Subscription identifier path. /subscriptions/{subscriptionId}
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	// CallCountSuccess - Number of succesful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect
	CallCountSuccess *int32 `json:"callCountSuccess,omitempty"`
	// CallCountBlocked - Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorize and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests
	CallCountBlocked *int32 `json:"callCountBlocked,omitempty"`
	// CallCountFailed - 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"`
	// CallCountOther - Number of other calls.
	CallCountOther *int32 `json:"callCountOther,omitempty"`
	// CallCountTotal - Total number of calls.
	CallCountTotal *int32 `json:"callCountTotal,omitempty"`
	// Bandwidth - Bandwidth consumed.
	Bandwidth *int64 `json:"bandwidth,omitempty"`
	// CacheHitCount - Number of times when content was served from cache policy.
	CacheHitCount *int32 `json:"cacheHitCount,omitempty"`
	// CacheMissCount - Number of times content was fetched from backend.
	CacheMissCount *int32 `json:"cacheMissCount,omitempty"`
	// APITimeAvg - Average time it took to process request.
	APITimeAvg *float64 `json:"apiTimeAvg,omitempty"`
	// APITimeMin - Minimum time it took to process request.
	APITimeMin *float64 `json:"apiTimeMin,omitempty"`
	// APITimeMax - Maximum time it took to process request.
	APITimeMax *float64 `json:"apiTimeMax,omitempty"`
	// ServiceTimeAvg - Average time it took to process request on backend.
	ServiceTimeAvg *float64 `json:"serviceTimeAvg,omitempty"`
	// ServiceTimeMin - Minimum time it took to process request on backend.
	ServiceTimeMin *float64 `json:"serviceTimeMin,omitempty"`
	// ServiceTimeMax - Maximum time it took to process request on backend.
	ServiceTimeMax *float64 `json:"serviceTimeMax,omitempty"`
}

ReportRecordContract report data.

type ReportsClient 

type ReportsClient struct {
	BaseClient
}

ReportsClient is the client for the Reports methods of the Apimanagement service.

func NewReportsClient 

func NewReportsClient() ReportsClient

NewReportsClient creates an instance of the ReportsClient client.

func (ReportsClient) ListByAPI 

func (client ReportsClient) ListByAPI(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByAPI lists report records by API.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is the filter to apply on the operation. top is number of records to return. skip is number of records to skip.

func (ReportsClient) ListByAPIComplete 

func (client ReportsClient) ListByAPIComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByAPIPreparer 

func (client ReportsClient) ListByAPIPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByAPIPreparer prepares the ListByAPI request.

func (ReportsClient) ListByAPIResponder 

func (client ReportsClient) ListByAPIResponder(resp *http.Response) (result ReportCollection, err error)

ListByAPIResponder handles the response to the ListByAPI request. The method always closes the http.Response Body.

func (ReportsClient) ListByAPISender 

func (client ReportsClient) ListByAPISender(req *http.Request) (*http.Response, error)

ListByAPISender sends the ListByAPI request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByGeo 

func (client ReportsClient) ListByGeo(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByGeo lists report records by GeoGraphy.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is the filter to apply on the operation. top is number of records to return. skip is number of records to skip.

func (ReportsClient) ListByGeoComplete 

func (client ReportsClient) ListByGeoComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByGeoComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByGeoPreparer 

func (client ReportsClient) ListByGeoPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByGeoPreparer prepares the ListByGeo request.

func (ReportsClient) ListByGeoResponder 

func (client ReportsClient) ListByGeoResponder(resp *http.Response) (result ReportCollection, err error)

ListByGeoResponder handles the response to the ListByGeo request. The method always closes the http.Response Body.

func (ReportsClient) ListByGeoSender 

func (client ReportsClient) ListByGeoSender(req *http.Request) (*http.Response, error)

ListByGeoSender sends the ListByGeo request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByOperation 

func (client ReportsClient) ListByOperation(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByOperation lists report records by API Operations.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is the filter to apply on the operation. top is number of records to return. skip is number of records to skip.

func (ReportsClient) ListByOperationComplete 

func (client ReportsClient) ListByOperationComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByOperationComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByOperationPreparer 

func (client ReportsClient) ListByOperationPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByOperationPreparer prepares the ListByOperation request.

func (ReportsClient) ListByOperationResponder 

func (client ReportsClient) ListByOperationResponder(resp *http.Response) (result ReportCollection, err error)

ListByOperationResponder handles the response to the ListByOperation request. The method always closes the http.Response Body.

func (ReportsClient) ListByOperationSender 

func (client ReportsClient) ListByOperationSender(req *http.Request) (*http.Response, error)

ListByOperationSender sends the ListByOperation request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByProduct 

func (client ReportsClient) ListByProduct(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByProduct lists report records by Product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is the filter to apply on the operation. top is number of records to return. skip is number of records to skip.

func (ReportsClient) ListByProductComplete 

func (client ReportsClient) ListByProductComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByProductComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByProductPreparer 

func (client ReportsClient) ListByProductPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ReportsClient) ListByProductResponder 

func (client ReportsClient) ListByProductResponder(resp *http.Response) (result ReportCollection, err error)

ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.

func (ReportsClient) ListByProductSender 

func (client ReportsClient) ListByProductSender(req *http.Request) (*http.Response, error)

ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByRequest 

func (client ReportsClient) ListByRequest(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result RequestReportCollection, err error)

ListByRequest lists report records by Request.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is the filter to apply on the operation. top is number of records to return. skip is number of records to skip.

func (ReportsClient) ListByRequestPreparer 

func (client ReportsClient) ListByRequestPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByRequestPreparer prepares the ListByRequest request.

func (ReportsClient) ListByRequestResponder 

func (client ReportsClient) ListByRequestResponder(resp *http.Response) (result RequestReportCollection, err error)

ListByRequestResponder handles the response to the ListByRequest request. The method always closes the http.Response Body.

func (ReportsClient) ListByRequestSender 

func (client ReportsClient) ListByRequestSender(req *http.Request) (*http.Response, error)

ListByRequestSender sends the ListByRequest request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListBySubscription 

func (client ReportsClient) ListBySubscription(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListBySubscription lists report records by subscription.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is the filter to apply on the operation. top is number of records to return. skip is number of records to skip.

func (ReportsClient) ListBySubscriptionComplete 

func (client ReportsClient) ListBySubscriptionComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListBySubscriptionPreparer 

func (client ReportsClient) ListBySubscriptionPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (ReportsClient) ListBySubscriptionResponder 

func (client ReportsClient) ListBySubscriptionResponder(resp *http.Response) (result ReportCollection, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (ReportsClient) ListBySubscriptionSender 

func (client ReportsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByTime 

func (client ReportsClient) ListByTime(ctx context.Context, apimBaseURL string, interval string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByTime lists report records by Time.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. interval is by time interval. 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).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds)) filter is the filter to apply on the operation. top is number of records to return. skip is number of records to skip.

func (ReportsClient) ListByTimeComplete 

func (client ReportsClient) ListByTimeComplete(ctx context.Context, apimBaseURL string, interval string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByTimeComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByTimePreparer 

func (client ReportsClient) ListByTimePreparer(ctx context.Context, apimBaseURL string, interval string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByTimePreparer prepares the ListByTime request.

func (ReportsClient) ListByTimeResponder 

func (client ReportsClient) ListByTimeResponder(resp *http.Response) (result ReportCollection, err error)

ListByTimeResponder handles the response to the ListByTime request. The method always closes the http.Response Body.

func (ReportsClient) ListByTimeSender 

func (client ReportsClient) ListByTimeSender(req *http.Request) (*http.Response, error)

ListByTimeSender sends the ListByTime request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByUser 

func (client ReportsClient) ListByUser(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByUser lists report records by User.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is the filter to apply on the operation. top is number of records to return. skip is number of records to skip.

func (ReportsClient) ListByUserComplete 

func (client ReportsClient) ListByUserComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByUserComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByUserPreparer 

func (client ReportsClient) ListByUserPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByUserPreparer prepares the ListByUser request.

func (ReportsClient) ListByUserResponder 

func (client ReportsClient) ListByUserResponder(resp *http.Response) (result ReportCollection, err error)

ListByUserResponder handles the response to the ListByUser request. The method always closes the http.Response Body.

func (ReportsClient) ListByUserSender 

func (client ReportsClient) ListByUserSender(req *http.Request) (*http.Response, error)

ListByUserSender sends the ListByUser request. The method will close the http.Response Body if it receives an error.

type RepresentationContract 

type RepresentationContract struct {
	// ContentType - Specifies a registered or custom content type for this representation, e.g. application/xml.
	ContentType *string `json:"contentType,omitempty"`
	// Sample - An example of the representation.
	Sample *string `json:"sample,omitempty"`
	// SchemaID - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
	SchemaID *string `json:"schemaId,omitempty"`
	// TypeName - 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"`
	// FormParameters - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
	FormParameters *[]ParameterContract `json:"formParameters,omitempty"`
}

RepresentationContract operation request/response representation details.

type RequestContract 

type RequestContract struct {
	// Description - Operation request description.
	Description *string `json:"description,omitempty"`
	// QueryParameters - Collection of operation request query parameters.
	QueryParameters *[]ParameterContract `json:"queryParameters,omitempty"`
	// Headers - Collection of operation request headers.
	Headers *[]ParameterContract `json:"headers,omitempty"`
	// Representations - Collection of operation request representations.
	Representations *[]RepresentationContract `json:"representations,omitempty"`
}

RequestContract operation request details.

type RequestReportCollection 

type RequestReportCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]RequestReportRecordContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
}

RequestReportCollection paged Report records list representation.

type RequestReportRecordContract 

type RequestReportRecordContract struct {
	// APIID - API identifier path. /apis/{apiId}
	APIID *string `json:"apiId,omitempty"`
	// OperationID - Operation identifier path. /apis/{apiId}/operations/{operationId}
	OperationID *string `json:"operationId,omitempty"`
	// ProductID - Product identifier path. /products/{productId}
	ProductID *string `json:"productId,omitempty"`
	// UserID - User identifier path. /users/{userId}
	UserID *string `json:"userId,omitempty"`
	// Method - The HTTP method associated with this request..
	Method *string `json:"method,omitempty"`
	// URL - The full URL associated with this request.
	URL *string `json:"url,omitempty"`
	// IPAddress - The client IP address associated with this request.
	IPAddress *string `json:"ipAddress,omitempty"`
	// BackendResponseCode - The HTTP status code received by the gateway as a result of forwarding this request to the backend.
	BackendResponseCode *string `json:"backendResponseCode,omitempty"`
	// ResponseCode - The HTTP status code returned by the gateway.
	ResponseCode *int32 `json:"responseCode,omitempty"`
	// ResponseSize - The size of the response returned by the gateway.
	ResponseSize *int32 `json:"responseSize,omitempty"`
	// Timestamp - The date and time when this request was received by the gateway in ISO 8601 format.
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// Cache - 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 fullfilled by the backend.
	Cache *string `json:"cache,omitempty"`
	// APITime - The total time it took to process this request.
	APITime *float64 `json:"apiTime,omitempty"`
	// ServiceTime - he time it took to forward this request to the backend and get the response back.
	ServiceTime *float64 `json:"serviceTime,omitempty"`
	// APIRegion - Azure region where the gateway that processed this request is located.
	APIRegion *string `json:"apiRegion,omitempty"`
	// SubscriptionID - Subscription identifier path. /subscriptions/{subscriptionId}
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	// RequestID - Request Identifier.
	RequestID *string `json:"requestId,omitempty"`
	// RequestSize - The size of this request..
	RequestSize *int32 `json:"requestSize,omitempty"`
}

RequestReportRecordContract request Report data.

type ResponseContract 

type ResponseContract struct {
	// StatusCode - Operation response HTTP status code.
	StatusCode *int32 `json:"statusCode,omitempty"`
	// Description - Operation response description.
	Description *string `json:"description,omitempty"`
	// Representations - Collection of operation response representations.
	Representations *[]RepresentationContract `json:"representations,omitempty"`
	// Headers - Collection of operation response headers.
	Headers *[]ParameterContract `json:"headers,omitempty"`
}

ResponseContract operation response details.

type SaveConfigurationParameter 

type SaveConfigurationParameter struct {
	// Branch - The name of the Git branch in which to commit the current configuration snapshot.
	Branch *string `json:"branch,omitempty"`
	// Force - 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"`
}

SaveConfigurationParameter parameters supplied to the Save Tenant Configuration operation.

type SchemaCollection 

type SchemaCollection struct {
	autorest.Response `json:"-"`
	// Value - Api Schema Contract value.
	Value *[]SchemaContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

SchemaCollection the response of the list schema operation.

func (SchemaCollection) IsEmpty 

func (sc SchemaCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type SchemaCollectionIterator 

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

SchemaCollectionIterator provides access to a complete listing of SchemaContract values.

func (*SchemaCollectionIterator) Next 

func (iter *SchemaCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (SchemaCollectionIterator) NotDone 

func (iter SchemaCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (SchemaCollectionIterator) Response 

func (iter SchemaCollectionIterator) Response() SchemaCollection

Response returns the raw server response from the last page request.

func (SchemaCollectionIterator) Value 

func (iter SchemaCollectionIterator) Value() SchemaContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type SchemaCollectionPage 

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

SchemaCollectionPage contains a page of SchemaContract values.

func (*SchemaCollectionPage) Next 

func (page *SchemaCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (SchemaCollectionPage) NotDone 

func (page SchemaCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (SchemaCollectionPage) Response 

func (page SchemaCollectionPage) Response() SchemaCollection

Response returns the raw server response from the last page request.

func (SchemaCollectionPage) Values 

func (page SchemaCollectionPage) Values() []SchemaContract

Values returns the slice of values for the current page or nil if there are no values.

type SchemaContract 

type SchemaContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Schema.
	ID *string `json:"id,omitempty"`
	// ContentType - 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).
	ContentType *string `json:"contentType,omitempty"`
	// SchemaDocumentProperties - Properties of the Schema Document.
	*SchemaDocumentProperties `json:"document,omitempty"`
}

SchemaContract schema Contract details.

type SchemaContractProperties 

type SchemaContractProperties struct {
	// ContentType - 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).
	ContentType *string `json:"contentType,omitempty"`
	// SchemaDocumentProperties - Properties of the Schema Document.
	*SchemaDocumentProperties `json:"document,omitempty"`
}

SchemaContractProperties schema contract Properties.

func (SchemaContractProperties) MarshalJSON 

func (scp SchemaContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SchemaContractProperties.

func (*SchemaContractProperties) UnmarshalJSON 

func (scp *SchemaContractProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SchemaContractProperties struct.

type SchemaDocumentProperties 

type SchemaDocumentProperties struct {
	// Value - Json escaped string defining the document representing the Schema.
	Value *string `json:"value,omitempty"`
}

SchemaDocumentProperties schema Document Properties.

type SignInSettingsClient 

type SignInSettingsClient struct {
	BaseClient
}

SignInSettingsClient is the client for the SignInSettings methods of the Apimanagement service.

func NewSignInSettingsClient 

func NewSignInSettingsClient() SignInSettingsClient

NewSignInSettingsClient creates an instance of the SignInSettingsClient client.

func (SignInSettingsClient) CreateOrUpdate 

func (client SignInSettingsClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, parameters PortalSigninSettings) (result PortalSigninSettings, err error)

CreateOrUpdate create or Update Sign-In settings.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is create or update parameters.

func (SignInSettingsClient) CreateOrUpdatePreparer 

func (client SignInSettingsClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, parameters PortalSigninSettings) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SignInSettingsClient) CreateOrUpdateResponder 

func (client SignInSettingsClient) CreateOrUpdateResponder(resp *http.Response) (result PortalSigninSettings, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (SignInSettingsClient) CreateOrUpdateSender 

func (client SignInSettingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (SignInSettingsClient) Get 

func (client SignInSettingsClient) Get(ctx context.Context, apimBaseURL string) (result PortalSigninSettings, err error)

Get get Sign-In settings.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (SignInSettingsClient) GetPreparer 

func (client SignInSettingsClient) GetPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SignInSettingsClient) GetResponder 

func (client SignInSettingsClient) GetResponder(resp *http.Response) (result PortalSigninSettings, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SignInSettingsClient) GetSender 

func (client SignInSettingsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (SignInSettingsClient) Update 

func (client SignInSettingsClient) Update(ctx context.Context, apimBaseURL string, parameters PortalSigninSettings, ifMatch string) (result autorest.Response, err error)

Update update Sign-In settings.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is update Sign-In settings. ifMatch is the entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (SignInSettingsClient) UpdatePreparer 

func (client SignInSettingsClient) UpdatePreparer(ctx context.Context, apimBaseURL string, parameters PortalSigninSettings, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (SignInSettingsClient) UpdateResponder 

func (client SignInSettingsClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (SignInSettingsClient) UpdateSender 

func (client SignInSettingsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type SignUpSettingsClient 

type SignUpSettingsClient struct {
	BaseClient
}

SignUpSettingsClient is the client for the SignUpSettings methods of the Apimanagement service.

func NewSignUpSettingsClient 

func NewSignUpSettingsClient() SignUpSettingsClient

NewSignUpSettingsClient creates an instance of the SignUpSettingsClient client.

func (SignUpSettingsClient) CreateOrUpdate 

func (client SignUpSettingsClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, parameters PortalSignupSettings) (result PortalSignupSettings, err error)

CreateOrUpdate create or Update Sign-Up settings.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is create or update parameters.

func (SignUpSettingsClient) CreateOrUpdatePreparer 

func (client SignUpSettingsClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, parameters PortalSignupSettings) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SignUpSettingsClient) CreateOrUpdateResponder 

func (client SignUpSettingsClient) CreateOrUpdateResponder(resp *http.Response) (result PortalSignupSettings, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (SignUpSettingsClient) CreateOrUpdateSender 

func (client SignUpSettingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (SignUpSettingsClient) Get 

func (client SignUpSettingsClient) Get(ctx context.Context, apimBaseURL string) (result PortalSignupSettings, err error)

Get get Sign-Up settings.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (SignUpSettingsClient) GetPreparer 

func (client SignUpSettingsClient) GetPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SignUpSettingsClient) GetResponder 

func (client SignUpSettingsClient) GetResponder(resp *http.Response) (result PortalSignupSettings, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SignUpSettingsClient) GetSender 

func (client SignUpSettingsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (SignUpSettingsClient) Update 

func (client SignUpSettingsClient) Update(ctx context.Context, apimBaseURL string, parameters PortalSignupSettings, ifMatch string) (result autorest.Response, err error)

Update update Sign-Up settings.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is update Sign-Up settings. ifMatch is the entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (SignUpSettingsClient) UpdatePreparer 

func (client SignUpSettingsClient) UpdatePreparer(ctx context.Context, apimBaseURL string, parameters PortalSignupSettings, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (SignUpSettingsClient) UpdateResponder 

func (client SignUpSettingsClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (SignUpSettingsClient) UpdateSender 

func (client SignUpSettingsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type SubscriptionClient 

type SubscriptionClient struct {
	BaseClient
}

SubscriptionClient is the client for the Subscription methods of the Apimanagement service.

func NewSubscriptionClient 

func NewSubscriptionClient() SubscriptionClient

NewSubscriptionClient creates an instance of the SubscriptionClient client.

func (SubscriptionClient) CreateOrUpdate 

func (client SubscriptionClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, sid string, parameters SubscriptionCreateParameters, notify string) (result SubscriptionContract, err error)

CreateOrUpdate creates or updates the subscription of specified user to the specified product.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. sid is subscription entity Identifier. The entity represents the association between a user and a product in API Management. parameters is create parameters. notify is notify the subscriber of the subscription state change to Submitted or Active state.

func (SubscriptionClient) CreateOrUpdatePreparer 

func (client SubscriptionClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, sid string, parameters SubscriptionCreateParameters, notify string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SubscriptionClient) CreateOrUpdateResponder 

func (client SubscriptionClient) CreateOrUpdateResponder(resp *http.Response) (result SubscriptionContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (SubscriptionClient) CreateOrUpdateSender 

func (client SubscriptionClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) Delete 

func (client SubscriptionClient) Delete(ctx context.Context, apimBaseURL string, sid string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified subscription.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. sid is subscription entity Identifier. The entity represents the association between a user and a product in API Management. ifMatch is eTag of the Subscription Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (SubscriptionClient) DeletePreparer 

func (client SubscriptionClient) DeletePreparer(ctx context.Context, apimBaseURL string, sid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (SubscriptionClient) DeleteResponder 

func (client SubscriptionClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (SubscriptionClient) DeleteSender 

func (client SubscriptionClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) Get 

func (client SubscriptionClient) Get(ctx context.Context, apimBaseURL string, sid string) (result SubscriptionContract, err error)

Get gets the specified Subscription entity.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. sid is subscription entity Identifier. The entity represents the association between a user and a product in API Management.

func (SubscriptionClient) GetPreparer 

func (client SubscriptionClient) GetPreparer(ctx context.Context, apimBaseURL string, sid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SubscriptionClient) GetResponder 

func (client SubscriptionClient) GetResponder(resp *http.Response) (result SubscriptionContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SubscriptionClient) GetSender 

func (client SubscriptionClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) List 

func (client SubscriptionClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)

List lists all subscriptions of the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |--------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top is number of records to return. skip is number of records to skip.

func (SubscriptionClient) ListComplete 

func (client SubscriptionClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (SubscriptionClient) ListPreparer 

func (client SubscriptionClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (SubscriptionClient) ListResponder 

func (client SubscriptionClient) ListResponder(resp *http.Response) (result SubscriptionCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (SubscriptionClient) ListSender 

func (client SubscriptionClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) RegeneratePrimaryKey 

func (client SubscriptionClient) RegeneratePrimaryKey(ctx context.Context, apimBaseURL string, sid string) (result autorest.Response, err error)

RegeneratePrimaryKey regenerates primary key of existing subscription of the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. sid is subscription entity Identifier. The entity represents the association between a user and a product in API Management.

func (SubscriptionClient) RegeneratePrimaryKeyPreparer 

func (client SubscriptionClient) RegeneratePrimaryKeyPreparer(ctx context.Context, apimBaseURL string, sid string) (*http.Request, error)

RegeneratePrimaryKeyPreparer prepares the RegeneratePrimaryKey request.

func (SubscriptionClient) RegeneratePrimaryKeyResponder 

func (client SubscriptionClient) RegeneratePrimaryKeyResponder(resp *http.Response) (result autorest.Response, err error)

RegeneratePrimaryKeyResponder handles the response to the RegeneratePrimaryKey request. The method always closes the http.Response Body.

func (SubscriptionClient) RegeneratePrimaryKeySender 

func (client SubscriptionClient) RegeneratePrimaryKeySender(req *http.Request) (*http.Response, error)

RegeneratePrimaryKeySender sends the RegeneratePrimaryKey request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) RegenerateSecondaryKey 

func (client SubscriptionClient) RegenerateSecondaryKey(ctx context.Context, apimBaseURL string, sid string) (result autorest.Response, err error)

RegenerateSecondaryKey regenerates secondary key of existing subscription of the API Management service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. sid is subscription entity Identifier. The entity represents the association between a user and a product in API Management.

func (SubscriptionClient) RegenerateSecondaryKeyPreparer 

func (client SubscriptionClient) RegenerateSecondaryKeyPreparer(ctx context.Context, apimBaseURL string, sid string) (*http.Request, error)

RegenerateSecondaryKeyPreparer prepares the RegenerateSecondaryKey request.

func (SubscriptionClient) RegenerateSecondaryKeyResponder 

func (client SubscriptionClient) RegenerateSecondaryKeyResponder(resp *http.Response) (result autorest.Response, err error)

RegenerateSecondaryKeyResponder handles the response to the RegenerateSecondaryKey request. The method always closes the http.Response Body.

func (SubscriptionClient) RegenerateSecondaryKeySender 

func (client SubscriptionClient) RegenerateSecondaryKeySender(req *http.Request) (*http.Response, error)

RegenerateSecondaryKeySender sends the RegenerateSecondaryKey request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) Update 

func (client SubscriptionClient) Update(ctx context.Context, apimBaseURL string, sid string, parameters SubscriptionUpdateParameters, ifMatch string, notify string) (result autorest.Response, err error)

Update updates the details of a subscription specificied by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. sid is subscription entity Identifier. The entity represents the association between a user and a product in API Management. parameters is update parameters. ifMatch is eTag of the Subscription Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. notify is notify the subscriber of the subscription state change to Submitted or Active state.

func (SubscriptionClient) UpdatePreparer 

func (client SubscriptionClient) UpdatePreparer(ctx context.Context, apimBaseURL string, sid string, parameters SubscriptionUpdateParameters, ifMatch string, notify string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (SubscriptionClient) UpdateResponder 

func (client SubscriptionClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (SubscriptionClient) UpdateSender 

func (client SubscriptionClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type SubscriptionCollection 

type SubscriptionCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]SubscriptionContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

SubscriptionCollection paged Subscriptions list representation.

func (SubscriptionCollection) IsEmpty 

func (sc SubscriptionCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type SubscriptionCollectionIterator 

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

SubscriptionCollectionIterator provides access to a complete listing of SubscriptionContract values.

func (*SubscriptionCollectionIterator) Next 

func (iter *SubscriptionCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (SubscriptionCollectionIterator) NotDone 

func (iter SubscriptionCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (SubscriptionCollectionIterator) Response 

func (iter SubscriptionCollectionIterator) Response() SubscriptionCollection

Response returns the raw server response from the last page request.

func (SubscriptionCollectionIterator) Value 

func (iter SubscriptionCollectionIterator) Value() SubscriptionContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type SubscriptionCollectionPage 

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

SubscriptionCollectionPage contains a page of SubscriptionContract values.

func (*SubscriptionCollectionPage) Next 

func (page *SubscriptionCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (SubscriptionCollectionPage) NotDone 

func (page SubscriptionCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (SubscriptionCollectionPage) Response 

func (page SubscriptionCollectionPage) Response() SubscriptionCollection

Response returns the raw server response from the last page request.

func (SubscriptionCollectionPage) Values 

func (page SubscriptionCollectionPage) Values() []SubscriptionContract

Values returns the slice of values for the current page or nil if there are no values.

type SubscriptionContract 

type SubscriptionContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the Subscription.
	ID *string `json:"id,omitempty"`
	// UserID - The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier.
	UserID *string `json:"userId,omitempty"`
	// ProductID - The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier.
	ProductID *string `json:"productId,omitempty"`
	// Name - The name of the subscription, or null if the subscription has no name.
	Name *string `json:"name,omitempty"`
	// State - 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. Possible values include: 'Suspended', 'Active', 'Expired', 'Submitted', 'Rejected', 'Cancelled'
	State SubscriptionState `json:"state,omitempty"`
	// CreatedDate - Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	CreatedDate *date.Time `json:"createdDate,omitempty"`
	// StartDate - 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 *date.Time `json:"startDate,omitempty"`
	// ExpirationDate - 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 *date.Time `json:"expirationDate,omitempty"`
	// EndDate - 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 *date.Time `json:"endDate,omitempty"`
	// NotificationDate - 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 *date.Time `json:"notificationDate,omitempty"`
	// PrimaryKey - Subscription primary key.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - Subscription secondary key.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
	// StateComment - Optional subscription comment added by an administrator.
	StateComment *string `json:"stateComment,omitempty"`
}

SubscriptionContract subscription details.

type SubscriptionContractProperties 

type SubscriptionContractProperties struct {
	// UserID - The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier.
	UserID *string `json:"userId,omitempty"`
	// ProductID - The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier.
	ProductID *string `json:"productId,omitempty"`
	// Name - The name of the subscription, or null if the subscription has no name.
	Name *string `json:"name,omitempty"`
	// State - 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. Possible values include: 'Suspended', 'Active', 'Expired', 'Submitted', 'Rejected', 'Cancelled'
	State SubscriptionState `json:"state,omitempty"`
	// CreatedDate - Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	CreatedDate *date.Time `json:"createdDate,omitempty"`
	// StartDate - 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 *date.Time `json:"startDate,omitempty"`
	// ExpirationDate - 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 *date.Time `json:"expirationDate,omitempty"`
	// EndDate - 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 *date.Time `json:"endDate,omitempty"`
	// NotificationDate - 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 *date.Time `json:"notificationDate,omitempty"`
	// PrimaryKey - Subscription primary key.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - Subscription secondary key.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
	// StateComment - Optional subscription comment added by an administrator.
	StateComment *string `json:"stateComment,omitempty"`
}

SubscriptionContractProperties subscription details.

type SubscriptionCreateParameters 

type SubscriptionCreateParameters struct {
	// UserID - User (user id path) for whom subscription is being created in form /users/{uid}
	UserID *string `json:"userId,omitempty"`
	// ProductID - Product (product id path) for which subscription is being created in form /products/{productid}
	ProductID *string `json:"productId,omitempty"`
	// Name - Subscription name.
	Name *string `json:"name,omitempty"`
	// PrimaryKey - Primary subscription key. If not specified during request key will be generated automatically.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - Secondary subscription key. If not specified during request key will be generated automatically.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
	// State - 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. Possible values include: 'Suspended', 'Active', 'Expired', 'Submitted', 'Rejected', 'Cancelled'
	State SubscriptionState `json:"state,omitempty"`
}

SubscriptionCreateParameters parameters supplied to the Create subscription operation.

type SubscriptionKeyParameterNamesContract 

type SubscriptionKeyParameterNamesContract struct {
	// Header - Subscription key header name.
	Header *string `json:"header,omitempty"`
	// Query - Subscription key query string parameter name.
	Query *string `json:"query,omitempty"`
}

SubscriptionKeyParameterNamesContract subscription key parameter names details.

type SubscriptionState 

type SubscriptionState string

SubscriptionState enumerates the values for subscription state. 

const (
	// Active ...
	Active SubscriptionState = "active"
	// Cancelled ...
	Cancelled SubscriptionState = "cancelled"
	// Expired ...
	Expired SubscriptionState = "expired"
	// Rejected ...
	Rejected SubscriptionState = "rejected"
	// Submitted ...
	Submitted SubscriptionState = "submitted"
	// Suspended ...
	Suspended SubscriptionState = "suspended"
)

func PossibleSubscriptionStateValues 

func PossibleSubscriptionStateValues() []SubscriptionState

PossibleSubscriptionStateValues returns an array of possible values for the SubscriptionState const type.

type SubscriptionUpdateParameters 

type SubscriptionUpdateParameters struct {
	// UserID - User identifier path: /users/{uid}
	UserID *string `json:"userId,omitempty"`
	// ProductID - Product identifier path: /products/{productId}
	ProductID *string `json:"productId,omitempty"`
	// ExpirationDate - 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 *date.Time `json:"expirationDate,omitempty"`
	// Name - Subscription name.
	Name *string `json:"name,omitempty"`
	// PrimaryKey - Primary subscription key.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - Secondary subscription key.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
	// State - 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. Possible values include: 'Suspended', 'Active', 'Expired', 'Submitted', 'Rejected', 'Cancelled'
	State SubscriptionState `json:"state,omitempty"`
	// StateComment - Comments describing subscription state change by the administrator.
	StateComment *string `json:"stateComment,omitempty"`
}

SubscriptionUpdateParameters parameters supplied to the Update subscription operation.

type SubscriptionsDelegationSettingsProperties 

type SubscriptionsDelegationSettingsProperties struct {
	// Enabled - Enable or disable delegation for subscriptions.
	Enabled *bool `json:"enabled,omitempty"`
}

SubscriptionsDelegationSettingsProperties subscriptions delegation settings properties.

type TemplateName 

type TemplateName string

TemplateName enumerates the values for template name. 

const (
	// AccountClosedDeveloper ...
	AccountClosedDeveloper TemplateName = "accountClosedDeveloper"
	// ApplicationApprovedNotificationMessage ...
	ApplicationApprovedNotificationMessage TemplateName = "applicationApprovedNotificationMessage"
	// ConfirmSignUpIdentityDefault ...
	ConfirmSignUpIdentityDefault TemplateName = "confirmSignUpIdentityDefault"
	// EmailChangeIdentityDefault ...
	EmailChangeIdentityDefault TemplateName = "emailChangeIdentityDefault"
	// InviteUserNotificationMessage ...
	InviteUserNotificationMessage TemplateName = "inviteUserNotificationMessage"
	// NewCommentNotificationMessage ...
	NewCommentNotificationMessage TemplateName = "newCommentNotificationMessage"
	// NewDeveloperNotificationMessage ...
	NewDeveloperNotificationMessage TemplateName = "newDeveloperNotificationMessage"
	// NewIssueNotificationMessage ...
	NewIssueNotificationMessage TemplateName = "newIssueNotificationMessage"
	// PasswordResetByAdminNotificationMessage ...
	PasswordResetByAdminNotificationMessage TemplateName = "passwordResetByAdminNotificationMessage"
	// PasswordResetIdentityDefault ...
	PasswordResetIdentityDefault TemplateName = "passwordResetIdentityDefault"
	// PurchaseDeveloperNotificationMessage ...
	PurchaseDeveloperNotificationMessage TemplateName = "purchaseDeveloperNotificationMessage"
	// QuotaLimitApproachingDeveloperNotificationMessage ...
	QuotaLimitApproachingDeveloperNotificationMessage TemplateName = "quotaLimitApproachingDeveloperNotificationMessage"
	// RejectDeveloperNotificationMessage ...
	RejectDeveloperNotificationMessage TemplateName = "rejectDeveloperNotificationMessage"
	// RequestDeveloperNotificationMessage ...
	RequestDeveloperNotificationMessage TemplateName = "requestDeveloperNotificationMessage"
)

func PossibleTemplateNameValues 

func PossibleTemplateNameValues() []TemplateName

PossibleTemplateNameValues returns an array of possible values for the TemplateName const type.

type TenantAccessClient 

type TenantAccessClient struct {
	BaseClient
}

TenantAccessClient is the client for the TenantAccess methods of the Apimanagement service.

func NewTenantAccessClient 

func NewTenantAccessClient() TenantAccessClient

NewTenantAccessClient creates an instance of the TenantAccessClient client.

func (TenantAccessClient) Get 

func (client TenantAccessClient) Get(ctx context.Context, apimBaseURL string) (result AccessInformationContract, err error)

Get get tenant access information details.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (TenantAccessClient) GetPreparer 

func (client TenantAccessClient) GetPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TenantAccessClient) GetResponder 

func (client TenantAccessClient) GetResponder(resp *http.Response) (result AccessInformationContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (TenantAccessClient) GetSender 

func (client TenantAccessClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (TenantAccessClient) RegeneratePrimaryKey 

func (client TenantAccessClient) RegeneratePrimaryKey(ctx context.Context, apimBaseURL string) (result autorest.Response, err error)

RegeneratePrimaryKey regenerate primary access key.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (TenantAccessClient) RegeneratePrimaryKeyPreparer 

func (client TenantAccessClient) RegeneratePrimaryKeyPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

RegeneratePrimaryKeyPreparer prepares the RegeneratePrimaryKey request.

func (TenantAccessClient) RegeneratePrimaryKeyResponder 

func (client TenantAccessClient) RegeneratePrimaryKeyResponder(resp *http.Response) (result autorest.Response, err error)

RegeneratePrimaryKeyResponder handles the response to the RegeneratePrimaryKey request. The method always closes the http.Response Body.

func (TenantAccessClient) RegeneratePrimaryKeySender 

func (client TenantAccessClient) RegeneratePrimaryKeySender(req *http.Request) (*http.Response, error)

RegeneratePrimaryKeySender sends the RegeneratePrimaryKey request. The method will close the http.Response Body if it receives an error.

func (TenantAccessClient) RegenerateSecondaryKey 

func (client TenantAccessClient) RegenerateSecondaryKey(ctx context.Context, apimBaseURL string) (result autorest.Response, err error)

RegenerateSecondaryKey regenerate secondary access key.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (TenantAccessClient) RegenerateSecondaryKeyPreparer 

func (client TenantAccessClient) RegenerateSecondaryKeyPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

RegenerateSecondaryKeyPreparer prepares the RegenerateSecondaryKey request.

func (TenantAccessClient) RegenerateSecondaryKeyResponder 

func (client TenantAccessClient) RegenerateSecondaryKeyResponder(resp *http.Response) (result autorest.Response, err error)

RegenerateSecondaryKeyResponder handles the response to the RegenerateSecondaryKey request. The method always closes the http.Response Body.

func (TenantAccessClient) RegenerateSecondaryKeySender 

func (client TenantAccessClient) RegenerateSecondaryKeySender(req *http.Request) (*http.Response, error)

RegenerateSecondaryKeySender sends the RegenerateSecondaryKey request. The method will close the http.Response Body if it receives an error.

func (TenantAccessClient) Update 

func (client TenantAccessClient) Update(ctx context.Context, apimBaseURL string, parameters AccessInformationUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update update tenant access information details.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is parameters supplied to retrieve the Tenant Access Information. ifMatch is the entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (TenantAccessClient) UpdatePreparer 

func (client TenantAccessClient) UpdatePreparer(ctx context.Context, apimBaseURL string, parameters AccessInformationUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (TenantAccessClient) UpdateResponder 

func (client TenantAccessClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (TenantAccessClient) UpdateSender 

func (client TenantAccessClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type TenantAccessGitClient 

type TenantAccessGitClient struct {
	BaseClient
}

TenantAccessGitClient is the client for the TenantAccessGit methods of the Apimanagement service.

func NewTenantAccessGitClient 

func NewTenantAccessGitClient() TenantAccessGitClient

NewTenantAccessGitClient creates an instance of the TenantAccessGitClient client.

func (TenantAccessGitClient) Get 

func (client TenantAccessGitClient) Get(ctx context.Context, apimBaseURL string) (result AccessInformationContract, err error)

Get gets the Git access configuration for the tenant.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (TenantAccessGitClient) GetPreparer 

func (client TenantAccessGitClient) GetPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TenantAccessGitClient) GetResponder 

func (client TenantAccessGitClient) GetResponder(resp *http.Response) (result AccessInformationContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (TenantAccessGitClient) GetSender 

func (client TenantAccessGitClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (TenantAccessGitClient) RegeneratePrimaryKey 

func (client TenantAccessGitClient) RegeneratePrimaryKey(ctx context.Context, apimBaseURL string) (result autorest.Response, err error)

RegeneratePrimaryKey regenerate primary access key for GIT.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (TenantAccessGitClient) RegeneratePrimaryKeyPreparer 

func (client TenantAccessGitClient) RegeneratePrimaryKeyPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

RegeneratePrimaryKeyPreparer prepares the RegeneratePrimaryKey request.

func (TenantAccessGitClient) RegeneratePrimaryKeyResponder 

func (client TenantAccessGitClient) RegeneratePrimaryKeyResponder(resp *http.Response) (result autorest.Response, err error)

RegeneratePrimaryKeyResponder handles the response to the RegeneratePrimaryKey request. The method always closes the http.Response Body.

func (TenantAccessGitClient) RegeneratePrimaryKeySender 

func (client TenantAccessGitClient) RegeneratePrimaryKeySender(req *http.Request) (*http.Response, error)

RegeneratePrimaryKeySender sends the RegeneratePrimaryKey request. The method will close the http.Response Body if it receives an error.

func (TenantAccessGitClient) RegenerateSecondaryKey 

func (client TenantAccessGitClient) RegenerateSecondaryKey(ctx context.Context, apimBaseURL string) (result autorest.Response, err error)

RegenerateSecondaryKey regenerate secondary access key for GIT.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (TenantAccessGitClient) RegenerateSecondaryKeyPreparer 

func (client TenantAccessGitClient) RegenerateSecondaryKeyPreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

RegenerateSecondaryKeyPreparer prepares the RegenerateSecondaryKey request.

func (TenantAccessGitClient) RegenerateSecondaryKeyResponder 

func (client TenantAccessGitClient) RegenerateSecondaryKeyResponder(resp *http.Response) (result autorest.Response, err error)

RegenerateSecondaryKeyResponder handles the response to the RegenerateSecondaryKey request. The method always closes the http.Response Body.

func (TenantAccessGitClient) RegenerateSecondaryKeySender 

func (client TenantAccessGitClient) RegenerateSecondaryKeySender(req *http.Request) (*http.Response, error)

RegenerateSecondaryKeySender sends the RegenerateSecondaryKey request. The method will close the http.Response Body if it receives an error.

type TenantConfigurationClient 

type TenantConfigurationClient struct {
	BaseClient
}

TenantConfigurationClient is the client for the TenantConfiguration methods of the Apimanagement service.

func NewTenantConfigurationClient 

func NewTenantConfigurationClient() TenantConfigurationClient

NewTenantConfigurationClient creates an instance of the TenantConfigurationClient client.

func (TenantConfigurationClient) Deploy 

func (client TenantConfigurationClient) Deploy(ctx context.Context, apimBaseURL string, parameters DeployConfigurationParameters) (result TenantConfigurationDeployFuture, err error)

Deploy 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.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is deploy Configuration parameters.

func (TenantConfigurationClient) DeployPreparer 

func (client TenantConfigurationClient) DeployPreparer(ctx context.Context, apimBaseURL string, parameters DeployConfigurationParameters) (*http.Request, error)

DeployPreparer prepares the Deploy request.

func (TenantConfigurationClient) DeployResponder 

func (client TenantConfigurationClient) DeployResponder(resp *http.Response) (result OperationResultContract, err error)

DeployResponder handles the response to the Deploy request. The method always closes the http.Response Body.

func (TenantConfigurationClient) DeploySender 

func (client TenantConfigurationClient) DeploySender(req *http.Request) (future TenantConfigurationDeployFuture, err error)

DeploySender sends the Deploy request. The method will close the http.Response Body if it receives an error.

func (TenantConfigurationClient) GetSyncState 

func (client TenantConfigurationClient) GetSyncState(ctx context.Context, apimBaseURL string) (result TenantConfigurationSyncStateContract, err error)

GetSyncState gets the status of the most recent synchronization between the configuration database and the Git repository.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (TenantConfigurationClient) GetSyncStatePreparer 

func (client TenantConfigurationClient) GetSyncStatePreparer(ctx context.Context, apimBaseURL string) (*http.Request, error)

GetSyncStatePreparer prepares the GetSyncState request.

func (TenantConfigurationClient) GetSyncStateResponder 

func (client TenantConfigurationClient) GetSyncStateResponder(resp *http.Response) (result TenantConfigurationSyncStateContract, err error)

GetSyncStateResponder handles the response to the GetSyncState request. The method always closes the http.Response Body.

func (TenantConfigurationClient) GetSyncStateSender 

func (client TenantConfigurationClient) GetSyncStateSender(req *http.Request) (*http.Response, error)

GetSyncStateSender sends the GetSyncState request. The method will close the http.Response Body if it receives an error.

func (TenantConfigurationClient) Save 

func (client TenantConfigurationClient) Save(ctx context.Context, apimBaseURL string, parameters SaveConfigurationParameter) (result TenantConfigurationSaveFuture, err error)

Save 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.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is save Configuration parameters.

func (TenantConfigurationClient) SavePreparer 

func (client TenantConfigurationClient) SavePreparer(ctx context.Context, apimBaseURL string, parameters SaveConfigurationParameter) (*http.Request, error)

SavePreparer prepares the Save request.

func (TenantConfigurationClient) SaveResponder 

func (client TenantConfigurationClient) SaveResponder(resp *http.Response) (result OperationResultContract, err error)

SaveResponder handles the response to the Save request. The method always closes the http.Response Body.

func (TenantConfigurationClient) SaveSender 

func (client TenantConfigurationClient) SaveSender(req *http.Request) (future TenantConfigurationSaveFuture, err error)

SaveSender sends the Save request. The method will close the http.Response Body if it receives an error.

func (TenantConfigurationClient) Validate 

func (client TenantConfigurationClient) Validate(ctx context.Context, apimBaseURL string, parameters DeployConfigurationParameters) (result TenantConfigurationValidateFuture, err error)

Validate this operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters is validate Configuration parameters.

func (TenantConfigurationClient) ValidatePreparer 

func (client TenantConfigurationClient) ValidatePreparer(ctx context.Context, apimBaseURL string, parameters DeployConfigurationParameters) (*http.Request, error)

ValidatePreparer prepares the Validate request.

func (TenantConfigurationClient) ValidateResponder 

func (client TenantConfigurationClient) ValidateResponder(resp *http.Response) (result OperationResultContract, err error)

ValidateResponder handles the response to the Validate request. The method always closes the http.Response Body.

func (TenantConfigurationClient) ValidateSender 

func (client TenantConfigurationClient) ValidateSender(req *http.Request) (future TenantConfigurationValidateFuture, err error)

ValidateSender sends the Validate request. The method will close the http.Response Body if it receives an error.

type TenantConfigurationDeployFuture 

type TenantConfigurationDeployFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

TenantConfigurationDeployFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (TenantConfigurationDeployFuture) Result 

func (future TenantConfigurationDeployFuture) Result(client TenantConfigurationClient) (orc OperationResultContract, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type TenantConfigurationSaveFuture 

type TenantConfigurationSaveFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

TenantConfigurationSaveFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (TenantConfigurationSaveFuture) Result 

func (future TenantConfigurationSaveFuture) Result(client TenantConfigurationClient) (orc OperationResultContract, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type TenantConfigurationSyncStateContract 

type TenantConfigurationSyncStateContract struct {
	autorest.Response `json:"-"`
	// Branch - The name of Git branch.
	Branch *string `json:"branch,omitempty"`
	// CommitID - The latest commit Id.
	CommitID *string `json:"commitId,omitempty"`
	// IsExport - value indicating if last sync was save (true) or deploy (false) operation.
	IsExport *bool `json:"isExport,omitempty"`
	// IsSynced - value indicating if last synchronization was later than the configuration change.
	IsSynced *bool `json:"isSynced,omitempty"`
	// IsGitEnabled - value indicating whether Git configuration access is enabled.
	IsGitEnabled *bool `json:"isGitEnabled,omitempty"`
	// SyncDate - 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 *date.Time `json:"syncDate,omitempty"`
	// ConfigurationChangeDate - 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 *date.Time `json:"configurationChangeDate,omitempty"`
}

TenantConfigurationSyncStateContract tenant Configuration Synchronization State.

type TenantConfigurationValidateFuture 

type TenantConfigurationValidateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

TenantConfigurationValidateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (TenantConfigurationValidateFuture) Result 

func (future TenantConfigurationValidateFuture) Result(client TenantConfigurationClient) (orc OperationResultContract, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type TermsOfServiceProperties 

type TermsOfServiceProperties struct {
	// Text - A terms of service text.
	Text *string `json:"text,omitempty"`
	// Enabled - Display terms of service during a sign-up process.
	Enabled *bool `json:"enabled,omitempty"`
	// ConsentRequired - Ask user for consent to the terms of service.
	ConsentRequired *bool `json:"consentRequired,omitempty"`
}

TermsOfServiceProperties terms of service contract properties.

type TokenBodyParameterContract 

type TokenBodyParameterContract struct {
	// Name - body parameter name.
	Name *string `json:"name,omitempty"`
	// Value - body parameter value.
	Value *string `json:"value,omitempty"`
}

TokenBodyParameterContract oAuth acquire token request body parameter (www-url-form-encoded).

type UserClient 

type UserClient struct {
	BaseClient
}

UserClient is the client for the User methods of the Apimanagement service.

func NewUserClient 

func NewUserClient() UserClient

NewUserClient creates an instance of the UserClient client.

func (UserClient) CreateOrUpdate 

func (client UserClient) CreateOrUpdate(ctx context.Context, apimBaseURL string, UID string, parameters UserCreateParameters) (result UserContract, err error)

CreateOrUpdate creates or Updates a user.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. UID is user identifier. Must be unique in the current API Management service instance. parameters is create or update parameters.

func (UserClient) CreateOrUpdatePreparer 

func (client UserClient) CreateOrUpdatePreparer(ctx context.Context, apimBaseURL string, UID string, parameters UserCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (UserClient) CreateOrUpdateResponder 

func (client UserClient) CreateOrUpdateResponder(resp *http.Response) (result UserContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (UserClient) CreateOrUpdateSender 

func (client UserClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (UserClient) Delete 

func (client UserClient) Delete(ctx context.Context, apimBaseURL string, UID string, ifMatch string, deleteSubscriptions string, notify string) (result autorest.Response, err error)

Delete deletes specific user.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. UID is user identifier. Must be unique in the current API Management service instance. ifMatch is the entity state (Etag) version of the user to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. deleteSubscriptions is whether to delete user's subscription or not. notify is send an Account Closed Email notification to the User.

func (UserClient) DeletePreparer 

func (client UserClient) DeletePreparer(ctx context.Context, apimBaseURL string, UID string, ifMatch string, deleteSubscriptions string, notify string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (UserClient) DeleteResponder 

func (client UserClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (UserClient) DeleteSender 

func (client UserClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (UserClient) GenerateSsoURL 

func (client UserClient) GenerateSsoURL(ctx context.Context, apimBaseURL string, UID string) (result GenerateSsoURLResult, err error)

GenerateSsoURL retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. UID is user identifier. Must be unique in the current API Management service instance.

func (UserClient) GenerateSsoURLPreparer 

func (client UserClient) GenerateSsoURLPreparer(ctx context.Context, apimBaseURL string, UID string) (*http.Request, error)

GenerateSsoURLPreparer prepares the GenerateSsoURL request.

func (UserClient) GenerateSsoURLResponder 

func (client UserClient) GenerateSsoURLResponder(resp *http.Response) (result GenerateSsoURLResult, err error)

GenerateSsoURLResponder handles the response to the GenerateSsoURL request. The method always closes the http.Response Body.

func (UserClient) GenerateSsoURLSender 

func (client UserClient) GenerateSsoURLSender(req *http.Request) (*http.Response, error)

GenerateSsoURLSender sends the GenerateSsoURL request. The method will close the http.Response Body if it receives an error.

func (UserClient) Get 

func (client UserClient) Get(ctx context.Context, apimBaseURL string, UID string) (result UserContract, err error)

Get gets the details of the user specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. UID is user identifier. Must be unique in the current API Management service instance.

func (UserClient) GetPreparer 

func (client UserClient) GetPreparer(ctx context.Context, apimBaseURL string, UID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (UserClient) GetResponder 

func (client UserClient) GetResponder(resp *http.Response) (result UserContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (UserClient) GetSender 

func (client UserClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (UserClient) GetSharedAccessToken 

func (client UserClient) GetSharedAccessToken(ctx context.Context, apimBaseURL string, UID string, parameters UserTokenParameters) (result UserTokenResult, err error)

GetSharedAccessToken gets the Shared Access Authorization Token for the User.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. UID is user identifier. Must be unique in the current API Management service instance. parameters is create Authorization Token parameters.

func (UserClient) GetSharedAccessTokenPreparer 

func (client UserClient) GetSharedAccessTokenPreparer(ctx context.Context, apimBaseURL string, UID string, parameters UserTokenParameters) (*http.Request, error)

GetSharedAccessTokenPreparer prepares the GetSharedAccessToken request.

func (UserClient) GetSharedAccessTokenResponder 

func (client UserClient) GetSharedAccessTokenResponder(resp *http.Response) (result UserTokenResult, err error)

GetSharedAccessTokenResponder handles the response to the GetSharedAccessToken request. The method always closes the http.Response Body.

func (UserClient) GetSharedAccessTokenSender 

func (client UserClient) GetSharedAccessTokenSender(req *http.Request) (*http.Response, error)

GetSharedAccessTokenSender sends the GetSharedAccessToken request. The method will close the http.Response Body if it receives an error.

func (UserClient) List 

func (client UserClient) List(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result UserCollectionPage, err error)

List lists a collection of registered users in the specified service instance.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. filter is | Field | Supported operators | Supported functions | |------------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | N/A | | registrationDate | ge, le, eq, ne, gt, lt | N/A | | note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (UserClient) ListComplete 

func (client UserClient) ListComplete(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (result UserCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UserClient) ListPreparer 

func (client UserClient) ListPreparer(ctx context.Context, apimBaseURL string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (UserClient) ListResponder 

func (client UserClient) ListResponder(resp *http.Response) (result UserCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UserClient) ListSender 

func (client UserClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (UserClient) Update 

func (client UserClient) Update(ctx context.Context, apimBaseURL string, UID string, parameters UserUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates the details of the user specified by its identifier.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. UID is user identifier. Must be unique in the current API Management service instance. parameters is update parameters. ifMatch is the entity state (Etag) version of the user to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (UserClient) UpdatePreparer 

func (client UserClient) UpdatePreparer(ctx context.Context, apimBaseURL string, UID string, parameters UserUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (UserClient) UpdateResponder 

func (client UserClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (UserClient) UpdateSender 

func (client UserClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type UserCollection 

type UserCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]UserContract `json:"value,omitempty"`
	// Count - Total number of entities
	Count *int32 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

UserCollection paged Users list representation.

func (UserCollection) IsEmpty 

func (uc UserCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UserCollectionIterator 

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

UserCollectionIterator provides access to a complete listing of UserContract values.

func (*UserCollectionIterator) Next 

func (iter *UserCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (UserCollectionIterator) NotDone 

func (iter UserCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (UserCollectionIterator) Response 

func (iter UserCollectionIterator) Response() UserCollection

Response returns the raw server response from the last page request.

func (UserCollectionIterator) Value 

func (iter UserCollectionIterator) Value() UserContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type UserCollectionPage 

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

UserCollectionPage contains a page of UserContract values.

func (*UserCollectionPage) Next 

func (page *UserCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (UserCollectionPage) NotDone 

func (page UserCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (UserCollectionPage) Response 

func (page UserCollectionPage) Response() UserCollection

Response returns the raw server response from the last page request.

func (UserCollectionPage) Values 

func (page UserCollectionPage) Values() []UserContract

Values returns the slice of values for the current page or nil if there are no values.

type UserContract 

type UserContract struct {
	autorest.Response `json:"-"`
	// ID - Identifier of the entity.
	ID *string `json:"id,omitempty"`
	// FirstName - First name.
	FirstName *string `json:"firstName,omitempty"`
	// LastName - Last name.
	LastName *string `json:"lastName,omitempty"`
	// Email - Email address.
	Email *string `json:"email,omitempty"`
	// RegistrationDate - Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	RegistrationDate *date.Time `json:"registrationDate,omitempty"`
	// Groups - Collection of groups user is part of.
	Groups *[]GroupContract `json:"groups,omitempty"`
	// State - 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. Possible values include: 'UserStateActive', 'UserStateBlocked'
	State UserState `json:"state,omitempty"`
	// Note - Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`
	// Identities - Collection of user identities.
	Identities *[]UserIdentityContract `json:"identities,omitempty"`
}

UserContract user details.

type UserContractProperties 

type UserContractProperties struct {
	// FirstName - First name.
	FirstName *string `json:"firstName,omitempty"`
	// LastName - Last name.
	LastName *string `json:"lastName,omitempty"`
	// Email - Email address.
	Email *string `json:"email,omitempty"`
	// RegistrationDate - Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	RegistrationDate *date.Time `json:"registrationDate,omitempty"`
	// Groups - Collection of groups user is part of.
	Groups *[]GroupContract `json:"groups,omitempty"`
	// State - 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. Possible values include: 'UserStateActive', 'UserStateBlocked'
	State UserState `json:"state,omitempty"`
	// Note - Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`
	// Identities - Collection of user identities.
	Identities *[]UserIdentityContract `json:"identities,omitempty"`
}

UserContractProperties user profile.

type UserCreateParameters 

type UserCreateParameters struct {
	// Email - Email address. Must not be empty and must be unique within the service instance.
	Email *string `json:"email,omitempty"`
	// FirstName - First name.
	FirstName *string `json:"firstName,omitempty"`
	// LastName - Last name.
	LastName *string `json:"lastName,omitempty"`
	// Password - User Password. If no value is provided, a default password is generated.
	Password *string `json:"password,omitempty"`
	// State - 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. Possible values include: 'UserStateActive', 'UserStateBlocked'
	State UserState `json:"state,omitempty"`
	// Note - Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`
	// Identities - Collection of user identities.
	Identities *[]UserIdentityContract `json:"identities,omitempty"`
}

UserCreateParameters parameters supplied to the Create User operation.

type UserEntityBaseParameters 

type UserEntityBaseParameters struct {
	// State - 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. Possible values include: 'UserStateActive', 'UserStateBlocked'
	State UserState `json:"state,omitempty"`
	// Note - Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`
	// Identities - Collection of user identities.
	Identities *[]UserIdentityContract `json:"identities,omitempty"`
}

UserEntityBaseParameters user Entity Base Parameters set.

type UserGroupClient 

type UserGroupClient struct {
	BaseClient
}

UserGroupClient is the client for the UserGroup methods of the Apimanagement service.

func NewUserGroupClient 

func NewUserGroupClient() UserGroupClient

NewUserGroupClient creates an instance of the UserGroupClient client.

func (UserGroupClient) List 

func (client UserGroupClient) List(ctx context.Context, apimBaseURL string, UID string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)

List lists all user groups.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. UID is user identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (UserGroupClient) ListComplete 

func (client UserGroupClient) ListComplete(ctx context.Context, apimBaseURL string, UID string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UserGroupClient) ListPreparer 

func (client UserGroupClient) ListPreparer(ctx context.Context, apimBaseURL string, UID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (UserGroupClient) ListResponder 

func (client UserGroupClient) ListResponder(resp *http.Response) (result GroupCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UserGroupClient) ListSender 

func (client UserGroupClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UserIdentitiesClient 

type UserIdentitiesClient struct {
	BaseClient
}

UserIdentitiesClient is the client for the UserIdentities methods of the Apimanagement service.

func NewUserIdentitiesClient 

func NewUserIdentitiesClient() UserIdentitiesClient

NewUserIdentitiesClient creates an instance of the UserIdentitiesClient client.

func (UserIdentitiesClient) List 

func (client UserIdentitiesClient) List(ctx context.Context, apimBaseURL string, UID string) (result UserIdentityCollection, err error)

List lists all user identities.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. UID is user identifier. Must be unique in the current API Management service instance.

func (UserIdentitiesClient) ListPreparer 

func (client UserIdentitiesClient) ListPreparer(ctx context.Context, apimBaseURL string, UID string) (*http.Request, error)

ListPreparer prepares the List request.

func (UserIdentitiesClient) ListResponder 

func (client UserIdentitiesClient) ListResponder(resp *http.Response) (result UserIdentityCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UserIdentitiesClient) ListSender 

func (client UserIdentitiesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UserIdentityCollection 

type UserIdentityCollection struct {
	autorest.Response `json:"-"`
	// Value - User Identity values.
	Value *[]UserIdentityContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

UserIdentityCollection list of Users Identity list representation.

type UserIdentityContract 

type UserIdentityContract struct {
	// Provider - Identity provider name.
	Provider *string `json:"provider,omitempty"`
	// ID - Identifier value within provider.
	ID *string `json:"id,omitempty"`
}

UserIdentityContract user identity details.

type UserState 

type UserState string

UserState enumerates the values for user state. 

const (
	// UserStateActive ...
	UserStateActive UserState = "active"
	// UserStateBlocked ...
	UserStateBlocked UserState = "blocked"
)

func PossibleUserStateValues 

func PossibleUserStateValues() []UserState

PossibleUserStateValues returns an array of possible values for the UserState const type.

type UserSubscriptionClient 

type UserSubscriptionClient struct {
	BaseClient
}

UserSubscriptionClient is the client for the UserSubscription methods of the Apimanagement service.

func NewUserSubscriptionClient 

func NewUserSubscriptionClient() UserSubscriptionClient

NewUserSubscriptionClient creates an instance of the UserSubscriptionClient client.

func (UserSubscriptionClient) List 

func (client UserSubscriptionClient) List(ctx context.Context, apimBaseURL string, UID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)

List lists the collection of subscriptions of the specified user.

apimBaseURL is the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. UID is user identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |--------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top is number of records to return. skip is number of records to skip.

func (UserSubscriptionClient) ListComplete 

func (client UserSubscriptionClient) ListComplete(ctx context.Context, apimBaseURL string, UID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UserSubscriptionClient) ListPreparer 

func (client UserSubscriptionClient) ListPreparer(ctx context.Context, apimBaseURL string, UID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (UserSubscriptionClient) ListResponder 

func (client UserSubscriptionClient) ListResponder(resp *http.Response) (result SubscriptionCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UserSubscriptionClient) ListSender 

func (client UserSubscriptionClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UserTokenParameters 

type UserTokenParameters struct {
	// KeyType - The Key to be used to generate token for user. Possible values include: 'Primary', 'Secondary'
	KeyType KeyType `json:"keyType,omitempty"`
	// Expiry - 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 *date.Time `json:"expiry,omitempty"`
}

UserTokenParameters parameters supplied to the Get User Token operation.

type UserTokenResult 

type UserTokenResult struct {
	autorest.Response `json:"-"`
	// Value - Shared Access Authorization token for the User.
	Value *string `json:"value,omitempty"`
}

UserTokenResult get User Token response details.

type UserUpdateParameters 

type UserUpdateParameters struct {
	// Email - Email address. Must not be empty and must be unique within the service instance.
	Email *string `json:"email,omitempty"`
	// Password - User Password.
	Password *string `json:"password,omitempty"`
	// FirstName - First name.
	FirstName *string `json:"firstName,omitempty"`
	// LastName - Last name.
	LastName *string `json:"lastName,omitempty"`
	// State - 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. Possible values include: 'UserStateActive', 'UserStateBlocked'
	State UserState `json:"state,omitempty"`
	// Note - Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`
	// Identities - Collection of user identities.
	Identities *[]UserIdentityContract `json:"identities,omitempty"`
}

UserUpdateParameters parameters supplied to the Update User operation.

type X509CertificateName 

type X509CertificateName struct {
	// Name - Common Name of the Certificate.
	Name *string `json:"name,omitempty"`
	// IssuerCertificateThumbprint - Thumbprint for the Issuer of the Certificate.
	IssuerCertificateThumbprint *string `json:"issuerCertificateThumbprint,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.