apimanagement

package
v12.3.0-beta+incompatible Latest Latest
Warning

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

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

Documentation

Overview

Package apimanagement implements the Azure ARM Apimanagement service API version 2016-10-10.

ApiManagement Client

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Apimanagement
	DefaultBaseURI = "https://management.azure.com"
)

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 APICollection 

type APICollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]APIContract `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"`
}

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:"-"`
	// 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"`
	// Type - Type of API. Possible values include: 'APITypeContractHTTP', 'APITypeContractSoap'
	Type APITypeContract `json:"type,omitempty"`
	// ID - API identifier path: /apis/{apiId}
	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 *[]APIProtocolContract `json:"protocols,omitempty"`
}

APIContract API details.

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"`
	// Type - Type of API. Possible values include: 'APITypeContractHTTP', 'APITypeContractSoap'
	Type APITypeContract `json:"type,omitempty"`
}

APIEntityBaseContract API base contract details.

type APIExportClient 

type APIExportClient struct {
	BaseClient
}

APIExportClient is the apiManagement Client

func NewAPIExportClient 

func NewAPIExportClient(subscriptionID string) APIExportClient

NewAPIExportClient creates an instance of the APIExportClient client.

func NewAPIExportClientWithBaseURI 

func NewAPIExportClientWithBaseURI(baseURI string, subscriptionID string) APIExportClient

NewAPIExportClientWithBaseURI creates an instance of the APIExportClient client.

func (APIExportClient) Get 

func (client APIExportClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (result APIExportResult, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiid is API identifier. Must be unique in the current API Management service instance.

func (APIExportClient) GetPreparer 

func (client APIExportClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName 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:"-"`
	// Content - Response content bytes.
	Content *[]byte `json:"content,omitempty"`
	// StatusCode - Possible values include: 'Continue', 'OK', 'Created', 'Accepted', 'NotFound', 'Conflict'
	StatusCode HTTPStatusCode `json:"statusCode,omitempty"`
	RequestID  *string        `json:"requestId,omitempty"`
}

APIExportResult the response model for the export API output operation.

type APIOperationsClient 

type APIOperationsClient struct {
	BaseClient
}

APIOperationsClient is the apiManagement Client

func NewAPIOperationsClient 

func NewAPIOperationsClient(subscriptionID string) APIOperationsClient

NewAPIOperationsClient creates an instance of the APIOperationsClient client.

func NewAPIOperationsClientWithBaseURI 

func NewAPIOperationsClientWithBaseURI(baseURI string, subscriptionID string) APIOperationsClient

NewAPIOperationsClientWithBaseURI creates an instance of the APIOperationsClient client.

func (APIOperationsClient) CreateOrUpdate 

func (client APIOperationsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, parameters OperationContract) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (APIOperationsClient) CreateOrUpdatePreparer 

func (client APIOperationsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, parameters OperationContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationsClient) CreateOrUpdateResponder 

func (client APIOperationsClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (APIOperationsClient) CreateOrUpdateSender 

func (client APIOperationsClient) 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 (APIOperationsClient) Delete 

func (client APIOperationsClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified operation.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (APIOperationsClient) DeletePreparer 

func (client APIOperationsClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (APIOperationsClient) DeleteResponder 

func (client APIOperationsClient) 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 (APIOperationsClient) DeleteSender 

func (client APIOperationsClient) 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 (APIOperationsClient) Get 

func (client APIOperationsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (result OperationContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (APIOperationsClient) GetPreparer 

func (client APIOperationsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (APIOperationsClient) GetResponder 

func (client APIOperationsClient) 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 (APIOperationsClient) GetSender 

func (client APIOperationsClient) 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 (APIOperationsClient) ListByApis 

func (client APIOperationsClient) ListByApis(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result OperationCollectionPage, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (APIOperationsClient) ListByApisComplete 

func (client APIOperationsClient) ListByApisComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result OperationCollectionIterator, err error)

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

func (APIOperationsClient) ListByApisPreparer 

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

ListByApisPreparer prepares the ListByApis request.

func (APIOperationsClient) ListByApisResponder 

func (client APIOperationsClient) ListByApisResponder(resp *http.Response) (result OperationCollection, err error)

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

func (APIOperationsClient) ListByApisSender 

func (client APIOperationsClient) 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.

func (APIOperationsClient) Update 

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

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (APIOperationsClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (APIOperationsClient) UpdateResponder 

func (client APIOperationsClient) 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 (APIOperationsClient) UpdateSender 

func (client APIOperationsClient) 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 APIOperationsPolicyClient 

type APIOperationsPolicyClient struct {
	BaseClient
}

APIOperationsPolicyClient is the apiManagement Client

func NewAPIOperationsPolicyClient 

func NewAPIOperationsPolicyClient(subscriptionID string) APIOperationsPolicyClient

NewAPIOperationsPolicyClient creates an instance of the APIOperationsPolicyClient client.

func NewAPIOperationsPolicyClientWithBaseURI 

func NewAPIOperationsPolicyClientWithBaseURI(baseURI string, subscriptionID string) APIOperationsPolicyClient

NewAPIOperationsPolicyClientWithBaseURI creates an instance of the APIOperationsPolicyClient client.

func (APIOperationsPolicyClient) CreateOrUpdate 

func (client APIOperationsPolicyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, parameters io.ReadCloser, ifMatch string) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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. parameters will be closed upon successful return. Callers should ensure closure when receiving an error.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 (APIOperationsPolicyClient) CreateOrUpdatePreparer 

func (client APIOperationsPolicyClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, parameters io.ReadCloser, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationsPolicyClient) CreateOrUpdateResponder 

func (client APIOperationsPolicyClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (APIOperationsPolicyClient) CreateOrUpdateSender 

func (client APIOperationsPolicyClient) 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 (APIOperationsPolicyClient) Delete 

func (client APIOperationsPolicyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, ifMatch string) (result autorest.Response, err error)

Delete deletes the policy configuration at the Api Operation.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (APIOperationsPolicyClient) DeletePreparer 

func (client APIOperationsPolicyClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (APIOperationsPolicyClient) DeleteResponder 

func (client APIOperationsPolicyClient) 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 (APIOperationsPolicyClient) DeleteSender 

func (client APIOperationsPolicyClient) 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 (APIOperationsPolicyClient) Get 

func (client APIOperationsPolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (result ReadCloser, err error)

Get get the policy configuration at the API Operation level.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (APIOperationsPolicyClient) GetPreparer 

func (client APIOperationsPolicyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (APIOperationsPolicyClient) GetResponder 

func (client APIOperationsPolicyClient) GetResponder(resp *http.Response) (result ReadCloser, err error)

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

func (APIOperationsPolicyClient) GetSender 

func (client APIOperationsPolicyClient) 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 APIPolicyClient 

type APIPolicyClient struct {
	BaseClient
}

APIPolicyClient is the apiManagement Client

func NewAPIPolicyClient 

func NewAPIPolicyClient(subscriptionID string) APIPolicyClient

NewAPIPolicyClient creates an instance of the APIPolicyClient client.

func NewAPIPolicyClientWithBaseURI 

func NewAPIPolicyClientWithBaseURI(baseURI string, subscriptionID string) APIPolicyClient

NewAPIPolicyClientWithBaseURI creates an instance of the APIPolicyClient client.

func (APIPolicyClient) CreateOrUpdate 

func (client APIPolicyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, parameters io.ReadCloser, ifMatch string) (result autorest.Response, err error)

CreateOrUpdate creates or updates policy configuration for the API.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiid is API identifier. Must be unique in the current API Management service instance. parameters is the policy contents to apply. parameters will be closed upon successful return. Callers should ensure closure when receiving an error.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, resourceGroupName string, serviceName string, apiid string, parameters io.ReadCloser, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIPolicyClient) CreateOrUpdateResponder 

func (client APIPolicyClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, 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, resourceGroupName string, serviceName string, apiid string, ifMatch string) (result autorest.Response, err error)

Delete deletes the policy configuration at the Api.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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, resourceGroupName string, serviceName 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, resourceGroupName string, serviceName string, apiid string) (result ReadCloser, err error)

Get get the policy configuration at the API level.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiid is API identifier. Must be unique in the current API Management service instance.

func (APIPolicyClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIPolicyClient) GetResponder 

func (client APIPolicyClient) GetResponder(resp *http.Response) (result ReadCloser, 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.

type APIProductsClient 

type APIProductsClient struct {
	BaseClient
}

APIProductsClient is the apiManagement Client

func NewAPIProductsClient 

func NewAPIProductsClient(subscriptionID string) APIProductsClient

NewAPIProductsClient creates an instance of the APIProductsClient client.

func NewAPIProductsClientWithBaseURI 

func NewAPIProductsClientWithBaseURI(baseURI string, subscriptionID string) APIProductsClient

NewAPIProductsClientWithBaseURI creates an instance of the APIProductsClient client.

func (APIProductsClient) ListByApis 

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

ListByApis lists all API associated products.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (APIProductsClient) ListByApisComplete 

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

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

func (APIProductsClient) ListByApisPreparer 

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

ListByApisPreparer prepares the ListByApis request.

func (APIProductsClient) ListByApisResponder 

func (client APIProductsClient) 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 (APIProductsClient) ListByApisSender 

func (client APIProductsClient) 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 APIProtocolContract 

type APIProtocolContract string

APIProtocolContract enumerates the values for api protocol contract. 

const (
	// HTTP ...
	HTTP APIProtocolContract = "Http"
	// HTTPS ...
	HTTPS APIProtocolContract = "Https"
)

type APITypeContract 

type APITypeContract string

APITypeContract enumerates the values for api type contract. 

const (
	// APITypeContractHTTP ...
	APITypeContractHTTP APITypeContract = "Http"
	// APITypeContractSoap ...
	APITypeContractSoap APITypeContract = "Soap"
)

type APIUpdateContract 

type APIUpdateContract 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"`
	// Type - Type of API. Possible values include: 'APITypeContractHTTP', 'APITypeContractSoap'
	Type APITypeContract `json:"type,omitempty"`
	// ID - API identifier path: /apis/{apiId}
	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 *[]APIProtocolContract `json:"protocols,omitempty"`
}

APIUpdateContract API Update Contract details.

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 AdditionalRegion 

type AdditionalRegion struct {
	// Location - The location name of the additional region among Azure Data center regions.
	Location *string `json:"location,omitempty"`
	// SkuType - The SKU type in the location. Possible values include: 'Developer', 'Standard', 'Premium'
	SkuType SkuType `json:"skuType,omitempty"`
	// SkuUnitCount - The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location.
	SkuUnitCount *int32 `json:"skuUnitCount,omitempty"`
	// StaticIPs - Static IP addresses of the location's virtual machines.
	StaticIPs *[]string `json:"staticIPs,omitempty"`
	// Vpnconfiguration - Virtual network configuration for the location.
	Vpnconfiguration *VirtualNetworkConfiguration `json:"vpnconfiguration,omitempty"`
}

AdditionalRegion description of an additional API Management resource location.

type ApisClient 

type ApisClient struct {
	BaseClient
}

ApisClient is the apiManagement Client

func NewApisClient 

func NewApisClient(subscriptionID string) ApisClient

NewApisClient creates an instance of the ApisClient client.

func NewApisClientWithBaseURI 

func NewApisClientWithBaseURI(baseURI string, subscriptionID string) ApisClient

NewApisClientWithBaseURI creates an instance of the ApisClient client.

func (ApisClient) CreateOrUpdate 

func (client ApisClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, parameters APIContract, ifMatch string) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ApisClient) CreateOrUpdatePreparer 

func (client ApisClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, parameters APIContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ApisClient) CreateOrUpdateResponder 

func (client ApisClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (ApisClient) CreateOrUpdateSender 

func (client ApisClient) 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 (ApisClient) Delete 

func (client ApisClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, ifMatch string) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ApisClient) DeletePreparer 

func (client ApisClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ApisClient) DeleteResponder 

func (client ApisClient) 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 (ApisClient) DeleteSender 

func (client ApisClient) 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 (ApisClient) Get 

func (client ApisClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (result APIContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiid is API identifier. Must be unique in the current API Management service instance.

func (ApisClient) GetPreparer 

func (client ApisClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ApisClient) GetResponder 

func (client ApisClient) 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 (ApisClient) GetSender 

func (client ApisClient) 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 (ApisClient) ListByService 

func (client ApisClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result APICollectionPage, err error)

ListByService lists all APIs of the API Management service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ApisClient) ListByServiceComplete 

func (client ApisClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result APICollectionIterator, err error)

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

func (ApisClient) ListByServicePreparer 

func (client ApisClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (ApisClient) ListByServiceResponder 

func (client ApisClient) ListByServiceResponder(resp *http.Response) (result APICollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (ApisClient) ListByServiceSender 

func (client ApisClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

func (ApisClient) Update 

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

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ApisClient) UpdatePreparer 

func (client ApisClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, parameters APIUpdateContract, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ApisClient) UpdateResponder 

func (client ApisClient) 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 (ApisClient) UpdateSender 

func (client ApisClient) 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 AsyncOperationState 

type AsyncOperationState string

AsyncOperationState enumerates the values for async operation state. 

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

type AuthenticationSettingsContract 

type AuthenticationSettingsContract struct {
	OAuth2 *OAuth2AuthenticationSettingsContract `json:"oAuth2,omitempty"`
}

AuthenticationSettingsContract API Authentication Settings.

type AuthorizationServerCollection 

type AuthorizationServerCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]OAuth2AuthorizationServerContract `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 OAuth2AuthorizationServerContract 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() OAuth2AuthorizationServerContract

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 OAuth2AuthorizationServerContract 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() []OAuth2AuthorizationServerContract

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

type AuthorizationServersClient 

type AuthorizationServersClient struct {
	BaseClient
}

AuthorizationServersClient is the apiManagement Client

func NewAuthorizationServersClient 

func NewAuthorizationServersClient(subscriptionID string) AuthorizationServersClient

NewAuthorizationServersClient creates an instance of the AuthorizationServersClient client.

func NewAuthorizationServersClientWithBaseURI 

func NewAuthorizationServersClientWithBaseURI(baseURI string, subscriptionID string) AuthorizationServersClient

NewAuthorizationServersClientWithBaseURI creates an instance of the AuthorizationServersClient client.

func (AuthorizationServersClient) CreateOrUpdate 

func (client AuthorizationServersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, authsid string, parameters OAuth2AuthorizationServerContract) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. authsid is identifier of the authorization server. parameters is create or update parameters.

func (AuthorizationServersClient) CreateOrUpdatePreparer 

func (client AuthorizationServersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, authsid string, parameters OAuth2AuthorizationServerContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AuthorizationServersClient) CreateOrUpdateResponder 

func (client AuthorizationServersClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (AuthorizationServersClient) CreateOrUpdateSender 

func (client AuthorizationServersClient) 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 (AuthorizationServersClient) Delete 

func (client AuthorizationServersClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, authsid string, ifMatch string) (result autorest.Response, err error)

Delete deletes specific authorization server instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (AuthorizationServersClient) DeletePreparer 

func (client AuthorizationServersClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, authsid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AuthorizationServersClient) DeleteResponder 

func (client AuthorizationServersClient) 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 (AuthorizationServersClient) DeleteSender 

func (client AuthorizationServersClient) 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 (AuthorizationServersClient) Get 

func (client AuthorizationServersClient) Get(ctx context.Context, resourceGroupName string, serviceName string, authsid string) (result OAuth2AuthorizationServerContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. authsid is identifier of the authorization server.

func (AuthorizationServersClient) GetPreparer 

func (client AuthorizationServersClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, authsid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AuthorizationServersClient) GetResponder 

func (client AuthorizationServersClient) GetResponder(resp *http.Response) (result OAuth2AuthorizationServerContract, err error)

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

func (AuthorizationServersClient) GetSender 

func (client AuthorizationServersClient) 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 (AuthorizationServersClient) ListByService 

func (client AuthorizationServersClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result AuthorizationServerCollectionPage, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (AuthorizationServersClient) ListByServiceComplete 

func (client AuthorizationServersClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result AuthorizationServerCollectionIterator, err error)

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

func (AuthorizationServersClient) ListByServicePreparer 

func (client AuthorizationServersClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (AuthorizationServersClient) ListByServiceResponder 

func (client AuthorizationServersClient) ListByServiceResponder(resp *http.Response) (result AuthorizationServerCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (AuthorizationServersClient) ListByServiceSender 

func (client AuthorizationServersClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

func (AuthorizationServersClient) Update 

func (client AuthorizationServersClient) Update(ctx context.Context, resourceGroupName string, serviceName string, authsid string, parameters OAuth2AuthorizationServerUpdateContract, ifMatch string) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (AuthorizationServersClient) UpdatePreparer 

func (client AuthorizationServersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, authsid string, parameters OAuth2AuthorizationServerUpdateContract, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AuthorizationServersClient) UpdateResponder 

func (client AuthorizationServersClient) 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 (AuthorizationServersClient) UpdateSender 

func (client AuthorizationServersClient) 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 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 {
	// Certificate - List of Client Certificate Thumbprint.
	Certificate *[]string `json:"certificate,omitempty"`
	// Query - Query Parameter description.
	Query *map[string][]string `json:"query,omitempty"`
	// Header - Header Parameter description.
	Header *map[string][]string `json:"header,omitempty"`
	// 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"`
	// 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"`
	*BackendProperties `json:"properties,omitempty"`
}

BackendBaseParameters backend entity base Parameter set.

func (*BackendBaseParameters) UnmarshalJSON 

func (bbp *BackendBaseParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BackendBaseParameters struct.

type BackendCollection 

type BackendCollection struct {
	autorest.Response `json:"-"`
	// Value - Backend values.
	Value *[]BackendResponse `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"`
}

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 BackendResponse 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() BackendResponse

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 BackendResponse 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() []BackendResponse

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

type BackendContract 

type BackendContract struct {
	// Certificate - List of Client Certificate Thumbprint.
	Certificate *[]string `json:"certificate,omitempty"`
	// Query - Query Parameter description.
	Query *map[string][]string `json:"query,omitempty"`
	// Header - Header Parameter description.
	Header *map[string][]string `json:"header,omitempty"`
	// 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"`
	// 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"`
	*BackendProperties `json:"properties,omitempty"`
	// ID - Uniquely identifies the backend within the current API Management service instance. The value is a valid relative URL in the format of /backends/{backendId} where {backendId} is a backend identifier.
	ID *string `json:"id,omitempty"`
	// Protocol - Backend communication protocol. Possible values include: 'BackendProtocolHTTP', 'BackendProtocolSoap'
	Protocol BackendProtocol `json:"protocol,omitempty"`
}

BackendContract parameters supplied to the Create Backend operation.

type BackendCredentialsContract 

type BackendCredentialsContract struct {
	// Scheme - Authentication Scheme name.
	Scheme *string `json:"scheme,omitempty"`
	// Parameter - Authentication Parameter value.
	Parameter *string `json:"parameter,omitempty"`
	// Certificate - List of Client Certificate Thumbprint.
	Certificate *[]string `json:"certificate,omitempty"`
	// Query - Query Parameter description.
	Query *map[string][]string `json:"query,omitempty"`
	// Header - Header Parameter description.
	Header *map[string][]string `json:"header,omitempty"`
}

BackendCredentialsContract details of the Credentials used to connect to Backend.

type BackendProperties 

type BackendProperties struct {
	// SkipCertificateChainValidation - Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.
	SkipCertificateChainValidation *bool `json:"skipCertificateChainValidation,omitempty"`
	// SkipCertificateNameValidation - Flag indicating whether SSL certificate name validation should be skipped when using self-signed certificates for this backend host.
	SkipCertificateNameValidation *bool `json:"skipCertificateNameValidation,omitempty"`
}

BackendProperties properties specific to a Backend.

type BackendProtocol 

type BackendProtocol string

BackendProtocol enumerates the values for backend protocol. 

const (
	// BackendProtocolHTTP ...
	BackendProtocolHTTP BackendProtocol = "http"
	// BackendProtocolSoap ...
	BackendProtocolSoap BackendProtocol = "soap"
)

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 BackendResponse 

type BackendResponse struct {
	autorest.Response `json:"-"`
	// Certificate - List of Client Certificate Thumbprint.
	Certificate *[]string `json:"certificate,omitempty"`
	// Query - Query Parameter description.
	Query *map[string][]string `json:"query,omitempty"`
	// Header - Header Parameter description.
	Header *map[string][]string `json:"header,omitempty"`
	// 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"`
	// 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"`
	*BackendProperties `json:"properties,omitempty"`
	// ID - Uniquely identifies the backend within the current API Management service instance. The value is a valid relative URL in the format of /backends/{backendId} where {backendId} is a backend identifier.
	ID *string `json:"id,omitempty"`
	// Protocol - Backend communication protocol. Possible values include: 'BackendProtocolHTTP', 'BackendProtocolSoap'
	Protocol BackendProtocol `json:"protocol,omitempty"`
}

BackendResponse the Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.

type BackendUpdateParameters 

type BackendUpdateParameters struct {
	// Certificate - List of Client Certificate Thumbprint.
	Certificate *[]string `json:"certificate,omitempty"`
	// Query - Query Parameter description.
	Query *map[string][]string `json:"query,omitempty"`
	// Header - Header Parameter description.
	Header *map[string][]string `json:"header,omitempty"`
	// 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"`
	// 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"`
	*BackendProperties `json:"properties,omitempty"`
	// Protocol - Backend communication protocol. Possible values include: 'BackendProtocolHTTP', 'BackendProtocolSoap'
	Protocol BackendProtocol `json:"protocol,omitempty"`
}

BackendUpdateParameters parameters supplied to the Update Backend operation.

type BackendsClient 

type BackendsClient struct {
	BaseClient
}

BackendsClient is the apiManagement Client

func NewBackendsClient 

func NewBackendsClient(subscriptionID string) BackendsClient

NewBackendsClient creates an instance of the BackendsClient client.

func NewBackendsClientWithBaseURI 

func NewBackendsClientWithBaseURI(baseURI string, subscriptionID string) BackendsClient

NewBackendsClientWithBaseURI creates an instance of the BackendsClient client.

func (BackendsClient) CreateOrUpdate 

func (client BackendsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters BackendContract) (result autorest.Response, err error)

CreateOrUpdate creates or Updates a backend.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. backendid is identifier of the Backend entity. Must be unique in the current API Management service instance. parameters is create parameters.

func (BackendsClient) CreateOrUpdatePreparer 

func (client BackendsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters BackendContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BackendsClient) CreateOrUpdateResponder 

func (client BackendsClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (BackendsClient) CreateOrUpdateSender 

func (client BackendsClient) 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 (BackendsClient) Delete 

func (client BackendsClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, backendid string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified backend.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (BackendsClient) DeletePreparer 

func (client BackendsClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (BackendsClient) DeleteResponder 

func (client BackendsClient) 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 (BackendsClient) DeleteSender 

func (client BackendsClient) 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 (BackendsClient) Get 

func (client BackendsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, backendid string) (result BackendResponse, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. backendid is identifier of the Backend entity. Must be unique in the current API Management service instance.

func (BackendsClient) GetPreparer 

func (client BackendsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (BackendsClient) GetResponder 

func (client BackendsClient) GetResponder(resp *http.Response) (result BackendResponse, err error)

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

func (BackendsClient) GetSender 

func (client BackendsClient) 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 (BackendsClient) ListByService 

func (client BackendsClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result BackendCollectionPage, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (BackendsClient) ListByServiceComplete 

func (client BackendsClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result BackendCollectionIterator, err error)

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

func (BackendsClient) ListByServicePreparer 

func (client BackendsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (BackendsClient) ListByServiceResponder 

func (client BackendsClient) ListByServiceResponder(resp *http.Response) (result BackendCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (BackendsClient) ListByServiceSender 

func (client BackendsClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

func (BackendsClient) Update 

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

Update updates an existing backend.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (BackendsClient) UpdatePreparer 

func (client BackendsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters BackendUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (BackendsClient) UpdateResponder 

func (client BackendsClient) 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 (BackendsClient) UpdateSender 

func (client BackendsClient) 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 BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Apimanagement.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type BearerTokenSendingMethodsContract 

type BearerTokenSendingMethodsContract string

BearerTokenSendingMethodsContract enumerates the values for bearer token sending methods contract. 

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

type CertificateCollection 

type CertificateCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]CertificateContract `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"`
}

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 - Certificate identifier path: /certificates/{certificateId}
	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 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 CertificateInformation 

type CertificateInformation struct {
	autorest.Response `json:"-"`
	// Expiry - Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	Expiry *date.Time `json:"expiry,omitempty"`
	// Thumbprint - Thumbprint of the certificate.
	Thumbprint *string `json:"thumbprint,omitempty"`
	// Subject - Subject of the certificate.
	Subject *string `json:"subject,omitempty"`
}

CertificateInformation SSL certificate information.

type CertificatesClient 

type CertificatesClient struct {
	BaseClient
}

CertificatesClient is the apiManagement Client

func NewCertificatesClient 

func NewCertificatesClient(subscriptionID string) CertificatesClient

NewCertificatesClient creates an instance of the CertificatesClient client.

func NewCertificatesClientWithBaseURI 

func NewCertificatesClientWithBaseURI(baseURI string, subscriptionID string) CertificatesClient

NewCertificatesClientWithBaseURI creates an instance of the CertificatesClient client.

func (CertificatesClient) CreateOrUpdate 

func (client CertificatesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, parameters CertificateCreateOrUpdateParameters, ifMatch string) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. certificateID is identifier of the certificate entity. Must be unique in the current API Management service instance. parameters is create 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 (CertificatesClient) CreateOrUpdatePreparer 

func (client CertificatesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, parameters CertificateCreateOrUpdateParameters, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CertificatesClient) CreateOrUpdateResponder 

func (client CertificatesClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (CertificatesClient) CreateOrUpdateSender 

func (client CertificatesClient) 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 (CertificatesClient) Delete 

func (client CertificatesClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, ifMatch string) (result autorest.Response, err error)

Delete deletes specific certificate.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (CertificatesClient) DeletePreparer 

func (client CertificatesClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (CertificatesClient) DeleteResponder 

func (client CertificatesClient) 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 (CertificatesClient) DeleteSender 

func (client CertificatesClient) 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 (CertificatesClient) Get 

func (client CertificatesClient) Get(ctx context.Context, resourceGroupName string, serviceName string, certificateID string) (result CertificateContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. certificateID is identifier of the certificate entity. Must be unique in the current API Management service instance.

func (CertificatesClient) GetPreparer 

func (client CertificatesClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, certificateID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (CertificatesClient) GetResponder 

func (client CertificatesClient) 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 (CertificatesClient) GetSender 

func (client CertificatesClient) 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 (CertificatesClient) ListByService 

func (client CertificatesClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result CertificateCollectionPage, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (CertificatesClient) ListByServiceComplete 

func (client CertificatesClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result CertificateCollectionIterator, err error)

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

func (CertificatesClient) ListByServicePreparer 

func (client CertificatesClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (CertificatesClient) ListByServiceResponder 

func (client CertificatesClient) ListByServiceResponder(resp *http.Response) (result CertificateCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (CertificatesClient) ListByServiceSender 

func (client CertificatesClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

type ClientAuthenticationMethodContract 

type ClientAuthenticationMethodContract string

ClientAuthenticationMethodContract enumerates the values for client authentication method contract. 

const (
	// Basic ...
	Basic ClientAuthenticationMethodContract = "Basic"
	// Body ...
	Body ClientAuthenticationMethodContract = "Body"
)

type ConnectivityStatusContract 

type ConnectivityStatusContract struct {
	// Name - The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon.
	Name *string `json:"name,omitempty"`
	// Status - Resource Connectivity Status Type identifier. Possible values include: 'Initializing', 'Success', 'Failure'
	Status ConnectivityStatusType `json:"status,omitempty"`
	// Error - Error details of the connectivity to the resource.
	Error *string `json:"error,omitempty"`
	// LastUpdated - The date when the resource connectivity status was last updated. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	LastUpdated *date.Time `json:"lastUpdated,omitempty"`
	// LastStatusChange - The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	LastStatusChange *date.Time `json:"lastStatusChange,omitempty"`
}

ConnectivityStatusContract details about connectivity to a resource.

type ConnectivityStatusType 

type ConnectivityStatusType string

ConnectivityStatusType enumerates the values for connectivity status type. 

const (
	// Failure ...
	Failure ConnectivityStatusType = "failure"
	// Initializing ...
	Initializing ConnectivityStatusType = "initializing"
	// Success ...
	Success ConnectivityStatusType = "success"
)

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 ErrorBodyContract 

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

ErrorBodyContract error Body contract.

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 - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponse error Response.

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 GrantTypesContract 

type GrantTypesContract string

GrantTypesContract enumerates the values for grant types contract. 

const (
	// AuthorizationCode ...
	AuthorizationCode GrantTypesContract = "authorizationCode"
	// ClientCredentials ...
	ClientCredentials GrantTypesContract = "clientCredentials"
	// Implicit ...
	Implicit GrantTypesContract = "implicit"
	// ResourceOwnerPassword ...
	ResourceOwnerPassword GrantTypesContract = "resourceOwnerPassword"
)

type GroupCollection 

type GroupCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]GroupContract `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"`
}

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 - Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupid} where {groupid} is a group identifier.
	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 GroupTypeContract `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 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 GroupTypeContract `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 GroupTypeContract 

type GroupTypeContract string

GroupTypeContract enumerates the values for group type contract. 

const (
	// Custom ...
	Custom GroupTypeContract = "Custom"
	// External ...
	External GroupTypeContract = "External"
	// System ...
	System GroupTypeContract = "System"
)

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 GroupTypeContract `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 GroupUsersClient 

type GroupUsersClient struct {
	BaseClient
}

GroupUsersClient is the apiManagement Client

func NewGroupUsersClient 

func NewGroupUsersClient(subscriptionID string) GroupUsersClient

NewGroupUsersClient creates an instance of the GroupUsersClient client.

func NewGroupUsersClientWithBaseURI 

func NewGroupUsersClientWithBaseURI(baseURI string, subscriptionID string) GroupUsersClient

NewGroupUsersClientWithBaseURI creates an instance of the GroupUsersClient client.

func (GroupUsersClient) Create 

func (client GroupUsersClient) Create(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (result ErrorBodyContract, err error)

Create adds a user to the specified group.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (GroupUsersClient) CreatePreparer 

func (client GroupUsersClient) CreatePreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (GroupUsersClient) CreateResponder 

func (client GroupUsersClient) CreateResponder(resp *http.Response) (result ErrorBodyContract, err error)

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

func (GroupUsersClient) CreateSender 

func (client GroupUsersClient) 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 (GroupUsersClient) Delete 

func (client GroupUsersClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (result ErrorBodyContract, err error)

Delete remove existing user from existing group.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (GroupUsersClient) DeletePreparer 

func (client GroupUsersClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GroupUsersClient) DeleteResponder 

func (client GroupUsersClient) DeleteResponder(resp *http.Response) (result ErrorBodyContract, err error)

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

func (GroupUsersClient) DeleteSender 

func (client GroupUsersClient) 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 (GroupUsersClient) ListByGroups 

func (client GroupUsersClient) ListByGroups(ctx context.Context, resourceGroupName string, serviceName string, groupID string, filter string, top *int32, skip *int32) (result UserCollectionPage, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (GroupUsersClient) ListByGroupsComplete 

func (client GroupUsersClient) ListByGroupsComplete(ctx context.Context, resourceGroupName string, serviceName string, groupID string, filter string, top *int32, skip *int32) (result UserCollectionIterator, err error)

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

func (GroupUsersClient) ListByGroupsPreparer 

func (client GroupUsersClient) ListByGroupsPreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByGroupsPreparer prepares the ListByGroups request.

func (GroupUsersClient) ListByGroupsResponder 

func (client GroupUsersClient) ListByGroupsResponder(resp *http.Response) (result UserCollection, err error)

ListByGroupsResponder handles the response to the ListByGroups request. The method always closes the http.Response Body.

func (GroupUsersClient) ListByGroupsSender 

func (client GroupUsersClient) ListByGroupsSender(req *http.Request) (*http.Response, error)

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

type GroupsClient 

type GroupsClient struct {
	BaseClient
}

GroupsClient is the apiManagement Client

func NewGroupsClient 

func NewGroupsClient(subscriptionID string) GroupsClient

NewGroupsClient creates an instance of the GroupsClient client.

func NewGroupsClientWithBaseURI 

func NewGroupsClientWithBaseURI(baseURI string, subscriptionID string) GroupsClient

NewGroupsClientWithBaseURI creates an instance of the GroupsClient client.

func (GroupsClient) CreateOrUpdate 

func (client GroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, groupID string, parameters GroupCreateParameters) (result autorest.Response, err error)

CreateOrUpdate creates or Updates a group.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. groupID is group identifier. Must be unique in the current API Management service instance. parameters is create parameters.

func (GroupsClient) CreateOrUpdatePreparer 

func (client GroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, parameters GroupCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupsClient) CreateOrUpdateResponder 

func (client GroupsClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (GroupsClient) CreateOrUpdateSender 

func (client GroupsClient) 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 (GroupsClient) Delete 

func (client GroupsClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, groupID string, ifMatch string) (result ErrorBodyContract, err error)

Delete deletes specific group of the API Management service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (GroupsClient) DeletePreparer 

func (client GroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GroupsClient) DeleteResponder 

func (client GroupsClient) DeleteResponder(resp *http.Response) (result ErrorBodyContract, err error)

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

func (GroupsClient) DeleteSender 

func (client GroupsClient) 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 (GroupsClient) Get 

func (client GroupsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, groupID string) (result GroupContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. groupID is group identifier. Must be unique in the current API Management service instance.

func (GroupsClient) GetPreparer 

func (client GroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (GroupsClient) GetResponder 

func (client GroupsClient) 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 (GroupsClient) GetSender 

func (client GroupsClient) 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 (GroupsClient) ListByService 

func (client GroupsClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (GroupsClient) ListByServiceComplete 

func (client GroupsClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)

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

func (GroupsClient) ListByServicePreparer 

func (client GroupsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (GroupsClient) ListByServiceResponder 

func (client GroupsClient) ListByServiceResponder(resp *http.Response) (result GroupCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (GroupsClient) ListByServiceSender 

func (client GroupsClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

func (GroupsClient) Update 

func (client GroupsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, groupID string, parameters GroupUpdateParameters, ifMatch string) (result ErrorBodyContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (GroupsClient) UpdatePreparer 

func (client GroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, parameters GroupUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (GroupsClient) UpdateResponder 

func (client GroupsClient) UpdateResponder(resp *http.Response) (result ErrorBodyContract, err error)

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

func (GroupsClient) UpdateSender 

func (client GroupsClient) 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 HTTPStatusCode 

type HTTPStatusCode string

HTTPStatusCode enumerates the values for http status code. 

const (
	// Accepted ...
	Accepted HTTPStatusCode = "Accepted"
	// Conflict ...
	Conflict HTTPStatusCode = "Conflict"
	// Continue ...
	Continue HTTPStatusCode = "Continue"
	// Created ...
	Created HTTPStatusCode = "Created"
	// NotFound ...
	NotFound HTTPStatusCode = "NotFound"
	// OK ...
	OK HTTPStatusCode = "OK"
)

type HostnameConfiguration 

type HostnameConfiguration struct {
	// Type - Hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm'
	Type HostnameType `json:"type,omitempty"`
	// Hostname - Hostname.
	Hostname *string `json:"hostname,omitempty"`
	// Certificate - Certificate information.
	Certificate *CertificateInformation `json:"certificate,omitempty"`
}

HostnameConfiguration custom hostname configuration.

type HostnameType 

type HostnameType string

HostnameType enumerates the values for hostname type. 

const (
	// Management ...
	Management HostnameType = "Management"
	// Portal ...
	Portal HostnameType = "Portal"
	// Proxy ...
	Proxy HostnameType = "Proxy"
	// Scm ...
	Scm HostnameType = "Scm"
)

type IdentityProviderContract 

type IdentityProviderContract struct {
	autorest.Response `json:"-"`
	// 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 IdentityProviderNameType `json:"type,omitempty"`
	// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
	AllowedTenants *[]string `json:"allowedTenants,omitempty"`
}

IdentityProviderContract 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"`
}

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

type IdentityProviderNameType 

type IdentityProviderNameType string

IdentityProviderNameType enumerates the values for identity provider name type. 

const (
	// Aad ...
	Aad IdentityProviderNameType = "aad"
	// AadB2C ...
	AadB2C IdentityProviderNameType = "aadB2C"
	// Facebook ...
	Facebook IdentityProviderNameType = "facebook"
	// Google ...
	Google IdentityProviderNameType = "google"
	// Microsoft ...
	Microsoft IdentityProviderNameType = "microsoft"
	// Twitter ...
	Twitter IdentityProviderNameType = "twitter"
)

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"`
	// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
	AllowedTenants *[]string `json:"allowedTenants,omitempty"`
}

IdentityProviderUpdateParameters parameters supplied to the Update Identity Provider operation.

type IdentityProvidersClient 

type IdentityProvidersClient struct {
	BaseClient
}

IdentityProvidersClient is the apiManagement Client

func NewIdentityProvidersClient 

func NewIdentityProvidersClient(subscriptionID string) IdentityProvidersClient

NewIdentityProvidersClient creates an instance of the IdentityProvidersClient client.

func NewIdentityProvidersClientWithBaseURI 

func NewIdentityProvidersClientWithBaseURI(baseURI string, subscriptionID string) IdentityProvidersClient

NewIdentityProvidersClientWithBaseURI creates an instance of the IdentityProvidersClient client.

func (IdentityProvidersClient) CreateOrUpdate 

func (client IdentityProvidersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderNameType, parameters IdentityProviderContract) (result autorest.Response, err error)

CreateOrUpdate creates or Updates the IdentityProvider configuration.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. identityProviderName is identity Provider Type identifier. parameters is create parameters.

func (IdentityProvidersClient) CreateOrUpdatePreparer 

func (client IdentityProvidersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderNameType, parameters IdentityProviderContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (IdentityProvidersClient) CreateOrUpdateResponder 

func (client IdentityProvidersClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (IdentityProvidersClient) CreateOrUpdateSender 

func (client IdentityProvidersClient) 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 (IdentityProvidersClient) Delete 

func (client IdentityProvidersClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderNameType, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified identity provider configuration.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (IdentityProvidersClient) DeletePreparer 

func (client IdentityProvidersClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderNameType, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (IdentityProvidersClient) DeleteResponder 

func (client IdentityProvidersClient) 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 (IdentityProvidersClient) DeleteSender 

func (client IdentityProvidersClient) 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 (IdentityProvidersClient) Get 

func (client IdentityProvidersClient) Get(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderNameType) (result IdentityProviderContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. identityProviderName is identity Provider Type identifier.

func (IdentityProvidersClient) GetPreparer 

func (client IdentityProvidersClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderNameType) (*http.Request, error)

GetPreparer prepares the Get request.

func (IdentityProvidersClient) GetResponder 

func (client IdentityProvidersClient) 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 (IdentityProvidersClient) GetSender 

func (client IdentityProvidersClient) 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 (IdentityProvidersClient) ListByService 

func (client IdentityProvidersClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string) (result IdentityProviderList, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (IdentityProvidersClient) ListByServicePreparer 

func (client IdentityProvidersClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (IdentityProvidersClient) ListByServiceResponder 

func (client IdentityProvidersClient) ListByServiceResponder(resp *http.Response) (result IdentityProviderList, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (IdentityProvidersClient) ListByServiceSender 

func (client IdentityProvidersClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

func (IdentityProvidersClient) Update 

func (client IdentityProvidersClient) Update(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderNameType, parameters IdentityProviderUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates an existing IdentityProvider configuration.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (IdentityProvidersClient) UpdatePreparer 

func (client IdentityProvidersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderNameType, parameters IdentityProviderUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (IdentityProvidersClient) UpdateResponder 

func (client IdentityProvidersClient) 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 (IdentityProvidersClient) UpdateSender 

func (client IdentityProvidersClient) 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 KeyTypeContract 

type KeyTypeContract string

KeyTypeContract enumerates the values for key type contract. 

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

type LoggerCollection 

type LoggerCollection struct {
	autorest.Response `json:"-"`
	// Value - Logger values.
	Value *[]LoggerResponse `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 LoggerResponse 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() LoggerResponse

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 LoggerResponse 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() []LoggerResponse

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

type LoggerCreateParameters 

type LoggerCreateParameters struct {
	// Type - Logger type.
	Type *string `json:"type,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,omitempty"`
	// IsBuffered - Whether records are buffered in the logger before publishing. Default is assumed to be true.
	IsBuffered *bool `json:"isBuffered,omitempty"`
}

LoggerCreateParameters parameters supplied to the Create Logger operation.

type LoggerResponse 

type LoggerResponse struct {
	autorest.Response `json:"-"`
	// ID - Uniquely identifies the logger within the current API Management service instance. The value is a valid relative URL in the format of /loggers/{loggerId} where {loggerId} is a logger identifier.
	ID *string `json:"id,omitempty"`
	// Type - Logger type.
	Type *string `json:"type,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,omitempty"`
	// IsBuffered - Whether records are buffered in the logger before publishing. Default is assumed to be true.
	IsBuffered *bool `json:"isBuffered,omitempty"`
}

LoggerResponse 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.

type LoggerUpdateParameters 

type LoggerUpdateParameters struct {
	// Type - Logger type.
	Type *string `json:"type,omitempty"`
	// Description - Logger description.
	Description *string `json:"description,omitempty"`
	// Credentials - Logger credentials.
	Credentials *map[string]*string `json:"credentials,omitempty"`
	// IsBuffered - whether records are buffered in the logger before publishing. Default is assumed to be true.
	IsBuffered *bool `json:"isBuffered,omitempty"`
}

LoggerUpdateParameters parameters supplied to the Update Logger operation.

type LoggersClient 

type LoggersClient struct {
	BaseClient
}

LoggersClient is the apiManagement Client

func NewLoggersClient 

func NewLoggersClient(subscriptionID string) LoggersClient

NewLoggersClient creates an instance of the LoggersClient client.

func NewLoggersClientWithBaseURI 

func NewLoggersClientWithBaseURI(baseURI string, subscriptionID string) LoggersClient

NewLoggersClientWithBaseURI creates an instance of the LoggersClient client.

func (LoggersClient) CreateOrUpdate 

func (client LoggersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, parameters LoggerCreateParameters) (result autorest.Response, err error)

CreateOrUpdate creates or Updates a logger.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. loggerid is logger identifier. Must be unique in the API Management service instance. parameters is create parameters.

func (LoggersClient) CreateOrUpdatePreparer 

func (client LoggersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, parameters LoggerCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (LoggersClient) CreateOrUpdateResponder 

func (client LoggersClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (LoggersClient) CreateOrUpdateSender 

func (client LoggersClient) 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 (LoggersClient) Delete 

func (client LoggersClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified logger.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (LoggersClient) DeletePreparer 

func (client LoggersClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (LoggersClient) DeleteResponder 

func (client LoggersClient) 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 (LoggersClient) DeleteSender 

func (client LoggersClient) 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 (LoggersClient) Get 

func (client LoggersClient) Get(ctx context.Context, resourceGroupName string, serviceName string, loggerid string) (result LoggerResponse, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. loggerid is logger identifier. Must be unique in the API Management service instance.

func (LoggersClient) GetPreparer 

func (client LoggersClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, loggerid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (LoggersClient) GetResponder 

func (client LoggersClient) GetResponder(resp *http.Response) (result LoggerResponse, err error)

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

func (LoggersClient) GetSender 

func (client LoggersClient) 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 (LoggersClient) ListByService 

func (client LoggersClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result LoggerCollectionPage, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (LoggersClient) ListByServiceComplete 

func (client LoggersClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result LoggerCollectionIterator, err error)

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

func (LoggersClient) ListByServicePreparer 

func (client LoggersClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (LoggersClient) ListByServiceResponder 

func (client LoggersClient) ListByServiceResponder(resp *http.Response) (result LoggerCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (LoggersClient) ListByServiceSender 

func (client LoggersClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

func (LoggersClient) Update 

func (client LoggersClient) Update(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, parameters LoggerUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates an existing logger.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (LoggersClient) UpdatePreparer 

func (client LoggersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, parameters LoggerUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (LoggersClient) UpdateResponder 

func (client LoggersClient) 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 (LoggersClient) UpdateSender 

func (client LoggersClient) 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 MethodContract 

type MethodContract string

MethodContract enumerates the values for method contract. 

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

type NameAvailabilityReason 

type NameAvailabilityReason string

NameAvailabilityReason enumerates the values for name availability reason. 

const (
	// AlreadyExists ...
	AlreadyExists NameAvailabilityReason = "AlreadyExists"
	// Invalid ...
	Invalid NameAvailabilityReason = "Invalid"
	// Valid ...
	Valid NameAvailabilityReason = "Valid"
)

type NetworkStatusClient 

type NetworkStatusClient struct {
	BaseClient
}

NetworkStatusClient is the apiManagement Client

func NewNetworkStatusClient 

func NewNetworkStatusClient(subscriptionID string) NetworkStatusClient

NewNetworkStatusClient creates an instance of the NetworkStatusClient client.

func NewNetworkStatusClientWithBaseURI 

func NewNetworkStatusClientWithBaseURI(baseURI string, subscriptionID string) NetworkStatusClient

NewNetworkStatusClientWithBaseURI creates an instance of the NetworkStatusClient client.

func (NetworkStatusClient) GetByService 

func (client NetworkStatusClient) GetByService(ctx context.Context, resourceGroupName string, serviceName string) (result NetworkStatusContract, err error)

GetByService gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (NetworkStatusClient) GetByServicePreparer 

func (client NetworkStatusClient) GetByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetByServicePreparer prepares the GetByService request.

func (NetworkStatusClient) GetByServiceResponder 

func (client NetworkStatusClient) GetByServiceResponder(resp *http.Response) (result NetworkStatusContract, err error)

GetByServiceResponder handles the response to the GetByService request. The method always closes the http.Response Body.

func (NetworkStatusClient) GetByServiceSender 

func (client NetworkStatusClient) GetByServiceSender(req *http.Request) (*http.Response, error)

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

type NetworkStatusContract 

type NetworkStatusContract struct {
	autorest.Response `json:"-"`
	// DNSServers - Gets the list of DNS servers IPV4 addresses.
	DNSServers *[]string `json:"dnsServers,omitempty"`
	// ConnectivityStatus - Gets the list of Connectivity Status to the Resources.
	ConnectivityStatus *[]ConnectivityStatusContract `json:"connectivityStatus,omitempty"`
}

NetworkStatusContract network Status details.

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 OAuth2AuthorizationServerContract 

type OAuth2AuthorizationServerContract struct {
	autorest.Response `json:"-"`
	// ID - Uniquely identifies the authorization server within the current API Management service instance. The value is a valid relative URL in the format of /authorizationServers/{authsid} where {authsid} is an authorization server identifier.
	ID *string `json:"id,omitempty"`
	// Name - User-friendly authorization server name.
	Name *string `json:"name,omitempty"`
	// Description - Description of the authorization server. Can contain HTML formatting tags.
	Description *string `json:"description,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"`
	// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
	AuthorizationMethods *[]MethodContract `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 *[]ClientAuthenticationMethodContract `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"`
	// GrantTypes - Form of an authorization grant, which the client uses to request the access token.
	GrantTypes *[]GrantTypesContract `json:"grantTypes,omitempty"`
	// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
	BearerTokenSendingMethods *[]BearerTokenSendingMethodsContract `json:"bearerTokenSendingMethods,omitempty"`
	// ClientID - Client or app id registered with this authorization server.
	ClientID *string `json:"clientId,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"`
}

OAuth2AuthorizationServerContract external OAuth authorization server settings.

type OAuth2AuthorizationServerUpdateContract 

type OAuth2AuthorizationServerUpdateContract struct {
	// Name - User-friendly authorization server name.
	Name *string `json:"name,omitempty"`
	// Description - Description of the authorization server. Can contain HTML formatting tags.
	Description *string `json:"description,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"`
	// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
	AuthorizationMethods *[]MethodContract `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 *[]ClientAuthenticationMethodContract `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"`
	// GrantTypes - Form of an authorization grant, which the client uses to request the access token.
	GrantTypes *[]GrantTypesContract `json:"grantTypes,omitempty"`
	// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
	BearerTokenSendingMethods *[]BearerTokenSendingMethodsContract `json:"bearerTokenSendingMethods,omitempty"`
	// ClientID - Client or app id registered with this authorization server.
	ClientID *string `json:"clientId,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"`
}

OAuth2AuthorizationServerUpdateContract external OAuth authorization server Update settings contract.

type OpenIDConnectProviderCollection 

type OpenIDConnectProviderCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]OpenidConnectProviderContract `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"`
}

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 OpenIDConnectProvidersClient 

type OpenIDConnectProvidersClient struct {
	BaseClient
}

OpenIDConnectProvidersClient is the apiManagement Client

func NewOpenIDConnectProvidersClient 

func NewOpenIDConnectProvidersClient(subscriptionID string) OpenIDConnectProvidersClient

NewOpenIDConnectProvidersClient creates an instance of the OpenIDConnectProvidersClient client.

func NewOpenIDConnectProvidersClientWithBaseURI 

func NewOpenIDConnectProvidersClientWithBaseURI(baseURI string, subscriptionID string) OpenIDConnectProvidersClient

NewOpenIDConnectProvidersClientWithBaseURI creates an instance of the OpenIDConnectProvidersClient client.

func (OpenIDConnectProvidersClient) CreateOrUpdate 

func (client OpenIDConnectProvidersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, opid string, parameters OpenidConnectProviderCreateContract) (result autorest.Response, err error)

CreateOrUpdate creates or updates the OpenID Connect Provider.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. opid is identifier of the OpenID Connect Provider. parameters is create parameters.

func (OpenIDConnectProvidersClient) CreateOrUpdatePreparer 

func (client OpenIDConnectProvidersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, opid string, parameters OpenidConnectProviderCreateContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (OpenIDConnectProvidersClient) CreateOrUpdateResponder 

func (client OpenIDConnectProvidersClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (OpenIDConnectProvidersClient) CreateOrUpdateSender 

func (client OpenIDConnectProvidersClient) 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 (OpenIDConnectProvidersClient) Delete 

func (client OpenIDConnectProvidersClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, opid string, ifMatch string) (result ErrorBodyContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (OpenIDConnectProvidersClient) DeletePreparer 

func (client OpenIDConnectProvidersClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, opid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (OpenIDConnectProvidersClient) DeleteResponder 

func (client OpenIDConnectProvidersClient) DeleteResponder(resp *http.Response) (result ErrorBodyContract, err error)

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

func (OpenIDConnectProvidersClient) DeleteSender 

func (client OpenIDConnectProvidersClient) 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 (OpenIDConnectProvidersClient) Get 

func (client OpenIDConnectProvidersClient) Get(ctx context.Context, resourceGroupName string, serviceName string, opid string) (result OpenidConnectProviderContract, err error)

Get gets specific OpenID Connect Provider.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. opid is identifier of the OpenID Connect Provider.

func (OpenIDConnectProvidersClient) GetPreparer 

func (client OpenIDConnectProvidersClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, opid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (OpenIDConnectProvidersClient) GetResponder 

func (client OpenIDConnectProvidersClient) 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 (OpenIDConnectProvidersClient) GetSender 

func (client OpenIDConnectProvidersClient) 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 (OpenIDConnectProvidersClient) ListByService 

func (client OpenIDConnectProvidersClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result OpenIDConnectProviderCollectionPage, err error)

ListByService lists all OpenID Connect Providers.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (OpenIDConnectProvidersClient) ListByServiceComplete 

func (client OpenIDConnectProvidersClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result OpenIDConnectProviderCollectionIterator, err error)

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

func (OpenIDConnectProvidersClient) ListByServicePreparer 

func (client OpenIDConnectProvidersClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (OpenIDConnectProvidersClient) ListByServiceResponder 

func (client OpenIDConnectProvidersClient) ListByServiceResponder(resp *http.Response) (result OpenIDConnectProviderCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (OpenIDConnectProvidersClient) ListByServiceSender 

func (client OpenIDConnectProvidersClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

func (OpenIDConnectProvidersClient) Update 

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

Update updates the specific OpenID Connect Provider.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (OpenIDConnectProvidersClient) UpdatePreparer 

func (client OpenIDConnectProvidersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, opid string, parameters OpenidConnectProviderUpdateContract, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (OpenIDConnectProvidersClient) UpdateResponder 

func (client OpenIDConnectProvidersClient) 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 (OpenIDConnectProvidersClient) UpdateSender 

func (client OpenIDConnectProvidersClient) 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 OpenidConnectProviderContract 

type OpenidConnectProviderContract struct {
	autorest.Response `json:"-"`
	// ID - OpenID Connect Provider identifier.
	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 Providers Contract.

type OpenidConnectProviderCreateContract 

type OpenidConnectProviderCreateContract 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"`
}

OpenidConnectProviderCreateContract parameters supplied to the Create OpenID Connect Provider operation.

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 Operation 

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - The object that describes the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation REST API operation

type OperationCollection 

type OperationCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]OperationContract `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"`
}

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:"-"`
	// 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 *[]ResultContract `json:"responses,omitempty"`
	// ID - Uniquely identifies the operation within the current API Management service instance. The value is a valid relative URL in the format of /apis/{aid}/operations/{id} where {aid} is an API identifier and {id} is an operation identifier.
	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"`
}

OperationContract api Operation details.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Friendly name of the resource provider
	Provider *string `json:"provider,omitempty"`
	// Operation - Operation type: read, write, delete, listKeys/action, etc.
	Operation *string `json:"operation,omitempty"`
	// Resource - Resource type on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
	// Description - Friendly name of the operation
	Description *string `json:"description,omitempty"`
}

OperationDisplay the object that describes the operation.

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 *[]ResultContract `json:"responses,omitempty"`
}

OperationEntityBaseContract api Operation Entity Base Contract details.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of operations supported by the resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) 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 (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) 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 (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

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 AsyncOperationState `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      *ErrorBodyContract `json:"error,omitempty"`
}

OperationResultContract operation Result.

type OperationUpdateContract 

type OperationUpdateContract 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 *[]ResultContract `json:"responses,omitempty"`
	// ID - Uniquely identifies the operation within the current API Management service instance. The value is a valid relative URL in the format of /apis/{aid}/operations/{id} where {aid} is an API identifier and {id} is an operation identifier.
	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"`
}

OperationUpdateContract api Operation Update Contract details.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the apiManagement Client

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available REST API operations of the Microsoft.ApiManagement provider.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

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

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender 

func (client OperationsClient) 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 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 PolicyScopeContract 

type PolicyScopeContract string

PolicyScopeContract enumerates the values for policy scope contract. 

const (
	// PolicyScopeContractAll ...
	PolicyScopeContractAll PolicyScopeContract = "All"
	// PolicyScopeContractAPI ...
	PolicyScopeContractAPI PolicyScopeContract = "Api"
	// PolicyScopeContractOperation ...
	PolicyScopeContractOperation PolicyScopeContract = "Operation"
	// PolicyScopeContractProduct ...
	PolicyScopeContractProduct PolicyScopeContract = "Product"
	// PolicyScopeContractTenant ...
	PolicyScopeContractTenant PolicyScopeContract = "Tenant"
)

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 - Snippet scope. Possible values include: 'PolicyScopeContractTenant', 'PolicyScopeContractProduct', 'PolicyScopeContractAPI', 'PolicyScopeContractOperation', 'PolicyScopeContractAll'
	Scope PolicyScopeContract `json:"scope,omitempty"`
}

PolicySnippetContract policy snippet.

type PolicySnippetsClient 

type PolicySnippetsClient struct {
	BaseClient
}

PolicySnippetsClient is the apiManagement Client

func NewPolicySnippetsClient 

func NewPolicySnippetsClient(subscriptionID string) PolicySnippetsClient

NewPolicySnippetsClient creates an instance of the PolicySnippetsClient client.

func NewPolicySnippetsClientWithBaseURI 

func NewPolicySnippetsClientWithBaseURI(baseURI string, subscriptionID string) PolicySnippetsClient

NewPolicySnippetsClientWithBaseURI creates an instance of the PolicySnippetsClient client.

func (PolicySnippetsClient) ListByService 

func (client PolicySnippetsClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, scope PolicyScopeContract) (result PolicySnippetsCollection, err error)

ListByService lists all policy snippets.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. scope is policy scope.

func (PolicySnippetsClient) ListByServicePreparer 

func (client PolicySnippetsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, scope PolicyScopeContract) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (PolicySnippetsClient) ListByServiceResponder 

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

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (PolicySnippetsClient) ListByServiceSender 

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

ListByServiceSender sends the ListByService 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 ProductApisClient 

type ProductApisClient struct {
	BaseClient
}

ProductApisClient is the apiManagement Client

func NewProductApisClient 

func NewProductApisClient(subscriptionID string) ProductApisClient

NewProductApisClient creates an instance of the ProductApisClient client.

func NewProductApisClientWithBaseURI 

func NewProductApisClientWithBaseURI(baseURI string, subscriptionID string) ProductApisClient

NewProductApisClientWithBaseURI creates an instance of the ProductApisClient client.

func (ProductApisClient) Create 

func (client ProductApisClient) Create(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (result autorest.Response, err error)

Create adds an API to the specified product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ProductApisClient) CreatePreparer 

func (client ProductApisClient) CreatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ProductApisClient) CreateResponder 

func (client ProductApisClient) CreateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (ProductApisClient) CreateSender 

func (client ProductApisClient) 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 (ProductApisClient) Delete 

func (client ProductApisClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (result autorest.Response, err error)

Delete deletes the specified API from the specified product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ProductApisClient) DeletePreparer 

func (client ProductApisClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProductApisClient) DeleteResponder 

func (client ProductApisClient) 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 (ProductApisClient) DeleteSender 

func (client ProductApisClient) 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 (ProductApisClient) ListByProducts 

func (client ProductApisClient) ListByProducts(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result APICollectionPage, err error)

ListByProducts lists a collection of the APIs associated with a product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ProductApisClient) ListByProductsComplete 

func (client ProductApisClient) ListByProductsComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result APICollectionIterator, err error)

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

func (ProductApisClient) ListByProductsPreparer 

func (client ProductApisClient) ListByProductsPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductsPreparer prepares the ListByProducts request.

func (ProductApisClient) ListByProductsResponder 

func (client ProductApisClient) ListByProductsResponder(resp *http.Response) (result APICollection, err error)

ListByProductsResponder handles the response to the ListByProducts request. The method always closes the http.Response Body.

func (ProductApisClient) ListByProductsSender 

func (client ProductApisClient) ListByProductsSender(req *http.Request) (*http.Response, error)

ListByProductsSender sends the ListByProducts 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 record count number across all pages.
	Count *int64 `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 - Uniquely identifies the product within the current API Management service instance. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier.
	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 ProductStateContract `json:"state,omitempty"`
}

ProductContract product profile.

type ProductGroupsClient 

type ProductGroupsClient struct {
	BaseClient
}

ProductGroupsClient is the apiManagement Client

func NewProductGroupsClient 

func NewProductGroupsClient(subscriptionID string) ProductGroupsClient

NewProductGroupsClient creates an instance of the ProductGroupsClient client.

func NewProductGroupsClientWithBaseURI 

func NewProductGroupsClientWithBaseURI(baseURI string, subscriptionID string) ProductGroupsClient

NewProductGroupsClientWithBaseURI creates an instance of the ProductGroupsClient client.

func (ProductGroupsClient) Create 

func (client ProductGroupsClient) Create(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (result autorest.Response, err error)

Create adds the association between the specified developer group with the specified product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ProductGroupsClient) CreatePreparer 

func (client ProductGroupsClient) CreatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ProductGroupsClient) CreateResponder 

func (client ProductGroupsClient) CreateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (ProductGroupsClient) CreateSender 

func (client ProductGroupsClient) 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 (ProductGroupsClient) Delete 

func (client ProductGroupsClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (result ErrorBodyContract, err error)

Delete deletes the association between the specified group and product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ProductGroupsClient) DeletePreparer 

func (client ProductGroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProductGroupsClient) DeleteResponder 

func (client ProductGroupsClient) DeleteResponder(resp *http.Response) (result ErrorBodyContract, err error)

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

func (ProductGroupsClient) DeleteSender 

func (client ProductGroupsClient) 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 (ProductGroupsClient) ListByProducts 

func (client ProductGroupsClient) ListByProducts(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)

ListByProducts lists the collection of developer groups associated with the specified product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ProductGroupsClient) ListByProductsComplete 

func (client ProductGroupsClient) ListByProductsComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)

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

func (ProductGroupsClient) ListByProductsPreparer 

func (client ProductGroupsClient) ListByProductsPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductsPreparer prepares the ListByProducts request.

func (ProductGroupsClient) ListByProductsResponder 

func (client ProductGroupsClient) ListByProductsResponder(resp *http.Response) (result GroupCollection, err error)

ListByProductsResponder handles the response to the ListByProducts request. The method always closes the http.Response Body.

func (ProductGroupsClient) ListByProductsSender 

func (client ProductGroupsClient) ListByProductsSender(req *http.Request) (*http.Response, error)

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

type ProductPolicyClient 

type ProductPolicyClient struct {
	BaseClient
}

ProductPolicyClient is the apiManagement Client

func NewProductPolicyClient 

func NewProductPolicyClient(subscriptionID string) ProductPolicyClient

NewProductPolicyClient creates an instance of the ProductPolicyClient client.

func NewProductPolicyClientWithBaseURI 

func NewProductPolicyClientWithBaseURI(baseURI string, subscriptionID string) ProductPolicyClient

NewProductPolicyClientWithBaseURI creates an instance of the ProductPolicyClient client.

func (ProductPolicyClient) CreateOrUpdate 

func (client ProductPolicyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters io.ReadCloser, ifMatch string) (result autorest.Response, err error)

CreateOrUpdate creates or updates policy configuration for the Product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. productID is product identifier. Must be unique in the current API Management service instance. parameters is the policy contents to apply. parameters will be closed upon successful return. Callers should ensure closure when receiving an error.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) CreateOrUpdatePreparer 

func (client ProductPolicyClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters io.ReadCloser, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductPolicyClient) CreateOrUpdateResponder 

func (client ProductPolicyClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, 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, resourceGroupName string, serviceName string, productID string, ifMatch string) (result autorest.Response, err error)

Delete deletes the policy configuration at the Product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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, resourceGroupName string, serviceName 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, resourceGroupName string, serviceName string, productID string) (result ReadCloser, err error)

Get get the policy configuration at the Product level.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. productID is product identifier. Must be unique in the current API Management service instance.

func (ProductPolicyClient) GetPreparer 

func (client ProductPolicyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProductPolicyClient) GetResponder 

func (client ProductPolicyClient) GetResponder(resp *http.Response) (result ReadCloser, 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.

type ProductStateContract 

type ProductStateContract string

ProductStateContract enumerates the values for product state contract. 

const (
	// NotPublished ...
	NotPublished ProductStateContract = "NotPublished"
	// Published ...
	Published ProductStateContract = "Published"
)

type ProductSubscriptionsClient 

type ProductSubscriptionsClient struct {
	BaseClient
}

ProductSubscriptionsClient is the apiManagement Client

func NewProductSubscriptionsClient 

func NewProductSubscriptionsClient(subscriptionID string) ProductSubscriptionsClient

NewProductSubscriptionsClient creates an instance of the ProductSubscriptionsClient client.

func NewProductSubscriptionsClientWithBaseURI 

func NewProductSubscriptionsClientWithBaseURI(baseURI string, subscriptionID string) ProductSubscriptionsClient

NewProductSubscriptionsClientWithBaseURI creates an instance of the ProductSubscriptionsClient client.

func (ProductSubscriptionsClient) ListByProducts 

func (client ProductSubscriptionsClient) ListByProducts(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)

ListByProducts lists the collection of subscriptions to the specified product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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) ListByProductsComplete 

func (client ProductSubscriptionsClient) ListByProductsComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)

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

func (ProductSubscriptionsClient) ListByProductsPreparer 

func (client ProductSubscriptionsClient) ListByProductsPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductsPreparer prepares the ListByProducts request.

func (ProductSubscriptionsClient) ListByProductsResponder 

func (client ProductSubscriptionsClient) ListByProductsResponder(resp *http.Response) (result SubscriptionCollection, err error)

ListByProductsResponder handles the response to the ListByProducts request. The method always closes the http.Response Body.

func (ProductSubscriptionsClient) ListByProductsSender 

func (client ProductSubscriptionsClient) ListByProductsSender(req *http.Request) (*http.Response, error)

ListByProductsSender sends the ListByProducts 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.
	Description *string `json:"description,omitempty"`
	// Terms - Product terms and conditions. Developer will have to accept these terms before he's allowed to call product API.
	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. Possible values include: 'NotPublished', 'Published'
	State ProductStateContract `json:"state,omitempty"`
}

ProductUpdateParameters parameters supplied to the CreateOrUpdate Product operation.

type ProductsClient 

type ProductsClient struct {
	BaseClient
}

ProductsClient is the apiManagement Client

func NewProductsClient 

func NewProductsClient(subscriptionID string) ProductsClient

NewProductsClient creates an instance of the ProductsClient client.

func NewProductsClientWithBaseURI 

func NewProductsClientWithBaseURI(baseURI string, subscriptionID string) ProductsClient

NewProductsClientWithBaseURI creates an instance of the ProductsClient client.

func (ProductsClient) CreateOrUpdate 

func (client ProductsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductContract) (result autorest.Response, err error)

CreateOrUpdate creates or Updates a product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. productID is product identifier. Must be unique in the current API Management service instance. parameters is create or update parameters.

func (ProductsClient) CreateOrUpdatePreparer 

func (client ProductsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductsClient) CreateOrUpdateResponder 

func (client ProductsClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (ProductsClient) CreateOrUpdateSender 

func (client ProductsClient) 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 (ProductsClient) Delete 

func (client ProductsClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string, deleteSubscriptions *bool) (result autorest.Response, err error)

Delete delete product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ProductsClient) DeletePreparer 

func (client ProductsClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string, deleteSubscriptions *bool) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProductsClient) DeleteResponder 

func (client ProductsClient) 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 (ProductsClient) DeleteSender 

func (client ProductsClient) 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 (ProductsClient) Get 

func (client ProductsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, productID string) (result ProductContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. productID is product identifier. Must be unique in the current API Management service instance.

func (ProductsClient) GetPreparer 

func (client ProductsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProductsClient) GetResponder 

func (client ProductsClient) 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 (ProductsClient) GetSender 

func (client ProductsClient) 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 (ProductsClient) ListByService 

func (client ProductsClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32, expandGroups *bool) (result ProductCollectionPage, err error)

ListByService lists a collection of products in the specified service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ProductsClient) ListByServiceComplete 

func (client ProductsClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32, expandGroups *bool) (result ProductCollectionIterator, err error)

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

func (ProductsClient) ListByServicePreparer 

func (client ProductsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32, expandGroups *bool) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (ProductsClient) ListByServiceResponder 

func (client ProductsClient) ListByServiceResponder(resp *http.Response) (result ProductCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (ProductsClient) ListByServiceSender 

func (client ProductsClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

func (ProductsClient) Update 

func (client ProductsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update update product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (ProductsClient) UpdatePreparer 

func (client ProductsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ProductsClient) UpdateResponder 

func (client ProductsClient) 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 (ProductsClient) UpdateSender 

func (client ProductsClient) 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 PropertiesClient 

type PropertiesClient struct {
	BaseClient
}

PropertiesClient is the apiManagement Client

func NewPropertiesClient 

func NewPropertiesClient(subscriptionID string) PropertiesClient

NewPropertiesClient creates an instance of the PropertiesClient client.

func NewPropertiesClientWithBaseURI 

func NewPropertiesClientWithBaseURI(baseURI string, subscriptionID string) PropertiesClient

NewPropertiesClientWithBaseURI creates an instance of the PropertiesClient client.

func (PropertiesClient) ListByService 

func (client PropertiesClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result PropertyCollectionPage, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (PropertiesClient) ListByServiceComplete 

func (client PropertiesClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result PropertyCollectionIterator, err error)

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

func (PropertiesClient) ListByServicePreparer 

func (client PropertiesClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (PropertiesClient) ListByServiceResponder 

func (client PropertiesClient) ListByServiceResponder(resp *http.Response) (result PropertyCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (PropertiesClient) ListByServiceSender 

func (client PropertiesClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

type PropertyClient 

type PropertyClient struct {
	BaseClient
}

PropertyClient is the apiManagement Client

func NewPropertyClient 

func NewPropertyClient(subscriptionID string) PropertyClient

NewPropertyClient creates an instance of the PropertyClient client.

func NewPropertyClientWithBaseURI 

func NewPropertyClientWithBaseURI(baseURI string, subscriptionID string) PropertyClient

NewPropertyClientWithBaseURI creates an instance of the PropertyClient client.

func (PropertyClient) CreateOrUpdate 

func (client PropertyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, propID string, parameters PropertyCreateParameters) (result autorest.Response, err error)

CreateOrUpdate creates or updates a property.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. propID is identifier of the property. parameters is create parameters.

func (PropertyClient) CreateOrUpdatePreparer 

func (client PropertyClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, propID string, parameters PropertyCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PropertyClient) CreateOrUpdateResponder 

func (client PropertyClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, 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, resourceGroupName string, serviceName string, propID string, ifMatch string) (result ErrorBodyContract, err error)

Delete deletes specific property from the the API Management service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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, resourceGroupName string, serviceName string, propID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PropertyClient) DeleteResponder 

func (client PropertyClient) DeleteResponder(resp *http.Response) (result ErrorBodyContract, 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, resourceGroupName string, serviceName string, propID string) (result PropertyContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. propID is identifier of the property.

func (PropertyClient) GetPreparer 

func (client PropertyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName 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) Update 

func (client PropertyClient) Update(ctx context.Context, resourceGroupName string, serviceName string, propID string, parameters PropertyUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates the specific property.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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, resourceGroupName string, serviceName 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 record count number across all pages.
	Count *int64 `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 - Uniquely identifies the property within the current API Management service instance. The value is a valid relative URL in the format of /properties/{propId} where {propId} is a property identifier.
	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 PropertyCreateParameters 

type PropertyCreateParameters 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"`
}

PropertyCreateParameters parameters supplied to the Create Property operation.

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 parameters supplied to the Update Property operation.

type QuotaByCounterKeysClient 

type QuotaByCounterKeysClient struct {
	BaseClient
}

QuotaByCounterKeysClient is the apiManagement Client

func NewQuotaByCounterKeysClient 

func NewQuotaByCounterKeysClient(subscriptionID string) QuotaByCounterKeysClient

NewQuotaByCounterKeysClient creates an instance of the QuotaByCounterKeysClient client.

func NewQuotaByCounterKeysClientWithBaseURI 

func NewQuotaByCounterKeysClientWithBaseURI(baseURI string, subscriptionID string) QuotaByCounterKeysClient

NewQuotaByCounterKeysClientWithBaseURI creates an instance of the QuotaByCounterKeysClient client.

func (QuotaByCounterKeysClient) ListByService 

func (client QuotaByCounterKeysClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string) (result QuotaCounterCollection, err error)

ListByService lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. quotaCounterKey is quota counter key identifier.

func (QuotaByCounterKeysClient) ListByServicePreparer 

func (client QuotaByCounterKeysClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (QuotaByCounterKeysClient) ListByServiceResponder 

func (client QuotaByCounterKeysClient) ListByServiceResponder(resp *http.Response) (result QuotaCounterCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (QuotaByCounterKeysClient) ListByServiceSender 

func (client QuotaByCounterKeysClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

func (QuotaByCounterKeysClient) Update 

func (client QuotaByCounterKeysClient) Update(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, parameters QuotaCounterValueContract) (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.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. quotaCounterKey is quota counter key identifier. 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, resourceGroupName string, serviceName string, quotaCounterKey string, parameters QuotaCounterValueContract) (*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 apiManagement Client

func NewQuotaByPeriodKeysClient 

func NewQuotaByPeriodKeysClient(subscriptionID string) QuotaByPeriodKeysClient

NewQuotaByPeriodKeysClient creates an instance of the QuotaByPeriodKeysClient client.

func NewQuotaByPeriodKeysClientWithBaseURI 

func NewQuotaByPeriodKeysClientWithBaseURI(baseURI string, subscriptionID string) QuotaByPeriodKeysClient

NewQuotaByPeriodKeysClientWithBaseURI creates an instance of the QuotaByPeriodKeysClient client.

func (QuotaByPeriodKeysClient) Get 

func (client QuotaByPeriodKeysClient) Get(ctx context.Context, resourceGroupName string, serviceName 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.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. quotaCounterKey is quota counter key identifier. quotaPeriodKey is quota period key identifier.

func (QuotaByPeriodKeysClient) GetPreparer 

func (client QuotaByPeriodKeysClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName 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, resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string, parameters QuotaCounterValueContract) (result autorest.Response, err error)

Update updates an existing quota counter value in the specified service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. quotaCounterKey is quota counter key identifier. 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, resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string, parameters QuotaCounterValueContract) (*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:"-"`
	// CallsCount - Number of times Counter was called.
	CallsCount *int32 `json:"callsCount,omitempty"`
	// KbTransferred - Data Transferred in KiloBytes.
	KbTransferred *float64 `json:"kbTransferred,omitempty"`
	// 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"`
}

QuotaCounterContract quota counter details.

type QuotaCounterValueContract 

type QuotaCounterValueContract struct {
	// CallsCount - Number of times Counter was called.
	CallsCount *int32 `json:"callsCount,omitempty"`
	// KbTransferred - Data Transferred in KiloBytes.
	KbTransferred *float64 `json:"kbTransferred,omitempty"`
}

QuotaCounterValueContract quota counter value details.

type ReadCloser 

type ReadCloser struct {
	autorest.Response `json:"-"`
	Value             *io.ReadCloser `json:"value,omitempty"`
}

ReadCloser ...

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"`
}

RegionContract region profile.

type RegionListResult 

type RegionListResult struct {
	autorest.Response `json:"-"`
	// Value - Lists of Regions.
	Value *[]RegionContract `json:"value,omitempty"`
}

RegionListResult lists Regions operation response details.

type RegionsClient 

type RegionsClient struct {
	BaseClient
}

RegionsClient is the apiManagement Client

func NewRegionsClient 

func NewRegionsClient(subscriptionID string) RegionsClient

NewRegionsClient creates an instance of the RegionsClient client.

func NewRegionsClientWithBaseURI 

func NewRegionsClientWithBaseURI(baseURI string, subscriptionID string) RegionsClient

NewRegionsClientWithBaseURI creates an instance of the RegionsClient client.

func (RegionsClient) ListByService 

func (client RegionsClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string) (result RegionListResult, err error)

ListByService lists all azure regions in which the service exists.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (RegionsClient) ListByServicePreparer 

func (client RegionsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (RegionsClient) ListByServiceResponder 

func (client RegionsClient) ListByServiceResponder(resp *http.Response) (result RegionListResult, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (RegionsClient) ListByServiceSender 

func (client RegionsClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

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 *int64 `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 ReportsAggregation 

type ReportsAggregation string

ReportsAggregation enumerates the values for reports aggregation. 

const (
	// ByAPI ...
	ByAPI ReportsAggregation = "byApi"
	// ByGeo ...
	ByGeo ReportsAggregation = "byGeo"
	// ByOperation ...
	ByOperation ReportsAggregation = "byOperation"
	// ByProduct ...
	ByProduct ReportsAggregation = "byProduct"
	// BySubscription ...
	BySubscription ReportsAggregation = "bySubscription"
	// ByTime ...
	ByTime ReportsAggregation = "byTime"
	// ByUser ...
	ByUser ReportsAggregation = "byUser"
)

type ReportsClient 

type ReportsClient struct {
	BaseClient
}

ReportsClient is the apiManagement Client

func NewReportsClient 

func NewReportsClient(subscriptionID string) ReportsClient

NewReportsClient creates an instance of the ReportsClient client.

func NewReportsClientWithBaseURI 

func NewReportsClientWithBaseURI(baseURI string, subscriptionID string) ReportsClient

NewReportsClientWithBaseURI creates an instance of the ReportsClient client.

func (ReportsClient) ListByService 

func (client ReportsClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, aggregation ReportsAggregation, filter string, top *int32, skip *int32, interval *string) (result ReportCollectionPage, err error)

ListByService lists report records.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. aggregation is report aggregation. filter is the filter to apply on the operation. top is number of records to return. skip is number of records to skip. interval is by time interval. This value is only applicable to ByTime aggregation. 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 TimSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))

func (ReportsClient) ListByServiceComplete 

func (client ReportsClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, aggregation ReportsAggregation, filter string, top *int32, skip *int32, interval *string) (result ReportCollectionIterator, err error)

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

func (ReportsClient) ListByServicePreparer 

func (client ReportsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, aggregation ReportsAggregation, filter string, top *int32, skip *int32, interval *string) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (ReportsClient) ListByServiceResponder 

func (client ReportsClient) ListByServiceResponder(resp *http.Response) (result ReportCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (ReportsClient) ListByServiceSender 

func (client ReportsClient) ListByServiceSender(req *http.Request) (*http.Response, error)

ListByServiceSender sends the ListByService 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"`
}

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 Resource 

type Resource struct {
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource is set to Microsoft.ApiManagement.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags *map[string]*string `json:"tags,omitempty"`
}

Resource the Resource definition.

type ResultContract 

type ResultContract 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"`
}

ResultContract 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 ServiceBackupRestoreParameters 

type ServiceBackupRestoreParameters struct {
	// StorageAccount - Azure Cloud Storage account (used to place/retrieve the backup) name.
	StorageAccount *string `json:"storageAccount,omitempty"`
	// AccessKey - Azure Cloud Storage account (used to place/retrieve the backup) access key.
	AccessKey *string `json:"accessKey,omitempty"`
	// ContainerName - Azure Cloud Storage blob container name used to place/retrieve the backup.
	ContainerName *string `json:"containerName,omitempty"`
	// BackupName - The name of the backup file to create.
	BackupName *string `json:"backupName,omitempty"`
}

ServiceBackupRestoreParameters parameters supplied to the Backup/Restore of an API Management service operation.

type ServiceCheckNameAvailabilityParameters 

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

ServiceCheckNameAvailabilityParameters parameters supplied to the CheckNameAvailability operation.

type ServiceGetSsoTokenResult 

type ServiceGetSsoTokenResult struct {
	autorest.Response `json:"-"`
	// RedirectURI - Redirect URL containing the SSO token.
	RedirectURI *string `json:"redirect_uri,omitempty"`
}

ServiceGetSsoTokenResult the response of the GetSsoToken operation.

type ServiceListResult 

type ServiceListResult struct {
	autorest.Response `json:"-"`
	// Value - Result of the List API Management services operation.
	Value *[]ServiceResource `json:"value,omitempty"`
	// NextLink - Link to the next set of results. Not empty if Value contains incomplete list of API Management services.
	NextLink *string `json:"nextLink,omitempty"`
}

ServiceListResult the response of the List API Management services operation.

func (ServiceListResult) IsEmpty 

func (slr ServiceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ServiceListResultIterator 

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

ServiceListResultIterator provides access to a complete listing of ServiceResource values.

func (*ServiceListResultIterator) Next 

func (iter *ServiceListResultIterator) 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 (ServiceListResultIterator) NotDone 

func (iter ServiceListResultIterator) NotDone() bool

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

func (ServiceListResultIterator) Response 

func (iter ServiceListResultIterator) Response() ServiceListResult

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

func (ServiceListResultIterator) Value 

func (iter ServiceListResultIterator) Value() ServiceResource

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

type ServiceListResultPage 

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

ServiceListResultPage contains a page of ServiceResource values.

func (*ServiceListResultPage) Next 

func (page *ServiceListResultPage) 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 (ServiceListResultPage) NotDone 

func (page ServiceListResultPage) NotDone() bool

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

func (ServiceListResultPage) Response 

func (page ServiceListResultPage) Response() ServiceListResult

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

func (ServiceListResultPage) Values 

func (page ServiceListResultPage) Values() []ServiceResource

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

type ServiceManageDeploymentsParameters 

type ServiceManageDeploymentsParameters struct {
	// Location - Location of the API Management service Azure data center.
	Location *string `json:"location,omitempty"`
	// SkuType - SKU type of the API Management service. Possible values include: 'Developer', 'Standard', 'Premium'
	SkuType SkuType `json:"skuType,omitempty"`
	// SkuUnitCount - SKU Unit count of the API Management service. Default value is 1.
	SkuUnitCount *int32 `json:"skuUnitCount,omitempty"`
	// AdditionalLocations - Additional data center locations for the API Management service.
	AdditionalLocations *[]AdditionalRegion `json:"additionalLocations,omitempty"`
	// VpnConfiguration - Virtual network configuration.
	VpnConfiguration *VirtualNetworkConfiguration `json:"vpnConfiguration,omitempty"`
	// VpnType - The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that the API Management service deployment is set up inside a Virtual Network having an Intranet Facing Endpoint only. When vpnConfiguration is specified, vpnType must be specified. Possible values include: 'VirtualNetworkTypeNone', 'VirtualNetworkTypeExternal', 'VirtualNetworkTypeInternal'
	VpnType VirtualNetworkType `json:"vpnType,omitempty"`
}

ServiceManageDeploymentsParameters parameters supplied to the ManageDeployments operation.

type ServiceNameAvailabilityResult 

type ServiceNameAvailabilityResult struct {
	autorest.Response `json:"-"`
	// NameAvailable - True if the name is available and can be used to create a new API Management service; otherwise false.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Message - If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that <resourceName> is already in use, and direct them to select a different name.
	Message *string `json:"message,omitempty"`
	// Reason - Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.)  AlreadyExists indicates that the name is already in use and is therefore unavailable. Possible values include: 'Valid', 'Invalid', 'AlreadyExists'
	Reason NameAvailabilityReason `json:"reason,omitempty"`
}

ServiceNameAvailabilityResult response of the CheckNameAvailability operation.

type ServiceProperties 

type ServiceProperties struct {
	// PublisherEmail - Publisher email.
	PublisherEmail *string `json:"publisherEmail,omitempty"`
	// PublisherName - Publisher name.
	PublisherName *string `json:"publisherName,omitempty"`
	// ProvisioningState - The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// TargetProvisioningState - The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
	TargetProvisioningState *string `json:"targetProvisioningState,omitempty"`
	// CreatedAtUtc - Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	CreatedAtUtc *date.Time `json:"createdAtUtc,omitempty"`
	// RuntimeURL - Proxy endpoint URL of the API Management service.
	RuntimeURL *string `json:"runtimeUrl,omitempty"`
	// PortalURL - Publisher portal endpoint Url of the API Management service.
	PortalURL *string `json:"portalUrl,omitempty"`
	// ManagementAPIURL - Management API endpoint URL of the API Management service.
	ManagementAPIURL *string `json:"managementApiUrl,omitempty"`
	// ScmURL - SCM endpoint URL of the API Management service.
	ScmURL *string `json:"scmUrl,omitempty"`
	// AddresserEmail - Addresser email.
	AddresserEmail *string `json:"addresserEmail,omitempty"`
	// HostnameConfigurations - Custom hostname configuration of the API Management service.
	HostnameConfigurations *[]HostnameConfiguration `json:"hostnameConfigurations,omitempty"`
	// StaticIPs - Static IP addresses of the API Management service virtual machines. Available only for Standard and Premium SKU.
	StaticIPs *[]string `json:"staticIPs,omitempty"`
	// Vpnconfiguration - Virtual network configuration of the API Management service.
	Vpnconfiguration *VirtualNetworkConfiguration `json:"vpnconfiguration,omitempty"`
	// AdditionalLocations - Additional datacenter locations of the API Management service.
	AdditionalLocations *[]AdditionalRegion `json:"additionalLocations,omitempty"`
	// CustomProperties - Custom properties of the API Management service, like disabling TLS 1.0.
	CustomProperties *map[string]*string `json:"customProperties,omitempty"`
	// VpnType - The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. Possible values include: 'VirtualNetworkTypeNone', 'VirtualNetworkTypeExternal', 'VirtualNetworkTypeInternal'
	VpnType VirtualNetworkType `json:"vpnType,omitempty"`
}

ServiceProperties properties of an API Management service resource description.

type ServiceResource 

type ServiceResource struct {
	autorest.Response `json:"-"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource is set to Microsoft.ApiManagement.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags *map[string]*string `json:"tags,omitempty"`
	// ServiceProperties - Properties of the API Management service.
	*ServiceProperties `json:"properties,omitempty"`
	// Sku - SKU properties of the API Management service.
	Sku *ServiceSkuProperties `json:"sku,omitempty"`
	// Etag - ETag of the resource.
	Etag *string `json:"etag,omitempty"`
}

ServiceResource a single API Management service resource in List or Get response.

func (*ServiceResource) UnmarshalJSON 

func (sr *ServiceResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServiceResource struct.

type ServiceSkuProperties 

type ServiceSkuProperties struct {
	// Name - Name of the Sku. Possible values include: 'Developer', 'Standard', 'Premium'
	Name SkuType `json:"name,omitempty"`
	// Capacity - Capacity of the SKU (number of deployed units of the SKU). The default value is 1.
	Capacity *int32 `json:"capacity,omitempty"`
}

ServiceSkuProperties API Management service resource SKU properties.

type ServiceUpdateHostnameParameters 

type ServiceUpdateHostnameParameters struct {
	// Update - Hostnames to create or update.
	Update *[]HostnameConfiguration `json:"update,omitempty"`
	// Delete - Hostnames types to delete.
	Delete *[]HostnameType `json:"delete,omitempty"`
}

ServiceUpdateHostnameParameters parameters supplied to the UpdateHostname operation.

type ServiceUpdateParameters 

type ServiceUpdateParameters struct {
	// ServiceProperties - Properties of the API Management service.
	*ServiceProperties `json:"properties,omitempty"`
	// Sku - SKU properties of the API Management service.
	Sku *ServiceSkuProperties `json:"sku,omitempty"`
	// Tags - Resource tags.
	Tags *map[string]*string `json:"tags,omitempty"`
}

ServiceUpdateParameters parameters supplied to the Update API Management service operation.

func (*ServiceUpdateParameters) UnmarshalJSON 

func (sup *ServiceUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServiceUpdateParameters struct.

type ServiceUploadCertificateParameters 

type ServiceUploadCertificateParameters struct {
	// Type - Hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm'
	Type HostnameType `json:"type,omitempty"`
	// Certificate - Base64 Encoded certificate.
	Certificate *string `json:"certificate,omitempty"`
	// CertificatePassword - Certificate password.
	CertificatePassword *string `json:"certificate_password,omitempty"`
}

ServiceUploadCertificateParameters parameters supplied to the Upload SSL certificate for an API Management service operation.

type ServicesApplyNetworkConfigurationUpdatesFuture 

type ServicesApplyNetworkConfigurationUpdatesFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

ServicesApplyNetworkConfigurationUpdatesFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (ServicesApplyNetworkConfigurationUpdatesFuture) Result 

func (future ServicesApplyNetworkConfigurationUpdatesFuture) Result(client ServicesClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ServicesBackupFuture 

type ServicesBackupFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

ServicesBackupFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (ServicesBackupFuture) Result 

func (future ServicesBackupFuture) Result(client ServicesClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ServicesClient 

type ServicesClient struct {
	BaseClient
}

ServicesClient is the apiManagement Client

func NewServicesClient 

func NewServicesClient(subscriptionID string) ServicesClient

NewServicesClient creates an instance of the ServicesClient client.

func NewServicesClientWithBaseURI 

func NewServicesClientWithBaseURI(baseURI string, subscriptionID string) ServicesClient

NewServicesClientWithBaseURI creates an instance of the ServicesClient client.

func (ServicesClient) ApplyNetworkConfigurationUpdates 

func (client ServicesClient) ApplyNetworkConfigurationUpdates(ctx context.Context, resourceGroupName string, serviceName string) (result ServicesApplyNetworkConfigurationUpdatesFuture, err error)

ApplyNetworkConfigurationUpdates updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (ServicesClient) ApplyNetworkConfigurationUpdatesPreparer 

func (client ServicesClient) ApplyNetworkConfigurationUpdatesPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

ApplyNetworkConfigurationUpdatesPreparer prepares the ApplyNetworkConfigurationUpdates request.

func (ServicesClient) ApplyNetworkConfigurationUpdatesResponder 

func (client ServicesClient) ApplyNetworkConfigurationUpdatesResponder(resp *http.Response) (result ServiceResource, err error)

ApplyNetworkConfigurationUpdatesResponder handles the response to the ApplyNetworkConfigurationUpdates request. The method always closes the http.Response Body.

func (ServicesClient) ApplyNetworkConfigurationUpdatesSender 

func (client ServicesClient) ApplyNetworkConfigurationUpdatesSender(req *http.Request) (future ServicesApplyNetworkConfigurationUpdatesFuture, err error)

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

func (ServicesClient) Backup 

func (client ServicesClient) Backup(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (result ServicesBackupFuture, err error)

Backup creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the ApiManagementServices_Backup operation.

func (ServicesClient) BackupPreparer 

func (client ServicesClient) BackupPreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (*http.Request, error)

BackupPreparer prepares the Backup request.

func (ServicesClient) BackupResponder 

func (client ServicesClient) BackupResponder(resp *http.Response) (result ServiceResource, err error)

BackupResponder handles the response to the Backup request. The method always closes the http.Response Body.

func (ServicesClient) BackupSender 

func (client ServicesClient) BackupSender(req *http.Request) (future ServicesBackupFuture, err error)

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

func (ServicesClient) CheckNameAvailability 

func (client ServicesClient) CheckNameAvailability(ctx context.Context, parameters ServiceCheckNameAvailabilityParameters) (result ServiceNameAvailabilityResult, err error)

CheckNameAvailability checks availability and correctness of a name for an API Management service.

parameters is parameters supplied to the CheckNameAvailability operation.

func (ServicesClient) CheckNameAvailabilityPreparer 

func (client ServicesClient) CheckNameAvailabilityPreparer(ctx context.Context, parameters ServiceCheckNameAvailabilityParameters) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (ServicesClient) CheckNameAvailabilityResponder 

func (client ServicesClient) CheckNameAvailabilityResponder(resp *http.Response) (result ServiceNameAvailabilityResult, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (ServicesClient) CheckNameAvailabilitySender 

func (client ServicesClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (ServicesClient) CreateOrUpdate 

func (client ServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceResource) (result ServiceResource, err error)

CreateOrUpdate creates or updates an API Management service. This is long running operation and could take several minutes to complete.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the CreateOrUpdate API Management service operation.

func (ServicesClient) CreateOrUpdatePreparer 

func (client ServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceResource) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ServicesClient) CreateOrUpdateResponder 

func (client ServicesClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceResource, err error)

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

func (ServicesClient) CreateOrUpdateSender 

func (client ServicesClient) 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 (ServicesClient) Delete 

func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)

Delete deletes an existing API Management service.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (ServicesClient) DeletePreparer 

func (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ServicesClient) DeleteResponder 

func (client ServicesClient) 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 (ServicesClient) DeleteSender 

func (client ServicesClient) 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 (ServicesClient) Get 

func (client ServicesClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result ServiceResource, err error)

Get gets an API Management service resource description.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (ServicesClient) GetPreparer 

func (client ServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ServicesClient) GetResponder 

func (client ServicesClient) GetResponder(resp *http.Response) (result ServiceResource, err error)

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

func (ServicesClient) GetSender 

func (client ServicesClient) 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 (ServicesClient) GetSsoToken 

func (client ServicesClient) GetSsoToken(ctx context.Context, resourceGroupName string, serviceName string) (result ServiceGetSsoTokenResult, err error)

GetSsoToken gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (ServicesClient) GetSsoTokenPreparer 

func (client ServicesClient) GetSsoTokenPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetSsoTokenPreparer prepares the GetSsoToken request.

func (ServicesClient) GetSsoTokenResponder 

func (client ServicesClient) GetSsoTokenResponder(resp *http.Response) (result ServiceGetSsoTokenResult, err error)

GetSsoTokenResponder handles the response to the GetSsoToken request. The method always closes the http.Response Body.

func (ServicesClient) GetSsoTokenSender 

func (client ServicesClient) GetSsoTokenSender(req *http.Request) (*http.Response, error)

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

func (ServicesClient) List 

func (client ServicesClient) List(ctx context.Context) (result ServiceListResultPage, err error)

List lists all API Management services within an Azure subscription.

func (ServicesClient) ListByResourceGroup 

func (client ServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ServiceListResultPage, err error)

ListByResourceGroup list all API Management services within a resource group.

resourceGroupName is the name of the resource group.

func (ServicesClient) ListByResourceGroupComplete 

func (client ServicesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ServiceListResultIterator, err error)

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

func (ServicesClient) ListByResourceGroupPreparer 

func (client ServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ServicesClient) ListByResourceGroupResponder 

func (client ServicesClient) ListByResourceGroupResponder(resp *http.Response) (result ServiceListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ServicesClient) ListByResourceGroupSender 

func (client ServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (ServicesClient) ListComplete 

func (client ServicesClient) ListComplete(ctx context.Context) (result ServiceListResultIterator, err error)

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

func (ServicesClient) ListPreparer 

func (client ServicesClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (ServicesClient) ListResponder 

func (client ServicesClient) ListResponder(resp *http.Response) (result ServiceListResult, err error)

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

func (ServicesClient) ListSender 

func (client ServicesClient) 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 (ServicesClient) ManageDeployments 

func (client ServicesClient) ManageDeployments(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceManageDeploymentsParameters) (result ServicesManageDeploymentsFuture, err error)

ManageDeployments manages deployments of an API Management service. This operation can be used to do the following: Change SKU, Change SKU Units, Change Service Tier (Developer/Standard/Premium) and Manage VPN Configuration. This is a long running operation and can take several minutes to complete.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the ManageDeployments operation.

func (ServicesClient) ManageDeploymentsPreparer 

func (client ServicesClient) ManageDeploymentsPreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceManageDeploymentsParameters) (*http.Request, error)

ManageDeploymentsPreparer prepares the ManageDeployments request.

func (ServicesClient) ManageDeploymentsResponder 

func (client ServicesClient) ManageDeploymentsResponder(resp *http.Response) (result ServiceResource, err error)

ManageDeploymentsResponder handles the response to the ManageDeployments request. The method always closes the http.Response Body.

func (ServicesClient) ManageDeploymentsSender 

func (client ServicesClient) ManageDeploymentsSender(req *http.Request) (future ServicesManageDeploymentsFuture, err error)

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

func (ServicesClient) Restore 

func (client ServicesClient) Restore(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (result ServicesRestoreFuture, err error)

Restore restores a backup of an API Management service created using the ApiManagementServices_Backup operation on the current service. This is a long running operation and could take several minutes to complete.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the Restore API Management service from backup operation.

func (ServicesClient) RestorePreparer 

func (client ServicesClient) RestorePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (*http.Request, error)

RestorePreparer prepares the Restore request.

func (ServicesClient) RestoreResponder 

func (client ServicesClient) RestoreResponder(resp *http.Response) (result ServiceResource, err error)

RestoreResponder handles the response to the Restore request. The method always closes the http.Response Body.

func (ServicesClient) RestoreSender 

func (client ServicesClient) RestoreSender(req *http.Request) (future ServicesRestoreFuture, err error)

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

func (ServicesClient) Update 

func (client ServicesClient) Update(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateParameters) (result ServicesUpdateFuture, err error)

Update updates an existing API Management service.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the CreateOrUpdate API Management service operation.

func (ServicesClient) UpdateHostname 

func (client ServicesClient) UpdateHostname(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateHostnameParameters) (result ServicesUpdateHostnameFuture, err error)

UpdateHostname creates, updates, or deletes the custom hostnames for an API Management service. The custom hostname can be applied to the Proxy and Portal endpoint. This is a long running operation and could take several minutes to complete.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the UpdateHostname operation.

func (ServicesClient) UpdateHostnamePreparer 

func (client ServicesClient) UpdateHostnamePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateHostnameParameters) (*http.Request, error)

UpdateHostnamePreparer prepares the UpdateHostname request.

func (ServicesClient) UpdateHostnameResponder 

func (client ServicesClient) UpdateHostnameResponder(resp *http.Response) (result ServiceResource, err error)

UpdateHostnameResponder handles the response to the UpdateHostname request. The method always closes the http.Response Body.

func (ServicesClient) UpdateHostnameSender 

func (client ServicesClient) UpdateHostnameSender(req *http.Request) (future ServicesUpdateHostnameFuture, err error)

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

func (ServicesClient) UpdatePreparer 

func (client ServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ServicesClient) UpdateResponder 

func (client ServicesClient) UpdateResponder(resp *http.Response) (result ServiceResource, err error)

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

func (ServicesClient) UpdateSender 

func (client ServicesClient) UpdateSender(req *http.Request) (future ServicesUpdateFuture, err error)

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

func (ServicesClient) UploadCertificate 

func (client ServicesClient) UploadCertificate(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUploadCertificateParameters) (result CertificateInformation, err error)

UploadCertificate upload Custom Domain SSL certificate for an API Management service.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the Upload SSL certificate for an API Management service operation.

func (ServicesClient) UploadCertificatePreparer 

func (client ServicesClient) UploadCertificatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUploadCertificateParameters) (*http.Request, error)

UploadCertificatePreparer prepares the UploadCertificate request.

func (ServicesClient) UploadCertificateResponder 

func (client ServicesClient) UploadCertificateResponder(resp *http.Response) (result CertificateInformation, err error)

UploadCertificateResponder handles the response to the UploadCertificate request. The method always closes the http.Response Body.

func (ServicesClient) UploadCertificateSender 

func (client ServicesClient) UploadCertificateSender(req *http.Request) (*http.Response, error)

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

type ServicesManageDeploymentsFuture 

type ServicesManageDeploymentsFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

ServicesManageDeploymentsFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (ServicesManageDeploymentsFuture) Result 

func (future ServicesManageDeploymentsFuture) Result(client ServicesClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ServicesRestoreFuture 

type ServicesRestoreFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

ServicesRestoreFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (ServicesRestoreFuture) Result 

func (future ServicesRestoreFuture) Result(client ServicesClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ServicesUpdateFuture 

type ServicesUpdateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

ServicesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (ServicesUpdateFuture) Result 

func (future ServicesUpdateFuture) Result(client ServicesClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ServicesUpdateHostnameFuture 

type ServicesUpdateHostnameFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

ServicesUpdateHostnameFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (ServicesUpdateHostnameFuture) Result 

func (future ServicesUpdateHostnameFuture) Result(client ServicesClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SkuType 

type SkuType string

SkuType enumerates the values for sku type. 

const (
	// Developer ...
	Developer SkuType = "Developer"
	// Premium ...
	Premium SkuType = "Premium"
	// Standard ...
	Standard SkuType = "Standard"
)

type SubscriptionCollection 

type SubscriptionCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]SubscriptionContract `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"`
}

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 - Uniquely identifies the subscription within the current API Management service instance. The value is a valid relative URL in the format of /subscriptions/{sid} where {sid} is a subscription identifier.
	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 SubscriptionStateContract `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 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 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 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 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 SubscriptionStateContract `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 SubscriptionStateContract 

type SubscriptionStateContract string

SubscriptionStateContract enumerates the values for subscription state contract. 

const (
	// Active ...
	Active SubscriptionStateContract = "Active"
	// Cancelled ...
	Cancelled SubscriptionStateContract = "Cancelled"
	// Expired ...
	Expired SubscriptionStateContract = "Expired"
	// Rejected ...
	Rejected SubscriptionStateContract = "Rejected"
	// Submitted ...
	Submitted SubscriptionStateContract = "Submitted"
	// Suspended ...
	Suspended SubscriptionStateContract = "Suspended"
)

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 - New subscription expiration date.
	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 SubscriptionStateContract `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 SubscriptionsClient 

type SubscriptionsClient struct {
	BaseClient
}

SubscriptionsClient is the apiManagement Client

func NewSubscriptionsClient 

func NewSubscriptionsClient(subscriptionID string) SubscriptionsClient

NewSubscriptionsClient creates an instance of the SubscriptionsClient client.

func NewSubscriptionsClientWithBaseURI 

func NewSubscriptionsClientWithBaseURI(baseURI string, subscriptionID string) SubscriptionsClient

NewSubscriptionsClientWithBaseURI creates an instance of the SubscriptionsClient client.

func (SubscriptionsClient) CreateOrUpdate 

func (client SubscriptionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionCreateParameters) (result autorest.Response, err error)

CreateOrUpdate creates or updates the subscription of specified user to the specified product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. sid is subscription entity Identifier. The entity represents the association between a user and a product in API Management. parameters is create parameters.

func (SubscriptionsClient) CreateOrUpdatePreparer 

func (client SubscriptionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SubscriptionsClient) CreateOrUpdateResponder 

func (client SubscriptionsClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (SubscriptionsClient) CreateOrUpdateSender 

func (client SubscriptionsClient) 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 (SubscriptionsClient) Delete 

func (client SubscriptionsClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, sid string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified subscription.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (SubscriptionsClient) DeletePreparer 

func (client SubscriptionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (SubscriptionsClient) DeleteResponder 

func (client SubscriptionsClient) 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 (SubscriptionsClient) DeleteSender 

func (client SubscriptionsClient) 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 (SubscriptionsClient) Get 

func (client SubscriptionsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result SubscriptionContract, err error)

Get gets the specified Subscription entity.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. sid is subscription entity Identifier. The entity represents the association between a user and a product in API Management.

func (SubscriptionsClient) GetPreparer 

func (client SubscriptionsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SubscriptionsClient) GetResponder 

func (client SubscriptionsClient) 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 (SubscriptionsClient) GetSender 

func (client SubscriptionsClient) 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 (SubscriptionsClient) List 

func (client SubscriptionsClient) List(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)

List lists all subscriptions of the API Management service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (SubscriptionsClient) ListComplete 

func (client SubscriptionsClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)

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

func (SubscriptionsClient) ListPreparer 

func (client SubscriptionsClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (SubscriptionsClient) ListResponder 

func (client SubscriptionsClient) 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 (SubscriptionsClient) ListSender 

func (client SubscriptionsClient) 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 (SubscriptionsClient) RegeneratePrimaryKey 

func (client SubscriptionsClient) RegeneratePrimaryKey(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result autorest.Response, err error)

RegeneratePrimaryKey regenerates primary key of existing subscription of the API Management service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. sid is subscription entity Identifier. The entity represents the association between a user and a product in API Management.

func (SubscriptionsClient) RegeneratePrimaryKeyPreparer 

func (client SubscriptionsClient) RegeneratePrimaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)

RegeneratePrimaryKeyPreparer prepares the RegeneratePrimaryKey request.

func (SubscriptionsClient) RegeneratePrimaryKeyResponder 

func (client SubscriptionsClient) 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 (SubscriptionsClient) RegeneratePrimaryKeySender 

func (client SubscriptionsClient) 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 (SubscriptionsClient) RegenerateSecondaryKey 

func (client SubscriptionsClient) RegenerateSecondaryKey(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result autorest.Response, err error)

RegenerateSecondaryKey regenerates secondary key of existing subscription of the API Management service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. sid is subscription entity Identifier. The entity represents the association between a user and a product in API Management.

func (SubscriptionsClient) RegenerateSecondaryKeyPreparer 

func (client SubscriptionsClient) RegenerateSecondaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)

RegenerateSecondaryKeyPreparer prepares the RegenerateSecondaryKey request.

func (SubscriptionsClient) RegenerateSecondaryKeyResponder 

func (client SubscriptionsClient) 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 (SubscriptionsClient) RegenerateSecondaryKeySender 

func (client SubscriptionsClient) 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 (SubscriptionsClient) Update 

func (client SubscriptionsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates the details of a subscription specificied by its identifier.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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.

func (SubscriptionsClient) UpdatePreparer 

func (client SubscriptionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (SubscriptionsClient) UpdateResponder 

func (client SubscriptionsClient) 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 (SubscriptionsClient) UpdateSender 

func (client SubscriptionsClient) 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 TenantAccessClient 

type TenantAccessClient struct {
	BaseClient
}

TenantAccessClient is the apiManagement Client

func NewTenantAccessClient 

func NewTenantAccessClient(subscriptionID string) TenantAccessClient

NewTenantAccessClient creates an instance of the TenantAccessClient client.

func NewTenantAccessClientWithBaseURI 

func NewTenantAccessClientWithBaseURI(baseURI string, subscriptionID string) TenantAccessClient

NewTenantAccessClientWithBaseURI creates an instance of the TenantAccessClient client.

func (TenantAccessClient) Get 

func (client TenantAccessClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result AccessInformationContract, err error)

Get get tenant access information details.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (TenantAccessClient) GetPreparer 

func (client TenantAccessClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName 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, resourceGroupName string, serviceName string) (result autorest.Response, err error)

RegeneratePrimaryKey regenerate primary access key.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (TenantAccessClient) RegeneratePrimaryKeyPreparer 

func (client TenantAccessClient) RegeneratePrimaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName 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, resourceGroupName string, serviceName string) (result autorest.Response, err error)

RegenerateSecondaryKey regenerate secondary access key.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (TenantAccessClient) RegenerateSecondaryKeyPreparer 

func (client TenantAccessClient) RegenerateSecondaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName 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, resourceGroupName string, serviceName string, parameters AccessInformationUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update update tenant access information details.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters. ifMatch is the entity state (Etag) version of the tenant access settings 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, resourceGroupName string, serviceName 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 apiManagement Client

func NewTenantAccessGitClient 

func NewTenantAccessGitClient(subscriptionID string) TenantAccessGitClient

NewTenantAccessGitClient creates an instance of the TenantAccessGitClient client.

func NewTenantAccessGitClientWithBaseURI 

func NewTenantAccessGitClientWithBaseURI(baseURI string, subscriptionID string) TenantAccessGitClient

NewTenantAccessGitClientWithBaseURI creates an instance of the TenantAccessGitClient client.

func (TenantAccessGitClient) Get 

func (client TenantAccessGitClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result AccessInformationContract, err error)

Get gets the Git access configuration for the tenant.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (TenantAccessGitClient) GetPreparer 

func (client TenantAccessGitClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName 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, resourceGroupName string, serviceName string) (result autorest.Response, err error)

RegeneratePrimaryKey regenerate primary access key for GIT.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (TenantAccessGitClient) RegeneratePrimaryKeyPreparer 

func (client TenantAccessGitClient) RegeneratePrimaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName 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, resourceGroupName string, serviceName string) (result autorest.Response, err error)

RegenerateSecondaryKey regenerate secondary access key for GIT.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (TenantAccessGitClient) RegenerateSecondaryKeyPreparer 

func (client TenantAccessGitClient) RegenerateSecondaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName 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 apiManagement Client

func NewTenantConfigurationClient 

func NewTenantConfigurationClient(subscriptionID string) TenantConfigurationClient

NewTenantConfigurationClient creates an instance of the TenantConfigurationClient client.

func NewTenantConfigurationClientWithBaseURI 

func NewTenantConfigurationClientWithBaseURI(baseURI string, subscriptionID string) TenantConfigurationClient

NewTenantConfigurationClientWithBaseURI creates an instance of the TenantConfigurationClient client.

func (TenantConfigurationClient) Deploy 

func (client TenantConfigurationClient) Deploy(ctx context.Context, resourceGroupName string, serviceName 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.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is deploy Configuration parameters.

func (TenantConfigurationClient) DeployPreparer 

func (client TenantConfigurationClient) DeployPreparer(ctx context.Context, resourceGroupName string, serviceName 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) Save 

func (client TenantConfigurationClient) Save(ctx context.Context, resourceGroupName string, serviceName 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.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is save Configuration parameters.

func (TenantConfigurationClient) SavePreparer 

func (client TenantConfigurationClient) SavePreparer(ctx context.Context, resourceGroupName string, serviceName 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, resourceGroupName string, serviceName 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.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is validate Configuration parameters.

func (TenantConfigurationClient) ValidatePreparer 

func (client TenantConfigurationClient) ValidatePreparer(ctx context.Context, resourceGroupName string, serviceName 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 TenantConfigurationSyncStateClient 

type TenantConfigurationSyncStateClient struct {
	BaseClient
}

TenantConfigurationSyncStateClient is the apiManagement Client

func NewTenantConfigurationSyncStateClient 

func NewTenantConfigurationSyncStateClient(subscriptionID string) TenantConfigurationSyncStateClient

NewTenantConfigurationSyncStateClient creates an instance of the TenantConfigurationSyncStateClient client.

func NewTenantConfigurationSyncStateClientWithBaseURI 

func NewTenantConfigurationSyncStateClientWithBaseURI(baseURI string, subscriptionID string) TenantConfigurationSyncStateClient

NewTenantConfigurationSyncStateClientWithBaseURI creates an instance of the TenantConfigurationSyncStateClient client.

func (TenantConfigurationSyncStateClient) Get 

func (client TenantConfigurationSyncStateClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result TenantConfigurationSyncStateContract, err error)

Get gets the status of the most recent synchronization between the configuration database and the Git repository.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (TenantConfigurationSyncStateClient) GetPreparer 

func (client TenantConfigurationSyncStateClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TenantConfigurationSyncStateClient) GetResponder 

func (client TenantConfigurationSyncStateClient) GetResponder(resp *http.Response) (result TenantConfigurationSyncStateContract, err error)

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

func (TenantConfigurationSyncStateClient) GetSender 

func (client TenantConfigurationSyncStateClient) 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 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 TenantPolicyClient 

type TenantPolicyClient struct {
	BaseClient
}

TenantPolicyClient is the apiManagement Client

func NewTenantPolicyClient 

func NewTenantPolicyClient(subscriptionID string) TenantPolicyClient

NewTenantPolicyClient creates an instance of the TenantPolicyClient client.

func NewTenantPolicyClientWithBaseURI 

func NewTenantPolicyClientWithBaseURI(baseURI string, subscriptionID string) TenantPolicyClient

NewTenantPolicyClientWithBaseURI creates an instance of the TenantPolicyClient client.

func (TenantPolicyClient) CreateOrUpdate 

func (client TenantPolicyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters io.ReadCloser, ifMatch string) (result autorest.Response, err error)

CreateOrUpdate creates or updates global policy configuration for the tenant.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is the policy content details. parameters will be closed upon successful return. Callers should ensure closure when receiving an error.ifMatch is the entity state (Etag) version of the tenant policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (TenantPolicyClient) CreateOrUpdatePreparer 

func (client TenantPolicyClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters io.ReadCloser, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (TenantPolicyClient) CreateOrUpdateResponder 

func (client TenantPolicyClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (TenantPolicyClient) CreateOrUpdateSender 

func (client TenantPolicyClient) 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 (TenantPolicyClient) Delete 

func (client TenantPolicyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, ifMatch string) (result autorest.Response, err error)

Delete deletes the global tenant policy configuration.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. ifMatch is the entity state (Etag) version of the tenant policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (TenantPolicyClient) DeletePreparer 

func (client TenantPolicyClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (TenantPolicyClient) DeleteResponder 

func (client TenantPolicyClient) 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 (TenantPolicyClient) DeleteSender 

func (client TenantPolicyClient) 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 (TenantPolicyClient) Get 

func (client TenantPolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result ReadCloser, err error)

Get get the global policy configuration of the tenant.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.

func (TenantPolicyClient) GetPreparer 

func (client TenantPolicyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TenantPolicyClient) GetResponder 

func (client TenantPolicyClient) GetResponder(resp *http.Response) (result ReadCloser, err error)

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

func (TenantPolicyClient) GetSender 

func (client TenantPolicyClient) 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 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 UserCollection 

type UserCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]UserContract `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"`
}

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 - User identifier path.
	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"`
	// State - User state. Possible values include: 'UserStateContractActive', 'UserStateContractBlocked'
	State UserStateContract `json:"state,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"`
	// Note - Administrator's note about given user.
	Note *string `json:"note,omitempty"`
	// Identities - Collection of user identities.
	Identities *[]UserIdentityContract `json:"identities,omitempty"`
}

UserContract 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"`
	// 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: 'UserStateContractActive', 'UserStateContractBlocked'
	State UserStateContract `json:"state,omitempty"`
	// Note - Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`
}

UserCreateParameters parameters supplied to the Create User operation.

type UserGroupsClient 

type UserGroupsClient struct {
	BaseClient
}

UserGroupsClient is the apiManagement Client

func NewUserGroupsClient 

func NewUserGroupsClient(subscriptionID string) UserGroupsClient

NewUserGroupsClient creates an instance of the UserGroupsClient client.

func NewUserGroupsClientWithBaseURI 

func NewUserGroupsClientWithBaseURI(baseURI string, subscriptionID string) UserGroupsClient

NewUserGroupsClientWithBaseURI creates an instance of the UserGroupsClient client.

func (UserGroupsClient) ListByUsers 

func (client UserGroupsClient) ListByUsers(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)

ListByUsers lists all user groups.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (UserGroupsClient) ListByUsersComplete 

func (client UserGroupsClient) ListByUsersComplete(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)

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

func (UserGroupsClient) ListByUsersPreparer 

func (client UserGroupsClient) ListByUsersPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByUsersPreparer prepares the ListByUsers request.

func (UserGroupsClient) ListByUsersResponder 

func (client UserGroupsClient) ListByUsersResponder(resp *http.Response) (result GroupCollection, err error)

ListByUsersResponder handles the response to the ListByUsers request. The method always closes the http.Response Body.

func (UserGroupsClient) ListByUsersSender 

func (client UserGroupsClient) ListByUsersSender(req *http.Request) (*http.Response, error)

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

type UserIdentitiesClient 

type UserIdentitiesClient struct {
	BaseClient
}

UserIdentitiesClient is the apiManagement Client

func NewUserIdentitiesClient 

func NewUserIdentitiesClient(subscriptionID string) UserIdentitiesClient

NewUserIdentitiesClient creates an instance of the UserIdentitiesClient client.

func NewUserIdentitiesClientWithBaseURI 

func NewUserIdentitiesClientWithBaseURI(baseURI string, subscriptionID string) UserIdentitiesClient

NewUserIdentitiesClientWithBaseURI creates an instance of the UserIdentitiesClient client.

func (UserIdentitiesClient) ListByUsers 

func (client UserIdentitiesClient) ListByUsers(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result UserIdentityCollection, err error)

ListByUsers lists all user identities.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. UID is user identifier. Must be unique in the current API Management service instance.

func (UserIdentitiesClient) ListByUsersPreparer 

func (client UserIdentitiesClient) ListByUsersPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)

ListByUsersPreparer prepares the ListByUsers request.

func (UserIdentitiesClient) ListByUsersResponder 

func (client UserIdentitiesClient) ListByUsersResponder(resp *http.Response) (result UserIdentityCollection, err error)

ListByUsersResponder handles the response to the ListByUsers request. The method always closes the http.Response Body.

func (UserIdentitiesClient) ListByUsersSender 

func (client UserIdentitiesClient) ListByUsersSender(req *http.Request) (*http.Response, error)

ListByUsersSender sends the ListByUsers 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"`
}

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 UserStateContract 

type UserStateContract string

UserStateContract enumerates the values for user state contract. 

const (
	// UserStateContractActive ...
	UserStateContractActive UserStateContract = "Active"
	// UserStateContractBlocked ...
	UserStateContractBlocked UserStateContract = "Blocked"
)

type UserSubscriptionsClient 

type UserSubscriptionsClient struct {
	BaseClient
}

UserSubscriptionsClient is the apiManagement Client

func NewUserSubscriptionsClient 

func NewUserSubscriptionsClient(subscriptionID string) UserSubscriptionsClient

NewUserSubscriptionsClient creates an instance of the UserSubscriptionsClient client.

func NewUserSubscriptionsClientWithBaseURI 

func NewUserSubscriptionsClientWithBaseURI(baseURI string, subscriptionID string) UserSubscriptionsClient

NewUserSubscriptionsClientWithBaseURI creates an instance of the UserSubscriptionsClient client.

func (UserSubscriptionsClient) ListByUsers 

func (client UserSubscriptionsClient) ListByUsers(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)

ListByUsers lists the collection of subscriptions of the specified user.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (UserSubscriptionsClient) ListByUsersComplete 

func (client UserSubscriptionsClient) ListByUsersComplete(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)

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

func (UserSubscriptionsClient) ListByUsersPreparer 

func (client UserSubscriptionsClient) ListByUsersPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByUsersPreparer prepares the ListByUsers request.

func (UserSubscriptionsClient) ListByUsersResponder 

func (client UserSubscriptionsClient) ListByUsersResponder(resp *http.Response) (result SubscriptionCollection, err error)

ListByUsersResponder handles the response to the ListByUsers request. The method always closes the http.Response Body.

func (UserSubscriptionsClient) ListByUsersSender 

func (client UserSubscriptionsClient) ListByUsersSender(req *http.Request) (*http.Response, error)

ListByUsersSender sends the ListByUsers 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 KeyTypeContract `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.
	Email *string `json:"email,omitempty"`
	// Password - 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. Possible values include: 'UserStateContractActive', 'UserStateContractBlocked'
	State UserStateContract `json:"state,omitempty"`
	// Note - Note about user.
	Note *string `json:"note,omitempty"`
}

UserUpdateParameters parameters supplied to the Update User operation.

type UsersClient 

type UsersClient struct {
	BaseClient
}

UsersClient is the apiManagement Client

func NewUsersClient 

func NewUsersClient(subscriptionID string) UsersClient

NewUsersClient creates an instance of the UsersClient client.

func NewUsersClientWithBaseURI 

func NewUsersClientWithBaseURI(baseURI string, subscriptionID string) UsersClient

NewUsersClientWithBaseURI creates an instance of the UsersClient client.

func (UsersClient) CreateOrUpdate 

func (client UsersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserCreateParameters) (result autorest.Response, err error)

CreateOrUpdate creates or Updates a user.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. UID is user identifier. Must be unique in the current API Management service instance. parameters is create or update parameters.

func (UsersClient) CreateOrUpdatePreparer 

func (client UsersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (UsersClient) CreateOrUpdateResponder 

func (client UsersClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

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

func (UsersClient) CreateOrUpdateSender 

func (client UsersClient) 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 (UsersClient) Delete 

func (client UsersClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, UID string, ifMatch string, deleteSubscriptions *bool) (result ErrorBodyContract, err error)

Delete deletes specific user.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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.

func (UsersClient) DeletePreparer 

func (client UsersClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, ifMatch string, deleteSubscriptions *bool) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (UsersClient) DeleteResponder 

func (client UsersClient) DeleteResponder(resp *http.Response) (result ErrorBodyContract, err error)

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

func (UsersClient) DeleteSender 

func (client UsersClient) 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 (UsersClient) GenerateSsoURL 

func (client UsersClient) GenerateSsoURL(ctx context.Context, resourceGroupName string, serviceName 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.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. UID is user identifier. Must be unique in the current API Management service instance.

func (UsersClient) GenerateSsoURLPreparer 

func (client UsersClient) GenerateSsoURLPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)

GenerateSsoURLPreparer prepares the GenerateSsoURL request.

func (UsersClient) GenerateSsoURLResponder 

func (client UsersClient) 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 (UsersClient) GenerateSsoURLSender 

func (client UsersClient) 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 (UsersClient) Get 

func (client UsersClient) Get(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result UserContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. UID is user identifier. Must be unique in the current API Management service instance.

func (UsersClient) GetPreparer 

func (client UsersClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (UsersClient) GetResponder 

func (client UsersClient) 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 (UsersClient) GetSender 

func (client UsersClient) 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 (UsersClient) GetSharedAccessToken 

func (client UsersClient) GetSharedAccessToken(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserTokenParameters) (result UserTokenResult, err error)

GetSharedAccessToken gets the Shared Access Authorization Token for the User.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. UID is user identifier. Must be unique in the current API Management service instance. parameters is create Authorization Token parameters.

func (UsersClient) GetSharedAccessTokenPreparer 

func (client UsersClient) GetSharedAccessTokenPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserTokenParameters) (*http.Request, error)

GetSharedAccessTokenPreparer prepares the GetSharedAccessToken request.

func (UsersClient) GetSharedAccessTokenResponder 

func (client UsersClient) 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 (UsersClient) GetSharedAccessTokenSender 

func (client UsersClient) 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 (UsersClient) ListByService 

func (client UsersClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result UserCollectionPage, err error)

ListByService lists a collection of registered users in the specified service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (UsersClient) ListByServiceComplete 

func (client UsersClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result UserCollectionIterator, err error)

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

func (UsersClient) ListByServicePreparer 

func (client UsersClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (UsersClient) ListByServiceResponder 

func (client UsersClient) ListByServiceResponder(resp *http.Response) (result UserCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (UsersClient) ListByServiceSender 

func (client UsersClient) ListByServiceSender(req *http.Request) (*http.Response, error)

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

func (UsersClient) Update 

func (client UsersClient) Update(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserUpdateParameters, ifMatch string) (result ErrorBodyContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. 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 (UsersClient) UpdatePreparer 

func (client UsersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (UsersClient) UpdateResponder 

func (client UsersClient) UpdateResponder(resp *http.Response) (result ErrorBodyContract, err error)

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

func (UsersClient) UpdateSender 

func (client UsersClient) 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 VirtualNetworkConfiguration 

type VirtualNetworkConfiguration struct {
	// Vnetid - The virtual network ID. This is typically a GUID. Expect a null GUID by default.
	Vnetid *string `json:"vnetid,omitempty"`
	// Subnetname - The name of the subnet.
	Subnetname *string `json:"subnetname,omitempty"`
	// SubnetResourceID - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
	SubnetResourceID *string `json:"subnetResourceId,omitempty"`
	// Location - The location of the virtual network.
	Location *string `json:"location,omitempty"`
}

VirtualNetworkConfiguration configuration of a virtual network to which API Management service is deployed.

type VirtualNetworkType 

type VirtualNetworkType string

VirtualNetworkType enumerates the values for virtual network type. 

const (
	// VirtualNetworkTypeExternal ...
	VirtualNetworkTypeExternal VirtualNetworkType = "External"
	// VirtualNetworkTypeInternal ...
	VirtualNetworkTypeInternal VirtualNetworkType = "Internal"
	// VirtualNetworkTypeNone ...
	VirtualNetworkTypeNone VirtualNetworkType = "None"
)

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.