apimanagement

package
v23.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 27, 2018 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

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

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 APIClient 

type APIClient struct {
	BaseClient
}

APIClient is the apiManagement Client

func NewAPIClient 

func NewAPIClient(subscriptionID string) APIClient

NewAPIClient creates an instance of the APIClient client.

func NewAPIClientWithBaseURI 

func NewAPIClientWithBaseURI(baseURI string, subscriptionID string) APIClient

NewAPIClientWithBaseURI creates an instance of the APIClient client.

func (APIClient) CreateOrUpdate 

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

CreateOrUpdate creates new or updates existing specified API of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. parameters - create or update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (APIClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIClient) CreateOrUpdateResponder 

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

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

func (APIClient) CreateOrUpdateSender 

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

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

func (APIClient) Delete 

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

Delete deletes the specified API of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. deleteRevisions - delete all revisions of the Api.

func (APIClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (APIClient) DeleteResponder 

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

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

func (APIClient) DeleteSender 

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

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

func (APIClient) Get 

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

Get gets the details of the API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

func (APIClient) GetEntityTag 

func (client APIClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

func (APIClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APIClient) GetEntityTagSender 

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

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

func (APIClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIClient) GetResponder 

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

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

func (APIClient) GetSender 

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

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

func (APIClient) ListByService 

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

ListByService lists all APIs of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip. expandAPIVersionSet - include full ApiVersionSet resource in response

func (APIClient) ListByServiceComplete 

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

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

func (APIClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (APIClient) ListByServiceResponder 

func (client APIClient) 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 (APIClient) ListByServiceSender 

func (client APIClient) 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 (APIClient) ListByTags 

func (client APIClient) ListByTags(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagResourceCollectionPage, err error)

ListByTags lists a collection of apis associated with tags. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 | | aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | 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 | | isCurrent | eq | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (APIClient) ListByTagsComplete 

func (client APIClient) ListByTagsComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagResourceCollectionIterator, err error)

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

func (APIClient) ListByTagsPreparer 

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

ListByTagsPreparer prepares the ListByTags request.

func (APIClient) ListByTagsResponder 

func (client APIClient) ListByTagsResponder(resp *http.Response) (result TagResourceCollection, err error)

ListByTagsResponder handles the response to the ListByTags request. The method always closes the http.Response Body.

func (APIClient) ListByTagsSender 

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

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

func (APIClient) Update 

func (client APIClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. parameters - API Update Contract parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (APIClient) UpdateResponder 

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

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

func (APIClient) UpdateSender 

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

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

type APICollection 

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

func NewAPICollectionIterator(page APICollectionPage) APICollectionIterator

Creates a new instance of the APICollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*APICollectionIterator) NextWithContext 

func (iter *APICollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewAPICollectionPage 

func NewAPICollectionPage(getNextPage func(context.Context, APICollection) (APICollection, error)) APICollectionPage

Creates a new instance of the APICollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*APICollectionPage) NextWithContext 

func (page *APICollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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:"-"`
	// APIContractProperties - Api entity contract properties.
	*APIContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

APIContract API details.

func (APIContract) MarshalJSON 

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

MarshalJSON is the custom marshaler for APIContract.

func (*APIContract) UnmarshalJSON 

func (ac *APIContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for APIContract struct.

type APIContractProperties 

type APIContractProperties struct {
	// DisplayName - API name.
	DisplayName *string `json:"displayName,omitempty"`
	// ServiceURL - Absolute URL of the backend service implementing this API.
	ServiceURL *string `json:"serviceUrl,omitempty"`
	// Path - Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
	Path *string `json:"path,omitempty"`
	// Protocols - Describes on which protocols the operations in this API can be invoked.
	Protocols     *[]Protocol                   `json:"protocols,omitempty"`
	APIVersionSet *APIVersionSetContractDetails `json:"apiVersionSet,omitempty"`
	// Description - Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthenticationSettings - Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
	// SubscriptionKeyParameterNames - Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
	APIType APIType `json:"type,omitempty"`
	// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`
	// APIVersion - Indicates the Version identifier of the API if the API is versioned
	APIVersion *string `json:"apiVersion,omitempty"`
	// IsCurrent - Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`
	// IsOnline - Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty"`
	// APIRevisionDescription - Description of the Api Revision.
	APIRevisionDescription *string `json:"apiRevisionDescription,omitempty"`
	// APIVersionDescription - Description of the Api Version.
	APIVersionDescription *string `json:"apiVersionDescription,omitempty"`
	// APIVersionSetID - A resource identifier for the related ApiVersionSet.
	APIVersionSetID *string `json:"apiVersionSetId,omitempty"`
}

APIContractProperties api Entity Properties

type APIContractUpdateProperties 

type APIContractUpdateProperties struct {
	// DisplayName - API name.
	DisplayName *string `json:"displayName,omitempty"`
	// ServiceURL - Absolute URL of the backend service implementing this API.
	ServiceURL *string `json:"serviceUrl,omitempty"`
	// Path - Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
	Path *string `json:"path,omitempty"`
	// Protocols - Describes on which protocols the operations in this API can be invoked.
	Protocols *[]Protocol `json:"protocols,omitempty"`
	// Description - Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthenticationSettings - Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
	// SubscriptionKeyParameterNames - Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
	APIType APIType `json:"type,omitempty"`
	// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`
	// APIVersion - Indicates the Version identifier of the API if the API is versioned
	APIVersion *string `json:"apiVersion,omitempty"`
	// IsCurrent - Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`
	// IsOnline - Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty"`
	// APIRevisionDescription - Description of the Api Revision.
	APIRevisionDescription *string `json:"apiRevisionDescription,omitempty"`
	// APIVersionDescription - Description of the Api Version.
	APIVersionDescription *string `json:"apiVersionDescription,omitempty"`
	// APIVersionSetID - A resource identifier for the related ApiVersionSet.
	APIVersionSetID *string `json:"apiVersionSetId,omitempty"`
}

APIContractUpdateProperties API update contract properties.

type APICreateOrUpdateParameter 

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

APICreateOrUpdateParameter API Create or Update Parameters.

func (APICreateOrUpdateParameter) MarshalJSON 

func (acoup APICreateOrUpdateParameter) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for APICreateOrUpdateParameter.

func (*APICreateOrUpdateParameter) UnmarshalJSON 

func (acoup *APICreateOrUpdateParameter) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for APICreateOrUpdateParameter struct.

type APICreateOrUpdateProperties 

type APICreateOrUpdateProperties struct {
	// ContentValue - Content value when Importing an API.
	ContentValue *string `json:"contentValue,omitempty"`
	// ContentFormat - Format of the Content in which the API is getting imported. Possible values include: 'WadlXML', 'WadlLinkJSON', 'SwaggerJSON', 'SwaggerLinkJSON', 'Wsdl', 'WsdlLink'
	ContentFormat ContentFormat `json:"contentFormat,omitempty"`
	// WsdlSelector - Criteria to limit import of WSDL to a subset of the document.
	WsdlSelector *APICreateOrUpdatePropertiesWsdlSelector `json:"wsdlSelector,omitempty"`
	// SoapAPIType - Type of Api to create.
	//  * `http` creates a SOAP to REST API
	//  * `soap` creates a SOAP pass-through API. Possible values include: 'SoapToRest', 'SoapPassThrough'
	SoapAPIType SoapAPIType `json:"apiType,omitempty"`
	// DisplayName - API name.
	DisplayName *string `json:"displayName,omitempty"`
	// ServiceURL - Absolute URL of the backend service implementing this API.
	ServiceURL *string `json:"serviceUrl,omitempty"`
	// Path - Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
	Path *string `json:"path,omitempty"`
	// Protocols - Describes on which protocols the operations in this API can be invoked.
	Protocols     *[]Protocol                   `json:"protocols,omitempty"`
	APIVersionSet *APIVersionSetContractDetails `json:"apiVersionSet,omitempty"`
	// Description - Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthenticationSettings - Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
	// SubscriptionKeyParameterNames - Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
	APIType APIType `json:"type,omitempty"`
	// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`
	// APIVersion - Indicates the Version identifier of the API if the API is versioned
	APIVersion *string `json:"apiVersion,omitempty"`
	// IsCurrent - Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`
	// IsOnline - Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty"`
	// APIRevisionDescription - Description of the Api Revision.
	APIRevisionDescription *string `json:"apiRevisionDescription,omitempty"`
	// APIVersionDescription - Description of the Api Version.
	APIVersionDescription *string `json:"apiVersionDescription,omitempty"`
	// APIVersionSetID - A resource identifier for the related ApiVersionSet.
	APIVersionSetID *string `json:"apiVersionSetId,omitempty"`
}

APICreateOrUpdateProperties api Create or Update Properties.

type APICreateOrUpdatePropertiesWsdlSelector 

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

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

type APIDiagnosticClient 

type APIDiagnosticClient struct {
	BaseClient
}

APIDiagnosticClient is the apiManagement Client

func NewAPIDiagnosticClient 

func NewAPIDiagnosticClient(subscriptionID string) APIDiagnosticClient

NewAPIDiagnosticClient creates an instance of the APIDiagnosticClient client.

func NewAPIDiagnosticClientWithBaseURI 

func NewAPIDiagnosticClientWithBaseURI(baseURI string, subscriptionID string) APIDiagnosticClient

NewAPIDiagnosticClientWithBaseURI creates an instance of the APIDiagnosticClient client.

func (APIDiagnosticClient) CreateOrUpdate 

func (client APIDiagnosticClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, parameters DiagnosticContract, ifMatch string) (result DiagnosticContract, err error)

CreateOrUpdate creates a new Diagnostic for an API or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (APIDiagnosticClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIDiagnosticClient) CreateOrUpdateResponder 

func (client APIDiagnosticClient) CreateOrUpdateResponder(resp *http.Response) (result DiagnosticContract, err error)

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

func (APIDiagnosticClient) CreateOrUpdateSender 

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

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

Delete deletes the specified Diagnostic from an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIDiagnosticClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (APIDiagnosticClient) DeleteResponder 

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

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

func (client APIDiagnosticClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string) (result DiagnosticContract, err error)

Get gets the details of the Diagnostic for an API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance.

func (APIDiagnosticClient) GetEntityTag 

func (client APIDiagnosticClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance.

func (APIDiagnosticClient) GetEntityTagPreparer 

func (client APIDiagnosticClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIDiagnosticClient) GetEntityTagResponder 

func (client APIDiagnosticClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APIDiagnosticClient) GetEntityTagSender 

func (client APIDiagnosticClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

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

func (APIDiagnosticClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIDiagnosticClient) GetResponder 

func (client APIDiagnosticClient) GetResponder(resp *http.Response) (result DiagnosticContract, err error)

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

func (APIDiagnosticClient) GetSender 

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

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

ListByService lists all diagnostics of an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (APIDiagnosticClient) ListByServiceComplete 

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

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

func (APIDiagnosticClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (APIDiagnosticClient) ListByServiceResponder 

func (client APIDiagnosticClient) ListByServiceResponder(resp *http.Response) (result DiagnosticCollection, err error)

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

func (APIDiagnosticClient) ListByServiceSender 

func (client APIDiagnosticClient) 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 (APIDiagnosticClient) Update 

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

Update updates the details of the Diagnostic for an API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. parameters - diagnostic Update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIDiagnosticClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (APIDiagnosticClient) UpdateResponder 

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

func (client APIDiagnosticClient) 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 APIDiagnosticLoggerClient 

type APIDiagnosticLoggerClient struct {
	BaseClient
}

APIDiagnosticLoggerClient is the apiManagement Client

func NewAPIDiagnosticLoggerClient 

func NewAPIDiagnosticLoggerClient(subscriptionID string) APIDiagnosticLoggerClient

NewAPIDiagnosticLoggerClient creates an instance of the APIDiagnosticLoggerClient client.

func NewAPIDiagnosticLoggerClientWithBaseURI 

func NewAPIDiagnosticLoggerClientWithBaseURI(baseURI string, subscriptionID string) APIDiagnosticLoggerClient

NewAPIDiagnosticLoggerClientWithBaseURI creates an instance of the APIDiagnosticLoggerClient client.

func (APIDiagnosticLoggerClient) CheckEntityExists 

func (client APIDiagnosticLoggerClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (result autorest.Response, err error)

CheckEntityExists checks that logger entity specified by identifier is associated with the diagnostics entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.

func (APIDiagnosticLoggerClient) CheckEntityExistsPreparer 

func (client APIDiagnosticLoggerClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (*http.Request, error)

CheckEntityExistsPreparer prepares the CheckEntityExists request.

func (APIDiagnosticLoggerClient) CheckEntityExistsResponder 

func (client APIDiagnosticLoggerClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)

CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.

func (APIDiagnosticLoggerClient) CheckEntityExistsSender 

func (client APIDiagnosticLoggerClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)

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

func (APIDiagnosticLoggerClient) CreateOrUpdate 

func (client APIDiagnosticLoggerClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (result LoggerContract, err error)

CreateOrUpdate attaches a logger to a dignostic for an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.

func (APIDiagnosticLoggerClient) CreateOrUpdatePreparer 

func (client APIDiagnosticLoggerClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIDiagnosticLoggerClient) CreateOrUpdateResponder 

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

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

func (APIDiagnosticLoggerClient) CreateOrUpdateSender 

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

func (client APIDiagnosticLoggerClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (result autorest.Response, err error)

Delete deletes the specified Logger from Diagnostic for an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.

func (APIDiagnosticLoggerClient) DeletePreparer 

func (client APIDiagnosticLoggerClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (APIDiagnosticLoggerClient) DeleteResponder 

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

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

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

ListByService lists all loggers assosiated with the specified Diagnostic of an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | type | eq | | top - number of records to return. skip - number of records to skip.

func (APIDiagnosticLoggerClient) ListByServiceComplete 

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

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

func (APIDiagnosticLoggerClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (APIDiagnosticLoggerClient) ListByServiceResponder 

func (client APIDiagnosticLoggerClient) 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 (APIDiagnosticLoggerClient) ListByServiceSender 

func (client APIDiagnosticLoggerClient) 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 APIEntityBaseContract 

type APIEntityBaseContract struct {
	// Description - Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthenticationSettings - Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
	// SubscriptionKeyParameterNames - Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
	APIType APIType `json:"type,omitempty"`
	// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`
	// APIVersion - Indicates the Version identifier of the API if the API is versioned
	APIVersion *string `json:"apiVersion,omitempty"`
	// IsCurrent - Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`
	// IsOnline - Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty"`
	// APIRevisionDescription - Description of the Api Revision.
	APIRevisionDescription *string `json:"apiRevisionDescription,omitempty"`
	// APIVersionDescription - Description of the Api Version.
	APIVersionDescription *string `json:"apiVersionDescription,omitempty"`
	// APIVersionSetID - A resource identifier for the related ApiVersionSet.
	APIVersionSetID *string `json:"apiVersionSetId,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, formatParameter ExportFormat) (result APIExportResult, err error)

Get gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. formatParameter - format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes.

func (APIExportClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIExportClient) GetResponder 

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

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

func (APIExportClient) GetSender 

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

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

type APIExportResult 

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

APIExportResult API Export result Blob Uri.

type APIIssueAttachmentClient 

type APIIssueAttachmentClient struct {
	BaseClient
}

APIIssueAttachmentClient is the apiManagement Client

func NewAPIIssueAttachmentClient 

func NewAPIIssueAttachmentClient(subscriptionID string) APIIssueAttachmentClient

NewAPIIssueAttachmentClient creates an instance of the APIIssueAttachmentClient client.

func NewAPIIssueAttachmentClientWithBaseURI 

func NewAPIIssueAttachmentClientWithBaseURI(baseURI string, subscriptionID string) APIIssueAttachmentClient

NewAPIIssueAttachmentClientWithBaseURI creates an instance of the APIIssueAttachmentClient client.

func (APIIssueAttachmentClient) CreateOrUpdate 

func (client APIIssueAttachmentClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, attachmentID string, parameters IssueAttachmentContract, ifMatch string) (result IssueAttachmentContract, err error)

CreateOrUpdate creates a new Attachment for the Issue in an API or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. attachmentID - attachment identifier within an Issue. Must be unique in the current Issue. parameters - create parameters. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIIssueAttachmentClient) CreateOrUpdatePreparer 

func (client APIIssueAttachmentClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, attachmentID string, parameters IssueAttachmentContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIIssueAttachmentClient) CreateOrUpdateResponder 

func (client APIIssueAttachmentClient) CreateOrUpdateResponder(resp *http.Response) (result IssueAttachmentContract, err error)

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

func (APIIssueAttachmentClient) CreateOrUpdateSender 

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

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

Delete deletes the specified comment from an Issue. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. attachmentID - attachment identifier within an Issue. Must be unique in the current Issue. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIIssueAttachmentClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (APIIssueAttachmentClient) DeleteResponder 

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

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

func (client APIIssueAttachmentClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, attachmentID string) (result IssueAttachmentContract, err error)

Get gets the details of the issue Attachment for an API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. attachmentID - attachment identifier within an Issue. Must be unique in the current Issue.

func (APIIssueAttachmentClient) GetEntityTag 

func (client APIIssueAttachmentClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, attachmentID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. attachmentID - attachment identifier within an Issue. Must be unique in the current Issue.

func (APIIssueAttachmentClient) GetEntityTagPreparer 

func (client APIIssueAttachmentClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, attachmentID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIIssueAttachmentClient) GetEntityTagResponder 

func (client APIIssueAttachmentClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APIIssueAttachmentClient) GetEntityTagSender 

func (client APIIssueAttachmentClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

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

func (APIIssueAttachmentClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIIssueAttachmentClient) GetResponder 

func (client APIIssueAttachmentClient) GetResponder(resp *http.Response) (result IssueAttachmentContract, err error)

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

func (APIIssueAttachmentClient) GetSender 

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

func (client APIIssueAttachmentClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, filter string, top *int32, skip *int32) (result IssueAttachmentCollectionPage, err error)

ListByService lists all comments for the Issue assosiated with the specified API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (APIIssueAttachmentClient) ListByServiceComplete 

func (client APIIssueAttachmentClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, filter string, top *int32, skip *int32) (result IssueAttachmentCollectionIterator, err error)

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

func (APIIssueAttachmentClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (APIIssueAttachmentClient) ListByServiceResponder 

func (client APIIssueAttachmentClient) ListByServiceResponder(resp *http.Response) (result IssueAttachmentCollection, err error)

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

func (APIIssueAttachmentClient) ListByServiceSender 

func (client APIIssueAttachmentClient) 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 APIIssueClient 

type APIIssueClient struct {
	BaseClient
}

APIIssueClient is the apiManagement Client

func NewAPIIssueClient 

func NewAPIIssueClient(subscriptionID string) APIIssueClient

NewAPIIssueClient creates an instance of the APIIssueClient client.

func NewAPIIssueClientWithBaseURI 

func NewAPIIssueClientWithBaseURI(baseURI string, subscriptionID string) APIIssueClient

NewAPIIssueClientWithBaseURI creates an instance of the APIIssueClient client.

func (APIIssueClient) CreateOrUpdate 

func (client APIIssueClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, parameters IssueContract, ifMatch string) (result IssueContract, err error)

CreateOrUpdate creates a new Issue for an API or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIIssueClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIIssueClient) CreateOrUpdateResponder 

func (client APIIssueClient) CreateOrUpdateResponder(resp *http.Response) (result IssueContract, err error)

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

func (APIIssueClient) CreateOrUpdateSender 

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

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

Delete deletes the specified Issue from an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIIssueClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (APIIssueClient) DeleteResponder 

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

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

func (client APIIssueClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string) (result IssueContract, err error)

Get gets the details of the Issue for an API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance.

func (APIIssueClient) GetEntityTag 

func (client APIIssueClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the Issue for an API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance.

func (APIIssueClient) GetEntityTagPreparer 

func (client APIIssueClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIIssueClient) GetEntityTagResponder 

func (client APIIssueClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APIIssueClient) GetEntityTagSender 

func (client APIIssueClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

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

func (APIIssueClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIIssueClient) GetResponder 

func (client APIIssueClient) GetResponder(resp *http.Response) (result IssueContract, err error)

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

func (APIIssueClient) GetSender 

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

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

ListByService lists all issues assosiated with the specified API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | state | eq | | | userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (APIIssueClient) ListByServiceComplete 

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

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

func (APIIssueClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (APIIssueClient) ListByServiceResponder 

func (client APIIssueClient) ListByServiceResponder(resp *http.Response) (result IssueCollection, err error)

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

func (APIIssueClient) ListByServiceSender 

func (client APIIssueClient) 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 (APIIssueClient) Update 

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

Update updates an existing issue for an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIIssueClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (APIIssueClient) UpdateResponder 

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

func (client APIIssueClient) 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 APIIssueCommentClient 

type APIIssueCommentClient struct {
	BaseClient
}

APIIssueCommentClient is the apiManagement Client

func NewAPIIssueCommentClient 

func NewAPIIssueCommentClient(subscriptionID string) APIIssueCommentClient

NewAPIIssueCommentClient creates an instance of the APIIssueCommentClient client.

func NewAPIIssueCommentClientWithBaseURI 

func NewAPIIssueCommentClientWithBaseURI(baseURI string, subscriptionID string) APIIssueCommentClient

NewAPIIssueCommentClientWithBaseURI creates an instance of the APIIssueCommentClient client.

func (APIIssueCommentClient) CreateOrUpdate 

func (client APIIssueCommentClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, commentID string, parameters IssueCommentContract, ifMatch string) (result IssueCommentContract, err error)

CreateOrUpdate creates a new Comment for the Issue in an API or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. commentID - comment identifier within an Issue. Must be unique in the current Issue. parameters - create parameters. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIIssueCommentClient) CreateOrUpdatePreparer 

func (client APIIssueCommentClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, commentID string, parameters IssueCommentContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIIssueCommentClient) CreateOrUpdateResponder 

func (client APIIssueCommentClient) CreateOrUpdateResponder(resp *http.Response) (result IssueCommentContract, err error)

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

func (APIIssueCommentClient) CreateOrUpdateSender 

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

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

Delete deletes the specified comment from an Issue. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. commentID - comment identifier within an Issue. Must be unique in the current Issue. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIIssueCommentClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (APIIssueCommentClient) DeleteResponder 

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

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

func (client APIIssueCommentClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, commentID string) (result IssueCommentContract, err error)

Get gets the details of the issue Comment for an API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. commentID - comment identifier within an Issue. Must be unique in the current Issue.

func (APIIssueCommentClient) GetEntityTag 

func (client APIIssueCommentClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, commentID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the issue Comment for an API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. commentID - comment identifier within an Issue. Must be unique in the current Issue.

func (APIIssueCommentClient) GetEntityTagPreparer 

func (client APIIssueCommentClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, commentID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIIssueCommentClient) GetEntityTagResponder 

func (client APIIssueCommentClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APIIssueCommentClient) GetEntityTagSender 

func (client APIIssueCommentClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

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

func (APIIssueCommentClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIIssueCommentClient) GetResponder 

func (client APIIssueCommentClient) GetResponder(resp *http.Response) (result IssueCommentContract, err error)

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

func (APIIssueCommentClient) GetSender 

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

func (client APIIssueCommentClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, filter string, top *int32, skip *int32) (result IssueCommentCollectionPage, err error)

ListByService lists all comments for the Issue assosiated with the specified API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (APIIssueCommentClient) ListByServiceComplete 

func (client APIIssueCommentClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, filter string, top *int32, skip *int32) (result IssueCommentCollectionIterator, err error)

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

func (APIIssueCommentClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (APIIssueCommentClient) ListByServiceResponder 

func (client APIIssueCommentClient) ListByServiceResponder(resp *http.Response) (result IssueCommentCollection, err error)

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

func (APIIssueCommentClient) ListByServiceSender 

func (client APIIssueCommentClient) 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 APIOperationClient 

type APIOperationClient struct {
	BaseClient
}

APIOperationClient is the apiManagement Client

func NewAPIOperationClient 

func NewAPIOperationClient(subscriptionID string) APIOperationClient

NewAPIOperationClient creates an instance of the APIOperationClient client.

func NewAPIOperationClientWithBaseURI 

func NewAPIOperationClientWithBaseURI(baseURI string, subscriptionID string) APIOperationClient

NewAPIOperationClientWithBaseURI creates an instance of the APIOperationClient client.

func (APIOperationClient) CreateOrUpdate 

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

CreateOrUpdate creates a new operation in the API or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (APIOperationClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationClient) CreateOrUpdateResponder 

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

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

func (APIOperationClient) CreateOrUpdateSender 

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

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

func (APIOperationClient) Delete 

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

Delete deletes the specified operation in the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIOperationClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (APIOperationClient) DeleteResponder 

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

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

func (APIOperationClient) DeleteSender 

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

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

func (APIOperationClient) Get 

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

Get gets the details of the API Operation specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance.

func (APIOperationClient) GetEntityTag 

func (client APIOperationClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the API operation specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance.

func (APIOperationClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIOperationClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APIOperationClient) GetEntityTagSender 

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

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

func (APIOperationClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIOperationClient) GetResponder 

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

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

func (APIOperationClient) GetSender 

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

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

func (APIOperationClient) ListByAPI 

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

ListByAPI lists a collection of the operations for the specified API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | 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 - number of records to return. skip - number of records to skip.

func (APIOperationClient) ListByAPIComplete 

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

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

func (APIOperationClient) ListByAPIPreparer 

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

ListByAPIPreparer prepares the ListByAPI request.

func (APIOperationClient) ListByAPIResponder 

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

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

func (APIOperationClient) ListByAPISender 

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

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

func (APIOperationClient) Update 

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

Update updates the details of the operation in the API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. parameters - API Operation Update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIOperationClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (APIOperationClient) UpdateResponder 

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

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

func (APIOperationClient) UpdateSender 

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

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

type APIOperationPolicyClient 

type APIOperationPolicyClient struct {
	BaseClient
}

APIOperationPolicyClient is the apiManagement Client

func NewAPIOperationPolicyClient 

func NewAPIOperationPolicyClient(subscriptionID string) APIOperationPolicyClient

NewAPIOperationPolicyClient creates an instance of the APIOperationPolicyClient client.

func NewAPIOperationPolicyClientWithBaseURI 

func NewAPIOperationPolicyClientWithBaseURI(baseURI string, subscriptionID string) APIOperationPolicyClient

NewAPIOperationPolicyClientWithBaseURI creates an instance of the APIOperationPolicyClient client.

func (APIOperationPolicyClient) CreateOrUpdate 

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

CreateOrUpdate creates or updates policy configuration for the API Operation level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. parameters - the policy contents to apply. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (APIOperationPolicyClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationPolicyClient) CreateOrUpdateResponder 

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

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

func (APIOperationPolicyClient) CreateOrUpdateSender 

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

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

func (APIOperationPolicyClient) Delete 

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

Delete deletes the policy configuration at the Api Operation. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIOperationPolicyClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (APIOperationPolicyClient) DeleteResponder 

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

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

func (APIOperationPolicyClient) DeleteSender 

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

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

func (APIOperationPolicyClient) Get 

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

Get get the policy configuration at the API Operation level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance.

func (APIOperationPolicyClient) GetEntityTag 

func (client APIOperationPolicyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the API operation policy specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance.

func (APIOperationPolicyClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIOperationPolicyClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APIOperationPolicyClient) GetEntityTagSender 

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

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

func (APIOperationPolicyClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIOperationPolicyClient) GetResponder 

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

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

func (APIOperationPolicyClient) GetSender 

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

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

func (APIOperationPolicyClient) ListByOperation 

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

ListByOperation get the list of policy configuration at the API Operation level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance.

func (APIOperationPolicyClient) ListByOperationPreparer 

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

ListByOperationPreparer prepares the ListByOperation request.

func (APIOperationPolicyClient) ListByOperationResponder 

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

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

func (APIOperationPolicyClient) ListByOperationSender 

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

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

type APIPolicyClient 

type APIPolicyClient struct {
	BaseClient
}

APIPolicyClient is the 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 PolicyContract, ifMatch string) (result PolicyContract, err error)

CreateOrUpdate creates or updates policy configuration for the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. parameters - the policy contents to apply. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (APIPolicyClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIPolicyClient) CreateOrUpdateResponder 

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

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

func (APIPolicyClient) CreateOrUpdateSender 

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

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

func (APIPolicyClient) Delete 

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

Delete deletes the policy configuration at the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

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 PolicyContract, err error)

Get get the policy configuration at the API level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

func (APIPolicyClient) GetEntityTag 

func (client APIPolicyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the API policy specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

func (APIPolicyClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIPolicyClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APIPolicyClient) GetEntityTagSender 

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

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

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 PolicyContract, err error)

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

func (APIPolicyClient) GetSender 

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

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

func (APIPolicyClient) ListByAPI 

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

ListByAPI get the policy configuration at the API level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

func (APIPolicyClient) ListByAPIPreparer 

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

ListByAPIPreparer prepares the ListByAPI request.

func (APIPolicyClient) ListByAPIResponder 

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

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

func (APIPolicyClient) ListByAPISender 

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

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

type APIProductClient 

type APIProductClient struct {
	BaseClient
}

APIProductClient is the apiManagement Client

func NewAPIProductClient 

func NewAPIProductClient(subscriptionID string) APIProductClient

NewAPIProductClient creates an instance of the APIProductClient client.

func NewAPIProductClientWithBaseURI 

func NewAPIProductClientWithBaseURI(baseURI string, subscriptionID string) APIProductClient

NewAPIProductClientWithBaseURI creates an instance of the APIProductClient client.

func (APIProductClient) ListByApis 

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

ListByApis lists all Products, which the API is part of. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (APIProductClient) ListByApisComplete 

func (client APIProductClient) 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 (APIProductClient) ListByApisPreparer 

func (client APIProductClient) 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 (APIProductClient) ListByApisResponder 

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

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

func (APIProductClient) ListByApisSender 

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

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

type APIReleaseClient 

type APIReleaseClient struct {
	BaseClient
}

APIReleaseClient is the apiManagement Client

func NewAPIReleaseClient 

func NewAPIReleaseClient(subscriptionID string) APIReleaseClient

NewAPIReleaseClient creates an instance of the APIReleaseClient client.

func NewAPIReleaseClientWithBaseURI 

func NewAPIReleaseClientWithBaseURI(baseURI string, subscriptionID string) APIReleaseClient

NewAPIReleaseClientWithBaseURI creates an instance of the APIReleaseClient client.

func (APIReleaseClient) Create 

func (client APIReleaseClient) Create(ctx context.Context, resourceGroupName string, serviceName string, apiid string, releaseID string, parameters APIReleaseContract) (result APIReleaseContract, err error)

Create creates a new Release for the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. releaseID - release identifier within an API. Must be unique in the current API Management service instance. parameters - create parameters.

func (APIReleaseClient) CreatePreparer 

func (client APIReleaseClient) CreatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, releaseID string, parameters APIReleaseContract) (*http.Request, error)

CreatePreparer prepares the Create request.

func (APIReleaseClient) CreateResponder 

func (client APIReleaseClient) CreateResponder(resp *http.Response) (result APIReleaseContract, err error)

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

func (APIReleaseClient) CreateSender 

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

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

Delete deletes the specified release in the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. releaseID - release identifier within an API. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIReleaseClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (APIReleaseClient) DeleteResponder 

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

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

func (client APIReleaseClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, releaseID string) (result APIReleaseContract, err error)

Get returns the details of an API release. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. releaseID - release identifier within an API. Must be unique in the current API Management service instance.

func (APIReleaseClient) GetEntityTag 

func (client APIReleaseClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiid string, releaseID string) (result autorest.Response, err error)

GetEntityTag returns the etag of an API release. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. releaseID - release identifier within an API. Must be unique in the current API Management service instance.

func (APIReleaseClient) GetEntityTagPreparer 

func (client APIReleaseClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, releaseID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIReleaseClient) GetEntityTagResponder 

func (client APIReleaseClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APIReleaseClient) GetEntityTagSender 

func (client APIReleaseClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

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

func (APIReleaseClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIReleaseClient) GetResponder 

func (client APIReleaseClient) GetResponder(resp *http.Response) (result APIReleaseContract, err error)

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

func (APIReleaseClient) GetSender 

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

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

List lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | |notes|ge le eq ne gt lt|substringof contains startswith endswith| top - number of records to return. skip - number of records to skip.

func (APIReleaseClient) ListComplete 

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

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

func (APIReleaseClient) ListPreparer 

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

ListPreparer prepares the List request.

func (APIReleaseClient) ListResponder 

func (client APIReleaseClient) ListResponder(resp *http.Response) (result APIReleaseCollection, err error)

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

func (APIReleaseClient) ListSender 

func (client APIReleaseClient) 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 (APIReleaseClient) Update 

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

Update updates the details of the release of the API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. releaseID - release identifier within an API. Must be unique in the current API Management service instance. parameters - API Release Update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIReleaseClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (APIReleaseClient) UpdateResponder 

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

func (client APIReleaseClient) 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 APIReleaseCollection 

type APIReleaseCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]APIReleaseContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

APIReleaseCollection paged Api Revision list representation.

func (APIReleaseCollection) IsEmpty 

func (arc APIReleaseCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type APIReleaseCollectionIterator 

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

APIReleaseCollectionIterator provides access to a complete listing of APIReleaseContract values.

func NewAPIReleaseCollectionIterator 

func NewAPIReleaseCollectionIterator(page APIReleaseCollectionPage) APIReleaseCollectionIterator

Creates a new instance of the APIReleaseCollectionIterator type.

func (*APIReleaseCollectionIterator) Next 

func (iter *APIReleaseCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*APIReleaseCollectionIterator) NextWithContext 

func (iter *APIReleaseCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (APIReleaseCollectionIterator) NotDone 

func (iter APIReleaseCollectionIterator) NotDone() bool

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

func (APIReleaseCollectionIterator) Response 

func (iter APIReleaseCollectionIterator) Response() APIReleaseCollection

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

func (APIReleaseCollectionIterator) Value 

func (iter APIReleaseCollectionIterator) Value() APIReleaseContract

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

type APIReleaseCollectionPage 

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

APIReleaseCollectionPage contains a page of APIReleaseContract values.

func NewAPIReleaseCollectionPage 

func NewAPIReleaseCollectionPage(getNextPage func(context.Context, APIReleaseCollection) (APIReleaseCollection, error)) APIReleaseCollectionPage

Creates a new instance of the APIReleaseCollectionPage type.

func (*APIReleaseCollectionPage) Next 

func (page *APIReleaseCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*APIReleaseCollectionPage) NextWithContext 

func (page *APIReleaseCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (APIReleaseCollectionPage) NotDone 

func (page APIReleaseCollectionPage) NotDone() bool

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

func (APIReleaseCollectionPage) Response 

func (page APIReleaseCollectionPage) Response() APIReleaseCollection

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

func (APIReleaseCollectionPage) Values 

func (page APIReleaseCollectionPage) Values() []APIReleaseContract

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

type APIReleaseContract 

type APIReleaseContract struct {
	autorest.Response `json:"-"`
	// APIReleaseContractProperties - Properties of the Api Release Contract.
	*APIReleaseContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

APIReleaseContract api Release details.

func (APIReleaseContract) MarshalJSON 

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

MarshalJSON is the custom marshaler for APIReleaseContract.

func (*APIReleaseContract) UnmarshalJSON 

func (arc *APIReleaseContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for APIReleaseContract struct.

type APIReleaseContractProperties 

type APIReleaseContractProperties struct {
	// APIID - Identifier of the API the release belongs to.
	APIID *string `json:"apiId,omitempty"`
	// CreatedDateTime - The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	CreatedDateTime *date.Time `json:"createdDateTime,omitempty"`
	// UpdatedDateTime - The time the API release was updated.
	UpdatedDateTime *date.Time `json:"updatedDateTime,omitempty"`
	// Notes - Release Notes
	Notes *string `json:"notes,omitempty"`
}

APIReleaseContractProperties API Release details

type APIRevisionCollection 

type APIRevisionCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]APIRevisionContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

APIRevisionCollection paged Api Revision list representation.

func (APIRevisionCollection) IsEmpty 

func (arc APIRevisionCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type APIRevisionCollectionIterator 

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

APIRevisionCollectionIterator provides access to a complete listing of APIRevisionContract values.

func NewAPIRevisionCollectionIterator 

func NewAPIRevisionCollectionIterator(page APIRevisionCollectionPage) APIRevisionCollectionIterator

Creates a new instance of the APIRevisionCollectionIterator type.

func (*APIRevisionCollectionIterator) Next 

func (iter *APIRevisionCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*APIRevisionCollectionIterator) NextWithContext 

func (iter *APIRevisionCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (APIRevisionCollectionIterator) NotDone 

func (iter APIRevisionCollectionIterator) NotDone() bool

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

func (APIRevisionCollectionIterator) Response 

func (iter APIRevisionCollectionIterator) Response() APIRevisionCollection

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

func (APIRevisionCollectionIterator) Value 

func (iter APIRevisionCollectionIterator) Value() APIRevisionContract

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

type APIRevisionCollectionPage 

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

APIRevisionCollectionPage contains a page of APIRevisionContract values.

func NewAPIRevisionCollectionPage 

func NewAPIRevisionCollectionPage(getNextPage func(context.Context, APIRevisionCollection) (APIRevisionCollection, error)) APIRevisionCollectionPage

Creates a new instance of the APIRevisionCollectionPage type.

func (*APIRevisionCollectionPage) Next 

func (page *APIRevisionCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*APIRevisionCollectionPage) NextWithContext 

func (page *APIRevisionCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (APIRevisionCollectionPage) NotDone 

func (page APIRevisionCollectionPage) NotDone() bool

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

func (APIRevisionCollectionPage) Response 

func (page APIRevisionCollectionPage) Response() APIRevisionCollection

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

func (APIRevisionCollectionPage) Values 

func (page APIRevisionCollectionPage) Values() []APIRevisionContract

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

type APIRevisionContract 

type APIRevisionContract struct {
	// APIID - Identifier of the API Revision.
	APIID *string `json:"apiId,omitempty"`
	// APIRevision - Revision number of API.
	APIRevision *string `json:"apiRevision,omitempty"`
	// CreatedDateTime - The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	CreatedDateTime *date.Time `json:"createdDateTime,omitempty"`
	// UpdatedDateTime - The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
	UpdatedDateTime *date.Time `json:"updatedDateTime,omitempty"`
	// Description - Description of the API Revision.
	Description *string `json:"description,omitempty"`
	// PrivateURL - Gateway URL for accessing the non-current API Revision.
	PrivateURL *string `json:"privateUrl,omitempty"`
	// IsOnline - Indicates if API revision is the current api revision.
	IsOnline *bool `json:"isOnline,omitempty"`
	// IsCurrent - Indicates if API revision is accessible via the gateway.
	IsCurrent *bool `json:"isCurrent,omitempty"`
}

APIRevisionContract summary of revision metadata.

type APIRevisionInfoContract 

type APIRevisionInfoContract struct {
	// SourceAPIID - Resource identifier of API to be used to create the revision from.
	SourceAPIID *string `json:"sourceApiId,omitempty"`
	// APIVersionName - Version identifier for the new API Version.
	APIVersionName *string `json:"apiVersionName,omitempty"`
	// APIRevisionDescription - Description of new API Revision.
	APIRevisionDescription *string `json:"apiRevisionDescription,omitempty"`
	// APIVersionSet - Version set details
	APIVersionSet *APIVersionSetContractDetails `json:"apiVersionSet,omitempty"`
}

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

type APIRevisionsClient 

type APIRevisionsClient struct {
	BaseClient
}

APIRevisionsClient is the apiManagement Client

func NewAPIRevisionsClient 

func NewAPIRevisionsClient(subscriptionID string) APIRevisionsClient

NewAPIRevisionsClient creates an instance of the APIRevisionsClient client.

func NewAPIRevisionsClientWithBaseURI 

func NewAPIRevisionsClientWithBaseURI(baseURI string, subscriptionID string) APIRevisionsClient

NewAPIRevisionsClientWithBaseURI creates an instance of the APIRevisionsClient client.

func (APIRevisionsClient) List 

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

List lists all revisions of an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------|

|apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| top - number of records to return. skip - number of records to skip.

func (APIRevisionsClient) ListComplete 

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

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

func (APIRevisionsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (APIRevisionsClient) ListResponder 

func (client APIRevisionsClient) ListResponder(resp *http.Response) (result APIRevisionCollection, err error)

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

func (APIRevisionsClient) ListSender 

func (client APIRevisionsClient) 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 APISchemaClient 

type APISchemaClient struct {
	BaseClient
}

APISchemaClient is the apiManagement Client

func NewAPISchemaClient 

func NewAPISchemaClient(subscriptionID string) APISchemaClient

NewAPISchemaClient creates an instance of the APISchemaClient client.

func NewAPISchemaClientWithBaseURI 

func NewAPISchemaClientWithBaseURI(baseURI string, subscriptionID string) APISchemaClient

NewAPISchemaClientWithBaseURI creates an instance of the APISchemaClient client.

func (APISchemaClient) CreateOrUpdate 

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

CreateOrUpdate creates or updates schema configuration for the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. schemaID - schema identifier within an API. Must be unique in the current API Management service instance. parameters - the schema contents to apply. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (APISchemaClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APISchemaClient) CreateOrUpdateResponder 

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

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

func (APISchemaClient) CreateOrUpdateSender 

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

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

func (APISchemaClient) Delete 

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

Delete deletes the schema configuration at the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. schemaID - schema identifier within an API. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APISchemaClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (APISchemaClient) DeleteResponder 

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

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

func (APISchemaClient) DeleteSender 

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

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

func (APISchemaClient) Get 

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

Get get the schema configuration at the API level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. schemaID - schema identifier within an API. Must be unique in the current API Management service instance.

func (APISchemaClient) GetEntityTag 

func (client APISchemaClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, apiid string, schemaID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the schema specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. schemaID - schema identifier within an API. Must be unique in the current API Management service instance.

func (APISchemaClient) GetEntityTagPreparer 

func (client APISchemaClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, schemaID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (APISchemaClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APISchemaClient) GetEntityTagSender 

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

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

func (APISchemaClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APISchemaClient) GetResponder 

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

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

func (APISchemaClient) GetSender 

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

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

func (APISchemaClient) ListByAPI 

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

ListByAPI get the schema configuration at the API level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

func (APISchemaClient) ListByAPIComplete 

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

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

func (APISchemaClient) ListByAPIPreparer 

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

ListByAPIPreparer prepares the ListByAPI request.

func (APISchemaClient) ListByAPIResponder 

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

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

func (APISchemaClient) ListByAPISender 

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

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

type APITagResourceContractProperties 

type APITagResourceContractProperties struct {
	// ID - API identifier in the form /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 *[]Protocol `json:"protocols,omitempty"`
	// Description - Description of the API. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthenticationSettings - Collection of authentication settings included into this API.
	AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
	// SubscriptionKeyParameterNames - Protocols over which API is made available.
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
	APIType APIType `json:"type,omitempty"`
	// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
	APIRevision *string `json:"apiRevision,omitempty"`
	// APIVersion - Indicates the Version identifier of the API if the API is versioned
	APIVersion *string `json:"apiVersion,omitempty"`
	// IsCurrent - Indicates if API revision is current api revision.
	IsCurrent *bool `json:"isCurrent,omitempty"`
	// IsOnline - Indicates if API revision is accessible via the gateway.
	IsOnline *bool `json:"isOnline,omitempty"`
	// APIRevisionDescription - Description of the Api Revision.
	APIRevisionDescription *string `json:"apiRevisionDescription,omitempty"`
	// APIVersionDescription - Description of the Api Version.
	APIVersionDescription *string `json:"apiVersionDescription,omitempty"`
	// APIVersionSetID - A resource identifier for the related ApiVersionSet.
	APIVersionSetID *string `json:"apiVersionSetId,omitempty"`
}

APITagResourceContractProperties API contract properties for the Tag Resources.

type APIType 

type APIType string

APIType enumerates the values for api type. 

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

func PossibleAPITypeValues 

func PossibleAPITypeValues() []APIType

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

type APIUpdateContract 

type APIUpdateContract struct {
	// APIContractUpdateProperties - Properties of the API entity that can be updated.
	*APIContractUpdateProperties `json:"properties,omitempty"`
}

APIUpdateContract API update contract details.

func (APIUpdateContract) MarshalJSON 

func (auc APIUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for APIUpdateContract.

func (*APIUpdateContract) UnmarshalJSON 

func (auc *APIUpdateContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for APIUpdateContract struct.

type APIVersionSetClient 

type APIVersionSetClient struct {
	BaseClient
}

APIVersionSetClient is the apiManagement Client

func NewAPIVersionSetClient 

func NewAPIVersionSetClient(subscriptionID string) APIVersionSetClient

NewAPIVersionSetClient creates an instance of the APIVersionSetClient client.

func NewAPIVersionSetClientWithBaseURI 

func NewAPIVersionSetClientWithBaseURI(baseURI string, subscriptionID string) APIVersionSetClient

NewAPIVersionSetClientWithBaseURI creates an instance of the APIVersionSetClient client.

func (APIVersionSetClient) CreateOrUpdate 

func (client APIVersionSetClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, parameters APIVersionSetContract, ifMatch string) (result APIVersionSetContract, err error)

CreateOrUpdate creates or Updates a Api Version Set. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. versionSetID - api Version Set identifier. Must be unique in the current API Management service instance. parameters - create or update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (APIVersionSetClient) CreateOrUpdatePreparer 

func (client APIVersionSetClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, parameters APIVersionSetContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIVersionSetClient) CreateOrUpdateResponder 

func (client APIVersionSetClient) CreateOrUpdateResponder(resp *http.Response) (result APIVersionSetContract, err error)

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

func (APIVersionSetClient) CreateOrUpdateSender 

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

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

Delete deletes specific Api Version Set. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. versionSetID - api Version Set identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIVersionSetClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (APIVersionSetClient) DeleteResponder 

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

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

func (client APIVersionSetClient) Get(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string) (result APIVersionSetContract, err error)

Get gets the details of the Api Version Set specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. versionSetID - api Version Set identifier. Must be unique in the current API Management service instance.

func (APIVersionSetClient) GetEntityTag 

func (client APIVersionSetClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the Api Version Set specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. versionSetID - api Version Set identifier. Must be unique in the current API Management service instance.

func (APIVersionSetClient) GetEntityTagPreparer 

func (client APIVersionSetClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIVersionSetClient) GetEntityTagResponder 

func (client APIVersionSetClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (APIVersionSetClient) GetEntityTagSender 

func (client APIVersionSetClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

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

func (APIVersionSetClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (APIVersionSetClient) GetResponder 

func (client APIVersionSetClient) GetResponder(resp *http.Response) (result APIVersionSetContract, err error)

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

func (APIVersionSetClient) GetSender 

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

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

ListByService lists a collection of API Version Sets in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip.

func (APIVersionSetClient) ListByServiceComplete 

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

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

func (APIVersionSetClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (APIVersionSetClient) ListByServiceResponder 

func (client APIVersionSetClient) ListByServiceResponder(resp *http.Response) (result APIVersionSetCollection, err error)

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

func (APIVersionSetClient) ListByServiceSender 

func (client APIVersionSetClient) 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 (APIVersionSetClient) Update 

func (client APIVersionSetClient) Update(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, parameters APIVersionSetUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates the details of the Api VersionSet specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. versionSetID - api Version Set identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIVersionSetClient) UpdatePreparer 

func (client APIVersionSetClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, parameters APIVersionSetUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (APIVersionSetClient) UpdateResponder 

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

func (client APIVersionSetClient) 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 APIVersionSetCollection 

type APIVersionSetCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]APIVersionSetContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

APIVersionSetCollection paged Api Version Set list representation.

func (APIVersionSetCollection) IsEmpty 

func (avsc APIVersionSetCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type APIVersionSetCollectionIterator 

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

APIVersionSetCollectionIterator provides access to a complete listing of APIVersionSetContract values.

func NewAPIVersionSetCollectionIterator 

func NewAPIVersionSetCollectionIterator(page APIVersionSetCollectionPage) APIVersionSetCollectionIterator

Creates a new instance of the APIVersionSetCollectionIterator type.

func (*APIVersionSetCollectionIterator) Next 

func (iter *APIVersionSetCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*APIVersionSetCollectionIterator) NextWithContext 

func (iter *APIVersionSetCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (APIVersionSetCollectionIterator) NotDone 

func (iter APIVersionSetCollectionIterator) NotDone() bool

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

func (APIVersionSetCollectionIterator) Response 

func (iter APIVersionSetCollectionIterator) Response() APIVersionSetCollection

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

func (APIVersionSetCollectionIterator) Value 

func (iter APIVersionSetCollectionIterator) Value() APIVersionSetContract

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

type APIVersionSetCollectionPage 

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

APIVersionSetCollectionPage contains a page of APIVersionSetContract values.

func NewAPIVersionSetCollectionPage 

func NewAPIVersionSetCollectionPage(getNextPage func(context.Context, APIVersionSetCollection) (APIVersionSetCollection, error)) APIVersionSetCollectionPage

Creates a new instance of the APIVersionSetCollectionPage type.

func (*APIVersionSetCollectionPage) Next 

func (page *APIVersionSetCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*APIVersionSetCollectionPage) NextWithContext 

func (page *APIVersionSetCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (APIVersionSetCollectionPage) NotDone 

func (page APIVersionSetCollectionPage) NotDone() bool

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

func (APIVersionSetCollectionPage) Response 

func (page APIVersionSetCollectionPage) Response() APIVersionSetCollection

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

func (APIVersionSetCollectionPage) Values 

func (page APIVersionSetCollectionPage) Values() []APIVersionSetContract

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

type APIVersionSetContract 

type APIVersionSetContract struct {
	autorest.Response `json:"-"`
	// APIVersionSetContractProperties - Api VersionSet contract properties.
	*APIVersionSetContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

APIVersionSetContract api Version Set Contract details.

func (APIVersionSetContract) MarshalJSON 

func (avsc APIVersionSetContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for APIVersionSetContract.

func (*APIVersionSetContract) UnmarshalJSON 

func (avsc *APIVersionSetContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for APIVersionSetContract struct.

type APIVersionSetContractDetails 

type APIVersionSetContractDetails struct {
	// ID - Identifier for existing API Version Set. Omit this value to create a new Version Set.
	ID *string `json:"id,omitempty"`
	// Description - Description of API Version Set.
	Description *string `json:"description,omitempty"`
	// VersioningScheme - An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'VersioningScheme1Segment', 'VersioningScheme1Query', 'VersioningScheme1Header'
	VersioningScheme VersioningScheme1 `json:"versioningScheme,omitempty"`
	// VersionQueryName - Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
	VersionQueryName *string `json:"versionQueryName,omitempty"`
	// VersionHeaderName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
	VersionHeaderName *string `json:"versionHeaderName,omitempty"`
}

APIVersionSetContractDetails an API Version Set contains the common configuration for a set of API Versions relating

type APIVersionSetContractProperties 

type APIVersionSetContractProperties struct {
	// DisplayName - Name of API Version Set
	DisplayName *string `json:"displayName,omitempty"`
	// VersioningScheme - An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'VersioningSchemeSegment', 'VersioningSchemeQuery', 'VersioningSchemeHeader'
	VersioningScheme VersioningScheme `json:"versioningScheme,omitempty"`
	// Description - Description of API Version Set.
	Description *string `json:"description,omitempty"`
	// VersionQueryName - Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
	VersionQueryName *string `json:"versionQueryName,omitempty"`
	// VersionHeaderName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
	VersionHeaderName *string `json:"versionHeaderName,omitempty"`
}

APIVersionSetContractProperties properties of an API Version Set.

type APIVersionSetEntityBase 

type APIVersionSetEntityBase struct {
	// Description - Description of API Version Set.
	Description *string `json:"description,omitempty"`
	// VersionQueryName - Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
	VersionQueryName *string `json:"versionQueryName,omitempty"`
	// VersionHeaderName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
	VersionHeaderName *string `json:"versionHeaderName,omitempty"`
}

APIVersionSetEntityBase api Version set base parameters

type APIVersionSetUpdateParameters 

type APIVersionSetUpdateParameters struct {
	// APIVersionSetUpdateParametersProperties - Parameters to update or create an Api Version Set Contract.
	*APIVersionSetUpdateParametersProperties `json:"properties,omitempty"`
}

APIVersionSetUpdateParameters parameters to update or create an Api Version Set Contract.

func (APIVersionSetUpdateParameters) MarshalJSON 

func (avsup APIVersionSetUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for APIVersionSetUpdateParameters.

func (*APIVersionSetUpdateParameters) UnmarshalJSON 

func (avsup *APIVersionSetUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for APIVersionSetUpdateParameters struct.

type APIVersionSetUpdateParametersProperties 

type APIVersionSetUpdateParametersProperties struct {
	// DisplayName - Name of API Version Set
	DisplayName *string `json:"displayName,omitempty"`
	// VersioningScheme - An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'VersioningSchemeSegment', 'VersioningSchemeQuery', 'VersioningSchemeHeader'
	VersioningScheme VersioningScheme `json:"versioningScheme,omitempty"`
	// Description - Description of API Version Set.
	Description *string `json:"description,omitempty"`
	// VersionQueryName - Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
	VersionQueryName *string `json:"versionQueryName,omitempty"`
	// VersionHeaderName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
	VersionHeaderName *string `json:"versionHeaderName,omitempty"`
}

APIVersionSetUpdateParametersProperties properties used to create or update an API Version Set.

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 AdditionalLocation 

type AdditionalLocation struct {
	// Location - The location name of the additional region among Azure Data center regions.
	Location *string `json:"location,omitempty"`
	// Sku - SKU properties of the API Management service.
	Sku *ServiceSkuProperties `json:"sku,omitempty"`
	// PublicIPAddresses - Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.
	PublicIPAddresses *[]string `json:"publicIPAddresses,omitempty"`
	// PrivateIPAddresses - Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard and Premium SKU.
	PrivateIPAddresses *[]string `json:"privateIPAddresses,omitempty"`
	// VirtualNetworkConfiguration - Virtual network configuration for the location.
	VirtualNetworkConfiguration *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`
	// GatewayRegionalURL - Gateway URL of the API Management service in the Region.
	GatewayRegionalURL *string `json:"gatewayRegionalUrl,omitempty"`
}

AdditionalLocation description of an additional API Management resource location.

type ApimResource 

type ApimResource 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"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

ApimResource the Resource definition.

func (ApimResource) MarshalJSON 

func (ar ApimResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ApimResource.

type AsyncOperationStatus 

type AsyncOperationStatus string

AsyncOperationStatus enumerates the values for async operation status. 

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

func PossibleAsyncOperationStatusValues 

func PossibleAsyncOperationStatusValues() []AsyncOperationStatus

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

type AuthenticationSettingsContract 

type AuthenticationSettingsContract struct {
	// OAuth2 - OAuth2 Authentication settings
	OAuth2 *OAuth2AuthenticationSettingsContract `json:"oAuth2,omitempty"`
	// Openid - OpenID Connect Authentication Settings
	Openid *OpenIDAuthenticationSettingsContract `json:"openid,omitempty"`
	// SubscriptionKeyRequired - Specifies whether subscription key is required during call to this API, true - API is included into closed products only, false - API is included into open products alone, null - there is a mix of products.
	SubscriptionKeyRequired *bool `json:"subscriptionKeyRequired,omitempty"`
}

AuthenticationSettingsContract API Authentication Settings.

type AuthorizationMethod 

type AuthorizationMethod string

AuthorizationMethod enumerates the values for authorization method. 

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

func PossibleAuthorizationMethodValues 

func PossibleAuthorizationMethodValues() []AuthorizationMethod

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

type AuthorizationServerClient 

type AuthorizationServerClient struct {
	BaseClient
}

AuthorizationServerClient is the apiManagement Client

func NewAuthorizationServerClient 

func NewAuthorizationServerClient(subscriptionID string) AuthorizationServerClient

NewAuthorizationServerClient creates an instance of the AuthorizationServerClient client.

func NewAuthorizationServerClientWithBaseURI 

func NewAuthorizationServerClientWithBaseURI(baseURI string, subscriptionID string) AuthorizationServerClient

NewAuthorizationServerClientWithBaseURI creates an instance of the AuthorizationServerClient client.

func (AuthorizationServerClient) CreateOrUpdate 

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

CreateOrUpdate creates new authorization server or updates an existing authorization server. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server. parameters - create or update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (AuthorizationServerClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AuthorizationServerClient) CreateOrUpdateResponder 

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

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

func (AuthorizationServerClient) CreateOrUpdateSender 

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

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

func (AuthorizationServerClient) Delete 

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

Delete deletes specific authorization server instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (AuthorizationServerClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (AuthorizationServerClient) DeleteResponder 

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

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

func (AuthorizationServerClient) DeleteSender 

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

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

func (AuthorizationServerClient) Get 

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

Get gets the details of the authorization server specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server.

func (AuthorizationServerClient) GetEntityTag 

func (client AuthorizationServerClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, authsid string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the authorizationServer specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server.

func (AuthorizationServerClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (AuthorizationServerClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (AuthorizationServerClient) GetEntityTagSender 

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

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

func (AuthorizationServerClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (AuthorizationServerClient) GetResponder 

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

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

func (AuthorizationServerClient) GetSender 

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

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

func (AuthorizationServerClient) ListByService 

func (client AuthorizationServerClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip.

func (AuthorizationServerClient) ListByServiceComplete 

func (client AuthorizationServerClient) 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 (AuthorizationServerClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (AuthorizationServerClient) ListByServiceResponder 

func (client AuthorizationServerClient) 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 (AuthorizationServerClient) ListByServiceSender 

func (client AuthorizationServerClient) 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 (AuthorizationServerClient) Update 

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

Update updates the details of the authorization server specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server. parameters - oAuth2 Server settings Update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (AuthorizationServerClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (AuthorizationServerClient) UpdateResponder 

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

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

func (AuthorizationServerClient) UpdateSender 

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

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

type AuthorizationServerCollection 

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

AuthorizationServerCollection paged OAuth2 Authorization Servers list representation.

func (AuthorizationServerCollection) IsEmpty 

func (asc AuthorizationServerCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AuthorizationServerCollectionIterator 

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

AuthorizationServerCollectionIterator provides access to a complete listing of AuthorizationServerContract values.

func NewAuthorizationServerCollectionIterator 

func NewAuthorizationServerCollectionIterator(page AuthorizationServerCollectionPage) AuthorizationServerCollectionIterator

Creates a new instance of the AuthorizationServerCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*AuthorizationServerCollectionIterator) NextWithContext 

func (iter *AuthorizationServerCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (AuthorizationServerCollectionIterator) NotDone 

func (iter AuthorizationServerCollectionIterator) NotDone() bool

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

func (AuthorizationServerCollectionIterator) Response 

func (iter AuthorizationServerCollectionIterator) Response() AuthorizationServerCollection

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

func (AuthorizationServerCollectionIterator) Value 

func (iter AuthorizationServerCollectionIterator) Value() AuthorizationServerContract

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

type AuthorizationServerCollectionPage 

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

AuthorizationServerCollectionPage contains a page of AuthorizationServerContract values.

func NewAuthorizationServerCollectionPage 

func NewAuthorizationServerCollectionPage(getNextPage func(context.Context, AuthorizationServerCollection) (AuthorizationServerCollection, error)) AuthorizationServerCollectionPage

Creates a new instance of the AuthorizationServerCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*AuthorizationServerCollectionPage) NextWithContext 

func (page *AuthorizationServerCollectionPage) NextWithContext(ctx context.Context) (err error)

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

func (AuthorizationServerCollectionPage) NotDone 

func (page AuthorizationServerCollectionPage) NotDone() bool

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

func (AuthorizationServerCollectionPage) Response 

func (page AuthorizationServerCollectionPage) Response() AuthorizationServerCollection

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

func (AuthorizationServerCollectionPage) Values 

func (page AuthorizationServerCollectionPage) Values() []AuthorizationServerContract

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

type AuthorizationServerContract 

type AuthorizationServerContract struct {
	autorest.Response `json:"-"`
	// AuthorizationServerContractProperties - Properties of the External OAuth authorization server Contract.
	*AuthorizationServerContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

AuthorizationServerContract external OAuth authorization server settings.

func (AuthorizationServerContract) MarshalJSON 

func (asc AuthorizationServerContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AuthorizationServerContract.

func (*AuthorizationServerContract) UnmarshalJSON 

func (asc *AuthorizationServerContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AuthorizationServerContract struct.

type AuthorizationServerContractBaseProperties 

type AuthorizationServerContractBaseProperties struct {
	// Description - Description of the authorization server. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
	AuthorizationMethods *[]AuthorizationMethod `json:"authorizationMethods,omitempty"`
	// ClientAuthenticationMethod - Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
	ClientAuthenticationMethod *[]ClientAuthenticationMethod `json:"clientAuthenticationMethod,omitempty"`
	// TokenBodyParameters - Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.
	TokenBodyParameters *[]TokenBodyParameterContract `json:"tokenBodyParameters,omitempty"`
	// TokenEndpoint - OAuth token endpoint. Contains absolute URI to entity being referenced.
	TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
	// SupportState - If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
	SupportState *bool `json:"supportState,omitempty"`
	// DefaultScope - Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
	DefaultScope *string `json:"defaultScope,omitempty"`
	// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
	BearerTokenSendingMethods *[]BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`
	// ClientSecret - Client or app secret registered with this authorization server.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// ResourceOwnerUsername - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
	ResourceOwnerUsername *string `json:"resourceOwnerUsername,omitempty"`
	// ResourceOwnerPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
	ResourceOwnerPassword *string `json:"resourceOwnerPassword,omitempty"`
}

AuthorizationServerContractBaseProperties external OAuth authorization server Update settings contract.

type AuthorizationServerContractProperties 

type AuthorizationServerContractProperties struct {
	// DisplayName - User-friendly authorization server name.
	DisplayName *string `json:"displayName,omitempty"`
	// ClientRegistrationEndpoint - Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
	ClientRegistrationEndpoint *string `json:"clientRegistrationEndpoint,omitempty"`
	// AuthorizationEndpoint - OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
	AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`
	// GrantTypes - Form of an authorization grant, which the client uses to request the access token.
	GrantTypes *[]GrantType `json:"grantTypes,omitempty"`
	// ClientID - Client or app id registered with this authorization server.
	ClientID *string `json:"clientId,omitempty"`
	// Description - Description of the authorization server. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
	AuthorizationMethods *[]AuthorizationMethod `json:"authorizationMethods,omitempty"`
	// ClientAuthenticationMethod - Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
	ClientAuthenticationMethod *[]ClientAuthenticationMethod `json:"clientAuthenticationMethod,omitempty"`
	// TokenBodyParameters - Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.
	TokenBodyParameters *[]TokenBodyParameterContract `json:"tokenBodyParameters,omitempty"`
	// TokenEndpoint - OAuth token endpoint. Contains absolute URI to entity being referenced.
	TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
	// SupportState - If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
	SupportState *bool `json:"supportState,omitempty"`
	// DefaultScope - Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
	DefaultScope *string `json:"defaultScope,omitempty"`
	// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
	BearerTokenSendingMethods *[]BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`
	// ClientSecret - Client or app secret registered with this authorization server.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// ResourceOwnerUsername - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
	ResourceOwnerUsername *string `json:"resourceOwnerUsername,omitempty"`
	// ResourceOwnerPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
	ResourceOwnerPassword *string `json:"resourceOwnerPassword,omitempty"`
}

AuthorizationServerContractProperties external OAuth authorization server settings Properties.

type AuthorizationServerUpdateContract 

type AuthorizationServerUpdateContract struct {
	// AuthorizationServerUpdateContractProperties - Properties of the External OAuth authorization server update Contract.
	*AuthorizationServerUpdateContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

AuthorizationServerUpdateContract external OAuth authorization server settings.

func (AuthorizationServerUpdateContract) MarshalJSON 

func (asuc AuthorizationServerUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AuthorizationServerUpdateContract.

func (*AuthorizationServerUpdateContract) UnmarshalJSON 

func (asuc *AuthorizationServerUpdateContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AuthorizationServerUpdateContract struct.

type AuthorizationServerUpdateContractProperties 

type AuthorizationServerUpdateContractProperties struct {
	// DisplayName - User-friendly authorization server name.
	DisplayName *string `json:"displayName,omitempty"`
	// ClientRegistrationEndpoint - Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
	ClientRegistrationEndpoint *string `json:"clientRegistrationEndpoint,omitempty"`
	// AuthorizationEndpoint - OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
	AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`
	// GrantTypes - Form of an authorization grant, which the client uses to request the access token.
	GrantTypes *[]GrantType `json:"grantTypes,omitempty"`
	// ClientID - Client or app id registered with this authorization server.
	ClientID *string `json:"clientId,omitempty"`
	// Description - Description of the authorization server. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
	AuthorizationMethods *[]AuthorizationMethod `json:"authorizationMethods,omitempty"`
	// ClientAuthenticationMethod - Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
	ClientAuthenticationMethod *[]ClientAuthenticationMethod `json:"clientAuthenticationMethod,omitempty"`
	// TokenBodyParameters - Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.
	TokenBodyParameters *[]TokenBodyParameterContract `json:"tokenBodyParameters,omitempty"`
	// TokenEndpoint - OAuth token endpoint. Contains absolute URI to entity being referenced.
	TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
	// SupportState - If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
	SupportState *bool `json:"supportState,omitempty"`
	// DefaultScope - Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
	DefaultScope *string `json:"defaultScope,omitempty"`
	// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
	BearerTokenSendingMethods *[]BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`
	// ClientSecret - Client or app secret registered with this authorization server.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// ResourceOwnerUsername - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
	ResourceOwnerUsername *string `json:"resourceOwnerUsername,omitempty"`
	// ResourceOwnerPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
	ResourceOwnerPassword *string `json:"resourceOwnerPassword,omitempty"`
}

AuthorizationServerUpdateContractProperties external OAuth authorization server Update settings contract.

type BackendAuthorizationHeaderCredentials 

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

BackendAuthorizationHeaderCredentials authorization header information.

type BackendBaseParameters 

type BackendBaseParameters struct {
	// Title - Backend Title.
	Title *string `json:"title,omitempty"`
	// Description - Backend Description.
	Description *string `json:"description,omitempty"`
	// ResourceID - Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
	ResourceID *string `json:"resourceId,omitempty"`
	// Properties - Backend Properties contract
	Properties *BackendProperties `json:"properties,omitempty"`
	// Credentials - Backend Credentials Contract Properties
	Credentials *BackendCredentialsContract `json:"credentials,omitempty"`
	// Proxy - Backend Proxy Contract Properties
	Proxy *BackendProxyContract `json:"proxy,omitempty"`
	// TLS - Backend TLS Properties
	TLS *BackendTLSProperties `json:"tls,omitempty"`
}

BackendBaseParameters backend entity base Parameter set.

type BackendClient 

type BackendClient struct {
	BaseClient
}

BackendClient is the apiManagement Client

func NewBackendClient 

func NewBackendClient(subscriptionID string) BackendClient

NewBackendClient creates an instance of the BackendClient client.

func NewBackendClientWithBaseURI 

func NewBackendClientWithBaseURI(baseURI string, subscriptionID string) BackendClient

NewBackendClientWithBaseURI creates an instance of the BackendClient client.

func (BackendClient) CreateOrUpdate 

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

CreateOrUpdate creates or Updates a backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (BackendClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BackendClient) CreateOrUpdateResponder 

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

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

func (BackendClient) CreateOrUpdateSender 

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

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

func (BackendClient) Delete 

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

Delete deletes the specified backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (BackendClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (BackendClient) DeleteResponder 

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

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

func (BackendClient) DeleteSender 

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

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

func (BackendClient) Get 

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

Get gets the details of the backend specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance.

func (BackendClient) GetEntityTag 

func (client BackendClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, backendid string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the backend specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance.

func (BackendClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (BackendClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (BackendClient) GetEntityTagSender 

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

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

func (BackendClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (BackendClient) GetResponder 

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

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

func (BackendClient) GetSender 

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

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

func (BackendClient) ListByService 

func (client BackendClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip.

func (BackendClient) ListByServiceComplete 

func (client BackendClient) 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 (BackendClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (BackendClient) ListByServiceResponder 

func (client BackendClient) 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 (BackendClient) ListByServiceSender 

func (client BackendClient) 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 (BackendClient) Reconnect 

func (client BackendClient) Reconnect(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters *BackendReconnectContract) (result autorest.Response, err error)

Reconnect notifies the APIM proxy to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance. parameters - reconnect request parameters.

func (BackendClient) ReconnectPreparer 

func (client BackendClient) ReconnectPreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters *BackendReconnectContract) (*http.Request, error)

ReconnectPreparer prepares the Reconnect request.

func (BackendClient) ReconnectResponder 

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

ReconnectResponder handles the response to the Reconnect request. The method always closes the http.Response Body.

func (BackendClient) ReconnectSender 

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

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

func (BackendClient) Update 

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

Update updates an existing backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (BackendClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (BackendClient) UpdateResponder 

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

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

func (BackendClient) UpdateSender 

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

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

type BackendCollection 

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

BackendCollection paged Backend list representation.

func (BackendCollection) IsEmpty 

func (bc BackendCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type BackendCollectionIterator 

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

BackendCollectionIterator provides access to a complete listing of BackendContract values.

func NewBackendCollectionIterator 

func NewBackendCollectionIterator(page BackendCollectionPage) BackendCollectionIterator

Creates a new instance of the BackendCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*BackendCollectionIterator) NextWithContext 

func (iter *BackendCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (BackendCollectionIterator) NotDone 

func (iter BackendCollectionIterator) NotDone() bool

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

func (BackendCollectionIterator) Response 

func (iter BackendCollectionIterator) Response() BackendCollection

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

func (BackendCollectionIterator) Value 

func (iter BackendCollectionIterator) Value() BackendContract

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

type BackendCollectionPage 

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

BackendCollectionPage contains a page of BackendContract values.

func NewBackendCollectionPage 

func NewBackendCollectionPage(getNextPage func(context.Context, BackendCollection) (BackendCollection, error)) BackendCollectionPage

Creates a new instance of the BackendCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*BackendCollectionPage) NextWithContext 

func (page *BackendCollectionPage) NextWithContext(ctx context.Context) (err error)

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

func (BackendCollectionPage) NotDone 

func (page BackendCollectionPage) NotDone() bool

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

func (BackendCollectionPage) Response 

func (page BackendCollectionPage) Response() BackendCollection

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

func (BackendCollectionPage) Values 

func (page BackendCollectionPage) Values() []BackendContract

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

type BackendContract 

type BackendContract struct {
	autorest.Response `json:"-"`
	// BackendContractProperties - Backend entity contract properties.
	*BackendContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

BackendContract backend details.

func (BackendContract) MarshalJSON 

func (bc BackendContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BackendContract.

func (*BackendContract) UnmarshalJSON 

func (bc *BackendContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BackendContract struct.

type BackendContractProperties 

type BackendContractProperties struct {
	// URL - Runtime Url of the Backend.
	URL *string `json:"url,omitempty"`
	// Protocol - Backend communication protocol. Possible values include: 'BackendProtocolHTTP', 'BackendProtocolSoap'
	Protocol BackendProtocol `json:"protocol,omitempty"`
	// Title - Backend Title.
	Title *string `json:"title,omitempty"`
	// Description - Backend Description.
	Description *string `json:"description,omitempty"`
	// ResourceID - Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
	ResourceID *string `json:"resourceId,omitempty"`
	// Properties - Backend Properties contract
	Properties *BackendProperties `json:"properties,omitempty"`
	// Credentials - Backend Credentials Contract Properties
	Credentials *BackendCredentialsContract `json:"credentials,omitempty"`
	// Proxy - Backend Proxy Contract Properties
	Proxy *BackendProxyContract `json:"proxy,omitempty"`
	// TLS - Backend TLS Properties
	TLS *BackendTLSProperties `json:"tls,omitempty"`
}

BackendContractProperties parameters supplied to the Create Backend operation.

type BackendCredentialsContract 

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

BackendCredentialsContract details of the Credentials used to connect to Backend.

func (BackendCredentialsContract) MarshalJSON 

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

MarshalJSON is the custom marshaler for BackendCredentialsContract.

type BackendProperties 

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

BackendProperties properties specific to the Backend Type.

type BackendProtocol 

type BackendProtocol string

BackendProtocol enumerates the values for backend protocol. 

const (
	// BackendProtocolHTTP The Backend is a RESTful service.
	BackendProtocolHTTP BackendProtocol = "http"
	// BackendProtocolSoap The Backend is a SOAP service.
	BackendProtocolSoap BackendProtocol = "soap"
)

func PossibleBackendProtocolValues 

func PossibleBackendProtocolValues() []BackendProtocol

PossibleBackendProtocolValues returns an array of possible values for the BackendProtocol const type.

type BackendProxyContract 

type BackendProxyContract struct {
	// URL - WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
	URL *string `json:"url,omitempty"`
	// Username - Username to connect to the WebProxy server
	Username *string `json:"username,omitempty"`
	// Password - Password to connect to the WebProxy Server
	Password *string `json:"password,omitempty"`
}

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

type BackendReconnectContract 

type BackendReconnectContract struct {
	// BackendReconnectProperties - Reconnect request properties.
	*BackendReconnectProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

BackendReconnectContract reconnect request parameters.

func (BackendReconnectContract) MarshalJSON 

func (brc BackendReconnectContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BackendReconnectContract.

func (*BackendReconnectContract) UnmarshalJSON 

func (brc *BackendReconnectContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BackendReconnectContract struct.

type BackendReconnectProperties 

type BackendReconnectProperties struct {
	// After - Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconect is PT2M.
	After *string `json:"after,omitempty"`
}

BackendReconnectProperties properties to control reconnect requests.

type BackendServiceFabricClusterProperties 

type BackendServiceFabricClusterProperties struct {
	// ClientCertificatethumbprint - The client certificate thumbprint for the management endpoint.
	ClientCertificatethumbprint *string `json:"clientCertificatethumbprint,omitempty"`
	// MaxPartitionResolutionRetries - Maximum number of retries while attempting resolve the partition.
	MaxPartitionResolutionRetries *int32 `json:"maxPartitionResolutionRetries,omitempty"`
	// ManagementEndpoints - The cluster management endpoint.
	ManagementEndpoints *[]string `json:"managementEndpoints,omitempty"`
	// ServerCertificateThumbprints - Thumbprints of certificates cluster management service uses for tls communication
	ServerCertificateThumbprints *[]string `json:"serverCertificateThumbprints,omitempty"`
	// ServerX509Names - Server X509 Certificate Names Collection
	ServerX509Names *[]X509CertificateName `json:"serverX509Names,omitempty"`
}

BackendServiceFabricClusterProperties properties of the Service Fabric Type Backend.

type BackendTLSProperties 

type BackendTLSProperties struct {
	// ValidateCertificateChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
	ValidateCertificateChain *bool `json:"validateCertificateChain,omitempty"`
	// ValidateCertificateName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
	ValidateCertificateName *bool `json:"validateCertificateName,omitempty"`
}

BackendTLSProperties properties controlling TLS Certificate Validation.

type BackendUpdateParameterProperties 

type BackendUpdateParameterProperties struct {
	// URL - Runtime Url of the Backend.
	URL *string `json:"url,omitempty"`
	// Protocol - Backend communication protocol. Possible values include: 'BackendProtocolHTTP', 'BackendProtocolSoap'
	Protocol BackendProtocol `json:"protocol,omitempty"`
	// Title - Backend Title.
	Title *string `json:"title,omitempty"`
	// Description - Backend Description.
	Description *string `json:"description,omitempty"`
	// ResourceID - Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
	ResourceID *string `json:"resourceId,omitempty"`
	// Properties - Backend Properties contract
	Properties *BackendProperties `json:"properties,omitempty"`
	// Credentials - Backend Credentials Contract Properties
	Credentials *BackendCredentialsContract `json:"credentials,omitempty"`
	// Proxy - Backend Proxy Contract Properties
	Proxy *BackendProxyContract `json:"proxy,omitempty"`
	// TLS - Backend TLS Properties
	TLS *BackendTLSProperties `json:"tls,omitempty"`
}

BackendUpdateParameterProperties parameters supplied to the Update Backend operation.

type BackendUpdateParameters 

type BackendUpdateParameters struct {
	// BackendUpdateParameterProperties - Backend entity update contract properties.
	*BackendUpdateParameterProperties `json:"properties,omitempty"`
}

BackendUpdateParameters backend update parameters.

func (BackendUpdateParameters) MarshalJSON 

func (bup BackendUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BackendUpdateParameters.

func (*BackendUpdateParameters) UnmarshalJSON 

func (bup *BackendUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BackendUpdateParameters struct.

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 BearerTokenSendingMethod 

type BearerTokenSendingMethod string

BearerTokenSendingMethod enumerates the values for bearer token sending method. 

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

func PossibleBearerTokenSendingMethodValues 

func PossibleBearerTokenSendingMethodValues() []BearerTokenSendingMethod

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

type BearerTokenSendingMethods 

type BearerTokenSendingMethods string

BearerTokenSendingMethods enumerates the values for bearer token sending methods. 

const (
	// BearerTokenSendingMethodsAuthorizationHeader Access token will be transmitted in the Authorization
	// header using Bearer schema
	BearerTokenSendingMethodsAuthorizationHeader BearerTokenSendingMethods = "authorizationHeader"
	// BearerTokenSendingMethodsQuery Access token will be transmitted as query parameters.
	BearerTokenSendingMethodsQuery BearerTokenSendingMethods = "query"
)

func PossibleBearerTokenSendingMethodsValues 

func PossibleBearerTokenSendingMethodsValues() []BearerTokenSendingMethods

PossibleBearerTokenSendingMethodsValues returns an array of possible values for the BearerTokenSendingMethods const type.

type CertificateClient 

type CertificateClient struct {
	BaseClient
}

CertificateClient is the apiManagement Client

func NewCertificateClient 

func NewCertificateClient(subscriptionID string) CertificateClient

NewCertificateClient creates an instance of the CertificateClient client.

func NewCertificateClientWithBaseURI 

func NewCertificateClientWithBaseURI(baseURI string, subscriptionID string) CertificateClient

NewCertificateClientWithBaseURI creates an instance of the CertificateClient client.

func (CertificateClient) CreateOrUpdate 

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

CreateOrUpdate creates or updates the certificate being used for authentication with the backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance. parameters - create or Update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (CertificateClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CertificateClient) CreateOrUpdateResponder 

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

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

func (CertificateClient) CreateOrUpdateSender 

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

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

func (CertificateClient) Delete 

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

Delete deletes specific certificate. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (CertificateClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (CertificateClient) DeleteResponder 

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

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

func (CertificateClient) DeleteSender 

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

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

func (CertificateClient) Get 

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

Get gets the details of the certificate specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance.

func (CertificateClient) GetEntityTag 

func (client CertificateClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, certificateID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the certificate specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance.

func (CertificateClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (CertificateClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (CertificateClient) GetEntityTagSender 

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

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

func (CertificateClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (CertificateClient) GetResponder 

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

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

func (CertificateClient) GetSender 

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

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

func (CertificateClient) ListByService 

func (client CertificateClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip.

func (CertificateClient) ListByServiceComplete 

func (client CertificateClient) 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 (CertificateClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (CertificateClient) ListByServiceResponder 

func (client CertificateClient) 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 (CertificateClient) ListByServiceSender 

func (client CertificateClient) 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 CertificateCollection 

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

func NewCertificateCollectionIterator(page CertificateCollectionPage) CertificateCollectionIterator

Creates a new instance of the CertificateCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*CertificateCollectionIterator) NextWithContext 

func (iter *CertificateCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewCertificateCollectionPage 

func NewCertificateCollectionPage(getNextPage func(context.Context, CertificateCollection) (CertificateCollection, error)) CertificateCollectionPage

Creates a new instance of the CertificateCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*CertificateCollectionPage) NextWithContext 

func (page *CertificateCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 CertificateConfiguration 

type CertificateConfiguration struct {
	// EncodedCertificate - Base64 Encoded certificate.
	EncodedCertificate *string `json:"encodedCertificate,omitempty"`
	// CertificatePassword - Certificate Password.
	CertificatePassword *string `json:"certificatePassword,omitempty"`
	// StoreName - The System.Security.Cryptography.x509certificates.Storename certificate store location. Only Root and CertificateAuthority are valid locations. Possible values include: 'CertificateAuthority', 'Root'
	StoreName StoreName `json:"storeName,omitempty"`
	// Certificate - Certificate information.
	Certificate *CertificateInformation `json:"certificate,omitempty"`
}

CertificateConfiguration certificate configuration which consist of non-trusted intermediates and root certificates.

type CertificateContract 

type CertificateContract struct {
	autorest.Response `json:"-"`
	// CertificateContractProperties - Certificate properties details.
	*CertificateContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

CertificateContract certificate details.

func (CertificateContract) MarshalJSON 

func (cc CertificateContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateContract.

func (*CertificateContract) UnmarshalJSON 

func (cc *CertificateContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CertificateContract struct.

type CertificateContractProperties 

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

CertificateContractProperties properties of the Certificate contract.

type CertificateCreateOrUpdateParameters 

type CertificateCreateOrUpdateParameters struct {
	// CertificateCreateOrUpdateProperties - Certificate create or update properties details.
	*CertificateCreateOrUpdateProperties `json:"properties,omitempty"`
}

CertificateCreateOrUpdateParameters certificate create or update details.

func (CertificateCreateOrUpdateParameters) MarshalJSON 

func (ccoup CertificateCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateCreateOrUpdateParameters.

func (*CertificateCreateOrUpdateParameters) UnmarshalJSON 

func (ccoup *CertificateCreateOrUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CertificateCreateOrUpdateParameters struct.

type CertificateCreateOrUpdateProperties 

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

CertificateCreateOrUpdateProperties 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 ClientAuthenticationMethod 

type ClientAuthenticationMethod string

ClientAuthenticationMethod enumerates the values for client authentication method. 

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

func PossibleClientAuthenticationMethodValues 

func PossibleClientAuthenticationMethodValues() []ClientAuthenticationMethod

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

type Confirmation 

type Confirmation string

Confirmation enumerates the values for confirmation. 

const (
	// Invite Send an e-mail inviting the user to sign-up and complete registration.
	Invite Confirmation = "invite"
	// Signup Send an e-mail to the user confirming they have successfully signed up.
	Signup Confirmation = "signup"
)

func PossibleConfirmationValues 

func PossibleConfirmationValues() []Confirmation

PossibleConfirmationValues returns an array of possible values for the Confirmation const type.

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. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	LastUpdated *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"
)

func PossibleConnectivityStatusTypeValues 

func PossibleConnectivityStatusTypeValues() []ConnectivityStatusType

PossibleConnectivityStatusTypeValues returns an array of possible values for the ConnectivityStatusType const type.

type ContentFormat 

type ContentFormat string

ContentFormat enumerates the values for content format. 

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

func PossibleContentFormatValues 

func PossibleContentFormatValues() []ContentFormat

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

type CurrentUserIdentity 

type CurrentUserIdentity struct {
	autorest.Response `json:"-"`
	// ID - API Management service user id.
	ID *string `json:"id,omitempty"`
}

CurrentUserIdentity ...

type DelegationSettingsClient 

type DelegationSettingsClient struct {
	BaseClient
}

DelegationSettingsClient is the apiManagement Client

func NewDelegationSettingsClient 

func NewDelegationSettingsClient(subscriptionID string) DelegationSettingsClient

NewDelegationSettingsClient creates an instance of the DelegationSettingsClient client.

func NewDelegationSettingsClientWithBaseURI 

func NewDelegationSettingsClientWithBaseURI(baseURI string, subscriptionID string) DelegationSettingsClient

NewDelegationSettingsClientWithBaseURI creates an instance of the DelegationSettingsClient client.

func (DelegationSettingsClient) CreateOrUpdate 

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

CreateOrUpdate create or Update Delegation settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - create or update parameters.

func (DelegationSettingsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DelegationSettingsClient) CreateOrUpdateResponder 

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

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

func (DelegationSettingsClient) CreateOrUpdateSender 

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

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

func (DelegationSettingsClient) Get 

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

Get get Delegation settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (DelegationSettingsClient) GetEntityTag 

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

GetEntityTag gets the entity state (Etag) version of the DelegationSettings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (DelegationSettingsClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (DelegationSettingsClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (DelegationSettingsClient) GetEntityTagSender 

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

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

func (DelegationSettingsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (DelegationSettingsClient) GetResponder 

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

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

func (DelegationSettingsClient) GetSender 

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

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

func (DelegationSettingsClient) Update 

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

Update update Delegation settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - update Delegation settings. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (DelegationSettingsClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (DelegationSettingsClient) UpdateResponder 

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

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

func (DelegationSettingsClient) UpdateSender 

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

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

type DeployConfigurationParameters 

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

DeployConfigurationParameters parameters supplied to the Deploy Configuration operation.

type DiagnosticClient 

type DiagnosticClient struct {
	BaseClient
}

DiagnosticClient is the apiManagement Client

func NewDiagnosticClient 

func NewDiagnosticClient(subscriptionID string) DiagnosticClient

NewDiagnosticClient creates an instance of the DiagnosticClient client.

func NewDiagnosticClientWithBaseURI 

func NewDiagnosticClientWithBaseURI(baseURI string, subscriptionID string) DiagnosticClient

NewDiagnosticClientWithBaseURI creates an instance of the DiagnosticClient client.

func (DiagnosticClient) CreateOrUpdate 

func (client DiagnosticClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, parameters DiagnosticContract, ifMatch string) (result DiagnosticContract, err error)

CreateOrUpdate creates a new Diagnostic or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (DiagnosticClient) CreateOrUpdatePreparer 

func (client DiagnosticClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, parameters DiagnosticContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DiagnosticClient) CreateOrUpdateResponder 

func (client DiagnosticClient) CreateOrUpdateResponder(resp *http.Response) (result DiagnosticContract, err error)

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

func (DiagnosticClient) CreateOrUpdateSender 

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

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

Delete deletes the specified Diagnostic. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (DiagnosticClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (DiagnosticClient) DeleteResponder 

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

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

func (client DiagnosticClient) Get(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string) (result DiagnosticContract, err error)

Get gets the details of the Diagnostic specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance.

func (DiagnosticClient) GetEntityTag 

func (client DiagnosticClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the Diagnostic specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance.

func (DiagnosticClient) GetEntityTagPreparer 

func (client DiagnosticClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (DiagnosticClient) GetEntityTagResponder 

func (client DiagnosticClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (DiagnosticClient) GetEntityTagSender 

func (client DiagnosticClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

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

func (DiagnosticClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (DiagnosticClient) GetResponder 

func (client DiagnosticClient) GetResponder(resp *http.Response) (result DiagnosticContract, err error)

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

func (DiagnosticClient) GetSender 

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

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

ListByService lists all diagnostics of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (DiagnosticClient) ListByServiceComplete 

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

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

func (DiagnosticClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (DiagnosticClient) ListByServiceResponder 

func (client DiagnosticClient) ListByServiceResponder(resp *http.Response) (result DiagnosticCollection, err error)

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

func (DiagnosticClient) ListByServiceSender 

func (client DiagnosticClient) 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 (DiagnosticClient) Update 

func (client DiagnosticClient) Update(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, parameters DiagnosticContract, ifMatch string) (result autorest.Response, err error)

Update updates the details of the Diagnostic specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. parameters - diagnostic Update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (DiagnosticClient) UpdatePreparer 

func (client DiagnosticClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, parameters DiagnosticContract, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DiagnosticClient) UpdateResponder 

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

func (client DiagnosticClient) 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 DiagnosticCollection 

type DiagnosticCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]DiagnosticContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

DiagnosticCollection paged Diagnostic list representation.

func (DiagnosticCollection) IsEmpty 

func (dc DiagnosticCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DiagnosticCollectionIterator 

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

DiagnosticCollectionIterator provides access to a complete listing of DiagnosticContract values.

func NewDiagnosticCollectionIterator 

func NewDiagnosticCollectionIterator(page DiagnosticCollectionPage) DiagnosticCollectionIterator

Creates a new instance of the DiagnosticCollectionIterator type.

func (*DiagnosticCollectionIterator) Next 

func (iter *DiagnosticCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*DiagnosticCollectionIterator) NextWithContext 

func (iter *DiagnosticCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (DiagnosticCollectionIterator) NotDone 

func (iter DiagnosticCollectionIterator) NotDone() bool

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

func (DiagnosticCollectionIterator) Response 

func (iter DiagnosticCollectionIterator) Response() DiagnosticCollection

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

func (DiagnosticCollectionIterator) Value 

func (iter DiagnosticCollectionIterator) Value() DiagnosticContract

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

type DiagnosticCollectionPage 

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

DiagnosticCollectionPage contains a page of DiagnosticContract values.

func NewDiagnosticCollectionPage 

func NewDiagnosticCollectionPage(getNextPage func(context.Context, DiagnosticCollection) (DiagnosticCollection, error)) DiagnosticCollectionPage

Creates a new instance of the DiagnosticCollectionPage type.

func (*DiagnosticCollectionPage) Next 

func (page *DiagnosticCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*DiagnosticCollectionPage) NextWithContext 

func (page *DiagnosticCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (DiagnosticCollectionPage) NotDone 

func (page DiagnosticCollectionPage) NotDone() bool

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

func (DiagnosticCollectionPage) Response 

func (page DiagnosticCollectionPage) Response() DiagnosticCollection

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

func (DiagnosticCollectionPage) Values 

func (page DiagnosticCollectionPage) Values() []DiagnosticContract

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

type DiagnosticContract 

type DiagnosticContract struct {
	autorest.Response `json:"-"`
	// DiagnosticContractProperties - Diagnostic entity contract properties.
	*DiagnosticContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

DiagnosticContract diagnostic details.

func (DiagnosticContract) MarshalJSON 

func (dc DiagnosticContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiagnosticContract.

func (*DiagnosticContract) UnmarshalJSON 

func (dc *DiagnosticContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DiagnosticContract struct.

type DiagnosticContractProperties 

type DiagnosticContractProperties struct {
	// Enabled - Indicates whether a diagnostic should receive data or not.
	Enabled *bool `json:"enabled,omitempty"`
}

DiagnosticContractProperties diagnostic Entity Properties

type DiagnosticLoggerClient 

type DiagnosticLoggerClient struct {
	BaseClient
}

DiagnosticLoggerClient is the apiManagement Client

func NewDiagnosticLoggerClient 

func NewDiagnosticLoggerClient(subscriptionID string) DiagnosticLoggerClient

NewDiagnosticLoggerClient creates an instance of the DiagnosticLoggerClient client.

func NewDiagnosticLoggerClientWithBaseURI 

func NewDiagnosticLoggerClientWithBaseURI(baseURI string, subscriptionID string) DiagnosticLoggerClient

NewDiagnosticLoggerClientWithBaseURI creates an instance of the DiagnosticLoggerClient client.

func (DiagnosticLoggerClient) CheckEntityExists 

func (client DiagnosticLoggerClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, loggerid string) (result autorest.Response, err error)

CheckEntityExists checks that logger entity specified by identifier is associated with the diagnostics entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.

func (DiagnosticLoggerClient) CheckEntityExistsPreparer 

func (client DiagnosticLoggerClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, loggerid string) (*http.Request, error)

CheckEntityExistsPreparer prepares the CheckEntityExists request.

func (DiagnosticLoggerClient) CheckEntityExistsResponder 

func (client DiagnosticLoggerClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)

CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.

func (DiagnosticLoggerClient) CheckEntityExistsSender 

func (client DiagnosticLoggerClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)

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

func (DiagnosticLoggerClient) CreateOrUpdate 

func (client DiagnosticLoggerClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, loggerid string) (result LoggerContract, err error)

CreateOrUpdate attaches a logger to a dignostic. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.

func (DiagnosticLoggerClient) CreateOrUpdatePreparer 

func (client DiagnosticLoggerClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, loggerid string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DiagnosticLoggerClient) CreateOrUpdateResponder 

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

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

func (DiagnosticLoggerClient) CreateOrUpdateSender 

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

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

Delete deletes the specified Logger from Diagnostic. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.

func (DiagnosticLoggerClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (DiagnosticLoggerClient) DeleteResponder 

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

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

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

ListByService lists all loggers assosiated with the specified Diagnostic of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | type | eq | | top - number of records to return. skip - number of records to skip.

func (DiagnosticLoggerClient) ListByServiceComplete 

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

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

func (DiagnosticLoggerClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (DiagnosticLoggerClient) ListByServiceResponder 

func (client DiagnosticLoggerClient) 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 (DiagnosticLoggerClient) ListByServiceSender 

func (client DiagnosticLoggerClient) 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 EmailTemplateClient 

type EmailTemplateClient struct {
	BaseClient
}

EmailTemplateClient is the apiManagement Client

func NewEmailTemplateClient 

func NewEmailTemplateClient(subscriptionID string) EmailTemplateClient

NewEmailTemplateClient creates an instance of the EmailTemplateClient client.

func NewEmailTemplateClientWithBaseURI 

func NewEmailTemplateClientWithBaseURI(baseURI string, subscriptionID string) EmailTemplateClient

NewEmailTemplateClientWithBaseURI creates an instance of the EmailTemplateClient client.

func (EmailTemplateClient) CreateOrUpdate 

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

CreateOrUpdate updates an Email Template. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. templateName - email Template Name Identifier. parameters - email Template update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (EmailTemplateClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (EmailTemplateClient) CreateOrUpdateResponder 

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

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

func (EmailTemplateClient) CreateOrUpdateSender 

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

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

func (EmailTemplateClient) Delete 

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

Delete reset the Email Template to default template provided by the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. templateName - email Template Name Identifier. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (EmailTemplateClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (EmailTemplateClient) DeleteResponder 

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

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

func (EmailTemplateClient) DeleteSender 

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

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

func (EmailTemplateClient) Get 

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

Get gets the details of the email template specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. templateName - email Template Name Identifier.

func (EmailTemplateClient) GetEntityTag 

func (client EmailTemplateClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the email template specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. templateName - email Template Name Identifier.

func (EmailTemplateClient) GetEntityTagPreparer 

func (client EmailTemplateClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (EmailTemplateClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (EmailTemplateClient) GetEntityTagSender 

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

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

func (EmailTemplateClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (EmailTemplateClient) GetResponder 

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

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

func (EmailTemplateClient) GetSender 

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

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

func (EmailTemplateClient) ListByService 

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

ListByService lists a collection of properties defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. top - number of records to return. skip - number of records to skip.

func (EmailTemplateClient) ListByServiceComplete 

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

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

func (EmailTemplateClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (EmailTemplateClient) ListByServiceResponder 

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

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

func (EmailTemplateClient) ListByServiceSender 

func (client EmailTemplateClient) 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 (EmailTemplateClient) Update 

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

Update updates the specific Email Template. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. templateName - email Template Name Identifier. parameters - update parameters.

func (EmailTemplateClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (EmailTemplateClient) UpdateResponder 

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

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

func (EmailTemplateClient) UpdateSender 

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

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

type EmailTemplateCollection 

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

EmailTemplateCollection paged email template list representation.

func (EmailTemplateCollection) IsEmpty 

func (etc EmailTemplateCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EmailTemplateCollectionIterator 

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

EmailTemplateCollectionIterator provides access to a complete listing of EmailTemplateContract values.

func NewEmailTemplateCollectionIterator 

func NewEmailTemplateCollectionIterator(page EmailTemplateCollectionPage) EmailTemplateCollectionIterator

Creates a new instance of the EmailTemplateCollectionIterator type.

func (*EmailTemplateCollectionIterator) Next 

func (iter *EmailTemplateCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*EmailTemplateCollectionIterator) NextWithContext 

func (iter *EmailTemplateCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (EmailTemplateCollectionIterator) NotDone 

func (iter EmailTemplateCollectionIterator) NotDone() bool

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

func (EmailTemplateCollectionIterator) Response 

func (iter EmailTemplateCollectionIterator) Response() EmailTemplateCollection

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

func (EmailTemplateCollectionIterator) Value 

func (iter EmailTemplateCollectionIterator) Value() EmailTemplateContract

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

type EmailTemplateCollectionPage 

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

EmailTemplateCollectionPage contains a page of EmailTemplateContract values.

func NewEmailTemplateCollectionPage 

func NewEmailTemplateCollectionPage(getNextPage func(context.Context, EmailTemplateCollection) (EmailTemplateCollection, error)) EmailTemplateCollectionPage

Creates a new instance of the EmailTemplateCollectionPage type.

func (*EmailTemplateCollectionPage) Next 

func (page *EmailTemplateCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*EmailTemplateCollectionPage) NextWithContext 

func (page *EmailTemplateCollectionPage) NextWithContext(ctx context.Context) (err error)

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

func (EmailTemplateCollectionPage) NotDone 

func (page EmailTemplateCollectionPage) NotDone() bool

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

func (EmailTemplateCollectionPage) Response 

func (page EmailTemplateCollectionPage) Response() EmailTemplateCollection

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

func (EmailTemplateCollectionPage) Values 

func (page EmailTemplateCollectionPage) Values() []EmailTemplateContract

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

type EmailTemplateContract 

type EmailTemplateContract struct {
	autorest.Response `json:"-"`
	// EmailTemplateContractProperties - Email Template entity contract properties.
	*EmailTemplateContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

EmailTemplateContract email Template details.

func (EmailTemplateContract) MarshalJSON 

func (etc EmailTemplateContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EmailTemplateContract.

func (*EmailTemplateContract) UnmarshalJSON 

func (etc *EmailTemplateContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EmailTemplateContract struct.

type EmailTemplateContractProperties 

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

EmailTemplateContractProperties email Template Contract properties.

type EmailTemplateParametersContractProperties 

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

EmailTemplateParametersContractProperties email Template Parameter contract.

type EmailTemplateUpdateParameterProperties 

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

EmailTemplateUpdateParameterProperties email Template Update Contract properties.

type EmailTemplateUpdateParameters 

type EmailTemplateUpdateParameters struct {
	// EmailTemplateUpdateParameterProperties - Email Template Update contract properties.
	*EmailTemplateUpdateParameterProperties `json:"properties,omitempty"`
}

EmailTemplateUpdateParameters email Template update Parameters.

func (EmailTemplateUpdateParameters) MarshalJSON 

func (etup EmailTemplateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EmailTemplateUpdateParameters.

func (*EmailTemplateUpdateParameters) UnmarshalJSON 

func (etup *EmailTemplateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EmailTemplateUpdateParameters struct.

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 {
	// ErrorResponseBody - Properties of the Error Response.
	*ErrorResponseBody `json:"error,omitempty"`
}

ErrorResponse error Response.

func (ErrorResponse) MarshalJSON 

func (er ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

func (er *ErrorResponse) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ErrorResponse struct.

type ErrorResponseBody 

type ErrorResponseBody struct {
	// Code - Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
	Code *string `json:"code,omitempty"`
	// Message - Human-readable representation of the error.
	Message *string `json:"message,omitempty"`
	// Details - The list of invalid fields send in request, in case of validation error.
	Details *[]ErrorFieldContract `json:"details,omitempty"`
}

ErrorResponseBody error Body contract.

type ExportFormat 

type ExportFormat string

ExportFormat enumerates the values for export format. 

const (
	// ExportFormatSwagger Export the Api Definition in OpenApi Specification 2.0 format to the Storage Blob.
	ExportFormatSwagger ExportFormat = "swagger-link"
	// ExportFormatWadl Export the Api Definition in WADL Schema to Storage Blob.
	ExportFormatWadl ExportFormat = "wadl-link"
	// ExportFormatWsdl Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for
	// APIs of Type `soap`
	ExportFormatWsdl ExportFormat = "wsdl-link"
)

func PossibleExportFormatValues 

func PossibleExportFormatValues() []ExportFormat

PossibleExportFormatValues returns an array of possible values for the ExportFormat const type.

type GenerateSsoURLResult 

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

GenerateSsoURLResult generate SSO Url operations response details.

type GrantType 

type GrantType string

GrantType enumerates the values for grant type. 

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

func PossibleGrantTypeValues 

func PossibleGrantTypeValues() []GrantType

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

type GroupClient 

type GroupClient struct {
	BaseClient
}

GroupClient is the apiManagement Client

func NewGroupClient 

func NewGroupClient(subscriptionID string) GroupClient

NewGroupClient creates an instance of the GroupClient client.

func NewGroupClientWithBaseURI 

func NewGroupClientWithBaseURI(baseURI string, subscriptionID string) GroupClient

NewGroupClientWithBaseURI creates an instance of the GroupClient client.

func (GroupClient) CreateOrUpdate 

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

CreateOrUpdate creates or Updates a group. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (GroupClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupClient) CreateOrUpdateResponder 

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

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

func (GroupClient) CreateOrUpdateSender 

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

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

func (GroupClient) Delete 

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

Delete deletes specific group of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (GroupClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (GroupClient) DeleteResponder 

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

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

func (GroupClient) DeleteSender 

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

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

func (GroupClient) Get 

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

Get gets the details of the group specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance.

func (GroupClient) GetEntityTag 

func (client GroupClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, groupID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the group specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance.

func (GroupClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (GroupClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (GroupClient) GetEntityTagSender 

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

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

func (GroupClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (GroupClient) GetResponder 

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

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

func (GroupClient) GetSender 

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

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

func (GroupClient) ListByService 

func (client GroupClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip.

func (GroupClient) ListByServiceComplete 

func (client GroupClient) 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 (GroupClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (GroupClient) ListByServiceResponder 

func (client GroupClient) 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 (GroupClient) ListByServiceSender 

func (client GroupClient) 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 (GroupClient) Update 

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

Update updates the details of the group specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (GroupClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (GroupClient) UpdateResponder 

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

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

func (GroupClient) UpdateSender 

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

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

type GroupCollection 

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

func NewGroupCollectionIterator(page GroupCollectionPage) GroupCollectionIterator

Creates a new instance of the GroupCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*GroupCollectionIterator) NextWithContext 

func (iter *GroupCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewGroupCollectionPage 

func NewGroupCollectionPage(getNextPage func(context.Context, GroupCollection) (GroupCollection, error)) GroupCollectionPage

Creates a new instance of the GroupCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*GroupCollectionPage) NextWithContext 

func (page *GroupCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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:"-"`
	// GroupContractProperties - Group entity contract properties.
	*GroupContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

GroupContract contract details.

func (GroupContract) MarshalJSON 

func (gc GroupContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupContract.

func (*GroupContract) UnmarshalJSON 

func (gc *GroupContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GroupContract struct.

type GroupContractProperties 

type GroupContractProperties struct {
	// DisplayName - Group name.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - Group description. Can contain HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// BuiltIn - true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
	BuiltIn *bool `json:"builtIn,omitempty"`
	// Type - Group type. Possible values include: 'Custom', 'System', 'External'
	Type GroupType `json:"type,omitempty"`
	// ExternalID - For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
	ExternalID *string `json:"externalId,omitempty"`
}

GroupContractProperties group contract Properties.

type GroupCreateParameters 

type GroupCreateParameters struct {
	// GroupCreateParametersProperties - Properties supplied to Create Group operation.
	*GroupCreateParametersProperties `json:"properties,omitempty"`
}

GroupCreateParameters parameters supplied to the Create Group operation.

func (GroupCreateParameters) MarshalJSON 

func (gcp GroupCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupCreateParameters.

func (*GroupCreateParameters) UnmarshalJSON 

func (gcp *GroupCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GroupCreateParameters struct.

type GroupCreateParametersProperties 

type GroupCreateParametersProperties struct {
	// DisplayName - Group name.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - Group description.
	Description *string `json:"description,omitempty"`
	// Type - Group type. Possible values include: 'Custom', 'System', 'External'
	Type GroupType `json:"type,omitempty"`
	// ExternalID - Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
	ExternalID *string `json:"externalId,omitempty"`
}

GroupCreateParametersProperties parameters supplied to the Create Group operation.

type GroupType 

type GroupType string

GroupType enumerates the values for group type. 

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

func PossibleGroupTypeValues 

func PossibleGroupTypeValues() []GroupType

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

type GroupUpdateParameters 

type GroupUpdateParameters struct {
	// GroupUpdateParametersProperties - Group entity update contract properties.
	*GroupUpdateParametersProperties `json:"properties,omitempty"`
}

GroupUpdateParameters parameters supplied to the Update Group operation.

func (GroupUpdateParameters) MarshalJSON 

func (gup GroupUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupUpdateParameters.

func (*GroupUpdateParameters) UnmarshalJSON 

func (gup *GroupUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GroupUpdateParameters struct.

type GroupUpdateParametersProperties 

type GroupUpdateParametersProperties struct {
	// DisplayName - Group name.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - Group description.
	Description *string `json:"description,omitempty"`
	// Type - Group type. Possible values include: 'Custom', 'System', 'External'
	Type GroupType `json:"type,omitempty"`
	// ExternalID - Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
	ExternalID *string `json:"externalId,omitempty"`
}

GroupUpdateParametersProperties parameters supplied to the Update Group operation.

type GroupUserClient 

type GroupUserClient struct {
	BaseClient
}

GroupUserClient is the apiManagement Client

func NewGroupUserClient 

func NewGroupUserClient(subscriptionID string) GroupUserClient

NewGroupUserClient creates an instance of the GroupUserClient client.

func NewGroupUserClientWithBaseURI 

func NewGroupUserClientWithBaseURI(baseURI string, subscriptionID string) GroupUserClient

NewGroupUserClientWithBaseURI creates an instance of the GroupUserClient client.

func (GroupUserClient) CheckEntityExists 

func (client GroupUserClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (result autorest.Response, err error)

CheckEntityExists checks that user entity specified by identifier is associated with the group entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. UID - user identifier. Must be unique in the current API Management service instance.

func (GroupUserClient) CheckEntityExistsPreparer 

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

CheckEntityExistsPreparer prepares the CheckEntityExists request.

func (GroupUserClient) CheckEntityExistsResponder 

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

CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.

func (GroupUserClient) CheckEntityExistsSender 

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

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

func (GroupUserClient) Create 

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

Create adds a user to the specified group. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. UID - user identifier. Must be unique in the current API Management service instance.

func (GroupUserClient) CreatePreparer 

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

CreatePreparer prepares the Create request.

func (GroupUserClient) CreateResponder 

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

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

func (GroupUserClient) CreateSender 

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

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

func (GroupUserClient) Delete 

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

Delete remove existing user from existing group. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. UID - user identifier. Must be unique in the current API Management service instance.

func (GroupUserClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (GroupUserClient) DeleteResponder 

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

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

func (GroupUserClient) DeleteSender 

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

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

func (GroupUserClient) List 

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

List lists a collection of the members of the group, specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. filter - | 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 - number of records to return. skip - number of records to skip.

func (GroupUserClient) ListComplete 

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

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

func (GroupUserClient) ListPreparer 

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

ListPreparer prepares the List request.

func (GroupUserClient) ListResponder 

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

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

func (GroupUserClient) ListSender 

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

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

type HostnameConfiguration 

type HostnameConfiguration struct {
	// Type - Hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm'
	Type HostnameType `json:"type,omitempty"`
	// HostName - Hostname to configure on the Api Management service.
	HostName *string `json:"hostName,omitempty"`
	// KeyVaultID - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type *application/x-pkcs12*
	KeyVaultID *string `json:"keyVaultId,omitempty"`
	// EncodedCertificate - Base64 Encoded certificate.
	EncodedCertificate *string `json:"encodedCertificate,omitempty"`
	// CertificatePassword - Certificate Password.
	CertificatePassword *string `json:"certificatePassword,omitempty"`
	// DefaultSslBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.
	DefaultSslBinding *bool `json:"defaultSslBinding,omitempty"`
	// NegotiateClientCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
	NegotiateClientCertificate *bool `json:"negotiateClientCertificate,omitempty"`
	// Certificate - Certificate information.
	Certificate *CertificateInformation `json:"certificate,omitempty"`
}

HostnameConfiguration custom hostname configuration.

type HostnameConfigurationOld 

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

HostnameConfigurationOld 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"
)

func PossibleHostnameTypeValues 

func PossibleHostnameTypeValues() []HostnameType

PossibleHostnameTypeValues returns an array of possible values for the HostnameType const type.

type IdentityProviderBaseParameters 

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

IdentityProviderBaseParameters identity Provider Base Parameter Properties.

type IdentityProviderClient 

type IdentityProviderClient struct {
	BaseClient
}

IdentityProviderClient is the apiManagement Client

func NewIdentityProviderClient 

func NewIdentityProviderClient(subscriptionID string) IdentityProviderClient

NewIdentityProviderClient creates an instance of the IdentityProviderClient client.

func NewIdentityProviderClientWithBaseURI 

func NewIdentityProviderClientWithBaseURI(baseURI string, subscriptionID string) IdentityProviderClient

NewIdentityProviderClientWithBaseURI creates an instance of the IdentityProviderClient client.

func (IdentityProviderClient) CreateOrUpdate 

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

CreateOrUpdate creates or Updates the IdentityProvider configuration. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (IdentityProviderClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (IdentityProviderClient) CreateOrUpdateResponder 

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

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

func (IdentityProviderClient) CreateOrUpdateSender 

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

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

func (IdentityProviderClient) Delete 

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

Delete deletes the specified identity provider configuration. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (IdentityProviderClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (IdentityProviderClient) DeleteResponder 

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

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

func (IdentityProviderClient) DeleteSender 

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

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

func (IdentityProviderClient) Get 

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

Get gets the configuration details of the identity Provider configured in specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier.

func (IdentityProviderClient) GetEntityTag 

func (client IdentityProviderClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the identityProvider specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier.

func (IdentityProviderClient) GetEntityTagPreparer 

func (client IdentityProviderClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (IdentityProviderClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (IdentityProviderClient) GetEntityTagSender 

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

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

func (IdentityProviderClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (IdentityProviderClient) GetResponder 

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

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

func (IdentityProviderClient) GetSender 

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

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

func (IdentityProviderClient) ListByService 

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

ListByService lists a collection of Identity Provider configured in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (IdentityProviderClient) ListByServiceComplete 

func (client IdentityProviderClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string) (result IdentityProviderListIterator, err error)

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

func (IdentityProviderClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (IdentityProviderClient) ListByServiceResponder 

func (client IdentityProviderClient) 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 (IdentityProviderClient) ListByServiceSender 

func (client IdentityProviderClient) 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 (IdentityProviderClient) Update 

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

Update updates an existing IdentityProvider configuration. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (IdentityProviderClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (IdentityProviderClient) UpdateResponder 

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

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

func (IdentityProviderClient) UpdateSender 

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

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

type IdentityProviderContract 

type IdentityProviderContract struct {
	autorest.Response `json:"-"`
	// IdentityProviderContractProperties - Identity Provider contract properties.
	*IdentityProviderContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

IdentityProviderContract identity Provider details.

func (IdentityProviderContract) MarshalJSON 

func (ipc IdentityProviderContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IdentityProviderContract.

func (*IdentityProviderContract) UnmarshalJSON 

func (ipc *IdentityProviderContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for IdentityProviderContract struct.

type IdentityProviderContractProperties 

type IdentityProviderContractProperties struct {
	// ClientID - Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
	ClientID *string `json:"clientId,omitempty"`
	// ClientSecret - Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
	Type IdentityProviderType `json:"type,omitempty"`
	// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
	AllowedTenants *[]string `json:"allowedTenants,omitempty"`
	// SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
	SignupPolicyName *string `json:"signupPolicyName,omitempty"`
	// SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
	SigninPolicyName *string `json:"signinPolicyName,omitempty"`
	// ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
	ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
	// PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
	PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`
}

IdentityProviderContractProperties the external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.

type IdentityProviderList 

type IdentityProviderList struct {
	autorest.Response `json:"-"`
	// Value - Identity Provider configuration values.
	Value *[]IdentityProviderContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

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

func (IdentityProviderList) IsEmpty 

func (ipl IdentityProviderList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type IdentityProviderListIterator 

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

IdentityProviderListIterator provides access to a complete listing of IdentityProviderContract values.

func NewIdentityProviderListIterator 

func NewIdentityProviderListIterator(page IdentityProviderListPage) IdentityProviderListIterator

Creates a new instance of the IdentityProviderListIterator type.

func (*IdentityProviderListIterator) Next 

func (iter *IdentityProviderListIterator) 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. Deprecated: Use NextWithContext() instead.

func (*IdentityProviderListIterator) NextWithContext 

func (iter *IdentityProviderListIterator) NextWithContext(ctx context.Context) (err error)

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

func (IdentityProviderListIterator) NotDone 

func (iter IdentityProviderListIterator) NotDone() bool

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

func (IdentityProviderListIterator) Response 

func (iter IdentityProviderListIterator) Response() IdentityProviderList

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

func (IdentityProviderListIterator) Value 

func (iter IdentityProviderListIterator) Value() IdentityProviderContract

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

type IdentityProviderListPage 

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

IdentityProviderListPage contains a page of IdentityProviderContract values.

func NewIdentityProviderListPage 

func NewIdentityProviderListPage(getNextPage func(context.Context, IdentityProviderList) (IdentityProviderList, error)) IdentityProviderListPage

Creates a new instance of the IdentityProviderListPage type.

func (*IdentityProviderListPage) Next 

func (page *IdentityProviderListPage) 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. Deprecated: Use NextWithContext() instead.

func (*IdentityProviderListPage) NextWithContext 

func (page *IdentityProviderListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (IdentityProviderListPage) NotDone 

func (page IdentityProviderListPage) NotDone() bool

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

func (IdentityProviderListPage) Response 

func (page IdentityProviderListPage) Response() IdentityProviderList

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

func (IdentityProviderListPage) Values 

func (page IdentityProviderListPage) Values() []IdentityProviderContract

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

type IdentityProviderType 

type IdentityProviderType string

IdentityProviderType enumerates the values for identity provider type. 

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

func PossibleIdentityProviderTypeValues 

func PossibleIdentityProviderTypeValues() []IdentityProviderType

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

type IdentityProviderUpdateParameters 

type IdentityProviderUpdateParameters struct {
	// IdentityProviderUpdateProperties - Identity Provider update properties.
	*IdentityProviderUpdateProperties `json:"properties,omitempty"`
}

IdentityProviderUpdateParameters parameters supplied to update Identity Provider

func (IdentityProviderUpdateParameters) MarshalJSON 

func (ipup IdentityProviderUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IdentityProviderUpdateParameters.

func (*IdentityProviderUpdateParameters) UnmarshalJSON 

func (ipup *IdentityProviderUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for IdentityProviderUpdateParameters struct.

type IdentityProviderUpdateProperties 

type IdentityProviderUpdateProperties struct {
	// ClientID - Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
	ClientID *string `json:"clientId,omitempty"`
	// ClientSecret - Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
	Type IdentityProviderType `json:"type,omitempty"`
	// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
	AllowedTenants *[]string `json:"allowedTenants,omitempty"`
	// SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
	SignupPolicyName *string `json:"signupPolicyName,omitempty"`
	// SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
	SigninPolicyName *string `json:"signinPolicyName,omitempty"`
	// ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
	ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
	// PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
	PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`
}

IdentityProviderUpdateProperties parameters supplied to the Update Identity Provider operation.

type IssueAttachmentCollection 

type IssueAttachmentCollection struct {
	autorest.Response `json:"-"`
	// Value - Issue Attachment values.
	Value *[]IssueAttachmentContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

IssueAttachmentCollection paged Issue Attachment list representation.

func (IssueAttachmentCollection) IsEmpty 

func (iac IssueAttachmentCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type IssueAttachmentCollectionIterator 

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

IssueAttachmentCollectionIterator provides access to a complete listing of IssueAttachmentContract values.

func NewIssueAttachmentCollectionIterator 

func NewIssueAttachmentCollectionIterator(page IssueAttachmentCollectionPage) IssueAttachmentCollectionIterator

Creates a new instance of the IssueAttachmentCollectionIterator type.

func (*IssueAttachmentCollectionIterator) Next 

func (iter *IssueAttachmentCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*IssueAttachmentCollectionIterator) NextWithContext 

func (iter *IssueAttachmentCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (IssueAttachmentCollectionIterator) NotDone 

func (iter IssueAttachmentCollectionIterator) NotDone() bool

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

func (IssueAttachmentCollectionIterator) Response 

func (iter IssueAttachmentCollectionIterator) Response() IssueAttachmentCollection

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

func (IssueAttachmentCollectionIterator) Value 

func (iter IssueAttachmentCollectionIterator) Value() IssueAttachmentContract

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

type IssueAttachmentCollectionPage 

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

IssueAttachmentCollectionPage contains a page of IssueAttachmentContract values.

func NewIssueAttachmentCollectionPage 

func NewIssueAttachmentCollectionPage(getNextPage func(context.Context, IssueAttachmentCollection) (IssueAttachmentCollection, error)) IssueAttachmentCollectionPage

Creates a new instance of the IssueAttachmentCollectionPage type.

func (*IssueAttachmentCollectionPage) Next 

func (page *IssueAttachmentCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*IssueAttachmentCollectionPage) NextWithContext 

func (page *IssueAttachmentCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (IssueAttachmentCollectionPage) NotDone 

func (page IssueAttachmentCollectionPage) NotDone() bool

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

func (IssueAttachmentCollectionPage) Response 

func (page IssueAttachmentCollectionPage) Response() IssueAttachmentCollection

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

func (IssueAttachmentCollectionPage) Values 

func (page IssueAttachmentCollectionPage) Values() []IssueAttachmentContract

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

type IssueAttachmentContract 

type IssueAttachmentContract struct {
	autorest.Response `json:"-"`
	// IssueAttachmentContractProperties - Properties of the Issue Attachment.
	*IssueAttachmentContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

IssueAttachmentContract issue Attachment Contract details.

func (IssueAttachmentContract) MarshalJSON 

func (iac IssueAttachmentContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IssueAttachmentContract.

func (*IssueAttachmentContract) UnmarshalJSON 

func (iac *IssueAttachmentContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for IssueAttachmentContract struct.

type IssueAttachmentContractProperties 

type IssueAttachmentContractProperties struct {
	// Title - Filename by which the binary data will be saved.
	Title *string `json:"title,omitempty"`
	// ContentFormat - Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.
	ContentFormat *string `json:"contentFormat,omitempty"`
	// Content - An HTTP link or Base64-encoded binary data.
	Content *string `json:"content,omitempty"`
}

IssueAttachmentContractProperties issue Attachment contract Properties.

type IssueCollection 

type IssueCollection struct {
	autorest.Response `json:"-"`
	// Value - Issue values.
	Value *[]IssueContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

IssueCollection paged Issue list representation.

func (IssueCollection) IsEmpty 

func (ic IssueCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type IssueCollectionIterator 

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

IssueCollectionIterator provides access to a complete listing of IssueContract values.

func NewIssueCollectionIterator 

func NewIssueCollectionIterator(page IssueCollectionPage) IssueCollectionIterator

Creates a new instance of the IssueCollectionIterator type.

func (*IssueCollectionIterator) Next 

func (iter *IssueCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*IssueCollectionIterator) NextWithContext 

func (iter *IssueCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (IssueCollectionIterator) NotDone 

func (iter IssueCollectionIterator) NotDone() bool

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

func (IssueCollectionIterator) Response 

func (iter IssueCollectionIterator) Response() IssueCollection

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

func (IssueCollectionIterator) Value 

func (iter IssueCollectionIterator) Value() IssueContract

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

type IssueCollectionPage 

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

IssueCollectionPage contains a page of IssueContract values.

func NewIssueCollectionPage 

func NewIssueCollectionPage(getNextPage func(context.Context, IssueCollection) (IssueCollection, error)) IssueCollectionPage

Creates a new instance of the IssueCollectionPage type.

func (*IssueCollectionPage) Next 

func (page *IssueCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*IssueCollectionPage) NextWithContext 

func (page *IssueCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (IssueCollectionPage) NotDone 

func (page IssueCollectionPage) NotDone() bool

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

func (IssueCollectionPage) Response 

func (page IssueCollectionPage) Response() IssueCollection

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

func (IssueCollectionPage) Values 

func (page IssueCollectionPage) Values() []IssueContract

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

type IssueCommentCollection 

type IssueCommentCollection struct {
	autorest.Response `json:"-"`
	// Value - Issue Comment values.
	Value *[]IssueCommentContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

IssueCommentCollection paged Issue Comment list representation.

func (IssueCommentCollection) IsEmpty 

func (icc IssueCommentCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type IssueCommentCollectionIterator 

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

IssueCommentCollectionIterator provides access to a complete listing of IssueCommentContract values.

func NewIssueCommentCollectionIterator 

func NewIssueCommentCollectionIterator(page IssueCommentCollectionPage) IssueCommentCollectionIterator

Creates a new instance of the IssueCommentCollectionIterator type.

func (*IssueCommentCollectionIterator) Next 

func (iter *IssueCommentCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*IssueCommentCollectionIterator) NextWithContext 

func (iter *IssueCommentCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (IssueCommentCollectionIterator) NotDone 

func (iter IssueCommentCollectionIterator) NotDone() bool

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

func (IssueCommentCollectionIterator) Response 

func (iter IssueCommentCollectionIterator) Response() IssueCommentCollection

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

func (IssueCommentCollectionIterator) Value 

func (iter IssueCommentCollectionIterator) Value() IssueCommentContract

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

type IssueCommentCollectionPage 

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

IssueCommentCollectionPage contains a page of IssueCommentContract values.

func NewIssueCommentCollectionPage 

func NewIssueCommentCollectionPage(getNextPage func(context.Context, IssueCommentCollection) (IssueCommentCollection, error)) IssueCommentCollectionPage

Creates a new instance of the IssueCommentCollectionPage type.

func (*IssueCommentCollectionPage) Next 

func (page *IssueCommentCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*IssueCommentCollectionPage) NextWithContext 

func (page *IssueCommentCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (IssueCommentCollectionPage) NotDone 

func (page IssueCommentCollectionPage) NotDone() bool

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

func (IssueCommentCollectionPage) Response 

func (page IssueCommentCollectionPage) Response() IssueCommentCollection

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

func (IssueCommentCollectionPage) Values 

func (page IssueCommentCollectionPage) Values() []IssueCommentContract

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

type IssueCommentContract 

type IssueCommentContract struct {
	autorest.Response `json:"-"`
	// IssueCommentContractProperties - Properties of the Issue Comment.
	*IssueCommentContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

IssueCommentContract issue Comment Contract details.

func (IssueCommentContract) MarshalJSON 

func (icc IssueCommentContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IssueCommentContract.

func (*IssueCommentContract) UnmarshalJSON 

func (icc *IssueCommentContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for IssueCommentContract struct.

type IssueCommentContractProperties 

type IssueCommentContractProperties struct {
	// Text - Comment text.
	Text *string `json:"text,omitempty"`
	// CreatedDate - Date and time when the comment was created.
	CreatedDate *date.Time `json:"createdDate,omitempty"`
	// UserID - A resource identifier for the user who left the comment.
	UserID *string `json:"userId,omitempty"`
}

IssueCommentContractProperties issue Comment contract Properties.

type IssueContract 

type IssueContract struct {
	autorest.Response `json:"-"`
	// IssueContractProperties - Properties of the Issue.
	*IssueContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

IssueContract issue Contract details.

func (IssueContract) MarshalJSON 

func (ic IssueContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IssueContract.

func (*IssueContract) UnmarshalJSON 

func (ic *IssueContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for IssueContract struct.

type IssueContractBaseProperties 

type IssueContractBaseProperties struct {
	// CreatedDate - Date and time when the issue was created.
	CreatedDate *date.Time `json:"createdDate,omitempty"`
	// State - Status of the issue. Possible values include: 'Proposed', 'Open', 'Removed', 'Resolved', 'Closed'
	State State `json:"state,omitempty"`
	// APIID - A resource identifier for the API the issue was created for.
	APIID *string `json:"apiId,omitempty"`
}

IssueContractBaseProperties issue contract Base Properties.

type IssueContractProperties 

type IssueContractProperties struct {
	// Title - The issue title.
	Title *string `json:"title,omitempty"`
	// Description - Text describing the issue.
	Description *string `json:"description,omitempty"`
	// UserID - A resource identifier for the user created the issue.
	UserID *string `json:"userId,omitempty"`
	// CreatedDate - Date and time when the issue was created.
	CreatedDate *date.Time `json:"createdDate,omitempty"`
	// State - Status of the issue. Possible values include: 'Proposed', 'Open', 'Removed', 'Resolved', 'Closed'
	State State `json:"state,omitempty"`
	// APIID - A resource identifier for the API the issue was created for.
	APIID *string `json:"apiId,omitempty"`
}

IssueContractProperties issue contract Properties.

type IssueUpdateContract 

type IssueUpdateContract struct {
	// IssueUpdateContractProperties - Issue entity Update contract properties.
	*IssueUpdateContractProperties `json:"properties,omitempty"`
}

IssueUpdateContract issue update Parameters.

func (IssueUpdateContract) MarshalJSON 

func (iuc IssueUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IssueUpdateContract.

func (*IssueUpdateContract) UnmarshalJSON 

func (iuc *IssueUpdateContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for IssueUpdateContract struct.

type IssueUpdateContractProperties 

type IssueUpdateContractProperties struct {
	// Title - The issue title.
	Title *string `json:"title,omitempty"`
	// Description - Text describing the issue.
	Description *string `json:"description,omitempty"`
	// UserID - A resource identifier for the user created the issue.
	UserID *string `json:"userId,omitempty"`
	// CreatedDate - Date and time when the issue was created.
	CreatedDate *date.Time `json:"createdDate,omitempty"`
	// State - Status of the issue. Possible values include: 'Proposed', 'Open', 'Removed', 'Resolved', 'Closed'
	State State `json:"state,omitempty"`
	// APIID - A resource identifier for the API the issue was created for.
	APIID *string `json:"apiId,omitempty"`
}

IssueUpdateContractProperties issue contract Update Properties.

type KeyType 

type KeyType string

KeyType enumerates the values for key type. 

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

func PossibleKeyTypeValues 

func PossibleKeyTypeValues() []KeyType

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

type ListNetworkStatusContractByLocation 

type ListNetworkStatusContractByLocation struct {
	autorest.Response `json:"-"`
	Value             *[]NetworkStatusContractByLocation `json:"value,omitempty"`
}

ListNetworkStatusContractByLocation ...

type LoggerClient 

type LoggerClient struct {
	BaseClient
}

LoggerClient is the apiManagement Client

func NewLoggerClient 

func NewLoggerClient(subscriptionID string) LoggerClient

NewLoggerClient creates an instance of the LoggerClient client.

func NewLoggerClientWithBaseURI 

func NewLoggerClientWithBaseURI(baseURI string, subscriptionID string) LoggerClient

NewLoggerClientWithBaseURI creates an instance of the LoggerClient client.

func (LoggerClient) CreateOrUpdate 

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

CreateOrUpdate creates or Updates a logger. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - logger identifier. Must be unique in the API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (LoggerClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (LoggerClient) CreateOrUpdateResponder 

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

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

func (LoggerClient) CreateOrUpdateSender 

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

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

func (LoggerClient) Delete 

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

Delete deletes the specified logger. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - logger identifier. Must be unique in the API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (LoggerClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (LoggerClient) DeleteResponder 

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

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

func (LoggerClient) DeleteSender 

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

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

func (LoggerClient) Get 

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

Get gets the details of the logger specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - logger identifier. Must be unique in the API Management service instance.

func (LoggerClient) GetEntityTag 

func (client LoggerClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, loggerid string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the logger specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - logger identifier. Must be unique in the API Management service instance.

func (LoggerClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (LoggerClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (LoggerClient) GetEntityTagSender 

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

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

func (LoggerClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (LoggerClient) GetResponder 

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

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

func (LoggerClient) GetSender 

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

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

func (LoggerClient) ListByService 

func (client LoggerClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq | | top - number of records to return. skip - number of records to skip.

func (LoggerClient) ListByServiceComplete 

func (client LoggerClient) 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 (LoggerClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (LoggerClient) ListByServiceResponder 

func (client LoggerClient) 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 (LoggerClient) ListByServiceSender 

func (client LoggerClient) 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 (LoggerClient) Update 

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

Update updates an existing logger. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - logger identifier. Must be unique in the API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (LoggerClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (LoggerClient) UpdateResponder 

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

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

func (LoggerClient) UpdateSender 

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

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

type LoggerCollection 

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

LoggerCollection paged Logger list representation.

func (LoggerCollection) IsEmpty 

func (lc LoggerCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type LoggerCollectionIterator 

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

LoggerCollectionIterator provides access to a complete listing of LoggerContract values.

func NewLoggerCollectionIterator 

func NewLoggerCollectionIterator(page LoggerCollectionPage) LoggerCollectionIterator

Creates a new instance of the LoggerCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*LoggerCollectionIterator) NextWithContext 

func (iter *LoggerCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (LoggerCollectionIterator) NotDone 

func (iter LoggerCollectionIterator) NotDone() bool

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

func (LoggerCollectionIterator) Response 

func (iter LoggerCollectionIterator) Response() LoggerCollection

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

func (LoggerCollectionIterator) Value 

func (iter LoggerCollectionIterator) Value() LoggerContract

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

type LoggerCollectionPage 

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

LoggerCollectionPage contains a page of LoggerContract values.

func NewLoggerCollectionPage 

func NewLoggerCollectionPage(getNextPage func(context.Context, LoggerCollection) (LoggerCollection, error)) LoggerCollectionPage

Creates a new instance of the LoggerCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*LoggerCollectionPage) NextWithContext 

func (page *LoggerCollectionPage) NextWithContext(ctx context.Context) (err error)

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

func (LoggerCollectionPage) NotDone 

func (page LoggerCollectionPage) NotDone() bool

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

func (LoggerCollectionPage) Response 

func (page LoggerCollectionPage) Response() LoggerCollection

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

func (LoggerCollectionPage) Values 

func (page LoggerCollectionPage) Values() []LoggerContract

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

type LoggerContract 

type LoggerContract struct {
	autorest.Response `json:"-"`
	// LoggerContractProperties - Logger entity contract properties.
	*LoggerContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

LoggerContract logger details.

func (LoggerContract) MarshalJSON 

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

MarshalJSON is the custom marshaler for LoggerContract.

func (*LoggerContract) UnmarshalJSON 

func (lc *LoggerContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for LoggerContract struct.

type LoggerContractProperties 

type LoggerContractProperties struct {
	// LoggerType - Logger type. Possible values include: 'AzureEventHub', 'ApplicationInsights'
	LoggerType LoggerType `json:"loggerType,omitempty"`
	// Description - Logger description.
	Description *string `json:"description,omitempty"`
	// Credentials - The name and SendRule connection string of the event hub for azureEventHub logger.
	// Instrumentation key for applicationInsights logger.
	Credentials map[string]*string `json:"credentials"`
	// IsBuffered - Whether records are buffered in the logger before publishing. Default is assumed to be true.
	IsBuffered *bool `json:"isBuffered,omitempty"`
}

LoggerContractProperties the Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.

func (LoggerContractProperties) MarshalJSON 

func (lcp LoggerContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LoggerContractProperties.

type LoggerType 

type LoggerType string

LoggerType enumerates the values for logger type. 

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

func PossibleLoggerTypeValues 

func PossibleLoggerTypeValues() []LoggerType

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

type LoggerUpdateContract 

type LoggerUpdateContract struct {
	// LoggerUpdateParameters - Logger entity update contract properties.
	*LoggerUpdateParameters `json:"properties,omitempty"`
}

LoggerUpdateContract logger update contract.

func (LoggerUpdateContract) MarshalJSON 

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

MarshalJSON is the custom marshaler for LoggerUpdateContract.

func (*LoggerUpdateContract) UnmarshalJSON 

func (luc *LoggerUpdateContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for LoggerUpdateContract struct.

type LoggerUpdateParameters 

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

LoggerUpdateParameters parameters supplied to the Update Logger operation.

func (LoggerUpdateParameters) MarshalJSON 

func (lup LoggerUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LoggerUpdateParameters.

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"
)

func PossibleNameAvailabilityReasonValues 

func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason

PossibleNameAvailabilityReasonValues returns an array of possible values for the NameAvailabilityReason const type.

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) ListByLocation 

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

ListByLocation gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. locationName - location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US.

func (NetworkStatusClient) ListByLocationPreparer 

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

ListByLocationPreparer prepares the ListByLocation request.

func (NetworkStatusClient) ListByLocationResponder 

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

ListByLocationResponder handles the response to the ListByLocation request. The method always closes the http.Response Body.

func (NetworkStatusClient) ListByLocationSender 

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

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

func (NetworkStatusClient) ListByService 

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

ListByService gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (NetworkStatusClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (NetworkStatusClient) ListByServiceResponder 

func (client NetworkStatusClient) ListByServiceResponder(resp *http.Response) (result ListNetworkStatusContractByLocation, err error)

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

func (NetworkStatusClient) ListByServiceSender 

func (client NetworkStatusClient) 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 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 on which the service depends upon.
	ConnectivityStatus *[]ConnectivityStatusContract `json:"connectivityStatus,omitempty"`
}

NetworkStatusContract network Status details.

type NetworkStatusContractByLocation 

type NetworkStatusContractByLocation struct {
	// Location - Location of service
	Location *string `json:"location,omitempty"`
	// NetworkStatus - Network status in Location
	NetworkStatus *NetworkStatusContract `json:"networkStatus,omitempty"`
}

NetworkStatusContractByLocation network Status in the Location

type NotificationClient 

type NotificationClient struct {
	BaseClient
}

NotificationClient is the apiManagement Client

func NewNotificationClient 

func NewNotificationClient(subscriptionID string) NotificationClient

NewNotificationClient creates an instance of the NotificationClient client.

func NewNotificationClientWithBaseURI 

func NewNotificationClientWithBaseURI(baseURI string, subscriptionID string) NotificationClient

NewNotificationClientWithBaseURI creates an instance of the NotificationClient client.

func (NotificationClient) CreateOrUpdate 

func (client NotificationClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, ifMatch string) (result NotificationContract, err error)

CreateOrUpdate updates an Notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (NotificationClient) CreateOrUpdatePreparer 

func (client NotificationClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (NotificationClient) CreateOrUpdateResponder 

func (client NotificationClient) CreateOrUpdateResponder(resp *http.Response) (result NotificationContract, err error)

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

func (NotificationClient) CreateOrUpdateSender 

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

func (client NotificationClient) Get(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (result NotificationContract, err error)

Get gets the details of the Notification specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier.

func (NotificationClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (NotificationClient) GetResponder 

func (client NotificationClient) GetResponder(resp *http.Response) (result NotificationContract, err error)

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

func (NotificationClient) GetSender 

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

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

ListByService lists a collection of properties defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. top - number of records to return. skip - number of records to skip.

func (NotificationClient) ListByServiceComplete 

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

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

func (NotificationClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (NotificationClient) ListByServiceResponder 

func (client NotificationClient) ListByServiceResponder(resp *http.Response) (result NotificationCollection, err error)

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

func (NotificationClient) ListByServiceSender 

func (client NotificationClient) 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 NotificationCollection 

type NotificationCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]NotificationContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

NotificationCollection paged Notification list representation.

func (NotificationCollection) IsEmpty 

func (nc NotificationCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type NotificationCollectionIterator 

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

NotificationCollectionIterator provides access to a complete listing of NotificationContract values.

func NewNotificationCollectionIterator 

func NewNotificationCollectionIterator(page NotificationCollectionPage) NotificationCollectionIterator

Creates a new instance of the NotificationCollectionIterator type.

func (*NotificationCollectionIterator) Next 

func (iter *NotificationCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*NotificationCollectionIterator) NextWithContext 

func (iter *NotificationCollectionIterator) NextWithContext(ctx context.Context) (err error)

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

func (NotificationCollectionIterator) NotDone 

func (iter NotificationCollectionIterator) NotDone() bool

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

func (NotificationCollectionIterator) Response 

func (iter NotificationCollectionIterator) Response() NotificationCollection

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

func (NotificationCollectionIterator) Value 

func (iter NotificationCollectionIterator) Value() NotificationContract

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

type NotificationCollectionPage 

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

NotificationCollectionPage contains a page of NotificationContract values.

func NewNotificationCollectionPage 

func NewNotificationCollectionPage(getNextPage func(context.Context, NotificationCollection) (NotificationCollection, error)) NotificationCollectionPage

Creates a new instance of the NotificationCollectionPage type.

func (*NotificationCollectionPage) Next 

func (page *NotificationCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*NotificationCollectionPage) NextWithContext 

func (page *NotificationCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (NotificationCollectionPage) NotDone 

func (page NotificationCollectionPage) NotDone() bool

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

func (NotificationCollectionPage) Response 

func (page NotificationCollectionPage) Response() NotificationCollection

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

func (NotificationCollectionPage) Values 

func (page NotificationCollectionPage) Values() []NotificationContract

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

type NotificationContract 

type NotificationContract struct {
	autorest.Response `json:"-"`
	// NotificationContractProperties - Notification entity contract properties.
	*NotificationContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

NotificationContract notification details.

func (NotificationContract) MarshalJSON 

func (nc NotificationContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for NotificationContract.

func (*NotificationContract) UnmarshalJSON 

func (nc *NotificationContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for NotificationContract struct.

type NotificationContractProperties 

type NotificationContractProperties struct {
	// Title - Title of the Notification.
	Title *string `json:"title,omitempty"`
	// Description - Description of the Notification.
	Description *string `json:"description,omitempty"`
	// Recipients - Recipient Parameter values.
	Recipients *RecipientsContractProperties `json:"recipients,omitempty"`
}

NotificationContractProperties notification Contract properties.

type NotificationName 

type NotificationName string

NotificationName enumerates the values for notification name. 

const (
	// AccountClosedPublisher The following email recipients and users will receive email notifications when
	// developer closes his account.
	AccountClosedPublisher NotificationName = "AccountClosedPublisher"
	// BCC The following recipients will receive blind carbon copies of all emails sent to developers.
	BCC NotificationName = "BCC"
	// NewApplicationNotificationMessage The following email recipients and users will receive email
	// notifications when new applications are submitted to the application gallery.
	NewApplicationNotificationMessage NotificationName = "NewApplicationNotificationMessage"
	// NewIssuePublisherNotificationMessage The following email recipients and users will receive email
	// notifications when a new issue or comment is submitted on the developer portal.
	NewIssuePublisherNotificationMessage NotificationName = "NewIssuePublisherNotificationMessage"
	// PurchasePublisherNotificationMessage The following email recipients and users will receive email
	// notifications about new API product subscriptions.
	PurchasePublisherNotificationMessage NotificationName = "PurchasePublisherNotificationMessage"
	// QuotaLimitApproachingPublisherNotificationMessage The following email recipients and users will receive
	// email notifications when subscription usage gets close to usage quota.
	QuotaLimitApproachingPublisherNotificationMessage NotificationName = "QuotaLimitApproachingPublisherNotificationMessage"
	// RequestPublisherNotificationMessage The following email recipients and users will receive email
	// notifications about subscription requests for API products requiring approval.
	RequestPublisherNotificationMessage NotificationName = "RequestPublisherNotificationMessage"
)

func PossibleNotificationNameValues 

func PossibleNotificationNameValues() []NotificationName

PossibleNotificationNameValues returns an array of possible values for the NotificationName const type.

type NotificationRecipientEmailClient 

type NotificationRecipientEmailClient struct {
	BaseClient
}

NotificationRecipientEmailClient is the apiManagement Client

func NewNotificationRecipientEmailClient 

func NewNotificationRecipientEmailClient(subscriptionID string) NotificationRecipientEmailClient

NewNotificationRecipientEmailClient creates an instance of the NotificationRecipientEmailClient client.

func NewNotificationRecipientEmailClientWithBaseURI 

func NewNotificationRecipientEmailClientWithBaseURI(baseURI string, subscriptionID string) NotificationRecipientEmailClient

NewNotificationRecipientEmailClientWithBaseURI creates an instance of the NotificationRecipientEmailClient client.

func (NotificationRecipientEmailClient) CheckEntityExists 

func (client NotificationRecipientEmailClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (result autorest.Response, err error)

CheckEntityExists determine if Notification Recipient Email subscribed to the notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. email - email identifier.

func (NotificationRecipientEmailClient) CheckEntityExistsPreparer 

func (client NotificationRecipientEmailClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (*http.Request, error)

CheckEntityExistsPreparer prepares the CheckEntityExists request.

func (NotificationRecipientEmailClient) CheckEntityExistsResponder 

func (client NotificationRecipientEmailClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)

CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.

func (NotificationRecipientEmailClient) CheckEntityExistsSender 

func (client NotificationRecipientEmailClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)

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

func (NotificationRecipientEmailClient) CreateOrUpdate 

func (client NotificationRecipientEmailClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (result RecipientEmailContract, err error)

CreateOrUpdate adds the Email address to the list of Recipients for the Notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. email - email identifier.

func (NotificationRecipientEmailClient) CreateOrUpdatePreparer 

func (client NotificationRecipientEmailClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (NotificationRecipientEmailClient) CreateOrUpdateResponder 

func (client NotificationRecipientEmailClient) CreateOrUpdateResponder(resp *http.Response) (result RecipientEmailContract, err error)

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

func (NotificationRecipientEmailClient) CreateOrUpdateSender 

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

func (client NotificationRecipientEmailClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (result autorest.Response, err error)

Delete removes the email from the list of Notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. email - email identifier.

func (NotificationRecipientEmailClient) DeletePreparer 

func (client NotificationRecipientEmailClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (NotificationRecipientEmailClient) DeleteResponder 

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

func (client NotificationRecipientEmailClient) 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 (NotificationRecipientEmailClient) ListByNotification 

func (client NotificationRecipientEmailClient) ListByNotification(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (result RecipientEmailCollection, err error)

ListByNotification gets the list of the Notification Recipient Emails subscribed to a notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier.

func (NotificationRecipientEmailClient) ListByNotificationPreparer 

func (client NotificationRecipientEmailClient) ListByNotificationPreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (*http.Request, error)

ListByNotificationPreparer prepares the ListByNotification request.

func (NotificationRecipientEmailClient) ListByNotificationResponder 

func (client NotificationRecipientEmailClient) ListByNotificationResponder(resp *http.Response) (result RecipientEmailCollection, err error)

ListByNotificationResponder handles the response to the ListByNotification request. The method always closes the http.Response Body.

func (NotificationRecipientEmailClient) ListByNotificationSender 

func (client NotificationRecipientEmailClient) ListByNotificationSender(req *http.Request) (*http.Response, error)

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

type NotificationRecipientUserClient 

type NotificationRecipientUserClient struct {
	BaseClient
}

NotificationRecipientUserClient is the apiManagement Client

func NewNotificationRecipientUserClient 

func NewNotificationRecipientUserClient(subscriptionID string) NotificationRecipientUserClient

NewNotificationRecipientUserClient creates an instance of the NotificationRecipientUserClient client.

func NewNotificationRecipientUserClientWithBaseURI 

func NewNotificationRecipientUserClientWithBaseURI(baseURI string, subscriptionID string) NotificationRecipientUserClient

NewNotificationRecipientUserClientWithBaseURI creates an instance of the NotificationRecipientUserClient client.

func (NotificationRecipientUserClient) CheckEntityExists 

func (client NotificationRecipientUserClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (result autorest.Response, err error)

CheckEntityExists determine if the Notification Recipient User is subscribed to the notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. UID - user identifier. Must be unique in the current API Management service instance.

func (NotificationRecipientUserClient) CheckEntityExistsPreparer 

func (client NotificationRecipientUserClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (*http.Request, error)

CheckEntityExistsPreparer prepares the CheckEntityExists request.

func (NotificationRecipientUserClient) CheckEntityExistsResponder 

func (client NotificationRecipientUserClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)

CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.

func (NotificationRecipientUserClient) CheckEntityExistsSender 

func (client NotificationRecipientUserClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)

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

func (NotificationRecipientUserClient) CreateOrUpdate 

func (client NotificationRecipientUserClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (result RecipientUserContract, err error)

CreateOrUpdate adds the API Management User to the list of Recipients for the Notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. UID - user identifier. Must be unique in the current API Management service instance.

func (NotificationRecipientUserClient) CreateOrUpdatePreparer 

func (client NotificationRecipientUserClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (NotificationRecipientUserClient) CreateOrUpdateResponder 

func (client NotificationRecipientUserClient) CreateOrUpdateResponder(resp *http.Response) (result RecipientUserContract, err error)

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

func (NotificationRecipientUserClient) CreateOrUpdateSender 

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

func (client NotificationRecipientUserClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (result autorest.Response, err error)

Delete removes the API Management user from the list of Notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. UID - user identifier. Must be unique in the current API Management service instance.

func (NotificationRecipientUserClient) DeletePreparer 

func (client NotificationRecipientUserClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (NotificationRecipientUserClient) DeleteResponder 

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

func (client NotificationRecipientUserClient) 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 (NotificationRecipientUserClient) ListByNotification 

func (client NotificationRecipientUserClient) ListByNotification(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (result RecipientUserCollection, err error)

ListByNotification gets the list of the Notification Recipient User subscribed to the notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier.

func (NotificationRecipientUserClient) ListByNotificationPreparer 

func (client NotificationRecipientUserClient) ListByNotificationPreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (*http.Request, error)

ListByNotificationPreparer prepares the ListByNotification request.

func (NotificationRecipientUserClient) ListByNotificationResponder 

func (client NotificationRecipientUserClient) ListByNotificationResponder(resp *http.Response) (result RecipientUserCollection, err error)

ListByNotificationResponder handles the response to the ListByNotification request. The method always closes the http.Response Body.

func (NotificationRecipientUserClient) ListByNotificationSender 

func (client NotificationRecipientUserClient) ListByNotificationSender(req *http.Request) (*http.Response, error)

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

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 OpenIDAuthenticationSettingsContract 

type OpenIDAuthenticationSettingsContract struct {
	// OpenidProviderID - OAuth authorization server identifier.
	OpenidProviderID *string `json:"openidProviderId,omitempty"`
	// BearerTokenSendingMethods - How to send token to the server.
	BearerTokenSendingMethods *[]BearerTokenSendingMethods `json:"bearerTokenSendingMethods,omitempty"`
}

OpenIDAuthenticationSettingsContract API OAuth2 Authentication settings details.

type OpenIDConnectProviderClient 

type OpenIDConnectProviderClient struct {
	BaseClient
}

OpenIDConnectProviderClient is the apiManagement Client

func NewOpenIDConnectProviderClient 

func NewOpenIDConnectProviderClient(subscriptionID string) OpenIDConnectProviderClient

NewOpenIDConnectProviderClient creates an instance of the OpenIDConnectProviderClient client.

func NewOpenIDConnectProviderClientWithBaseURI 

func NewOpenIDConnectProviderClientWithBaseURI(baseURI string, subscriptionID string) OpenIDConnectProviderClient

NewOpenIDConnectProviderClientWithBaseURI creates an instance of the OpenIDConnectProviderClient client.

func (OpenIDConnectProviderClient) CreateOrUpdate 

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

CreateOrUpdate creates or updates the OpenID Connect Provider. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (OpenIDConnectProviderClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (OpenIDConnectProviderClient) CreateOrUpdateResponder 

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

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

func (OpenIDConnectProviderClient) CreateOrUpdateSender 

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

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

func (OpenIDConnectProviderClient) Delete 

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

Delete deletes specific OpenID Connect Provider of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (OpenIDConnectProviderClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (OpenIDConnectProviderClient) DeleteResponder 

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

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

func (OpenIDConnectProviderClient) DeleteSender 

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

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

func (OpenIDConnectProviderClient) Get 

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

Get gets specific OpenID Connect Provider. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider.

func (OpenIDConnectProviderClient) GetEntityTag 

func (client OpenIDConnectProviderClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, opid string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider.

func (OpenIDConnectProviderClient) GetEntityTagPreparer 

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (OpenIDConnectProviderClient) GetEntityTagResponder 

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

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (OpenIDConnectProviderClient) GetEntityTagSender 

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

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

func (OpenIDConnectProviderClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (OpenIDConnectProviderClient) GetResponder 

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

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

func (OpenIDConnectProviderClient) GetSender 

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

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

func (OpenIDConnectProviderClient) ListByService 

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

ListByService lists all OpenID Connect Providers. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip.

func (OpenIDConnectProviderClient) ListByServiceComplete 

func (client OpenIDConnectProviderClient) 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 (OpenIDConnectProviderClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (OpenIDConnectProviderClient) ListByServiceResponder 

func (client OpenIDConnectProviderClient) 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 (OpenIDConnectProviderClient) ListByServiceSender 

func (client OpenIDConnectProviderClient) 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 (OpenIDConnectProviderClient) Update 

func (client OpenIDConnectProviderClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (OpenIDConnectProviderClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (OpenIDConnectProviderClient) UpdateResponder 

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

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

func (OpenIDConnectProviderClient) UpdateSender 

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

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

type OpenIDConnectProviderCollection 

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

func NewOpenIDConnectProviderCollectionIterator(page OpenIDConnectProviderCollectionPage) OpenIDConnectProviderCollectionIterator

Creates a new instance of the OpenIDConnectProviderCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*OpenIDConnectProviderCollectionIterator) NextWithContext 

func (iter *OpenIDConnectProviderCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewOpenIDConnectProviderCollectionPage 

func NewOpenIDConnectProviderCollectionPage(getNextPage func(context.Context, OpenIDConnectProviderCollection) (OpenIDConnectProviderCollection, error)) OpenIDConnectProviderCollectionPage

Creates a new instance of the OpenIDConnectProviderCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*OpenIDConnectProviderCollectionPage) NextWithContext 

func (page *OpenIDConnectProviderCollectionPage) NextWithContext(ctx context.Context) (err error)

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

func (OpenIDConnectProviderCollectionPage) NotDone 

func (page OpenIDConnectProviderCollectionPage) NotDone() bool

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

func (OpenIDConnectProviderCollectionPage) Response 

func (page OpenIDConnectProviderCollectionPage) Response() OpenIDConnectProviderCollection

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

func (OpenIDConnectProviderCollectionPage) Values 

func (page OpenIDConnectProviderCollectionPage) Values() []OpenidConnectProviderContract

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

type OpenidConnectProviderContract 

type OpenidConnectProviderContract struct {
	autorest.Response `json:"-"`
	// OpenidConnectProviderContractProperties - OpenId Connect Provider contract properties.
	*OpenidConnectProviderContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

OpenidConnectProviderContract openId Connect Provider details.

func (OpenidConnectProviderContract) MarshalJSON 

func (ocpc OpenidConnectProviderContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OpenidConnectProviderContract.

func (*OpenidConnectProviderContract) UnmarshalJSON 

func (ocpc *OpenidConnectProviderContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OpenidConnectProviderContract struct.

type OpenidConnectProviderContractProperties 

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

OpenidConnectProviderContractProperties openID Connect Providers Contract.

type OpenidConnectProviderUpdateContract 

type OpenidConnectProviderUpdateContract struct {
	// OpenidConnectProviderUpdateContractProperties - OpenId Connect Provider Update contract properties.
	*OpenidConnectProviderUpdateContractProperties `json:"properties,omitempty"`
}

OpenidConnectProviderUpdateContract parameters supplied to the Update OpenID Connect Provider operation.

func (OpenidConnectProviderUpdateContract) MarshalJSON 

func (ocpuc OpenidConnectProviderUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OpenidConnectProviderUpdateContract.

func (*OpenidConnectProviderUpdateContract) UnmarshalJSON 

func (ocpuc *OpenidConnectProviderUpdateContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OpenidConnectProviderUpdateContract struct.

type OpenidConnectProviderUpdateContractProperties 

type OpenidConnectProviderUpdateContractProperties struct {
	// DisplayName - User-friendly OpenID Connect Provider name.
	DisplayName *string `json:"displayName,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"`
}

OpenidConnectProviderUpdateContractProperties 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"`
	// Origin - The operation origin.
	Origin *string `json:"origin,omitempty"`
	// Properties - The operation properties.
	Properties interface{} `json:"properties,omitempty"`
}

Operation REST API operation

type OperationClient 

type OperationClient struct {
	BaseClient
}

OperationClient is the apiManagement Client

func NewOperationClient 

func NewOperationClient(subscriptionID string) OperationClient

NewOperationClient creates an instance of the OperationClient client.

func NewOperationClientWithBaseURI 

func NewOperationClientWithBaseURI(baseURI string, subscriptionID string) OperationClient

NewOperationClientWithBaseURI creates an instance of the OperationClient client.

func (OperationClient) ListByTags 

func (client OperationClient) ListByTags(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagResourceCollectionPage, err error)

ListByTags lists a collection of operations associated with tags. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | 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 | | apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (OperationClient) ListByTagsComplete 

func (client OperationClient) ListByTagsComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagResourceCollectionIterator, err error)

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

func (OperationClient) ListByTagsPreparer 

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

ListByTagsPreparer prepares the ListByTags request.

func (OperationClient) ListByTagsResponder 

func (client OperationClient) ListByTagsResponder(resp *http.Response) (result TagResourceCollection, err error)

ListByTagsResponder handles the response to the ListByTags request. The method always closes the http.Response Body.

func (OperationClient) ListByTagsSender 

func (client OperationClient) ListByTagsSender(req *http.Request) (*http.Response, error)

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

type OperationCollection 

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

func NewOperationCollectionIterator(page OperationCollectionPage) OperationCollectionIterator

Creates a new instance of the OperationCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*OperationCollectionIterator) NextWithContext 

func (iter *OperationCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewOperationCollectionPage 

func NewOperationCollectionPage(getNextPage func(context.Context, OperationCollection) (OperationCollection, error)) OperationCollectionPage

Creates a new instance of the OperationCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*OperationCollectionPage) NextWithContext 

func (page *OperationCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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:"-"`
	// OperationContractProperties - Properties of the Operation Contract.
	*OperationContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

OperationContract api Operation details.

func (OperationContract) MarshalJSON 

func (oc OperationContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationContract.

func (*OperationContract) UnmarshalJSON 

func (oc *OperationContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OperationContract struct.

type OperationContractProperties 

type OperationContractProperties struct {
	// DisplayName - Operation Name.
	DisplayName *string `json:"displayName,omitempty"`
	// Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
	Method *string `json:"method,omitempty"`
	// URLTemplate - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
	URLTemplate *string `json:"urlTemplate,omitempty"`
	// TemplateParameters - Collection of URL template parameters.
	TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
	// Description - Description of the operation. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Request - An entity containing request details.
	Request *RequestContract `json:"request,omitempty"`
	// Responses - Array of Operation responses.
	Responses *[]ResponseContract `json:"responses,omitempty"`
	// Policies - Operation Policies
	Policies *string `json:"policies,omitempty"`
}

OperationContractProperties operation Contract Properties

type 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 *[]ResponseContract `json:"responses,omitempty"`
	// Policies - Operation Policies
	Policies *string `json:"policies,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 NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext 

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewOperationListResultPage 

func NewOperationListResultPage(getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

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. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext 

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 AsyncOperationStatus `json:"status,omitempty"`
	// Started - Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	Started *date.Time `json:"started,omitempty"`
	// Updated - Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	Updated *date.Time `json:"updated,omitempty"`
	// ResultInfo - Optional result info.
	ResultInfo *string `json:"resultInfo,omitempty"`
	// Error - Error Body Contract
	Error *ErrorResponseBody `json:"error,omitempty"`
	// ActionLog - This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation.
	ActionLog *[]OperationResultLogItemContract `json:"actionLog,omitempty"`
}

OperationResultContract operation Result.

type OperationResultLogItemContract 

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

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

type OperationTagResourceContractProperties 

type OperationTagResourceContractProperties struct {
	// ID - Identifier of the operation in form /operations/{operationId}.
	ID *string `json:"id,omitempty"`
	// Name - Operation name.
	Name *string `json:"name,omitempty"`
	// APIName - Api Name.
	APIName *string `json:"apiName,omitempty"`
	// APIRevision - Api Revision.
	APIRevision *string `json:"apiRevision,omitempty"`
	// APIVersion - Api Version.
	APIVersion *string `json:"apiVersion,omitempty"`
	// Description - Operation Description.
	Description *string `json:"description,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"`
}

OperationTagResourceContractProperties operation Entity contract Properties.

type OperationUpdateContract 

type OperationUpdateContract struct {
	// OperationUpdateContractProperties - Properties of the API Operation entity that can be updated.
	*OperationUpdateContractProperties `json:"properties,omitempty"`
}

OperationUpdateContract api Operation Update Contract details.

func (OperationUpdateContract) MarshalJSON 

func (ouc OperationUpdateContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationUpdateContract.

func (*OperationUpdateContract) UnmarshalJSON 

func (ouc *OperationUpdateContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OperationUpdateContract struct.

type OperationUpdateContractProperties 

type OperationUpdateContractProperties struct {
	// DisplayName - Operation Name.
	DisplayName *string `json:"displayName,omitempty"`
	// Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
	Method *string `json:"method,omitempty"`
	// URLTemplate - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
	URLTemplate *string `json:"urlTemplate,omitempty"`
	// TemplateParameters - Collection of URL template parameters.
	TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
	// Description - Description of the operation. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Request - An entity containing request details.
	Request *RequestContract `json:"request,omitempty"`
	// Responses - Array of Operation responses.
	Responses *[]ResponseContract `json:"responses,omitempty"`
	// Policies - Operation Policies
	Policies *string `json:"policies,omitempty"`
}

OperationUpdateContractProperties operation Update Contract Properties.

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 PolicyClient 

type PolicyClient struct {
	BaseClient
}

PolicyClient is the apiManagement Client

func NewPolicyClient 

func NewPolicyClient(subscriptionID string) PolicyClient

NewPolicyClient creates an instance of the PolicyClient client.

func NewPolicyClientWithBaseURI 

func NewPolicyClientWithBaseURI(baseURI string, subscriptionID string) PolicyClient

NewPolicyClientWithBaseURI creates an instance of the PolicyClient client.

func (PolicyClient) CreateOrUpdate 

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

CreateOrUpdate creates or updates the global policy configuration of the Api Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - the policy contents to apply.

func (PolicyClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PolicyClient) CreateOrUpdateResponder 

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

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

func (PolicyClient) CreateOrUpdateSender 

func (client PolicyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (PolicyClient) Delete 

func (client PolicyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, ifMatch string) (result autorest.Response, err error)

Delete deletes the global policy configuration of the Api Management Service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (PolicyClient) DeletePreparer 

func (client PolicyClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PolicyClient) DeleteResponder 

func (client PolicyClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (PolicyClient) DeleteSender 

func (client PolicyClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (PolicyClient) Get 

func (client PolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result PolicyContract, err error)

Get get the Global policy definition of the Api Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (PolicyClient) GetEntityTag 

func (client PolicyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the Global policy definition in the Api Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (PolicyClient) GetEntityTagPreparer 

func (client PolicyClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (PolicyClient) GetEntityTagResponder 

func (client PolicyClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (PolicyClient) GetEntityTagSender 

func (client PolicyClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.

func (PolicyClient) GetPreparer 

func (client PolicyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PolicyClient) GetResponder 

func (client PolicyClient) GetResponder(resp *http.Response) (result PolicyContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PolicyClient) GetSender 

func (client PolicyClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (PolicyClient) ListByService 

func (client PolicyClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, scope PolicyScopeContract) (result PolicyCollection, err error)

ListByService lists all the Global Policy definitions of the Api Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. scope - policy scope.

func (PolicyClient) ListByServicePreparer 

func (client PolicyClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, scope PolicyScopeContract) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (PolicyClient) ListByServiceResponder 

func (client PolicyClient) ListByServiceResponder(resp *http.Response) (result PolicyCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (PolicyClient) ListByServiceSender 

func (client PolicyClient) 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 PolicyCollection 

type PolicyCollection struct {
	autorest.Response `json:"-"`
	// Value - Policy Contract value.
	Value *[]PolicyContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

PolicyCollection the response of the list policy operation.

type PolicyContentFormat 

type PolicyContentFormat string

PolicyContentFormat enumerates the values for policy content format. 

const (
	// Rawxml The contents are inline and Content type is a non XML encoded policy document.
	Rawxml PolicyContentFormat = "rawxml"
	// RawxmlLink The policy document is not Xml encoded and is hosted on a http endpoint accessible from the
	// API Management service.
	RawxmlLink PolicyContentFormat = "rawxml-link"
	// XML The contents are inline and Content type is an XML document.
	XML PolicyContentFormat = "xml"
	// XMLLink The policy XML document is hosted on a http endpoint accessible from the API Management service.
	XMLLink PolicyContentFormat = "xml-link"
)

func PossiblePolicyContentFormatValues 

func PossiblePolicyContentFormatValues() []PolicyContentFormat

PossiblePolicyContentFormatValues returns an array of possible values for the PolicyContentFormat const type.

type PolicyContract 

type PolicyContract struct {
	autorest.Response `json:"-"`
	// PolicyContractProperties - Properties of the Policy.
	*PolicyContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

PolicyContract policy Contract details.

func (PolicyContract) MarshalJSON 

func (pc PolicyContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PolicyContract.

func (*PolicyContract) UnmarshalJSON 

func (pc *PolicyContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PolicyContract struct.

type PolicyContractProperties 

type PolicyContractProperties struct {
	// PolicyContent - Json escaped Xml Encoded contents of the Policy.
	PolicyContent *string `json:"policyContent,omitempty"`
	// ContentFormat - Format of the policyContent. Possible values include: 'XML', 'XMLLink', 'Rawxml', 'RawxmlLink'
	ContentFormat PolicyContentFormat `json:"contentFormat,omitempty"`
}

PolicyContractProperties policy contract Properties.

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"
)

func PossiblePolicyScopeContractValues 

func PossiblePolicyScopeContractValues() []PolicyScopeContract

PossiblePolicyScopeContractValues returns an array of possible values for the PolicyScopeContract const type.

type PolicySnippetContract 

type PolicySnippetContract struct {
	// Name - Snippet name.
	Name *string `json:"name,omitempty"`
	// Content - Snippet content.
	Content *string `json:"content,omitempty"`
	// ToolTip - Snippet toolTip.
	ToolTip *string `json:"toolTip,omitempty"`
	// Scope - Binary OR value of the Snippet scope.
	Scope *int32 `json:"scope,omitempty"`
}

PolicySnippetContract policy snippet.

type PolicySnippetsClient 

type PolicySnippetsClient struct {
	BaseClient
}

PolicySnippetsClient is the 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. scope - 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 PortalDelegationSettings 

type PortalDelegationSettings struct {
	autorest.Response `json:"-"`
	// PortalDelegationSettingsProperties - Delegation settings contract properties.
	*PortalDelegationSettingsProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

PortalDelegationSettings delegation settings for a developer portal.

func (PortalDelegationSettings) MarshalJSON 

func (pds PortalDelegationSettings) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PortalDelegationSettings.

func (*PortalDelegationSettings) UnmarshalJSON 

func (pds *PortalDelegationSettings) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PortalDelegationSettings struct.

type PortalDelegationSettingsProperties 

type PortalDelegationSettingsProperties struct {
	// URL - A delegation Url.
	URL *string `json:"url,omitempty"`
	// ValidationKey - A base64-encoded validation key to validate, that a request is coming from Azure API Management.
	ValidationKey *string `json:"validationKey,omitempty"`
	// Subscriptions - Subscriptions delegation settings.
	Subscriptions *SubscriptionsDelegationSettingsProperties `json:"subscriptions,omitempty"`
	// UserRegistration - User registration delegation settings.
	UserRegistration *RegistrationDelegationSettingsProperties `json:"userRegistration,omitempty"`
}

PortalDelegationSettingsProperties delegation settings contract properties.

type PortalSigninSettingProperties 

type PortalSigninSettingProperties struct {
	// Enabled - Redirect Anonymous users to the Sign-In page.
	Enabled *bool `json:"enabled,omitempty"`
}

PortalSigninSettingProperties sign-in settings contract properties.

type PortalSigninSettings 

type PortalSigninSettings struct {
	autorest.Response `json:"-"`
	// PortalSigninSettingProperties - Sign-in settings contract properties.
	*PortalSigninSettingProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

PortalSigninSettings sign-In settings for the Developer Portal.

func (PortalSigninSettings) MarshalJSON 

func (pss PortalSigninSettings) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PortalSigninSettings.

func (*PortalSigninSettings) UnmarshalJSON 

func (pss *PortalSigninSettings) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PortalSigninSettings struct.

type PortalSignupSettings 

type PortalSignupSettings struct {
	autorest.Response `json:"-"`
	// PortalSignupSettingsProperties - Sign-up settings contract properties.
	*PortalSignupSettingsProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

PortalSignupSettings sign-Up settings for a developer portal.

func (PortalSignupSettings) MarshalJSON 

func (pss PortalSignupSettings) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PortalSignupSettings.

func (*PortalSignupSettings) UnmarshalJSON 

func (pss *PortalSignupSettings) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PortalSignupSettings struct.

type PortalSignupSettingsProperties 

type PortalSignupSettingsProperties struct {
	// Enabled - Allow users to sign up on a developer portal.
	Enabled *bool `json:"enabled,omitempty"`
	// TermsOfService - Terms of service contract properties.
	TermsOfService *TermsOfServiceProperties `json:"termsOfService,omitempty"`
}

PortalSignupSettingsProperties sign-up settings contract properties.

type ProductAPIClient 

type ProductAPIClient struct {
	BaseClient
}

ProductAPIClient is the apiManagement Client

func NewProductAPIClient 

func NewProductAPIClient(subscriptionID string) ProductAPIClient

NewProductAPIClient creates an instance of the ProductAPIClient client.

func NewProductAPIClientWithBaseURI 

func NewProductAPIClientWithBaseURI(baseURI string, subscriptionID string) ProductAPIClient

NewProductAPIClientWithBaseURI creates an instance of the ProductAPIClient client.

func (ProductAPIClient) CheckEntityExists 

func (client ProductAPIClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (result autorest.Response, err error)

CheckEntityExists checks that API entity specified by identifier is associated with the Product entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

func (ProductAPIClient) CheckEntityExistsPreparer 

func (client ProductAPIClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (*http.Request, error)

CheckEntityExistsPreparer prepares the CheckEntityExists request.

func (ProductAPIClient) CheckEntityExistsResponder 

func (client ProductAPIClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)

CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.

func (ProductAPIClient) CheckEntityExistsSender 

func (client ProductAPIClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)

CheckEntityExistsSender sends the CheckEntityExists request. The method will close the http.Response Body if it receives an error.

func (ProductAPIClient) CreateOrUpdate 

func (client ProductAPIClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (result APIContract, err error)

CreateOrUpdate adds an API to the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

func (ProductAPIClient) CreateOrUpdatePreparer 

func (client ProductAPIClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductAPIClient) CreateOrUpdateResponder 

func (client ProductAPIClient) CreateOrUpdateResponder(resp *http.Response) (result APIContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ProductAPIClient) CreateOrUpdateSender 

func (client ProductAPIClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ProductAPIClient) Delete 

func (client ProductAPIClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (result autorest.Response, err error)

Delete deletes the specified API from the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

func (ProductAPIClient) DeletePreparer 

func (client ProductAPIClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProductAPIClient) DeleteResponder 

func (client ProductAPIClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ProductAPIClient) DeleteSender 

func (client ProductAPIClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ProductAPIClient) ListByProduct 

func (client ProductAPIClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result APICollectionPage, err error)

ListByProduct lists a collection of the APIs associated with a product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. filter - | 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 - number of records to return. skip - number of records to skip.

func (ProductAPIClient) ListByProductComplete 

func (client ProductAPIClient) ListByProductComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result APICollectionIterator, err error)

ListByProductComplete enumerates all values, automatically crossing page boundaries as required.

func (ProductAPIClient) ListByProductPreparer 

func (client ProductAPIClient) ListByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ProductAPIClient) ListByProductResponder 

func (client ProductAPIClient) ListByProductResponder(resp *http.Response) (result APICollection, err error)

ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.

func (ProductAPIClient) ListByProductSender 

func (client ProductAPIClient) ListByProductSender(req *http.Request) (*http.Response, error)

ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.

type ProductClient 

type ProductClient struct {
	BaseClient
}

ProductClient is the apiManagement Client

func NewProductClient 

func NewProductClient(subscriptionID string) ProductClient

NewProductClient creates an instance of the ProductClient client.

func NewProductClientWithBaseURI 

func NewProductClientWithBaseURI(baseURI string, subscriptionID string) ProductClient

NewProductClientWithBaseURI creates an instance of the ProductClient client.

func (ProductClient) CreateOrUpdate 

func (client ProductClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductContract, ifMatch string) (result ProductContract, err error)

CreateOrUpdate creates or Updates a product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. parameters - create or update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (ProductClient) CreateOrUpdatePreparer 

func (client ProductClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductClient) CreateOrUpdateResponder 

func (client ProductClient) CreateOrUpdateResponder(resp *http.Response) (result ProductContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ProductClient) CreateOrUpdateSender 

func (client ProductClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ProductClient) Delete 

func (client ProductClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string, deleteSubscriptions *bool) (result autorest.Response, err error)

Delete delete product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. deleteSubscriptions - delete existing subscriptions associated with the product or not.

func (ProductClient) DeletePreparer 

func (client ProductClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string, deleteSubscriptions *bool) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProductClient) DeleteResponder 

func (client ProductClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ProductClient) DeleteSender 

func (client ProductClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ProductClient) Get 

func (client ProductClient) Get(ctx context.Context, resourceGroupName string, serviceName string, productID string) (result ProductContract, err error)

Get gets the details of the product specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance.

func (ProductClient) GetEntityTag 

func (client ProductClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, productID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the product specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance.

func (ProductClient) GetEntityTagPreparer 

func (client ProductClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (ProductClient) GetEntityTagResponder 

func (client ProductClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (ProductClient) GetEntityTagSender 

func (client ProductClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.

func (ProductClient) GetPreparer 

func (client ProductClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProductClient) GetResponder 

func (client ProductClient) GetResponder(resp *http.Response) (result ProductContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ProductClient) GetSender 

func (client ProductClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ProductClient) ListByService 

func (client ProductClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip. expandGroups - when set to true, the response contains an array of groups that have visibility to the product. The default is false.

func (ProductClient) ListByServiceComplete 

func (client ProductClient) 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 (ProductClient) ListByServicePreparer 

func (client ProductClient) 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 (ProductClient) ListByServiceResponder 

func (client ProductClient) 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 (ProductClient) ListByServiceSender 

func (client ProductClient) 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 (ProductClient) Update 

func (client ProductClient) Update(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update update product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (ProductClient) UpdatePreparer 

func (client ProductClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ProductClient) UpdateResponder 

func (client ProductClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ProductClient) UpdateSender 

func (client ProductClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type ProductCollection 

type ProductCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]ProductContract `json:"value,omitempty"`
	// 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 NewProductCollectionIterator 

func NewProductCollectionIterator(page ProductCollectionPage) ProductCollectionIterator

Creates a new instance of the ProductCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*ProductCollectionIterator) NextWithContext 

func (iter *ProductCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewProductCollectionPage 

func NewProductCollectionPage(getNextPage func(context.Context, ProductCollection) (ProductCollection, error)) ProductCollectionPage

Creates a new instance of the ProductCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*ProductCollectionPage) NextWithContext 

func (page *ProductCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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:"-"`
	// ProductContractProperties - Product entity contract properties.
	*ProductContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

ProductContract product details.

func (ProductContract) MarshalJSON 

func (pc ProductContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductContract.

func (*ProductContract) UnmarshalJSON 

func (pc *ProductContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ProductContract struct.

type ProductContractProperties 

type ProductContractProperties struct {
	// DisplayName - Product name.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - Product description. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Terms - Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
	Terms *string `json:"terms,omitempty"`
	// SubscriptionRequired - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
	SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
	// ApprovalRequired - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
	ApprovalRequired *bool `json:"approvalRequired,omitempty"`
	// SubscriptionsLimit - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
	SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`
	// State - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'NotPublished', 'Published'
	State ProductState `json:"state,omitempty"`
}

ProductContractProperties product profile.

type ProductEntityBaseParameters 

type ProductEntityBaseParameters struct {
	// Description - Product description. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Terms - Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
	Terms *string `json:"terms,omitempty"`
	// SubscriptionRequired - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
	SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
	// ApprovalRequired - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
	ApprovalRequired *bool `json:"approvalRequired,omitempty"`
	// SubscriptionsLimit - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
	SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`
	// State - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'NotPublished', 'Published'
	State ProductState `json:"state,omitempty"`
}

ProductEntityBaseParameters product Entity Base Parameters

type ProductGroupClient 

type ProductGroupClient struct {
	BaseClient
}

ProductGroupClient is the apiManagement Client

func NewProductGroupClient 

func NewProductGroupClient(subscriptionID string) ProductGroupClient

NewProductGroupClient creates an instance of the ProductGroupClient client.

func NewProductGroupClientWithBaseURI 

func NewProductGroupClientWithBaseURI(baseURI string, subscriptionID string) ProductGroupClient

NewProductGroupClientWithBaseURI creates an instance of the ProductGroupClient client.

func (ProductGroupClient) CheckEntityExists 

func (client ProductGroupClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (result autorest.Response, err error)

CheckEntityExists checks that Group entity specified by identifier is associated with the Product entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. groupID - group identifier. Must be unique in the current API Management service instance.

func (ProductGroupClient) CheckEntityExistsPreparer 

func (client ProductGroupClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (*http.Request, error)

CheckEntityExistsPreparer prepares the CheckEntityExists request.

func (ProductGroupClient) CheckEntityExistsResponder 

func (client ProductGroupClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)

CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.

func (ProductGroupClient) CheckEntityExistsSender 

func (client ProductGroupClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)

CheckEntityExistsSender sends the CheckEntityExists request. The method will close the http.Response Body if it receives an error.

func (ProductGroupClient) CreateOrUpdate 

func (client ProductGroupClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (result GroupContract, err error)

CreateOrUpdate adds the association between the specified developer group with the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. groupID - group identifier. Must be unique in the current API Management service instance.

func (ProductGroupClient) CreateOrUpdatePreparer 

func (client ProductGroupClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductGroupClient) CreateOrUpdateResponder 

func (client ProductGroupClient) CreateOrUpdateResponder(resp *http.Response) (result GroupContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ProductGroupClient) CreateOrUpdateSender 

func (client ProductGroupClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ProductGroupClient) Delete 

func (client ProductGroupClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (result autorest.Response, err error)

Delete deletes the association between the specified group and product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. groupID - group identifier. Must be unique in the current API Management service instance.

func (ProductGroupClient) DeletePreparer 

func (client ProductGroupClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProductGroupClient) DeleteResponder 

func (client ProductGroupClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ProductGroupClient) DeleteSender 

func (client ProductGroupClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ProductGroupClient) ListByProduct 

func (client ProductGroupClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)

ListByProduct lists the collection of developer groups associated with the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. filter - | 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 - number of records to return. skip - number of records to skip.

func (ProductGroupClient) ListByProductComplete 

func (client ProductGroupClient) ListByProductComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)

ListByProductComplete enumerates all values, automatically crossing page boundaries as required.

func (ProductGroupClient) ListByProductPreparer 

func (client ProductGroupClient) ListByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ProductGroupClient) ListByProductResponder 

func (client ProductGroupClient) ListByProductResponder(resp *http.Response) (result GroupCollection, err error)

ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.

func (ProductGroupClient) ListByProductSender 

func (client ProductGroupClient) ListByProductSender(req *http.Request) (*http.Response, error)

ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.

type ProductPolicyClient 

type ProductPolicyClient struct {
	BaseClient
}

ProductPolicyClient is the 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 PolicyContract, ifMatch string) (result PolicyContract, err error)

CreateOrUpdate creates or updates policy configuration for the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. parameters - the policy contents to apply. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (ProductPolicyClient) CreateOrUpdatePreparer 

func (client ProductPolicyClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters PolicyContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductPolicyClient) CreateOrUpdateResponder 

func (client ProductPolicyClient) CreateOrUpdateResponder(resp *http.Response) (result PolicyContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ProductPolicyClient) CreateOrUpdateSender 

func (client ProductPolicyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ProductPolicyClient) Delete 

func (client ProductPolicyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string) (result autorest.Response, err error)

Delete deletes the policy configuration at the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

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 PolicyContract, err error)

Get get the policy configuration at the Product level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance.

func (ProductPolicyClient) GetEntityTag 

func (client ProductPolicyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, productID string) (result autorest.Response, err error)

GetEntityTag get the ETag of the policy configuration at the Product level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance.

func (ProductPolicyClient) GetEntityTagPreparer 

func (client ProductPolicyClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (ProductPolicyClient) GetEntityTagResponder 

func (client ProductPolicyClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (ProductPolicyClient) GetEntityTagSender 

func (client ProductPolicyClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.

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 PolicyContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ProductPolicyClient) GetSender 

func (client ProductPolicyClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ProductPolicyClient) ListByProduct 

func (client ProductPolicyClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string) (result PolicyCollection, err error)

ListByProduct get the policy configuration at the Product level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance.

func (ProductPolicyClient) ListByProductPreparer 

func (client ProductPolicyClient) ListByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ProductPolicyClient) ListByProductResponder 

func (client ProductPolicyClient) ListByProductResponder(resp *http.Response) (result PolicyCollection, err error)

ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.

func (ProductPolicyClient) ListByProductSender 

func (client ProductPolicyClient) ListByProductSender(req *http.Request) (*http.Response, error)

ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.

type ProductState 

type ProductState string

ProductState enumerates the values for product state. 

const (
	// NotPublished ...
	NotPublished ProductState = "notPublished"
	// Published ...
	Published ProductState = "published"
)

func PossibleProductStateValues 

func PossibleProductStateValues() []ProductState

PossibleProductStateValues returns an array of possible values for the ProductState const type.

type ProductSubscriptionsClient 

type ProductSubscriptionsClient struct {
	BaseClient
}

ProductSubscriptionsClient is the 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) List 

func (client ProductSubscriptionsClient) List(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)

List lists the collection of subscriptions to the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. filter - | 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 - number of records to return. skip - number of records to skip.

func (ProductSubscriptionsClient) ListComplete 

func (client ProductSubscriptionsClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ProductSubscriptionsClient) ListPreparer 

func (client ProductSubscriptionsClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (ProductSubscriptionsClient) ListResponder 

func (client ProductSubscriptionsClient) ListResponder(resp *http.Response) (result SubscriptionCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ProductSubscriptionsClient) ListSender 

func (client ProductSubscriptionsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ProductTagResourceContractProperties 

type ProductTagResourceContractProperties struct {
	// ID - Identifier of the product in the form of /products/{productId}
	ID *string `json:"id,omitempty"`
	// Name - Product name.
	Name *string `json:"name,omitempty"`
	// Description - Product description. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Terms - Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
	Terms *string `json:"terms,omitempty"`
	// SubscriptionRequired - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
	SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
	// ApprovalRequired - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
	ApprovalRequired *bool `json:"approvalRequired,omitempty"`
	// SubscriptionsLimit - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
	SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`
	// State - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'NotPublished', 'Published'
	State ProductState `json:"state,omitempty"`
}

ProductTagResourceContractProperties product profile.

type ProductUpdateParameters 

type ProductUpdateParameters struct {
	// ProductUpdateProperties - Product entity Update contract properties.
	*ProductUpdateProperties `json:"properties,omitempty"`
}

ProductUpdateParameters product Update parameters.

func (ProductUpdateParameters) MarshalJSON 

func (pup ProductUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProductUpdateParameters.

func (*ProductUpdateParameters) UnmarshalJSON 

func (pup *ProductUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ProductUpdateParameters struct.

type ProductUpdateProperties 

type ProductUpdateProperties struct {
	// DisplayName - Product name.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - Product description. May include HTML formatting tags.
	Description *string `json:"description,omitempty"`
	// Terms - Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
	Terms *string `json:"terms,omitempty"`
	// SubscriptionRequired - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
	SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
	// ApprovalRequired - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
	ApprovalRequired *bool `json:"approvalRequired,omitempty"`
	// SubscriptionsLimit - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
	SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`
	// State - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'NotPublished', 'Published'
	State ProductState `json:"state,omitempty"`
}

ProductUpdateProperties parameters supplied to the Update Product operation.

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 PropertyContract, ifMatch string) (result PropertyContract, err error)

CreateOrUpdate creates or updates a property. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (PropertyClient) CreateOrUpdatePreparer 

func (client PropertyClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, propID string, parameters PropertyContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PropertyClient) CreateOrUpdateResponder 

func (client PropertyClient) CreateOrUpdateResponder(resp *http.Response) (result PropertyContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (PropertyClient) CreateOrUpdateSender 

func (client PropertyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (PropertyClient) Delete 

func (client PropertyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, propID string, ifMatch string) (result autorest.Response, err error)

Delete deletes specific property from the the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

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 autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (PropertyClient) DeleteSender 

func (client PropertyClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (PropertyClient) Get 

func (client PropertyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, propID string) (result PropertyContract, err error)

Get gets the details of the property specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property.

func (PropertyClient) GetEntityTag 

func (client PropertyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, propID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the property specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property.

func (PropertyClient) GetEntityTagPreparer 

func (client PropertyClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, propID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (PropertyClient) GetEntityTagResponder 

func (client PropertyClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (PropertyClient) GetEntityTagSender 

func (client PropertyClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.

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) ListByService 

func (client PropertyClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip.

func (PropertyClient) ListByServiceComplete 

func (client PropertyClient) 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 (PropertyClient) ListByServicePreparer 

func (client PropertyClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (PropertyClient) ListByServiceResponder 

func (client PropertyClient) 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 (PropertyClient) ListByServiceSender 

func (client PropertyClient) 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 (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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

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"`
	// 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 NewPropertyCollectionIterator 

func NewPropertyCollectionIterator(page PropertyCollectionPage) PropertyCollectionIterator

Creates a new instance of the PropertyCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*PropertyCollectionIterator) NextWithContext 

func (iter *PropertyCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewPropertyCollectionPage 

func NewPropertyCollectionPage(getNextPage func(context.Context, PropertyCollection) (PropertyCollection, error)) PropertyCollectionPage

Creates a new instance of the PropertyCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*PropertyCollectionPage) NextWithContext 

func (page *PropertyCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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:"-"`
	// PropertyContractProperties - Property entity contract properties.
	*PropertyContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

PropertyContract property details.

func (PropertyContract) MarshalJSON 

func (pc PropertyContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PropertyContract.

func (*PropertyContract) UnmarshalJSON 

func (pc *PropertyContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PropertyContract struct.

type PropertyContractProperties 

type PropertyContractProperties struct {
	// DisplayName - Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
	DisplayName *string `json:"displayName,omitempty"`
	// Value - Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
	Value *string `json:"value,omitempty"`
	// Tags - Optional tags that when provided can be used to filter the property list.
	Tags *[]string `json:"tags,omitempty"`
	// Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
	Secret *bool `json:"secret,omitempty"`
}

PropertyContractProperties property Contract properties.

type PropertyEntityBaseParameters 

type PropertyEntityBaseParameters struct {
	// Tags - Optional tags that when provided can be used to filter the property list.
	Tags *[]string `json:"tags,omitempty"`
	// Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
	Secret *bool `json:"secret,omitempty"`
}

PropertyEntityBaseParameters property Entity Base Parameters set.

type PropertyUpdateParameterProperties 

type PropertyUpdateParameterProperties struct {
	// DisplayName - Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
	DisplayName *string `json:"displayName,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"`
}

PropertyUpdateParameterProperties property Contract properties.

type PropertyUpdateParameters 

type PropertyUpdateParameters struct {
	// PropertyUpdateParameterProperties - Property entity Update contract properties.
	*PropertyUpdateParameterProperties `json:"properties,omitempty"`
}

PropertyUpdateParameters property update Parameters.

func (PropertyUpdateParameters) MarshalJSON 

func (pup PropertyUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PropertyUpdateParameters.

func (*PropertyUpdateParameters) UnmarshalJSON 

func (pup *PropertyUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PropertyUpdateParameters struct.

type Protocol 

type Protocol string

Protocol enumerates the values for protocol. 

const (
	// ProtocolHTTP ...
	ProtocolHTTP Protocol = "http"
	// ProtocolHTTPS ...
	ProtocolHTTPS Protocol = "https"
)

func PossibleProtocolValues 

func PossibleProtocolValues() []Protocol

PossibleProtocolValues returns an array of possible values for the Protocol const type.

type QuotaByCounterKeysClient 

type QuotaByCounterKeysClient struct {
	BaseClient
}

QuotaByCounterKeysClient is the 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key

func (QuotaByCounterKeysClient) 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 QuotaCounterValueContractProperties) (result autorest.Response, err error)

Update updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key parameters - 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 QuotaCounterValueContractProperties) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (QuotaByCounterKeysClient) UpdateResponder 

func (client QuotaByCounterKeysClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (QuotaByCounterKeysClient) UpdateSender 

func (client QuotaByCounterKeysClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type QuotaByPeriodKeysClient 

type QuotaByPeriodKeysClient struct {
	BaseClient
}

QuotaByPeriodKeysClient is the 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key quotaPeriodKey - 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 QuotaCounterValueContractProperties) (result autorest.Response, err error)

Update updates an existing quota counter value in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key quotaPeriodKey - quota period key identifier. parameters - 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 QuotaCounterValueContractProperties) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (QuotaByPeriodKeysClient) UpdateResponder 

func (client QuotaByPeriodKeysClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (QuotaByPeriodKeysClient) UpdateSender 

func (client QuotaByPeriodKeysClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type QuotaCounterCollection 

type QuotaCounterCollection struct {
	autorest.Response `json:"-"`
	// Value - Quota counter values.
	Value *[]QuotaCounterContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

QuotaCounterCollection paged Quota Counter list representation.

type QuotaCounterContract 

type QuotaCounterContract struct {
	autorest.Response `json:"-"`
	// CounterKey - The Key value of the Counter. Must not be empty.
	CounterKey *string `json:"counterKey,omitempty"`
	// PeriodKey - Identifier of the Period for which the counter was collected. Must not be empty.
	PeriodKey *string `json:"periodKey,omitempty"`
	// PeriodStartTime - The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	PeriodStartTime *date.Time `json:"periodStartTime,omitempty"`
	// PeriodEndTime - The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	PeriodEndTime *date.Time `json:"periodEndTime,omitempty"`
	// Value - Quota Value Properties
	Value *QuotaCounterValueContractProperties `json:"value,omitempty"`
}

QuotaCounterContract quota counter details.

type QuotaCounterValueContract 

type QuotaCounterValueContract struct {
	// QuotaCounterValueContractProperties - Quota counter Value Properties.
	*QuotaCounterValueContractProperties `json:"value,omitempty"`
}

QuotaCounterValueContract quota counter value details.

func (QuotaCounterValueContract) MarshalJSON 

func (qcvc QuotaCounterValueContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QuotaCounterValueContract.

func (*QuotaCounterValueContract) UnmarshalJSON 

func (qcvc *QuotaCounterValueContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for QuotaCounterValueContract struct.

type QuotaCounterValueContractProperties 

type QuotaCounterValueContractProperties struct {
	// CallsCount - Number of times Counter was called.
	CallsCount *int32 `json:"callsCount,omitempty"`
	// KbTransferred - Data Transferred in KiloBytes.
	KbTransferred *float64 `json:"kbTransferred,omitempty"`
}

QuotaCounterValueContractProperties quota counter value details.

type RecipientEmailCollection 

type RecipientEmailCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]RecipientEmailContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

RecipientEmailCollection paged Recipient User list representation.

type RecipientEmailContract 

type RecipientEmailContract struct {
	autorest.Response `json:"-"`
	// RecipientEmailContractProperties - Recipient Email contract properties.
	*RecipientEmailContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

RecipientEmailContract recipient Email details.

func (RecipientEmailContract) MarshalJSON 

func (rec RecipientEmailContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RecipientEmailContract.

func (*RecipientEmailContract) UnmarshalJSON 

func (rec *RecipientEmailContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RecipientEmailContract struct.

type RecipientEmailContractProperties 

type RecipientEmailContractProperties struct {
	// Email - User Email subscribed to notification.
	Email *string `json:"email,omitempty"`
}

RecipientEmailContractProperties recipient Email Contract Properties.

type RecipientUserCollection 

type RecipientUserCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]RecipientUserContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

RecipientUserCollection paged Recipient User list representation.

type RecipientUserContract 

type RecipientUserContract struct {
	autorest.Response `json:"-"`
	// RecipientUsersContractProperties - Recipient User entity contract properties.
	*RecipientUsersContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

RecipientUserContract recipient User details.

func (RecipientUserContract) MarshalJSON 

func (ruc RecipientUserContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RecipientUserContract.

func (*RecipientUserContract) UnmarshalJSON 

func (ruc *RecipientUserContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RecipientUserContract struct.

type RecipientUsersContractProperties 

type RecipientUsersContractProperties struct {
	// UserID - API Management UserId subscribed to notification.
	UserID *string `json:"userId,omitempty"`
}

RecipientUsersContractProperties recipient User Contract Properties.

type RecipientsContractProperties 

type RecipientsContractProperties struct {
	// Emails - List of Emails subscribed for the notification.
	Emails *[]string `json:"emails,omitempty"`
	// Users - List of Users subscribed for the notification.
	Users *[]string `json:"users,omitempty"`
}

RecipientsContractProperties notification Parameter contract.

type RegionContract 

type RegionContract struct {
	// Name - Region name.
	Name *string `json:"name,omitempty"`
	// IsMasterRegion - whether Region is the master region.
	IsMasterRegion *bool `json:"isMasterRegion,omitempty"`
	// IsDeleted - whether Region is deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`
}

RegionContract region profile.

type RegionListResult 

type RegionListResult struct {
	autorest.Response `json:"-"`
	// Value - Lists of Regions.
	Value *[]RegionContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

RegionListResult lists Regions operation response details.

func (RegionListResult) IsEmpty 

func (rlr RegionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RegionListResultIterator 

type RegionListResultIterator struct {
	// contains filtered or unexported fields
}

RegionListResultIterator provides access to a complete listing of RegionContract values.

func NewRegionListResultIterator 

func NewRegionListResultIterator(page RegionListResultPage) RegionListResultIterator

Creates a new instance of the RegionListResultIterator type.

func (*RegionListResultIterator) Next 

func (iter *RegionListResultIterator) 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. Deprecated: Use NextWithContext() instead.

func (*RegionListResultIterator) NextWithContext 

func (iter *RegionListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (RegionListResultIterator) NotDone 

func (iter RegionListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (RegionListResultIterator) Response 

func (iter RegionListResultIterator) Response() RegionListResult

Response returns the raw server response from the last page request.

func (RegionListResultIterator) Value 

func (iter RegionListResultIterator) Value() RegionContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type RegionListResultPage 

type RegionListResultPage struct {
	// contains filtered or unexported fields
}

RegionListResultPage contains a page of RegionContract values.

func NewRegionListResultPage 

func NewRegionListResultPage(getNextPage func(context.Context, RegionListResult) (RegionListResult, error)) RegionListResultPage

Creates a new instance of the RegionListResultPage type.

func (*RegionListResultPage) Next 

func (page *RegionListResultPage) 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. Deprecated: Use NextWithContext() instead.

func (*RegionListResultPage) NextWithContext 

func (page *RegionListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (RegionListResultPage) NotDone 

func (page RegionListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (RegionListResultPage) Response 

func (page RegionListResultPage) Response() RegionListResult

Response returns the raw server response from the last page request.

func (RegionListResultPage) Values 

func (page RegionListResultPage) Values() []RegionContract

Values returns the slice of values for the current page or nil if there are no values.

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 RegionListResultPage, err error)

ListByService lists all azure regions in which the service exists. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (RegionsClient) ListByServiceComplete 

func (client RegionsClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string) (result RegionListResultIterator, err error)

ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.

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 RegistrationDelegationSettingsProperties 

type RegistrationDelegationSettingsProperties struct {
	// Enabled - Enable or disable delegation for user registration.
	Enabled *bool `json:"enabled,omitempty"`
}

RegistrationDelegationSettingsProperties user registration delegation settings properties.

type ReportCollection 

type ReportCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]ReportRecordContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

ReportCollection paged Report records list representation.

func (ReportCollection) IsEmpty 

func (rc ReportCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ReportCollectionIterator 

type ReportCollectionIterator struct {
	// contains filtered or unexported fields
}

ReportCollectionIterator provides access to a complete listing of ReportRecordContract values.

func NewReportCollectionIterator 

func NewReportCollectionIterator(page ReportCollectionPage) ReportCollectionIterator

Creates a new instance of the ReportCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*ReportCollectionIterator) NextWithContext 

func (iter *ReportCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewReportCollectionPage 

func NewReportCollectionPage(getNextPage func(context.Context, ReportCollection) (ReportCollection, error)) ReportCollectionPage

Creates a new instance of the ReportCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*ReportCollectionPage) NextWithContext 

func (page *ReportCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ReportCollectionPage) NotDone 

func (page ReportCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ReportCollectionPage) Response 

func (page ReportCollectionPage) Response() ReportCollection

Response returns the raw server response from the last page request.

func (ReportCollectionPage) Values 

func (page ReportCollectionPage) Values() []ReportRecordContract

Values returns the slice of values for the current page or nil if there are no values.

type ReportRecordContract 

type ReportRecordContract struct {
	// Name - Name depending on report endpoint specifies product, API, operation or developer name.
	Name *string `json:"name,omitempty"`
	// Timestamp - Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// Interval - Length of agregation period.  Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).
	Interval *string `json:"interval,omitempty"`
	// Country - Country to which this record data is related.
	Country *string `json:"country,omitempty"`
	// Region - Country region to which this record data is related.
	Region *string `json:"region,omitempty"`
	// Zip - Zip code to which this record data is related.
	Zip *string `json:"zip,omitempty"`
	// UserID - User identifier path. /users/{userId}
	UserID *string `json:"userId,omitempty"`
	// ProductID - Product identifier path. /products/{productId}
	ProductID *string `json:"productId,omitempty"`
	// APIID - API identifier path. /apis/{apiId}
	APIID *string `json:"apiId,omitempty"`
	// OperationID - Operation identifier path. /apis/{apiId}/operations/{operationId}
	OperationID *string `json:"operationId,omitempty"`
	// APIRegion - API region identifier.
	APIRegion *string `json:"apiRegion,omitempty"`
	// SubscriptionID - Subscription identifier path. /subscriptions/{subscriptionId}
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	// CallCountSuccess - Number of succesful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect
	CallCountSuccess *int32 `json:"callCountSuccess,omitempty"`
	// CallCountBlocked - Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorize and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests
	CallCountBlocked *int32 `json:"callCountBlocked,omitempty"`
	// CallCountFailed - Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600
	CallCountFailed *int32 `json:"callCountFailed,omitempty"`
	// CallCountOther - Number of other calls.
	CallCountOther *int32 `json:"callCountOther,omitempty"`
	// CallCountTotal - Total number of calls.
	CallCountTotal *int32 `json:"callCountTotal,omitempty"`
	// Bandwidth - Bandwidth consumed.
	Bandwidth *int64 `json:"bandwidth,omitempty"`
	// CacheHitCount - Number of times when content was served from cache policy.
	CacheHitCount *int32 `json:"cacheHitCount,omitempty"`
	// CacheMissCount - Number of times content was fetched from backend.
	CacheMissCount *int32 `json:"cacheMissCount,omitempty"`
	// APITimeAvg - Average time it took to process request.
	APITimeAvg *float64 `json:"apiTimeAvg,omitempty"`
	// APITimeMin - Minimum time it took to process request.
	APITimeMin *float64 `json:"apiTimeMin,omitempty"`
	// APITimeMax - Maximum time it took to process request.
	APITimeMax *float64 `json:"apiTimeMax,omitempty"`
	// ServiceTimeAvg - Average time it took to process request on backend.
	ServiceTimeAvg *float64 `json:"serviceTimeAvg,omitempty"`
	// ServiceTimeMin - Minimum time it took to process request on backend.
	ServiceTimeMin *float64 `json:"serviceTimeMin,omitempty"`
	// ServiceTimeMax - Maximum time it took to process request on backend.
	ServiceTimeMax *float64 `json:"serviceTimeMax,omitempty"`
}

ReportRecordContract report data.

type ReportsClient 

type ReportsClient struct {
	BaseClient
}

ReportsClient is the 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) ListByAPI 

func (client ReportsClient) ListByAPI(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByAPI lists report records by API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.

func (ReportsClient) ListByAPIComplete 

func (client ReportsClient) ListByAPIComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByAPIPreparer 

func (client ReportsClient) ListByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByAPIPreparer prepares the ListByAPI request.

func (ReportsClient) ListByAPIResponder 

func (client ReportsClient) ListByAPIResponder(resp *http.Response) (result ReportCollection, err error)

ListByAPIResponder handles the response to the ListByAPI request. The method always closes the http.Response Body.

func (ReportsClient) ListByAPISender 

func (client ReportsClient) ListByAPISender(req *http.Request) (*http.Response, error)

ListByAPISender sends the ListByAPI request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByGeo 

func (client ReportsClient) ListByGeo(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByGeo lists report records by GeoGraphy. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.

func (ReportsClient) ListByGeoComplete 

func (client ReportsClient) ListByGeoComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByGeoComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByGeoPreparer 

func (client ReportsClient) ListByGeoPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByGeoPreparer prepares the ListByGeo request.

func (ReportsClient) ListByGeoResponder 

func (client ReportsClient) ListByGeoResponder(resp *http.Response) (result ReportCollection, err error)

ListByGeoResponder handles the response to the ListByGeo request. The method always closes the http.Response Body.

func (ReportsClient) ListByGeoSender 

func (client ReportsClient) ListByGeoSender(req *http.Request) (*http.Response, error)

ListByGeoSender sends the ListByGeo request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByOperation 

func (client ReportsClient) ListByOperation(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByOperation lists report records by API Operations. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.

func (ReportsClient) ListByOperationComplete 

func (client ReportsClient) ListByOperationComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByOperationComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByOperationPreparer 

func (client ReportsClient) ListByOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByOperationPreparer prepares the ListByOperation request.

func (ReportsClient) ListByOperationResponder 

func (client ReportsClient) ListByOperationResponder(resp *http.Response) (result ReportCollection, err error)

ListByOperationResponder handles the response to the ListByOperation request. The method always closes the http.Response Body.

func (ReportsClient) ListByOperationSender 

func (client ReportsClient) ListByOperationSender(req *http.Request) (*http.Response, error)

ListByOperationSender sends the ListByOperation request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByProduct 

func (client ReportsClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByProduct lists report records by Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.

func (ReportsClient) ListByProductComplete 

func (client ReportsClient) ListByProductComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByProductComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByProductPreparer 

func (client ReportsClient) ListByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ReportsClient) ListByProductResponder 

func (client ReportsClient) ListByProductResponder(resp *http.Response) (result ReportCollection, err error)

ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.

func (ReportsClient) ListByProductSender 

func (client ReportsClient) ListByProductSender(req *http.Request) (*http.Response, error)

ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByRequest 

func (client ReportsClient) ListByRequest(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result RequestReportCollection, err error)

ListByRequest lists report records by Request. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.

func (ReportsClient) ListByRequestPreparer 

func (client ReportsClient) ListByRequestPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByRequestPreparer prepares the ListByRequest request.

func (ReportsClient) ListByRequestResponder 

func (client ReportsClient) ListByRequestResponder(resp *http.Response) (result RequestReportCollection, err error)

ListByRequestResponder handles the response to the ListByRequest request. The method always closes the http.Response Body.

func (ReportsClient) ListByRequestSender 

func (client ReportsClient) ListByRequestSender(req *http.Request) (*http.Response, error)

ListByRequestSender sends the ListByRequest request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListBySubscription 

func (client ReportsClient) ListBySubscription(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListBySubscription lists report records by subscription. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.

func (ReportsClient) ListBySubscriptionComplete 

func (client ReportsClient) ListBySubscriptionComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListBySubscriptionPreparer 

func (client ReportsClient) ListBySubscriptionPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (ReportsClient) ListBySubscriptionResponder 

func (client ReportsClient) ListBySubscriptionResponder(resp *http.Response) (result ReportCollection, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (ReportsClient) ListBySubscriptionSender 

func (client ReportsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByTime 

func (client ReportsClient) ListByTime(ctx context.Context, resourceGroupName string, serviceName string, interval string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByTime lists report records by Time. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. interval - by time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds)) filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.

func (ReportsClient) ListByTimeComplete 

func (client ReportsClient) ListByTimeComplete(ctx context.Context, resourceGroupName string, serviceName string, interval string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByTimeComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByTimePreparer 

func (client ReportsClient) ListByTimePreparer(ctx context.Context, resourceGroupName string, serviceName string, interval string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByTimePreparer prepares the ListByTime request.

func (ReportsClient) ListByTimeResponder 

func (client ReportsClient) ListByTimeResponder(resp *http.Response) (result ReportCollection, err error)

ListByTimeResponder handles the response to the ListByTime request. The method always closes the http.Response Body.

func (ReportsClient) ListByTimeSender 

func (client ReportsClient) ListByTimeSender(req *http.Request) (*http.Response, error)

ListByTimeSender sends the ListByTime request. The method will close the http.Response Body if it receives an error.

func (ReportsClient) ListByUser 

func (client ReportsClient) ListByUser(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)

ListByUser lists report records by User. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.

func (ReportsClient) ListByUserComplete 

func (client ReportsClient) ListByUserComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)

ListByUserComplete enumerates all values, automatically crossing page boundaries as required.

func (ReportsClient) ListByUserPreparer 

func (client ReportsClient) ListByUserPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByUserPreparer prepares the ListByUser request.

func (ReportsClient) ListByUserResponder 

func (client ReportsClient) ListByUserResponder(resp *http.Response) (result ReportCollection, err error)

ListByUserResponder handles the response to the ListByUser request. The method always closes the http.Response Body.

func (ReportsClient) ListByUserSender 

func (client ReportsClient) ListByUserSender(req *http.Request) (*http.Response, error)

ListByUserSender sends the ListByUser request. The method will close the http.Response Body if it receives an error.

type RepresentationContract 

type RepresentationContract struct {
	// ContentType - Specifies a registered or custom content type for this representation, e.g. application/xml.
	ContentType *string `json:"contentType,omitempty"`
	// Sample - An example of the representation.
	Sample *string `json:"sample,omitempty"`
	// SchemaID - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
	SchemaID *string `json:"schemaId,omitempty"`
	// TypeName - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
	TypeName *string `json:"typeName,omitempty"`
	// FormParameters - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
	FormParameters *[]ParameterContract `json:"formParameters,omitempty"`
}

RepresentationContract operation request/response representation details.

type RequestContract 

type RequestContract struct {
	// Description - Operation request description.
	Description *string `json:"description,omitempty"`
	// QueryParameters - Collection of operation request query parameters.
	QueryParameters *[]ParameterContract `json:"queryParameters,omitempty"`
	// Headers - Collection of operation request headers.
	Headers *[]ParameterContract `json:"headers,omitempty"`
	// Representations - Collection of operation request representations.
	Representations *[]RepresentationContract `json:"representations,omitempty"`
}

RequestContract operation request details.

type RequestReportCollection 

type RequestReportCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]RequestReportRecordContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
}

RequestReportCollection paged Report records list representation.

type RequestReportRecordContract 

type RequestReportRecordContract struct {
	// APIID - API identifier path. /apis/{apiId}
	APIID *string `json:"apiId,omitempty"`
	// OperationID - Operation identifier path. /apis/{apiId}/operations/{operationId}
	OperationID *string `json:"operationId,omitempty"`
	// ProductID - Product identifier path. /products/{productId}
	ProductID *string `json:"productId,omitempty"`
	// UserID - User identifier path. /users/{userId}
	UserID *string `json:"userId,omitempty"`
	// Method - The HTTP method associated with this request..
	Method *string `json:"method,omitempty"`
	// URL - The full URL associated with this request.
	URL *string `json:"url,omitempty"`
	// IPAddress - The client IP address associated with this request.
	IPAddress *string `json:"ipAddress,omitempty"`
	// BackendResponseCode - The HTTP status code received by the gateway as a result of forwarding this request to the backend.
	BackendResponseCode *string `json:"backendResponseCode,omitempty"`
	// ResponseCode - The HTTP status code returned by the gateway.
	ResponseCode *int32 `json:"responseCode,omitempty"`
	// ResponseSize - The size of the response returned by the gateway.
	ResponseSize *int32 `json:"responseSize,omitempty"`
	// Timestamp - The date and time when this request was received by the gateway in ISO 8601 format.
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// Cache - Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fullfilled by the backend.
	Cache *string `json:"cache,omitempty"`
	// APITime - The total time it took to process this request.
	APITime *float64 `json:"apiTime,omitempty"`
	// ServiceTime - he time it took to forward this request to the backend and get the response back.
	ServiceTime *float64 `json:"serviceTime,omitempty"`
	// APIRegion - Azure region where the gateway that processed this request is located.
	APIRegion *string `json:"apiRegion,omitempty"`
	// SubscriptionID - Subscription identifier path. /subscriptions/{subscriptionId}
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	// RequestID - Request Identifier.
	RequestID *string `json:"requestId,omitempty"`
	// RequestSize - The size of this request..
	RequestSize *int32 `json:"requestSize,omitempty"`
}

RequestReportRecordContract request Report data.

type 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.
	Type *string `json:"type,omitempty"`
}

Resource the Resource definition.

type ResponseContract 

type ResponseContract struct {
	// StatusCode - Operation response HTTP status code.
	StatusCode *int32 `json:"statusCode,omitempty"`
	// Description - Operation response description.
	Description *string `json:"description,omitempty"`
	// Representations - Collection of operation response representations.
	Representations *[]RepresentationContract `json:"representations,omitempty"`
	// Headers - Collection of operation response headers.
	Headers *[]ParameterContract `json:"headers,omitempty"`
}

ResponseContract operation response details.

type SaveConfigurationParameter 

type SaveConfigurationParameter struct {
	// Branch - The name of the Git branch in which to commit the current configuration snapshot.
	Branch *string `json:"branch,omitempty"`
	// Force - The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten.
	Force *bool `json:"force,omitempty"`
}

SaveConfigurationParameter parameters supplied to the Save Tenant Configuration operation.

type SchemaCollection 

type SchemaCollection struct {
	autorest.Response `json:"-"`
	// Value - Api Schema Contract value.
	Value *[]SchemaContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

SchemaCollection the response of the list schema operation.

func (SchemaCollection) IsEmpty 

func (sc SchemaCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type SchemaCollectionIterator 

type SchemaCollectionIterator struct {
	// contains filtered or unexported fields
}

SchemaCollectionIterator provides access to a complete listing of SchemaContract values.

func NewSchemaCollectionIterator 

func NewSchemaCollectionIterator(page SchemaCollectionPage) SchemaCollectionIterator

Creates a new instance of the SchemaCollectionIterator type.

func (*SchemaCollectionIterator) Next 

func (iter *SchemaCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*SchemaCollectionIterator) NextWithContext 

func (iter *SchemaCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (SchemaCollectionIterator) NotDone 

func (iter SchemaCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (SchemaCollectionIterator) Response 

func (iter SchemaCollectionIterator) Response() SchemaCollection

Response returns the raw server response from the last page request.

func (SchemaCollectionIterator) Value 

func (iter SchemaCollectionIterator) Value() SchemaContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type SchemaCollectionPage 

type SchemaCollectionPage struct {
	// contains filtered or unexported fields
}

SchemaCollectionPage contains a page of SchemaContract values.

func NewSchemaCollectionPage 

func NewSchemaCollectionPage(getNextPage func(context.Context, SchemaCollection) (SchemaCollection, error)) SchemaCollectionPage

Creates a new instance of the SchemaCollectionPage type.

func (*SchemaCollectionPage) Next 

func (page *SchemaCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*SchemaCollectionPage) NextWithContext 

func (page *SchemaCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (SchemaCollectionPage) NotDone 

func (page SchemaCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (SchemaCollectionPage) Response 

func (page SchemaCollectionPage) Response() SchemaCollection

Response returns the raw server response from the last page request.

func (SchemaCollectionPage) Values 

func (page SchemaCollectionPage) Values() []SchemaContract

Values returns the slice of values for the current page or nil if there are no values.

type SchemaContract 

type SchemaContract struct {
	autorest.Response `json:"-"`
	// SchemaContractProperties - Properties of the Schema.
	*SchemaContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

SchemaContract schema Contract details.

func (SchemaContract) MarshalJSON 

func (sc SchemaContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SchemaContract.

func (*SchemaContract) UnmarshalJSON 

func (sc *SchemaContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SchemaContract struct.

type SchemaContractProperties 

type SchemaContractProperties struct {
	// ContentType - Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
	ContentType *string `json:"contentType,omitempty"`
	// SchemaDocumentProperties - Properties of the Schema Document.
	*SchemaDocumentProperties `json:"document,omitempty"`
}

SchemaContractProperties schema contract Properties.

func (SchemaContractProperties) MarshalJSON 

func (scp SchemaContractProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SchemaContractProperties.

func (*SchemaContractProperties) UnmarshalJSON 

func (scp *SchemaContractProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SchemaContractProperties struct.

type SchemaDocumentProperties 

type SchemaDocumentProperties struct {
	// Value - Json escaped string defining the document representing the Schema.
	Value *string `json:"value,omitempty"`
}

SchemaDocumentProperties schema Document Properties.

type ServiceApplyNetworkConfigurationParameters 

type ServiceApplyNetworkConfigurationParameters struct {
	// Location - Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required.
	Location *string `json:"location,omitempty"`
}

ServiceApplyNetworkConfigurationParameters parameter supplied to the Apply Network configuration operation.

type ServiceApplyNetworkConfigurationUpdatesFuture 

type ServiceApplyNetworkConfigurationUpdatesFuture struct {
	azure.Future
}

ServiceApplyNetworkConfigurationUpdatesFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ServiceApplyNetworkConfigurationUpdatesFuture) Result 

func (future *ServiceApplyNetworkConfigurationUpdatesFuture) Result(client ServiceClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ServiceBackupFuture 

type ServiceBackupFuture struct {
	azure.Future
}

ServiceBackupFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ServiceBackupFuture) Result 

func (future *ServiceBackupFuture) Result(client ServiceClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

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 ServiceBaseProperties 

type ServiceBaseProperties struct {
	// NotificationSenderEmail - Email address from which the notification will be sent.
	NotificationSenderEmail *string `json:"notificationSenderEmail,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"`
	// GatewayURL - Gateway URL of the API Management service.
	GatewayURL *string `json:"gatewayUrl,omitempty"`
	// GatewayRegionalURL - Gateway URL of the API Management service in the Default Region.
	GatewayRegionalURL *string `json:"gatewayRegionalUrl,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"`
	// HostnameConfigurations - Custom hostname configuration of the API Management service.
	HostnameConfigurations *[]HostnameConfiguration `json:"hostnameConfigurations,omitempty"`
	// PublicIPAddresses - Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
	PublicIPAddresses *[]string `json:"publicIPAddresses,omitempty"`
	// PrivateIPAddresses - Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU.
	PrivateIPAddresses *[]string `json:"privateIPAddresses,omitempty"`
	// VirtualNetworkConfiguration - Virtual network configuration of the API Management service.
	VirtualNetworkConfiguration *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`
	// AdditionalLocations - Additional datacenter locations of the API Management service.
	AdditionalLocations *[]AdditionalLocation `json:"additionalLocations,omitempty"`
	// CustomProperties - Custom properties of the API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1 and setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
	CustomProperties map[string]*string `json:"customProperties"`
	// Certificates - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
	Certificates *[]CertificateConfiguration `json:"certificates,omitempty"`
	// VirtualNetworkType - 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'
	VirtualNetworkType VirtualNetworkType `json:"virtualNetworkType,omitempty"`
}

ServiceBaseProperties base Properties of an API Management service resource description.

func (ServiceBaseProperties) MarshalJSON 

func (sbp ServiceBaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBaseProperties.

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 ServiceClient 

type ServiceClient struct {
	BaseClient
}

ServiceClient is the apiManagement Client

func NewServiceClient 

func NewServiceClient(subscriptionID string) ServiceClient

NewServiceClient creates an instance of the ServiceClient client.

func NewServiceClientWithBaseURI 

func NewServiceClientWithBaseURI(baseURI string, subscriptionID string) ServiceClient

NewServiceClientWithBaseURI creates an instance of the ServiceClient client.

func (ServiceClient) ApplyNetworkConfigurationUpdates 

func (client ServiceClient) ApplyNetworkConfigurationUpdates(ctx context.Context, resourceGroupName string, serviceName string, parameters *ServiceApplyNetworkConfigurationParameters) (result ServiceApplyNetworkConfigurationUpdatesFuture, err error)

ApplyNetworkConfigurationUpdates updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region.

func (ServiceClient) ApplyNetworkConfigurationUpdatesPreparer 

func (client ServiceClient) ApplyNetworkConfigurationUpdatesPreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters *ServiceApplyNetworkConfigurationParameters) (*http.Request, error)

ApplyNetworkConfigurationUpdatesPreparer prepares the ApplyNetworkConfigurationUpdates request.

func (ServiceClient) ApplyNetworkConfigurationUpdatesResponder 

func (client ServiceClient) 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 (ServiceClient) ApplyNetworkConfigurationUpdatesSender 

func (client ServiceClient) ApplyNetworkConfigurationUpdatesSender(req *http.Request) (future ServiceApplyNetworkConfigurationUpdatesFuture, err error)

ApplyNetworkConfigurationUpdatesSender sends the ApplyNetworkConfigurationUpdates request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) Backup 

func (client ServiceClient) Backup(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (result ServiceBackupFuture, 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the ApiManagementService_Backup operation.

func (ServiceClient) BackupPreparer 

func (client ServiceClient) BackupPreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (*http.Request, error)

BackupPreparer prepares the Backup request.

func (ServiceClient) BackupResponder 

func (client ServiceClient) 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 (ServiceClient) BackupSender 

func (client ServiceClient) BackupSender(req *http.Request) (future ServiceBackupFuture, err error)

BackupSender sends the Backup request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) CheckNameAvailability 

func (client ServiceClient) CheckNameAvailability(ctx context.Context, parameters ServiceCheckNameAvailabilityParameters) (result ServiceNameAvailabilityResult, err error)

CheckNameAvailability checks availability and correctness of a name for an API Management service. Parameters: parameters - parameters supplied to the CheckNameAvailability operation.

func (ServiceClient) CheckNameAvailabilityPreparer 

func (client ServiceClient) CheckNameAvailabilityPreparer(ctx context.Context, parameters ServiceCheckNameAvailabilityParameters) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (ServiceClient) CheckNameAvailabilityResponder 

func (client ServiceClient) 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 (ServiceClient) CheckNameAvailabilitySender 

func (client ServiceClient) 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 (ServiceClient) CreateOrUpdate 

func (client ServiceClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceResource) (result ServiceCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates an API Management service. This is long running operation and could take several minutes to complete. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the CreateOrUpdate API Management service operation.

func (ServiceClient) CreateOrUpdatePreparer 

func (client ServiceClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceResource) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ServiceClient) CreateOrUpdateResponder 

func (client ServiceClient) 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 (ServiceClient) CreateOrUpdateSender 

func (client ServiceClient) CreateOrUpdateSender(req *http.Request) (future ServiceCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) Delete 

func (client ServiceClient) Delete(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)

Delete deletes an existing API Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (ServiceClient) DeletePreparer 

func (client ServiceClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ServiceClient) DeleteResponder 

func (client ServiceClient) 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 (ServiceClient) DeleteSender 

func (client ServiceClient) 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 (ServiceClient) Get 

func (client ServiceClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result ServiceResource, err error)

Get gets an API Management service resource description. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (ServiceClient) GetPreparer 

func (client ServiceClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ServiceClient) GetResponder 

func (client ServiceClient) 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 (ServiceClient) GetSender 

func (client ServiceClient) 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 (ServiceClient) GetSsoToken 

func (client ServiceClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (ServiceClient) GetSsoTokenPreparer 

func (client ServiceClient) GetSsoTokenPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetSsoTokenPreparer prepares the GetSsoToken request.

func (ServiceClient) GetSsoTokenResponder 

func (client ServiceClient) 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 (ServiceClient) GetSsoTokenSender 

func (client ServiceClient) 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 (ServiceClient) List 

func (client ServiceClient) List(ctx context.Context) (result ServiceListResultPage, err error)

List lists all API Management services within an Azure subscription.

func (ServiceClient) ListByResourceGroup 

func (client ServiceClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ServiceListResultPage, err error)

ListByResourceGroup list all API Management services within a resource group. Parameters: resourceGroupName - the name of the resource group.

func (ServiceClient) ListByResourceGroupComplete 

func (client ServiceClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ServiceListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (ServiceClient) ListByResourceGroupPreparer 

func (client ServiceClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ServiceClient) ListByResourceGroupResponder 

func (client ServiceClient) 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 (ServiceClient) ListByResourceGroupSender 

func (client ServiceClient) 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 (ServiceClient) ListComplete 

func (client ServiceClient) ListComplete(ctx context.Context) (result ServiceListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ServiceClient) ListPreparer 

func (client ServiceClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (ServiceClient) ListResponder 

func (client ServiceClient) 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 (ServiceClient) ListSender 

func (client ServiceClient) 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 (ServiceClient) Restore 

func (client ServiceClient) Restore(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (result ServiceRestoreFuture, err error)

Restore restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the Restore API Management service from backup operation.

func (ServiceClient) RestorePreparer 

func (client ServiceClient) RestorePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (*http.Request, error)

RestorePreparer prepares the Restore request.

func (ServiceClient) RestoreResponder 

func (client ServiceClient) 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 (ServiceClient) RestoreSender 

func (client ServiceClient) RestoreSender(req *http.Request) (future ServiceRestoreFuture, err error)

RestoreSender sends the Restore request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) Update 

func (client ServiceClient) Update(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateParameters) (result ServiceUpdateFuture, err error)

Update updates an existing API Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the CreateOrUpdate API Management service operation.

func (ServiceClient) UpdateHostname 

func (client ServiceClient) UpdateHostname(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateHostnameParameters) (result ServiceUpdateHostnameFuture, 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. This operation will be deprecated in the next version update. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the UpdateHostname operation.

func (ServiceClient) UpdateHostnamePreparer 

func (client ServiceClient) UpdateHostnamePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateHostnameParameters) (*http.Request, error)

UpdateHostnamePreparer prepares the UpdateHostname request.

func (ServiceClient) UpdateHostnameResponder 

func (client ServiceClient) 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 (ServiceClient) UpdateHostnameSender 

func (client ServiceClient) UpdateHostnameSender(req *http.Request) (future ServiceUpdateHostnameFuture, err error)

UpdateHostnameSender sends the UpdateHostname request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) UpdatePreparer 

func (client ServiceClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ServiceClient) UpdateResponder 

func (client ServiceClient) 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 (ServiceClient) UpdateSender 

func (client ServiceClient) UpdateSender(req *http.Request) (future ServiceUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

func (ServiceClient) UploadCertificate 

func (client ServiceClient) 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. This operation will be deprecated in future releases. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the Upload SSL certificate for an API Management service operation.

func (ServiceClient) UploadCertificatePreparer 

func (client ServiceClient) UploadCertificatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUploadCertificateParameters) (*http.Request, error)

UploadCertificatePreparer prepares the UploadCertificate request.

func (ServiceClient) UploadCertificateResponder 

func (client ServiceClient) 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 (ServiceClient) UploadCertificateSender 

func (client ServiceClient) 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 ServiceCreateOrUpdateFuture 

type ServiceCreateOrUpdateFuture struct {
	azure.Future
}

ServiceCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ServiceCreateOrUpdateFuture) Result 

func (future *ServiceCreateOrUpdateFuture) Result(client ServiceClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ServiceGetSsoTokenResult 

type ServiceGetSsoTokenResult struct {
	autorest.Response `json:"-"`
	// RedirectURI - Redirect URL to the Publisher Portal containing the SSO token.
	RedirectURI *string `json:"redirectUri,omitempty"`
}

ServiceGetSsoTokenResult the response of the GetSsoToken operation.

type ServiceIdentity 

type ServiceIdentity struct {
	// Type - The identity type. Currently the only supported type is 'SystemAssigned'.
	Type *string `json:"type,omitempty"`
	// PrincipalID - The principal id of the identity.
	PrincipalID *uuid.UUID `json:"principalId,omitempty"`
	// TenantID - The client tenant id of the identity.
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
}

ServiceIdentity identity properties of the Api Management service resource.

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 NewServiceListResultIterator 

func NewServiceListResultIterator(page ServiceListResultPage) ServiceListResultIterator

Creates a new instance of the ServiceListResultIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*ServiceListResultIterator) NextWithContext 

func (iter *ServiceListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewServiceListResultPage 

func NewServiceListResultPage(getNextPage func(context.Context, ServiceListResult) (ServiceListResult, error)) ServiceListResultPage

Creates a new instance of the ServiceListResultPage type.

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. Deprecated: Use NextWithContext() instead.

func (*ServiceListResultPage) NextWithContext 

func (page *ServiceListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 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"`
	// NotificationSenderEmail - Email address from which the notification will be sent.
	NotificationSenderEmail *string `json:"notificationSenderEmail,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"`
	// GatewayURL - Gateway URL of the API Management service.
	GatewayURL *string `json:"gatewayUrl,omitempty"`
	// GatewayRegionalURL - Gateway URL of the API Management service in the Default Region.
	GatewayRegionalURL *string `json:"gatewayRegionalUrl,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"`
	// HostnameConfigurations - Custom hostname configuration of the API Management service.
	HostnameConfigurations *[]HostnameConfiguration `json:"hostnameConfigurations,omitempty"`
	// PublicIPAddresses - Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
	PublicIPAddresses *[]string `json:"publicIPAddresses,omitempty"`
	// PrivateIPAddresses - Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU.
	PrivateIPAddresses *[]string `json:"privateIPAddresses,omitempty"`
	// VirtualNetworkConfiguration - Virtual network configuration of the API Management service.
	VirtualNetworkConfiguration *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`
	// AdditionalLocations - Additional datacenter locations of the API Management service.
	AdditionalLocations *[]AdditionalLocation `json:"additionalLocations,omitempty"`
	// CustomProperties - Custom properties of the API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1 and setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
	CustomProperties map[string]*string `json:"customProperties"`
	// Certificates - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
	Certificates *[]CertificateConfiguration `json:"certificates,omitempty"`
	// VirtualNetworkType - 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'
	VirtualNetworkType VirtualNetworkType `json:"virtualNetworkType,omitempty"`
}

ServiceProperties properties of an API Management service resource description.

func (ServiceProperties) MarshalJSON 

func (sp ServiceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceProperties.

type ServiceResource 

type ServiceResource struct {
	autorest.Response `json:"-"`
	// ServiceProperties - Properties of the API Management service.
	*ServiceProperties `json:"properties,omitempty"`
	// Sku - SKU properties of the API Management service.
	Sku *ServiceSkuProperties `json:"sku,omitempty"`
	// Identity - Managed service identity of the Api Management service.
	Identity *ServiceIdentity `json:"identity,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Etag - ETag of the resource.
	Etag *string `json:"etag,omitempty"`
	// 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"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

ServiceResource a single API Management service resource in List or Get response.

func (ServiceResource) MarshalJSON 

func (sr ServiceResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceResource.

func (*ServiceResource) UnmarshalJSON 

func (sr *ServiceResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServiceResource struct.

type ServiceRestoreFuture 

type ServiceRestoreFuture struct {
	azure.Future
}

ServiceRestoreFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ServiceRestoreFuture) Result 

func (future *ServiceRestoreFuture) Result(client ServiceClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ServiceSkuProperties 

type ServiceSkuProperties struct {
	// Name - Name of the Sku. Possible values include: 'SkuTypeDeveloper', 'SkuTypeStandard', 'SkuTypePremium', 'SkuTypeBasic'
	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 ServiceUpdateFuture 

type ServiceUpdateFuture struct {
	azure.Future
}

ServiceUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ServiceUpdateFuture) Result 

func (future *ServiceUpdateFuture) Result(client ServiceClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ServiceUpdateHostnameFuture 

type ServiceUpdateHostnameFuture struct {
	azure.Future
}

ServiceUpdateHostnameFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ServiceUpdateHostnameFuture) Result 

func (future *ServiceUpdateHostnameFuture) Result(client ServiceClient) (sr ServiceResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ServiceUpdateHostnameParameters 

type ServiceUpdateHostnameParameters struct {
	// Update - Hostnames to create or update.
	Update *[]HostnameConfigurationOld `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 {
	// ServiceUpdateProperties - Properties of the API Management service.
	*ServiceUpdateProperties `json:"properties,omitempty"`
	// Sku - SKU properties of the API Management service.
	Sku *ServiceSkuProperties `json:"sku,omitempty"`
	// Identity - Managed service identity of the Api Management service.
	Identity *ServiceIdentity `json:"identity,omitempty"`
	// Etag - ETag of the resource.
	Etag *string `json:"etag,omitempty"`
	// 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"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

ServiceUpdateParameters parameter supplied to Update Api Management Service.

func (ServiceUpdateParameters) MarshalJSON 

func (sup ServiceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceUpdateParameters.

func (*ServiceUpdateParameters) UnmarshalJSON 

func (sup *ServiceUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServiceUpdateParameters struct.

type ServiceUpdateProperties 

type ServiceUpdateProperties struct {
	// PublisherEmail - Publisher email.
	PublisherEmail *string `json:"publisherEmail,omitempty"`
	// PublisherName - Publisher name.
	PublisherName *string `json:"publisherName,omitempty"`
	// NotificationSenderEmail - Email address from which the notification will be sent.
	NotificationSenderEmail *string `json:"notificationSenderEmail,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"`
	// GatewayURL - Gateway URL of the API Management service.
	GatewayURL *string `json:"gatewayUrl,omitempty"`
	// GatewayRegionalURL - Gateway URL of the API Management service in the Default Region.
	GatewayRegionalURL *string `json:"gatewayRegionalUrl,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"`
	// HostnameConfigurations - Custom hostname configuration of the API Management service.
	HostnameConfigurations *[]HostnameConfiguration `json:"hostnameConfigurations,omitempty"`
	// PublicIPAddresses - Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
	PublicIPAddresses *[]string `json:"publicIPAddresses,omitempty"`
	// PrivateIPAddresses - Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU.
	PrivateIPAddresses *[]string `json:"privateIPAddresses,omitempty"`
	// VirtualNetworkConfiguration - Virtual network configuration of the API Management service.
	VirtualNetworkConfiguration *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`
	// AdditionalLocations - Additional datacenter locations of the API Management service.
	AdditionalLocations *[]AdditionalLocation `json:"additionalLocations,omitempty"`
	// CustomProperties - Custom properties of the API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1 and setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
	CustomProperties map[string]*string `json:"customProperties"`
	// Certificates - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
	Certificates *[]CertificateConfiguration `json:"certificates,omitempty"`
	// VirtualNetworkType - 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'
	VirtualNetworkType VirtualNetworkType `json:"virtualNetworkType,omitempty"`
}

ServiceUpdateProperties properties of an API Management service resource description.

func (ServiceUpdateProperties) MarshalJSON 

func (sup ServiceUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceUpdateProperties.

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 SignInSettingsClient 

type SignInSettingsClient struct {
	BaseClient
}

SignInSettingsClient is the apiManagement Client

func NewSignInSettingsClient 

func NewSignInSettingsClient(subscriptionID string) SignInSettingsClient

NewSignInSettingsClient creates an instance of the SignInSettingsClient client.

func NewSignInSettingsClientWithBaseURI 

func NewSignInSettingsClientWithBaseURI(baseURI string, subscriptionID string) SignInSettingsClient

NewSignInSettingsClientWithBaseURI creates an instance of the SignInSettingsClient client.

func (SignInSettingsClient) CreateOrUpdate 

func (client SignInSettingsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSigninSettings) (result PortalSigninSettings, err error)

CreateOrUpdate create or Update Sign-In settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - create or update parameters.

func (SignInSettingsClient) CreateOrUpdatePreparer 

func (client SignInSettingsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSigninSettings) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SignInSettingsClient) CreateOrUpdateResponder 

func (client SignInSettingsClient) CreateOrUpdateResponder(resp *http.Response) (result PortalSigninSettings, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (SignInSettingsClient) CreateOrUpdateSender 

func (client SignInSettingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (SignInSettingsClient) Get 

func (client SignInSettingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result PortalSigninSettings, err error)

Get get Sign-In settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (SignInSettingsClient) GetEntityTag 

func (client SignInSettingsClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the SignInSettings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (SignInSettingsClient) GetEntityTagPreparer 

func (client SignInSettingsClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (SignInSettingsClient) GetEntityTagResponder 

func (client SignInSettingsClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (SignInSettingsClient) GetEntityTagSender 

func (client SignInSettingsClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.

func (SignInSettingsClient) GetPreparer 

func (client SignInSettingsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SignInSettingsClient) GetResponder 

func (client SignInSettingsClient) GetResponder(resp *http.Response) (result PortalSigninSettings, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SignInSettingsClient) GetSender 

func (client SignInSettingsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (SignInSettingsClient) Update 

func (client SignInSettingsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSigninSettings, ifMatch string) (result autorest.Response, err error)

Update update Sign-In settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - update Sign-In settings. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (SignInSettingsClient) UpdatePreparer 

func (client SignInSettingsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSigninSettings, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (SignInSettingsClient) UpdateResponder 

func (client SignInSettingsClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (SignInSettingsClient) UpdateSender 

func (client SignInSettingsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type SignUpSettingsClient 

type SignUpSettingsClient struct {
	BaseClient
}

SignUpSettingsClient is the apiManagement Client

func NewSignUpSettingsClient 

func NewSignUpSettingsClient(subscriptionID string) SignUpSettingsClient

NewSignUpSettingsClient creates an instance of the SignUpSettingsClient client.

func NewSignUpSettingsClientWithBaseURI 

func NewSignUpSettingsClientWithBaseURI(baseURI string, subscriptionID string) SignUpSettingsClient

NewSignUpSettingsClientWithBaseURI creates an instance of the SignUpSettingsClient client.

func (SignUpSettingsClient) CreateOrUpdate 

func (client SignUpSettingsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSignupSettings) (result PortalSignupSettings, err error)

CreateOrUpdate create or Update Sign-Up settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - create or update parameters.

func (SignUpSettingsClient) CreateOrUpdatePreparer 

func (client SignUpSettingsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSignupSettings) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SignUpSettingsClient) CreateOrUpdateResponder 

func (client SignUpSettingsClient) CreateOrUpdateResponder(resp *http.Response) (result PortalSignupSettings, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (SignUpSettingsClient) CreateOrUpdateSender 

func (client SignUpSettingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (SignUpSettingsClient) Get 

func (client SignUpSettingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result PortalSignupSettings, err error)

Get get Sign-Up settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (SignUpSettingsClient) GetEntityTag 

func (client SignUpSettingsClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the SignUpSettings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (SignUpSettingsClient) GetEntityTagPreparer 

func (client SignUpSettingsClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (SignUpSettingsClient) GetEntityTagResponder 

func (client SignUpSettingsClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (SignUpSettingsClient) GetEntityTagSender 

func (client SignUpSettingsClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.

func (SignUpSettingsClient) GetPreparer 

func (client SignUpSettingsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SignUpSettingsClient) GetResponder 

func (client SignUpSettingsClient) GetResponder(resp *http.Response) (result PortalSignupSettings, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SignUpSettingsClient) GetSender 

func (client SignUpSettingsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (SignUpSettingsClient) Update 

func (client SignUpSettingsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSignupSettings, ifMatch string) (result autorest.Response, err error)

Update update Sign-Up settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - update Sign-Up settings. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (SignUpSettingsClient) UpdatePreparer 

func (client SignUpSettingsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSignupSettings, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (SignUpSettingsClient) UpdateResponder 

func (client SignUpSettingsClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (SignUpSettingsClient) UpdateSender 

func (client SignUpSettingsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type SkuType 

type SkuType string

SkuType enumerates the values for sku type. 

const (
	// SkuTypeBasic Basic SKU of Api Management.
	SkuTypeBasic SkuType = "Basic"
	// SkuTypeDeveloper Developer SKU of Api Management.
	SkuTypeDeveloper SkuType = "Developer"
	// SkuTypePremium Premium SKU of Api Management.
	SkuTypePremium SkuType = "Premium"
	// SkuTypeStandard Standard SKU of Api Management.
	SkuTypeStandard SkuType = "Standard"
)

func PossibleSkuTypeValues 

func PossibleSkuTypeValues() []SkuType

PossibleSkuTypeValues returns an array of possible values for the SkuType const type.

type SoapAPIType 

type SoapAPIType string

SoapAPIType enumerates the values for soap api type. 

const (
	// SoapPassThrough Imports the Soap API having a SOAP front end.
	SoapPassThrough SoapAPIType = "soap"
	// SoapToRest Imports a SOAP API having a RESTful front end.
	SoapToRest SoapAPIType = "http"
)

func PossibleSoapAPITypeValues 

func PossibleSoapAPITypeValues() []SoapAPIType

PossibleSoapAPITypeValues returns an array of possible values for the SoapAPIType const type.

type State 

type State string

State enumerates the values for state. 

const (
	// Closed The issue was closed.
	Closed State = "closed"
	// Open The issue is opened.
	Open State = "open"
	// Proposed The issue is proposed.
	Proposed State = "proposed"
	// Removed The issue was removed.
	Removed State = "removed"
	// Resolved The issue is now resolved.
	Resolved State = "resolved"
)

func PossibleStateValues 

func PossibleStateValues() []State

PossibleStateValues returns an array of possible values for the State const type.

type StoreName 

type StoreName string

StoreName enumerates the values for store name. 

const (
	// CertificateAuthority ...
	CertificateAuthority StoreName = "CertificateAuthority"
	// Root ...
	Root StoreName = "Root"
)

func PossibleStoreNameValues 

func PossibleStoreNameValues() []StoreName

PossibleStoreNameValues returns an array of possible values for the StoreName const type.

type SubscriptionClient 

type SubscriptionClient struct {
	BaseClient
}

SubscriptionClient is the apiManagement Client

func NewSubscriptionClient 

func NewSubscriptionClient(subscriptionID string) SubscriptionClient

NewSubscriptionClient creates an instance of the SubscriptionClient client.

func NewSubscriptionClientWithBaseURI 

func NewSubscriptionClientWithBaseURI(baseURI string, subscriptionID string) SubscriptionClient

NewSubscriptionClientWithBaseURI creates an instance of the SubscriptionClient client.

func (SubscriptionClient) CreateOrUpdate 

func (client SubscriptionClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionCreateParameters, notify *bool, ifMatch string) (result SubscriptionContract, err error)

CreateOrUpdate creates or updates the subscription of specified user to the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management. parameters - create parameters. notify - notify change in Subscription State. - If false, do not send any email notification for change of state of subscription - If true, send email notification of change of state of subscription ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (SubscriptionClient) CreateOrUpdatePreparer 

func (client SubscriptionClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionCreateParameters, notify *bool, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SubscriptionClient) CreateOrUpdateResponder 

func (client SubscriptionClient) CreateOrUpdateResponder(resp *http.Response) (result SubscriptionContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (SubscriptionClient) CreateOrUpdateSender 

func (client SubscriptionClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) Delete 

func (client SubscriptionClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, sid string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified subscription. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (SubscriptionClient) DeletePreparer 

func (client SubscriptionClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (SubscriptionClient) DeleteResponder 

func (client SubscriptionClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (SubscriptionClient) DeleteSender 

func (client SubscriptionClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) Get 

func (client SubscriptionClient) Get(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result SubscriptionContract, err error)

Get gets the specified Subscription entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management.

func (SubscriptionClient) GetEntityTag 

func (client SubscriptionClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the apimanagement subscription specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management.

func (SubscriptionClient) GetEntityTagPreparer 

func (client SubscriptionClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (SubscriptionClient) GetEntityTagResponder 

func (client SubscriptionClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (SubscriptionClient) GetEntityTagSender 

func (client SubscriptionClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) GetPreparer 

func (client SubscriptionClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SubscriptionClient) GetResponder 

func (client SubscriptionClient) GetResponder(resp *http.Response) (result SubscriptionContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SubscriptionClient) GetSender 

func (client SubscriptionClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) List 

func (client SubscriptionClient) List(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)

List lists all subscriptions of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip.

func (SubscriptionClient) ListComplete 

func (client SubscriptionClient) 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 (SubscriptionClient) ListPreparer 

func (client SubscriptionClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (SubscriptionClient) ListResponder 

func (client SubscriptionClient) ListResponder(resp *http.Response) (result SubscriptionCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (SubscriptionClient) ListSender 

func (client SubscriptionClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) RegeneratePrimaryKey 

func (client SubscriptionClient) RegeneratePrimaryKey(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result autorest.Response, err error)

RegeneratePrimaryKey regenerates primary key of existing subscription of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management.

func (SubscriptionClient) RegeneratePrimaryKeyPreparer 

func (client SubscriptionClient) RegeneratePrimaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)

RegeneratePrimaryKeyPreparer prepares the RegeneratePrimaryKey request.

func (SubscriptionClient) RegeneratePrimaryKeyResponder 

func (client SubscriptionClient) RegeneratePrimaryKeyResponder(resp *http.Response) (result autorest.Response, err error)

RegeneratePrimaryKeyResponder handles the response to the RegeneratePrimaryKey request. The method always closes the http.Response Body.

func (SubscriptionClient) RegeneratePrimaryKeySender 

func (client SubscriptionClient) RegeneratePrimaryKeySender(req *http.Request) (*http.Response, error)

RegeneratePrimaryKeySender sends the RegeneratePrimaryKey request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) RegenerateSecondaryKey 

func (client SubscriptionClient) RegenerateSecondaryKey(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result autorest.Response, err error)

RegenerateSecondaryKey regenerates secondary key of existing subscription of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management.

func (SubscriptionClient) RegenerateSecondaryKeyPreparer 

func (client SubscriptionClient) RegenerateSecondaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)

RegenerateSecondaryKeyPreparer prepares the RegenerateSecondaryKey request.

func (SubscriptionClient) RegenerateSecondaryKeyResponder 

func (client SubscriptionClient) RegenerateSecondaryKeyResponder(resp *http.Response) (result autorest.Response, err error)

RegenerateSecondaryKeyResponder handles the response to the RegenerateSecondaryKey request. The method always closes the http.Response Body.

func (SubscriptionClient) RegenerateSecondaryKeySender 

func (client SubscriptionClient) RegenerateSecondaryKeySender(req *http.Request) (*http.Response, error)

RegenerateSecondaryKeySender sends the RegenerateSecondaryKey request. The method will close the http.Response Body if it receives an error.

func (SubscriptionClient) Update 

func (client SubscriptionClient) Update(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionUpdateParameters, ifMatch string, notify *bool) (result autorest.Response, err error)

Update updates the details of a subscription specificied by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. notify - notify change in Subscription State. - If false, do not send any email notification for change of state of subscription - If true, send email notification of change of state of subscription

func (SubscriptionClient) UpdatePreparer 

func (client SubscriptionClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionUpdateParameters, ifMatch string, notify *bool) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (SubscriptionClient) UpdateResponder 

func (client SubscriptionClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (SubscriptionClient) UpdateSender 

func (client SubscriptionClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type SubscriptionCollection 

type SubscriptionCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]SubscriptionContract `json:"value,omitempty"`
	// 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 NewSubscriptionCollectionIterator 

func NewSubscriptionCollectionIterator(page SubscriptionCollectionPage) SubscriptionCollectionIterator

Creates a new instance of the SubscriptionCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*SubscriptionCollectionIterator) NextWithContext 

func (iter *SubscriptionCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewSubscriptionCollectionPage 

func NewSubscriptionCollectionPage(getNextPage func(context.Context, SubscriptionCollection) (SubscriptionCollection, error)) SubscriptionCollectionPage

Creates a new instance of the SubscriptionCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*SubscriptionCollectionPage) NextWithContext 

func (page *SubscriptionCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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:"-"`
	// SubscriptionContractProperties - Subscription contract properties.
	*SubscriptionContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

SubscriptionContract subscription details.

func (SubscriptionContract) MarshalJSON 

func (sc SubscriptionContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SubscriptionContract.

func (*SubscriptionContract) UnmarshalJSON 

func (sc *SubscriptionContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SubscriptionContract struct.

type SubscriptionContractProperties 

type SubscriptionContractProperties struct {
	// UserID - The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier.
	UserID *string `json:"userId,omitempty"`
	// ProductID - The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier.
	ProductID *string `json:"productId,omitempty"`
	// DisplayName - The name of the subscription, or null if the subscription has no name.
	DisplayName *string `json:"displayName,omitempty"`
	// State - Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Possible values include: 'Suspended', 'Active', 'Expired', 'Submitted', 'Rejected', 'Cancelled'
	State SubscriptionState `json:"state,omitempty"`
	// CreatedDate - Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	CreatedDate *date.Time `json:"createdDate,omitempty"`
	// StartDate - Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	StartDate *date.Time `json:"startDate,omitempty"`
	// ExpirationDate - Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	ExpirationDate *date.Time `json:"expirationDate,omitempty"`
	// EndDate - Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	EndDate *date.Time `json:"endDate,omitempty"`
	// NotificationDate - Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	NotificationDate *date.Time `json:"notificationDate,omitempty"`
	// PrimaryKey - Subscription primary key.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - Subscription secondary key.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
	// StateComment - Optional subscription comment added by an administrator.
	StateComment *string `json:"stateComment,omitempty"`
}

SubscriptionContractProperties subscription details.

type SubscriptionCreateParameterProperties 

type SubscriptionCreateParameterProperties 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"`
	// DisplayName - Subscription name.
	DisplayName *string `json:"displayName,omitempty"`
	// PrimaryKey - Primary subscription key. If not specified during request key will be generated automatically.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - Secondary subscription key. If not specified during request key will be generated automatically.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
	// State - Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Possible values include: 'Suspended', 'Active', 'Expired', 'Submitted', 'Rejected', 'Cancelled'
	State SubscriptionState `json:"state,omitempty"`
}

SubscriptionCreateParameterProperties parameters supplied to the Create subscription operation.

type SubscriptionCreateParameters 

type SubscriptionCreateParameters struct {
	// SubscriptionCreateParameterProperties - Subscription contract properties.
	*SubscriptionCreateParameterProperties `json:"properties,omitempty"`
}

SubscriptionCreateParameters subscription create details.

func (SubscriptionCreateParameters) MarshalJSON 

func (scp SubscriptionCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SubscriptionCreateParameters.

func (*SubscriptionCreateParameters) UnmarshalJSON 

func (scp *SubscriptionCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SubscriptionCreateParameters struct.

type SubscriptionKeyParameterNamesContract 

type SubscriptionKeyParameterNamesContract struct {
	// Header - Subscription key header name.
	Header *string `json:"header,omitempty"`
	// Query - Subscription key query string parameter name.
	Query *string `json:"query,omitempty"`
}

SubscriptionKeyParameterNamesContract subscription key parameter names details.

type SubscriptionState 

type SubscriptionState string

SubscriptionState enumerates the values for subscription state. 

const (
	// Active ...
	Active SubscriptionState = "active"
	// Cancelled ...
	Cancelled SubscriptionState = "cancelled"
	// Expired ...
	Expired SubscriptionState = "expired"
	// Rejected ...
	Rejected SubscriptionState = "rejected"
	// Submitted ...
	Submitted SubscriptionState = "submitted"
	// Suspended ...
	Suspended SubscriptionState = "suspended"
)

func PossibleSubscriptionStateValues 

func PossibleSubscriptionStateValues() []SubscriptionState

PossibleSubscriptionStateValues returns an array of possible values for the SubscriptionState const type.

type SubscriptionUpdateParameterProperties 

type SubscriptionUpdateParameterProperties struct {
	// UserID - User identifier path: /users/{uid}
	UserID *string `json:"userId,omitempty"`
	// ProductID - Product identifier path: /products/{productId}
	ProductID *string `json:"productId,omitempty"`
	// ExpirationDate - Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	ExpirationDate *date.Time `json:"expirationDate,omitempty"`
	// DisplayName - Subscription name.
	DisplayName *string `json:"displayName,omitempty"`
	// PrimaryKey - Primary subscription key.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - Secondary subscription key.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
	// State - Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Possible values include: 'Suspended', 'Active', 'Expired', 'Submitted', 'Rejected', 'Cancelled'
	State SubscriptionState `json:"state,omitempty"`
	// StateComment - Comments describing subscription state change by the administrator.
	StateComment *string `json:"stateComment,omitempty"`
}

SubscriptionUpdateParameterProperties parameters supplied to the Update subscription operation.

type SubscriptionUpdateParameters 

type SubscriptionUpdateParameters struct {
	// SubscriptionUpdateParameterProperties - Subscription Update contract properties.
	*SubscriptionUpdateParameterProperties `json:"properties,omitempty"`
}

SubscriptionUpdateParameters subscription update details.

func (SubscriptionUpdateParameters) MarshalJSON 

func (sup SubscriptionUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SubscriptionUpdateParameters.

func (*SubscriptionUpdateParameters) UnmarshalJSON 

func (sup *SubscriptionUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SubscriptionUpdateParameters struct.

type SubscriptionsDelegationSettingsProperties 

type SubscriptionsDelegationSettingsProperties struct {
	// Enabled - Enable or disable delegation for subscriptions.
	Enabled *bool `json:"enabled,omitempty"`
}

SubscriptionsDelegationSettingsProperties subscriptions delegation settings properties.

type TagClient 

type TagClient struct {
	BaseClient
}

TagClient is the apiManagement Client

func NewTagClient 

func NewTagClient(subscriptionID string) TagClient

NewTagClient creates an instance of the TagClient client.

func NewTagClientWithBaseURI 

func NewTagClientWithBaseURI(baseURI string, subscriptionID string) TagClient

NewTagClientWithBaseURI creates an instance of the TagClient client.

func (TagClient) AssignToAPI 

func (client TagClient) AssignToAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (result TagContract, err error)

AssignToAPI assign tag to the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (TagClient) AssignToAPIPreparer 

func (client TagClient) AssignToAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (*http.Request, error)

AssignToAPIPreparer prepares the AssignToAPI request.

func (TagClient) AssignToAPIResponder 

func (client TagClient) AssignToAPIResponder(resp *http.Response) (result TagContract, err error)

AssignToAPIResponder handles the response to the AssignToAPI request. The method always closes the http.Response Body.

func (TagClient) AssignToAPISender 

func (client TagClient) AssignToAPISender(req *http.Request) (*http.Response, error)

AssignToAPISender sends the AssignToAPI request. The method will close the http.Response Body if it receives an error.

func (TagClient) AssignToOperation 

func (client TagClient) AssignToOperation(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string, ifMatch string) (result TagContract, err error)

AssignToOperation assign tag to the Operation. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (TagClient) AssignToOperationPreparer 

func (client TagClient) AssignToOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string, ifMatch string) (*http.Request, error)

AssignToOperationPreparer prepares the AssignToOperation request.

func (TagClient) AssignToOperationResponder 

func (client TagClient) AssignToOperationResponder(resp *http.Response) (result TagContract, err error)

AssignToOperationResponder handles the response to the AssignToOperation request. The method always closes the http.Response Body.

func (TagClient) AssignToOperationSender 

func (client TagClient) AssignToOperationSender(req *http.Request) (*http.Response, error)

AssignToOperationSender sends the AssignToOperation request. The method will close the http.Response Body if it receives an error.

func (TagClient) AssignToProduct 

func (client TagClient) AssignToProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, ifMatch string) (result TagContract, err error)

AssignToProduct assign tag to the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (TagClient) AssignToProductPreparer 

func (client TagClient) AssignToProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, ifMatch string) (*http.Request, error)

AssignToProductPreparer prepares the AssignToProduct request.

func (TagClient) AssignToProductResponder 

func (client TagClient) AssignToProductResponder(resp *http.Response) (result TagContract, err error)

AssignToProductResponder handles the response to the AssignToProduct request. The method always closes the http.Response Body.

func (TagClient) AssignToProductSender 

func (client TagClient) AssignToProductSender(req *http.Request) (*http.Response, error)

AssignToProductSender sends the AssignToProduct request. The method will close the http.Response Body if it receives an error.

func (TagClient) CreateOrUpdate 

func (client TagClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, tagID string, parameters TagCreateUpdateParameters) (result TagContract, err error)

CreateOrUpdate creates a tag. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. tagID - tag identifier. Must be unique in the current API Management service instance. parameters - create parameters.

func (TagClient) CreateOrUpdatePreparer 

func (client TagClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, tagID string, parameters TagCreateUpdateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (TagClient) CreateOrUpdateResponder 

func (client TagClient) CreateOrUpdateResponder(resp *http.Response) (result TagContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (TagClient) CreateOrUpdateSender 

func (client TagClient) 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 (TagClient) Delete 

func (client TagClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, tagID string, ifMatch string) (result autorest.Response, err error)

Delete deletes specific tag of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (TagClient) DeletePreparer 

func (client TagClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, tagID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (TagClient) DeleteResponder 

func (client TagClient) 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 (TagClient) DeleteSender 

func (client TagClient) 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 (TagClient) DetachFromAPI 

func (client TagClient) DetachFromAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (result autorest.Response, err error)

DetachFromAPI detach the tag from the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (TagClient) DetachFromAPIPreparer 

func (client TagClient) DetachFromAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (*http.Request, error)

DetachFromAPIPreparer prepares the DetachFromAPI request.

func (TagClient) DetachFromAPIResponder 

func (client TagClient) DetachFromAPIResponder(resp *http.Response) (result autorest.Response, err error)

DetachFromAPIResponder handles the response to the DetachFromAPI request. The method always closes the http.Response Body.

func (TagClient) DetachFromAPISender 

func (client TagClient) DetachFromAPISender(req *http.Request) (*http.Response, error)

DetachFromAPISender sends the DetachFromAPI request. The method will close the http.Response Body if it receives an error.

func (TagClient) DetachFromOperation 

func (client TagClient) DetachFromOperation(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string, ifMatch string) (result autorest.Response, err error)

DetachFromOperation detach the tag from the Operation. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (TagClient) DetachFromOperationPreparer 

func (client TagClient) DetachFromOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string, ifMatch string) (*http.Request, error)

DetachFromOperationPreparer prepares the DetachFromOperation request.

func (TagClient) DetachFromOperationResponder 

func (client TagClient) DetachFromOperationResponder(resp *http.Response) (result autorest.Response, err error)

DetachFromOperationResponder handles the response to the DetachFromOperation request. The method always closes the http.Response Body.

func (TagClient) DetachFromOperationSender 

func (client TagClient) DetachFromOperationSender(req *http.Request) (*http.Response, error)

DetachFromOperationSender sends the DetachFromOperation request. The method will close the http.Response Body if it receives an error.

func (TagClient) DetachFromProduct 

func (client TagClient) DetachFromProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, ifMatch string) (result autorest.Response, err error)

DetachFromProduct detach the tag from the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (TagClient) DetachFromProductPreparer 

func (client TagClient) DetachFromProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, ifMatch string) (*http.Request, error)

DetachFromProductPreparer prepares the DetachFromProduct request.

func (TagClient) DetachFromProductResponder 

func (client TagClient) DetachFromProductResponder(resp *http.Response) (result autorest.Response, err error)

DetachFromProductResponder handles the response to the DetachFromProduct request. The method always closes the http.Response Body.

func (TagClient) DetachFromProductSender 

func (client TagClient) DetachFromProductSender(req *http.Request) (*http.Response, error)

DetachFromProductSender sends the DetachFromProduct request. The method will close the http.Response Body if it receives an error.

func (TagClient) Get 

func (client TagClient) Get(ctx context.Context, resourceGroupName string, serviceName string, tagID string) (result TagContract, err error)

Get gets the details of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. tagID - tag identifier. Must be unique in the current API Management service instance.

func (TagClient) GetByAPI 

func (client TagClient) GetByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (result TagContract, err error)

GetByAPI get tag associated with the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance.

func (TagClient) GetByAPIPreparer 

func (client TagClient) GetByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (*http.Request, error)

GetByAPIPreparer prepares the GetByAPI request.

func (TagClient) GetByAPIResponder 

func (client TagClient) GetByAPIResponder(resp *http.Response) (result TagContract, err error)

GetByAPIResponder handles the response to the GetByAPI request. The method always closes the http.Response Body.

func (TagClient) GetByAPISender 

func (client TagClient) GetByAPISender(req *http.Request) (*http.Response, error)

GetByAPISender sends the GetByAPI request. The method will close the http.Response Body if it receives an error.

func (TagClient) GetByOperation 

func (client TagClient) GetByOperation(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string) (result TagContract, err error)

GetByOperation get tag associated with the Operation. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance.

func (TagClient) GetByOperationPreparer 

func (client TagClient) GetByOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string) (*http.Request, error)

GetByOperationPreparer prepares the GetByOperation request.

func (TagClient) GetByOperationResponder 

func (client TagClient) GetByOperationResponder(resp *http.Response) (result TagContract, err error)

GetByOperationResponder handles the response to the GetByOperation request. The method always closes the http.Response Body.

func (TagClient) GetByOperationSender 

func (client TagClient) GetByOperationSender(req *http.Request) (*http.Response, error)

GetByOperationSender sends the GetByOperation request. The method will close the http.Response Body if it receives an error.

func (TagClient) GetByProduct 

func (client TagClient) GetByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string) (result TagContract, err error)

GetByProduct get tag associated with the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance.

func (TagClient) GetByProductPreparer 

func (client TagClient) GetByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string) (*http.Request, error)

GetByProductPreparer prepares the GetByProduct request.

func (TagClient) GetByProductResponder 

func (client TagClient) GetByProductResponder(resp *http.Response) (result TagContract, err error)

GetByProductResponder handles the response to the GetByProduct request. The method always closes the http.Response Body.

func (TagClient) GetByProductSender 

func (client TagClient) GetByProductSender(req *http.Request) (*http.Response, error)

GetByProductSender sends the GetByProduct request. The method will close the http.Response Body if it receives an error.

func (TagClient) GetEntityState 

func (client TagClient) GetEntityState(ctx context.Context, resourceGroupName string, serviceName string, tagID string) (result autorest.Response, err error)

GetEntityState gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. tagID - tag identifier. Must be unique in the current API Management service instance.

func (TagClient) GetEntityStateByAPI 

func (client TagClient) GetEntityStateByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (result autorest.Response, err error)

GetEntityStateByAPI gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance.

func (TagClient) GetEntityStateByAPIPreparer 

func (client TagClient) GetEntityStateByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (*http.Request, error)

GetEntityStateByAPIPreparer prepares the GetEntityStateByAPI request.

func (TagClient) GetEntityStateByAPIResponder 

func (client TagClient) GetEntityStateByAPIResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityStateByAPIResponder handles the response to the GetEntityStateByAPI request. The method always closes the http.Response Body.

func (TagClient) GetEntityStateByAPISender 

func (client TagClient) GetEntityStateByAPISender(req *http.Request) (*http.Response, error)

GetEntityStateByAPISender sends the GetEntityStateByAPI request. The method will close the http.Response Body if it receives an error.

func (TagClient) GetEntityStateByOperation 

func (client TagClient) GetEntityStateByOperation(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string) (result autorest.Response, err error)

GetEntityStateByOperation gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance.

func (TagClient) GetEntityStateByOperationPreparer 

func (client TagClient) GetEntityStateByOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string) (*http.Request, error)

GetEntityStateByOperationPreparer prepares the GetEntityStateByOperation request.

func (TagClient) GetEntityStateByOperationResponder 

func (client TagClient) GetEntityStateByOperationResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityStateByOperationResponder handles the response to the GetEntityStateByOperation request. The method always closes the http.Response Body.

func (TagClient) GetEntityStateByOperationSender 

func (client TagClient) GetEntityStateByOperationSender(req *http.Request) (*http.Response, error)

GetEntityStateByOperationSender sends the GetEntityStateByOperation request. The method will close the http.Response Body if it receives an error.

func (TagClient) GetEntityStateByProduct 

func (client TagClient) GetEntityStateByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string) (result autorest.Response, err error)

GetEntityStateByProduct gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance.

func (TagClient) GetEntityStateByProductPreparer 

func (client TagClient) GetEntityStateByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string) (*http.Request, error)

GetEntityStateByProductPreparer prepares the GetEntityStateByProduct request.

func (TagClient) GetEntityStateByProductResponder 

func (client TagClient) GetEntityStateByProductResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityStateByProductResponder handles the response to the GetEntityStateByProduct request. The method always closes the http.Response Body.

func (TagClient) GetEntityStateByProductSender 

func (client TagClient) GetEntityStateByProductSender(req *http.Request) (*http.Response, error)

GetEntityStateByProductSender sends the GetEntityStateByProduct request. The method will close the http.Response Body if it receives an error.

func (TagClient) GetEntityStatePreparer 

func (client TagClient) GetEntityStatePreparer(ctx context.Context, resourceGroupName string, serviceName string, tagID string) (*http.Request, error)

GetEntityStatePreparer prepares the GetEntityState request.

func (TagClient) GetEntityStateResponder 

func (client TagClient) GetEntityStateResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityStateResponder handles the response to the GetEntityState request. The method always closes the http.Response Body.

func (TagClient) GetEntityStateSender 

func (client TagClient) GetEntityStateSender(req *http.Request) (*http.Response, error)

GetEntityStateSender sends the GetEntityState request. The method will close the http.Response Body if it receives an error.

func (TagClient) GetPreparer 

func (client TagClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, tagID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TagClient) GetResponder 

func (client TagClient) GetResponder(resp *http.Response) (result TagContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (TagClient) GetSender 

func (client TagClient) 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 (TagClient) ListByAPI 

func (client TagClient) ListByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagCollectionPage, err error)

ListByAPI lists all Tags associated with the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | 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 - number of records to return. skip - number of records to skip.

func (TagClient) ListByAPIComplete 

func (client TagClient) ListByAPIComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagCollectionIterator, err error)

ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.

func (TagClient) ListByAPIPreparer 

func (client TagClient) ListByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByAPIPreparer prepares the ListByAPI request.

func (TagClient) ListByAPIResponder 

func (client TagClient) ListByAPIResponder(resp *http.Response) (result TagCollection, err error)

ListByAPIResponder handles the response to the ListByAPI request. The method always closes the http.Response Body.

func (TagClient) ListByAPISender 

func (client TagClient) ListByAPISender(req *http.Request) (*http.Response, error)

ListByAPISender sends the ListByAPI request. The method will close the http.Response Body if it receives an error.

func (TagClient) ListByOperation 

func (client TagClient) ListByOperation(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, filter string, top *int32, skip *int32) (result TagCollectionPage, err error)

ListByOperation lists all Tags associated with the Operation. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. filter - | 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 | | method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (TagClient) ListByOperationComplete 

func (client TagClient) ListByOperationComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, filter string, top *int32, skip *int32) (result TagCollectionIterator, err error)

ListByOperationComplete enumerates all values, automatically crossing page boundaries as required.

func (TagClient) ListByOperationPreparer 

func (client TagClient) ListByOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByOperationPreparer prepares the ListByOperation request.

func (TagClient) ListByOperationResponder 

func (client TagClient) ListByOperationResponder(resp *http.Response) (result TagCollection, err error)

ListByOperationResponder handles the response to the ListByOperation request. The method always closes the http.Response Body.

func (TagClient) ListByOperationSender 

func (client TagClient) ListByOperationSender(req *http.Request) (*http.Response, error)

ListByOperationSender sends the ListByOperation request. The method will close the http.Response Body if it receives an error.

func (TagClient) ListByProduct 

func (client TagClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result TagCollectionPage, err error)

ListByProduct lists all Tags associated with the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. filter - | 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 - number of records to return. skip - number of records to skip.

func (TagClient) ListByProductComplete 

func (client TagClient) ListByProductComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result TagCollectionIterator, err error)

ListByProductComplete enumerates all values, automatically crossing page boundaries as required.

func (TagClient) ListByProductPreparer 

func (client TagClient) ListByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (TagClient) ListByProductResponder 

func (client TagClient) ListByProductResponder(resp *http.Response) (result TagCollection, err error)

ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.

func (TagClient) ListByProductSender 

func (client TagClient) ListByProductSender(req *http.Request) (*http.Response, error)

ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.

func (TagClient) ListByService 

func (client TagClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagCollectionPage, err error)

ListByService lists a collection of tags defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip.

func (TagClient) ListByServiceComplete 

func (client TagClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagCollectionIterator, err error)

ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.

func (TagClient) ListByServicePreparer 

func (client TagClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (TagClient) ListByServiceResponder 

func (client TagClient) ListByServiceResponder(resp *http.Response) (result TagCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (TagClient) ListByServiceSender 

func (client TagClient) 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 (TagClient) Update 

func (client TagClient) Update(ctx context.Context, resourceGroupName string, serviceName string, tagID string, parameters TagCreateUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates the details of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. tagID - tag identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (TagClient) UpdatePreparer 

func (client TagClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, tagID string, parameters TagCreateUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (TagClient) UpdateResponder 

func (client TagClient) 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 (TagClient) UpdateSender 

func (client TagClient) 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 TagCollection 

type TagCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]TagContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

TagCollection paged Tag list representation.

func (TagCollection) IsEmpty 

func (tc TagCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type TagCollectionIterator 

type TagCollectionIterator struct {
	// contains filtered or unexported fields
}

TagCollectionIterator provides access to a complete listing of TagContract values.

func NewTagCollectionIterator 

func NewTagCollectionIterator(page TagCollectionPage) TagCollectionIterator

Creates a new instance of the TagCollectionIterator type.

func (*TagCollectionIterator) Next 

func (iter *TagCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*TagCollectionIterator) NextWithContext 

func (iter *TagCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (TagCollectionIterator) NotDone 

func (iter TagCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (TagCollectionIterator) Response 

func (iter TagCollectionIterator) Response() TagCollection

Response returns the raw server response from the last page request.

func (TagCollectionIterator) Value 

func (iter TagCollectionIterator) Value() TagContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type TagCollectionPage 

type TagCollectionPage struct {
	// contains filtered or unexported fields
}

TagCollectionPage contains a page of TagContract values.

func NewTagCollectionPage 

func NewTagCollectionPage(getNextPage func(context.Context, TagCollection) (TagCollection, error)) TagCollectionPage

Creates a new instance of the TagCollectionPage type.

func (*TagCollectionPage) Next 

func (page *TagCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*TagCollectionPage) NextWithContext 

func (page *TagCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (TagCollectionPage) NotDone 

func (page TagCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (TagCollectionPage) Response 

func (page TagCollectionPage) Response() TagCollection

Response returns the raw server response from the last page request.

func (TagCollectionPage) Values 

func (page TagCollectionPage) Values() []TagContract

Values returns the slice of values for the current page or nil if there are no values.

type TagContract 

type TagContract struct {
	autorest.Response `json:"-"`
	// TagContractProperties - Tag entity contract properties.
	*TagContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

TagContract tag Contract details.

func (TagContract) MarshalJSON 

func (tc TagContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagContract.

func (*TagContract) UnmarshalJSON 

func (tc *TagContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TagContract struct.

type TagContractProperties 

type TagContractProperties struct {
	// DisplayName - Tag name.
	DisplayName *string `json:"displayName,omitempty"`
}

TagContractProperties tag contract Properties.

type TagCreateUpdateParameters 

type TagCreateUpdateParameters struct {
	// TagContractProperties - Properties supplied to Create Tag operation.
	*TagContractProperties `json:"properties,omitempty"`
}

TagCreateUpdateParameters parameters supplied to Create/Update Tag operations.

func (TagCreateUpdateParameters) MarshalJSON 

func (tcup TagCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagCreateUpdateParameters.

func (*TagCreateUpdateParameters) UnmarshalJSON 

func (tcup *TagCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TagCreateUpdateParameters struct.

type TagDescriptionBaseProperties 

type TagDescriptionBaseProperties struct {
	// Description - Description of the Tag.
	Description *string `json:"description,omitempty"`
	// ExternalDocsURL - Absolute URL of external resources describing the tag.
	ExternalDocsURL *string `json:"externalDocsUrl,omitempty"`
	// ExternalDocsDescription - Description of the external resources describing the tag.
	ExternalDocsDescription *string `json:"externalDocsDescription,omitempty"`
}

TagDescriptionBaseProperties parameters supplied to the Create TagDescription operation.

type TagDescriptionClient 

type TagDescriptionClient struct {
	BaseClient
}

TagDescriptionClient is the apiManagement Client

func NewTagDescriptionClient 

func NewTagDescriptionClient(subscriptionID string) TagDescriptionClient

NewTagDescriptionClient creates an instance of the TagDescriptionClient client.

func NewTagDescriptionClientWithBaseURI 

func NewTagDescriptionClientWithBaseURI(baseURI string, subscriptionID string) TagDescriptionClient

NewTagDescriptionClientWithBaseURI creates an instance of the TagDescriptionClient client.

func (TagDescriptionClient) CreateOrUpdate 

func (client TagDescriptionClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, parameters TagDescriptionCreateParameters, ifMatch string) (result TagDescriptionContract, err error)

CreateOrUpdate create/Update tag fescription in scope of the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (TagDescriptionClient) CreateOrUpdatePreparer 

func (client TagDescriptionClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, parameters TagDescriptionCreateParameters, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (TagDescriptionClient) CreateOrUpdateResponder 

func (client TagDescriptionClient) CreateOrUpdateResponder(resp *http.Response) (result TagDescriptionContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (TagDescriptionClient) CreateOrUpdateSender 

func (client TagDescriptionClient) 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 (TagDescriptionClient) Delete 

func (client TagDescriptionClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (result autorest.Response, err error)

Delete delete tag description for the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (TagDescriptionClient) DeletePreparer 

func (client TagDescriptionClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (TagDescriptionClient) DeleteResponder 

func (client TagDescriptionClient) 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 (TagDescriptionClient) DeleteSender 

func (client TagDescriptionClient) 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 (TagDescriptionClient) Get 

func (client TagDescriptionClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (result TagDescriptionContract, err error)

Get get tag associated with the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance.

func (TagDescriptionClient) GetEntityState 

func (client TagDescriptionClient) GetEntityState(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (result autorest.Response, err error)

GetEntityState gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance.

func (TagDescriptionClient) GetEntityStatePreparer 

func (client TagDescriptionClient) GetEntityStatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (*http.Request, error)

GetEntityStatePreparer prepares the GetEntityState request.

func (TagDescriptionClient) GetEntityStateResponder 

func (client TagDescriptionClient) GetEntityStateResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityStateResponder handles the response to the GetEntityState request. The method always closes the http.Response Body.

func (TagDescriptionClient) GetEntityStateSender 

func (client TagDescriptionClient) GetEntityStateSender(req *http.Request) (*http.Response, error)

GetEntityStateSender sends the GetEntityState request. The method will close the http.Response Body if it receives an error.

func (TagDescriptionClient) GetPreparer 

func (client TagDescriptionClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TagDescriptionClient) GetResponder 

func (client TagDescriptionClient) GetResponder(resp *http.Response) (result TagDescriptionContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (TagDescriptionClient) GetSender 

func (client TagDescriptionClient) 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 (TagDescriptionClient) ListByAPI 

func (client TagDescriptionClient) ListByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagDescriptionCollectionPage, err error)

ListByAPI lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | 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 - number of records to return. skip - number of records to skip.

func (TagDescriptionClient) ListByAPIComplete 

func (client TagDescriptionClient) ListByAPIComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagDescriptionCollectionIterator, err error)

ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.

func (TagDescriptionClient) ListByAPIPreparer 

func (client TagDescriptionClient) ListByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByAPIPreparer prepares the ListByAPI request.

func (TagDescriptionClient) ListByAPIResponder 

func (client TagDescriptionClient) ListByAPIResponder(resp *http.Response) (result TagDescriptionCollection, err error)

ListByAPIResponder handles the response to the ListByAPI request. The method always closes the http.Response Body.

func (TagDescriptionClient) ListByAPISender 

func (client TagDescriptionClient) ListByAPISender(req *http.Request) (*http.Response, error)

ListByAPISender sends the ListByAPI request. The method will close the http.Response Body if it receives an error.

type TagDescriptionCollection 

type TagDescriptionCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]TagDescriptionContract `json:"value,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

TagDescriptionCollection paged TagDescription list representation.

func (TagDescriptionCollection) IsEmpty 

func (tdc TagDescriptionCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type TagDescriptionCollectionIterator 

type TagDescriptionCollectionIterator struct {
	// contains filtered or unexported fields
}

TagDescriptionCollectionIterator provides access to a complete listing of TagDescriptionContract values.

func NewTagDescriptionCollectionIterator 

func NewTagDescriptionCollectionIterator(page TagDescriptionCollectionPage) TagDescriptionCollectionIterator

Creates a new instance of the TagDescriptionCollectionIterator type.

func (*TagDescriptionCollectionIterator) Next 

func (iter *TagDescriptionCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*TagDescriptionCollectionIterator) NextWithContext 

func (iter *TagDescriptionCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (TagDescriptionCollectionIterator) NotDone 

func (iter TagDescriptionCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (TagDescriptionCollectionIterator) Response 

func (iter TagDescriptionCollectionIterator) Response() TagDescriptionCollection

Response returns the raw server response from the last page request.

func (TagDescriptionCollectionIterator) Value 

func (iter TagDescriptionCollectionIterator) Value() TagDescriptionContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type TagDescriptionCollectionPage 

type TagDescriptionCollectionPage struct {
	// contains filtered or unexported fields
}

TagDescriptionCollectionPage contains a page of TagDescriptionContract values.

func NewTagDescriptionCollectionPage 

func NewTagDescriptionCollectionPage(getNextPage func(context.Context, TagDescriptionCollection) (TagDescriptionCollection, error)) TagDescriptionCollectionPage

Creates a new instance of the TagDescriptionCollectionPage type.

func (*TagDescriptionCollectionPage) Next 

func (page *TagDescriptionCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*TagDescriptionCollectionPage) NextWithContext 

func (page *TagDescriptionCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (TagDescriptionCollectionPage) NotDone 

func (page TagDescriptionCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (TagDescriptionCollectionPage) Response 

func (page TagDescriptionCollectionPage) Response() TagDescriptionCollection

Response returns the raw server response from the last page request.

func (TagDescriptionCollectionPage) Values 

func (page TagDescriptionCollectionPage) Values() []TagDescriptionContract

Values returns the slice of values for the current page or nil if there are no values.

type TagDescriptionContract 

type TagDescriptionContract struct {
	autorest.Response `json:"-"`
	// TagDescriptionContractProperties - TagDescription entity contract properties.
	*TagDescriptionContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

TagDescriptionContract contract details.

func (TagDescriptionContract) MarshalJSON 

func (tdc TagDescriptionContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagDescriptionContract.

func (*TagDescriptionContract) UnmarshalJSON 

func (tdc *TagDescriptionContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TagDescriptionContract struct.

type TagDescriptionContractProperties 

type TagDescriptionContractProperties struct {
	// DisplayName - Tag name.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - Description of the Tag.
	Description *string `json:"description,omitempty"`
	// ExternalDocsURL - Absolute URL of external resources describing the tag.
	ExternalDocsURL *string `json:"externalDocsUrl,omitempty"`
	// ExternalDocsDescription - Description of the external resources describing the tag.
	ExternalDocsDescription *string `json:"externalDocsDescription,omitempty"`
}

TagDescriptionContractProperties tagDescription contract Properties.

type TagDescriptionCreateParameters 

type TagDescriptionCreateParameters struct {
	// TagDescriptionBaseProperties - Properties supplied to Create TagDescription operation.
	*TagDescriptionBaseProperties `json:"properties,omitempty"`
}

TagDescriptionCreateParameters parameters supplied to the Create TagDescription operation.

func (TagDescriptionCreateParameters) MarshalJSON 

func (tdcp TagDescriptionCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagDescriptionCreateParameters.

func (*TagDescriptionCreateParameters) UnmarshalJSON 

func (tdcp *TagDescriptionCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TagDescriptionCreateParameters struct.

type TagResourceClient 

type TagResourceClient struct {
	BaseClient
}

TagResourceClient is the apiManagement Client

func NewTagResourceClient 

func NewTagResourceClient(subscriptionID string) TagResourceClient

NewTagResourceClient creates an instance of the TagResourceClient client.

func NewTagResourceClientWithBaseURI 

func NewTagResourceClientWithBaseURI(baseURI string, subscriptionID string) TagResourceClient

NewTagResourceClientWithBaseURI creates an instance of the TagResourceClient client.

func (TagResourceClient) ListByService 

func (client TagResourceClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagResourceCollectionPage, err error)

ListByService lists a collection of resources associated with tags. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 | | aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | 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 | | method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | isCurrent | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (TagResourceClient) ListByServiceComplete 

func (client TagResourceClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagResourceCollectionIterator, err error)

ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.

func (TagResourceClient) ListByServicePreparer 

func (client TagResourceClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (TagResourceClient) ListByServiceResponder 

func (client TagResourceClient) ListByServiceResponder(resp *http.Response) (result TagResourceCollection, err error)

ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.

func (TagResourceClient) ListByServiceSender 

func (client TagResourceClient) 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 TagResourceCollection 

type TagResourceCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]TagResourceContract `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"`
}

TagResourceCollection paged Tag list representation.

func (TagResourceCollection) IsEmpty 

func (trc TagResourceCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type TagResourceCollectionIterator 

type TagResourceCollectionIterator struct {
	// contains filtered or unexported fields
}

TagResourceCollectionIterator provides access to a complete listing of TagResourceContract values.

func NewTagResourceCollectionIterator 

func NewTagResourceCollectionIterator(page TagResourceCollectionPage) TagResourceCollectionIterator

Creates a new instance of the TagResourceCollectionIterator type.

func (*TagResourceCollectionIterator) Next 

func (iter *TagResourceCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*TagResourceCollectionIterator) NextWithContext 

func (iter *TagResourceCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (TagResourceCollectionIterator) NotDone 

func (iter TagResourceCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (TagResourceCollectionIterator) Response 

func (iter TagResourceCollectionIterator) Response() TagResourceCollection

Response returns the raw server response from the last page request.

func (TagResourceCollectionIterator) Value 

func (iter TagResourceCollectionIterator) Value() TagResourceContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type TagResourceCollectionPage 

type TagResourceCollectionPage struct {
	// contains filtered or unexported fields
}

TagResourceCollectionPage contains a page of TagResourceContract values.

func NewTagResourceCollectionPage 

func NewTagResourceCollectionPage(getNextPage func(context.Context, TagResourceCollection) (TagResourceCollection, error)) TagResourceCollectionPage

Creates a new instance of the TagResourceCollectionPage type.

func (*TagResourceCollectionPage) Next 

func (page *TagResourceCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*TagResourceCollectionPage) NextWithContext 

func (page *TagResourceCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (TagResourceCollectionPage) NotDone 

func (page TagResourceCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (TagResourceCollectionPage) Response 

func (page TagResourceCollectionPage) Response() TagResourceCollection

Response returns the raw server response from the last page request.

func (TagResourceCollectionPage) Values 

func (page TagResourceCollectionPage) Values() []TagResourceContract

Values returns the slice of values for the current page or nil if there are no values.

type TagResourceContract 

type TagResourceContract struct {
	// Tag - Tag associated with the resource.
	Tag *TagTagResourceContractProperties `json:"tag,omitempty"`
	// API - Api associated with the tag.
	API *APITagResourceContractProperties `json:"api,omitempty"`
	// Operation - Operation associated with the tag.
	Operation *OperationTagResourceContractProperties `json:"operation,omitempty"`
	// Product - Product associated with the tag.
	Product *ProductTagResourceContractProperties `json:"product,omitempty"`
}

TagResourceContract tagResource contract properties.

type TagTagResourceContractProperties 

type TagTagResourceContractProperties struct {
	// ID - Tag identifier
	ID *string `json:"id,omitempty"`
	// Name - Tag Name
	Name *string `json:"name,omitempty"`
}

TagTagResourceContractProperties contract defining the Tag property in the Tag Resource Contract

type TemplateName 

type TemplateName string

TemplateName enumerates the values for template name. 

const (
	// AccountClosedDeveloper ...
	AccountClosedDeveloper TemplateName = "accountClosedDeveloper"
	// ApplicationApprovedNotificationMessage ...
	ApplicationApprovedNotificationMessage TemplateName = "applicationApprovedNotificationMessage"
	// ConfirmSignUpIdentityDefault ...
	ConfirmSignUpIdentityDefault TemplateName = "confirmSignUpIdentityDefault"
	// EmailChangeIdentityDefault ...
	EmailChangeIdentityDefault TemplateName = "emailChangeIdentityDefault"
	// InviteUserNotificationMessage ...
	InviteUserNotificationMessage TemplateName = "inviteUserNotificationMessage"
	// NewCommentNotificationMessage ...
	NewCommentNotificationMessage TemplateName = "newCommentNotificationMessage"
	// NewDeveloperNotificationMessage ...
	NewDeveloperNotificationMessage TemplateName = "newDeveloperNotificationMessage"
	// NewIssueNotificationMessage ...
	NewIssueNotificationMessage TemplateName = "newIssueNotificationMessage"
	// PasswordResetByAdminNotificationMessage ...
	PasswordResetByAdminNotificationMessage TemplateName = "passwordResetByAdminNotificationMessage"
	// PasswordResetIdentityDefault ...
	PasswordResetIdentityDefault TemplateName = "passwordResetIdentityDefault"
	// PurchaseDeveloperNotificationMessage ...
	PurchaseDeveloperNotificationMessage TemplateName = "purchaseDeveloperNotificationMessage"
	// QuotaLimitApproachingDeveloperNotificationMessage ...
	QuotaLimitApproachingDeveloperNotificationMessage TemplateName = "quotaLimitApproachingDeveloperNotificationMessage"
	// RejectDeveloperNotificationMessage ...
	RejectDeveloperNotificationMessage TemplateName = "rejectDeveloperNotificationMessage"
	// RequestDeveloperNotificationMessage ...
	RequestDeveloperNotificationMessage TemplateName = "requestDeveloperNotificationMessage"
)

func PossibleTemplateNameValues 

func PossibleTemplateNameValues() []TemplateName

PossibleTemplateNameValues returns an array of possible values for the TemplateName const type.

type TenantAccessClient 

type TenantAccessClient struct {
	BaseClient
}

TenantAccessClient is the 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. Parameters: resourceGroupName - the name of the resource group. serviceName - 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. Parameters: resourceGroupName - the name of the resource group. serviceName - 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. Parameters: resourceGroupName - the name of the resource group. serviceName - 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to retrieve the Tenant Access Information. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

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. Parameters: resourceGroupName - the name of the resource group. serviceName - 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. Parameters: resourceGroupName - the name of the resource group. serviceName - 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. Parameters: resourceGroupName - the name of the resource group. serviceName - 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - 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) GetSyncState 

func (client TenantConfigurationClient) GetSyncState(ctx context.Context, resourceGroupName string, serviceName string) (result TenantConfigurationSyncStateContract, err error)

GetSyncState gets the status of the most recent synchronization between the configuration database and the Git repository. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (TenantConfigurationClient) GetSyncStatePreparer 

func (client TenantConfigurationClient) GetSyncStatePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetSyncStatePreparer prepares the GetSyncState request.

func (TenantConfigurationClient) GetSyncStateResponder 

func (client TenantConfigurationClient) GetSyncStateResponder(resp *http.Response) (result TenantConfigurationSyncStateContract, err error)

GetSyncStateResponder handles the response to the GetSyncState request. The method always closes the http.Response Body.

func (TenantConfigurationClient) GetSyncStateSender 

func (client TenantConfigurationClient) GetSyncStateSender(req *http.Request) (*http.Response, error)

GetSyncStateSender sends the GetSyncState request. The method will close the http.Response Body if it receives an error.

func (TenantConfigurationClient) Save 

func (client TenantConfigurationClient) Save(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - 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
}

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
}

TenantConfigurationSaveFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*TenantConfigurationSaveFuture) Result 

func (future *TenantConfigurationSaveFuture) Result(client TenantConfigurationClient) (orc OperationResultContract, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type TenantConfigurationSyncStateContract 

type TenantConfigurationSyncStateContract struct {
	autorest.Response `json:"-"`
	// Branch - The name of Git branch.
	Branch *string `json:"branch,omitempty"`
	// CommitID - The latest commit Id.
	CommitID *string `json:"commitId,omitempty"`
	// IsExport - value indicating if last sync was save (true) or deploy (false) operation.
	IsExport *bool `json:"isExport,omitempty"`
	// IsSynced - value indicating if last synchronization was later than the configuration change.
	IsSynced *bool `json:"isSynced,omitempty"`
	// IsGitEnabled - value indicating whether Git configuration access is enabled.
	IsGitEnabled *bool `json:"isGitEnabled,omitempty"`
	// SyncDate - The date of the latest synchronization. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	SyncDate *date.Time `json:"syncDate,omitempty"`
	// ConfigurationChangeDate - The date of the latest configuration change. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	ConfigurationChangeDate *date.Time `json:"configurationChangeDate,omitempty"`
}

TenantConfigurationSyncStateContract tenant Configuration Synchronization State.

type TenantConfigurationValidateFuture 

type TenantConfigurationValidateFuture struct {
	azure.Future
}

TenantConfigurationValidateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*TenantConfigurationValidateFuture) Result 

func (future *TenantConfigurationValidateFuture) Result(client TenantConfigurationClient) (orc OperationResultContract, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type TermsOfServiceProperties 

type TermsOfServiceProperties struct {
	// Text - A terms of service text.
	Text *string `json:"text,omitempty"`
	// Enabled - Display terms of service during a sign-up process.
	Enabled *bool `json:"enabled,omitempty"`
	// ConsentRequired - Ask user for consent to the terms of service.
	ConsentRequired *bool `json:"consentRequired,omitempty"`
}

TermsOfServiceProperties terms of service contract properties.

type TokenBodyParameterContract 

type TokenBodyParameterContract struct {
	// Name - body parameter name.
	Name *string `json:"name,omitempty"`
	// Value - body parameter value.
	Value *string `json:"value,omitempty"`
}

TokenBodyParameterContract oAuth acquire token request body parameter (www-url-form-encoded).

type UserClient 

type UserClient struct {
	BaseClient
}

UserClient is the apiManagement Client

func NewUserClient 

func NewUserClient(subscriptionID string) UserClient

NewUserClient creates an instance of the UserClient client.

func NewUserClientWithBaseURI 

func NewUserClientWithBaseURI(baseURI string, subscriptionID string) UserClient

NewUserClientWithBaseURI creates an instance of the UserClient client.

func (UserClient) CreateOrUpdate 

func (client UserClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserCreateParameters, ifMatch string) (result UserContract, err error)

CreateOrUpdate creates or Updates a user. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. parameters - create or update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (UserClient) CreateOrUpdatePreparer 

func (client UserClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserCreateParameters, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (UserClient) CreateOrUpdateResponder 

func (client UserClient) CreateOrUpdateResponder(resp *http.Response) (result UserContract, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (UserClient) CreateOrUpdateSender 

func (client UserClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (UserClient) Delete 

func (client UserClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, UID string, ifMatch string, deleteSubscriptions *bool, notify *bool) (result autorest.Response, err error)

Delete deletes specific user. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. deleteSubscriptions - whether to delete user's subscription or not. notify - send an Account Closed Email notification to the User.

func (UserClient) DeletePreparer 

func (client UserClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, ifMatch string, deleteSubscriptions *bool, notify *bool) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (UserClient) DeleteResponder 

func (client UserClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (UserClient) DeleteSender 

func (client UserClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (UserClient) GenerateSsoURL 

func (client UserClient) GenerateSsoURL(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance.

func (UserClient) GenerateSsoURLPreparer 

func (client UserClient) GenerateSsoURLPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)

GenerateSsoURLPreparer prepares the GenerateSsoURL request.

func (UserClient) GenerateSsoURLResponder 

func (client UserClient) GenerateSsoURLResponder(resp *http.Response) (result GenerateSsoURLResult, err error)

GenerateSsoURLResponder handles the response to the GenerateSsoURL request. The method always closes the http.Response Body.

func (UserClient) GenerateSsoURLSender 

func (client UserClient) GenerateSsoURLSender(req *http.Request) (*http.Response, error)

GenerateSsoURLSender sends the GenerateSsoURL request. The method will close the http.Response Body if it receives an error.

func (UserClient) Get 

func (client UserClient) Get(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result UserContract, err error)

Get gets the details of the user specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance.

func (UserClient) GetEntityTag 

func (client UserClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result autorest.Response, err error)

GetEntityTag gets the entity state (Etag) version of the user specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance.

func (UserClient) GetEntityTagPreparer 

func (client UserClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)

GetEntityTagPreparer prepares the GetEntityTag request.

func (UserClient) GetEntityTagResponder 

func (client UserClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)

GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.

func (UserClient) GetEntityTagSender 

func (client UserClient) GetEntityTagSender(req *http.Request) (*http.Response, error)

GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.

func (UserClient) GetIdentity 

func (client UserClient) GetIdentity(ctx context.Context, resourceGroupName string, serviceName string) (result CurrentUserIdentity, err error)

GetIdentity returns calling user identity information. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (UserClient) GetIdentityPreparer 

func (client UserClient) GetIdentityPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)

GetIdentityPreparer prepares the GetIdentity request.

func (UserClient) GetIdentityResponder 

func (client UserClient) GetIdentityResponder(resp *http.Response) (result CurrentUserIdentity, err error)

GetIdentityResponder handles the response to the GetIdentity request. The method always closes the http.Response Body.

func (UserClient) GetIdentitySender 

func (client UserClient) GetIdentitySender(req *http.Request) (*http.Response, error)

GetIdentitySender sends the GetIdentity request. The method will close the http.Response Body if it receives an error.

func (UserClient) GetPreparer 

func (client UserClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (UserClient) GetResponder 

func (client UserClient) GetResponder(resp *http.Response) (result UserContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (UserClient) GetSender 

func (client UserClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (UserClient) GetSharedAccessToken 

func (client UserClient) GetSharedAccessToken(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserTokenParameters) (result UserTokenResult, err error)

GetSharedAccessToken gets the Shared Access Authorization Token for the User. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. parameters - create Authorization Token parameters.

func (UserClient) GetSharedAccessTokenPreparer 

func (client UserClient) GetSharedAccessTokenPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserTokenParameters) (*http.Request, error)

GetSharedAccessTokenPreparer prepares the GetSharedAccessToken request.

func (UserClient) GetSharedAccessTokenResponder 

func (client UserClient) GetSharedAccessTokenResponder(resp *http.Response) (result UserTokenResult, err error)

GetSharedAccessTokenResponder handles the response to the GetSharedAccessToken request. The method always closes the http.Response Body.

func (UserClient) GetSharedAccessTokenSender 

func (client UserClient) GetSharedAccessTokenSender(req *http.Request) (*http.Response, error)

GetSharedAccessTokenSender sends the GetSharedAccessToken request. The method will close the http.Response Body if it receives an error.

func (UserClient) ListByService 

func (client UserClient) 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | 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 - number of records to return. skip - number of records to skip.

func (UserClient) ListByServiceComplete 

func (client UserClient) 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 (UserClient) ListByServicePreparer 

func (client UserClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (UserClient) ListByServiceResponder 

func (client UserClient) 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 (UserClient) ListByServiceSender 

func (client UserClient) 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 (UserClient) Update 

func (client UserClient) Update(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates the details of the user specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (UserClient) UpdatePreparer 

func (client UserClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (UserClient) UpdateResponder 

func (client UserClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (UserClient) UpdateSender 

func (client UserClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type UserCollection 

type UserCollection struct {
	autorest.Response `json:"-"`
	// Value - Page values.
	Value *[]UserContract `json:"value,omitempty"`
	// 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 NewUserCollectionIterator 

func NewUserCollectionIterator(page UserCollectionPage) UserCollectionIterator

Creates a new instance of the UserCollectionIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*UserCollectionIterator) NextWithContext 

func (iter *UserCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewUserCollectionPage 

func NewUserCollectionPage(getNextPage func(context.Context, UserCollection) (UserCollection, error)) UserCollectionPage

Creates a new instance of the UserCollectionPage type.

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. Deprecated: Use NextWithContext() instead.

func (*UserCollectionPage) NextWithContext 

func (page *UserCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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:"-"`
	// UserContractProperties - User entity contract properties.
	*UserContractProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type for API Management resource.
	Type *string `json:"type,omitempty"`
}

UserContract user details.

func (UserContract) MarshalJSON 

func (uc UserContract) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UserContract.

func (*UserContract) UnmarshalJSON 

func (uc *UserContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UserContract struct.

type UserContractProperties 

type UserContractProperties struct {
	// FirstName - First name.
	FirstName *string `json:"firstName,omitempty"`
	// LastName - Last name.
	LastName *string `json:"lastName,omitempty"`
	// Email - Email address.
	Email *string `json:"email,omitempty"`
	// RegistrationDate - Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	RegistrationDate *date.Time `json:"registrationDate,omitempty"`
	// Groups - Collection of groups user is part of.
	Groups *[]GroupContractProperties `json:"groups,omitempty"`
	// State - Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'UserStateActive', 'UserStateBlocked', 'UserStatePending', 'UserStateDeleted'
	State UserState `json:"state,omitempty"`
	// Note - Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`
	// Identities - Collection of user identities.
	Identities *[]UserIdentityContract `json:"identities,omitempty"`
}

UserContractProperties user profile.

type UserCreateParameterProperties 

type UserCreateParameterProperties struct {
	// Email - Email address. Must not be empty and must be unique within the service instance.
	Email *string `json:"email,omitempty"`
	// FirstName - First name.
	FirstName *string `json:"firstName,omitempty"`
	// LastName - Last name.
	LastName *string `json:"lastName,omitempty"`
	// Password - User Password. If no value is provided, a default password is generated.
	Password *string `json:"password,omitempty"`
	// Confirmation - Determines the type of confirmation e-mail that will be sent to the newly created user. Possible values include: 'Signup', 'Invite'
	Confirmation Confirmation `json:"confirmation,omitempty"`
	// State - Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'UserStateActive', 'UserStateBlocked', 'UserStatePending', 'UserStateDeleted'
	State UserState `json:"state,omitempty"`
	// Note - Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`
	// Identities - Collection of user identities.
	Identities *[]UserIdentityContract `json:"identities,omitempty"`
}

UserCreateParameterProperties parameters supplied to the Create User operation.

type UserCreateParameters 

type UserCreateParameters struct {
	// UserCreateParameterProperties - User entity create contract properties.
	*UserCreateParameterProperties `json:"properties,omitempty"`
}

UserCreateParameters user create details.

func (UserCreateParameters) MarshalJSON 

func (ucp UserCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UserCreateParameters.

func (*UserCreateParameters) UnmarshalJSON 

func (ucp *UserCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UserCreateParameters struct.

type UserEntityBaseParameters 

type UserEntityBaseParameters struct {
	// State - Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'UserStateActive', 'UserStateBlocked', 'UserStatePending', 'UserStateDeleted'
	State UserState `json:"state,omitempty"`
	// Note - Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`
	// Identities - Collection of user identities.
	Identities *[]UserIdentityContract `json:"identities,omitempty"`
}

UserEntityBaseParameters user Entity Base Parameters set.

type UserGroupClient 

type UserGroupClient struct {
	BaseClient
}

UserGroupClient is the apiManagement Client

func NewUserGroupClient 

func NewUserGroupClient(subscriptionID string) UserGroupClient

NewUserGroupClient creates an instance of the UserGroupClient client.

func NewUserGroupClientWithBaseURI 

func NewUserGroupClientWithBaseURI(baseURI string, subscriptionID string) UserGroupClient

NewUserGroupClientWithBaseURI creates an instance of the UserGroupClient client.

func (UserGroupClient) List 

func (client UserGroupClient) List(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)

List lists all user groups. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. filter - | 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 - number of records to return. skip - number of records to skip.

func (UserGroupClient) ListComplete 

func (client UserGroupClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UserGroupClient) ListPreparer 

func (client UserGroupClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (UserGroupClient) ListResponder 

func (client UserGroupClient) ListResponder(resp *http.Response) (result GroupCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UserGroupClient) ListSender 

func (client UserGroupClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UserIdentitiesClient 

type UserIdentitiesClient struct {
	BaseClient
}

UserIdentitiesClient is the 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) List 

func (client UserIdentitiesClient) List(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result UserIdentityCollectionPage, err error)

List lists all user identities. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance.

func (UserIdentitiesClient) ListComplete 

func (client UserIdentitiesClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result UserIdentityCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UserIdentitiesClient) ListPreparer 

func (client UserIdentitiesClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)

ListPreparer prepares the List request.

func (UserIdentitiesClient) ListResponder 

func (client UserIdentitiesClient) ListResponder(resp *http.Response) (result UserIdentityCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UserIdentitiesClient) ListSender 

func (client UserIdentitiesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UserIdentityCollection 

type UserIdentityCollection struct {
	autorest.Response `json:"-"`
	// Value - User Identity values.
	Value *[]UserIdentityContract `json:"value,omitempty"`
	// Count - Total record count number across all pages.
	Count *int64 `json:"count,omitempty"`
	// NextLink - Next page link if any.
	NextLink *string `json:"nextLink,omitempty"`
}

UserIdentityCollection list of Users Identity list representation.

func (UserIdentityCollection) IsEmpty 

func (uic UserIdentityCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UserIdentityCollectionIterator 

type UserIdentityCollectionIterator struct {
	// contains filtered or unexported fields
}

UserIdentityCollectionIterator provides access to a complete listing of UserIdentityContract values.

func NewUserIdentityCollectionIterator 

func NewUserIdentityCollectionIterator(page UserIdentityCollectionPage) UserIdentityCollectionIterator

Creates a new instance of the UserIdentityCollectionIterator type.

func (*UserIdentityCollectionIterator) Next 

func (iter *UserIdentityCollectionIterator) 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. Deprecated: Use NextWithContext() instead.

func (*UserIdentityCollectionIterator) NextWithContext 

func (iter *UserIdentityCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (UserIdentityCollectionIterator) NotDone 

func (iter UserIdentityCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (UserIdentityCollectionIterator) Response 

func (iter UserIdentityCollectionIterator) Response() UserIdentityCollection

Response returns the raw server response from the last page request.

func (UserIdentityCollectionIterator) Value 

func (iter UserIdentityCollectionIterator) Value() UserIdentityContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type UserIdentityCollectionPage 

type UserIdentityCollectionPage struct {
	// contains filtered or unexported fields
}

UserIdentityCollectionPage contains a page of UserIdentityContract values.

func NewUserIdentityCollectionPage 

func NewUserIdentityCollectionPage(getNextPage func(context.Context, UserIdentityCollection) (UserIdentityCollection, error)) UserIdentityCollectionPage

Creates a new instance of the UserIdentityCollectionPage type.

func (*UserIdentityCollectionPage) Next 

func (page *UserIdentityCollectionPage) 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. Deprecated: Use NextWithContext() instead.

func (*UserIdentityCollectionPage) NextWithContext 

func (page *UserIdentityCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (UserIdentityCollectionPage) NotDone 

func (page UserIdentityCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (UserIdentityCollectionPage) Response 

func (page UserIdentityCollectionPage) Response() UserIdentityCollection

Response returns the raw server response from the last page request.

func (UserIdentityCollectionPage) Values 

func (page UserIdentityCollectionPage) Values() []UserIdentityContract

Values returns the slice of values for the current page or nil if there are no values.

type UserIdentityContract 

type UserIdentityContract struct {
	// Provider - Identity provider name.
	Provider *string `json:"provider,omitempty"`
	// ID - Identifier value within provider.
	ID *string `json:"id,omitempty"`
}

UserIdentityContract user identity details.

type UserState 

type UserState string

UserState enumerates the values for user state. 

const (
	// UserStateActive User state is active.
	UserStateActive UserState = "active"
	// UserStateBlocked User is blocked. Blocked users cannot authenticate at developer portal or call API.
	UserStateBlocked UserState = "blocked"
	// UserStateDeleted User account is closed. All identities and related entities are removed.
	UserStateDeleted UserState = "deleted"
	// UserStatePending User account is pending. Requires identity confirmation before it can be made active.
	UserStatePending UserState = "pending"
)

func PossibleUserStateValues 

func PossibleUserStateValues() []UserState

PossibleUserStateValues returns an array of possible values for the UserState const type.

type UserSubscriptionClient 

type UserSubscriptionClient struct {
	BaseClient
}

UserSubscriptionClient is the apiManagement Client

func NewUserSubscriptionClient 

func NewUserSubscriptionClient(subscriptionID string) UserSubscriptionClient

NewUserSubscriptionClient creates an instance of the UserSubscriptionClient client.

func NewUserSubscriptionClientWithBaseURI 

func NewUserSubscriptionClientWithBaseURI(baseURI string, subscriptionID string) UserSubscriptionClient

NewUserSubscriptionClientWithBaseURI creates an instance of the UserSubscriptionClient client.

func (UserSubscriptionClient) List 

func (client UserSubscriptionClient) List(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)

List lists the collection of subscriptions of the specified user. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. filter - | 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 - number of records to return. skip - number of records to skip.

func (UserSubscriptionClient) ListComplete 

func (client UserSubscriptionClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UserSubscriptionClient) ListPreparer 

func (client UserSubscriptionClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (UserSubscriptionClient) ListResponder 

func (client UserSubscriptionClient) ListResponder(resp *http.Response) (result SubscriptionCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UserSubscriptionClient) ListSender 

func (client UserSubscriptionClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UserTokenParameters 

type UserTokenParameters struct {
	// KeyType - The Key to be used to generate token for user. Possible values include: 'Primary', 'Secondary'
	KeyType KeyType `json:"keyType,omitempty"`
	// Expiry - The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
	Expiry *date.Time `json:"expiry,omitempty"`
}

UserTokenParameters parameters supplied to the Get User Token operation.

type UserTokenResult 

type UserTokenResult struct {
	autorest.Response `json:"-"`
	// Value - Shared Access Authorization token for the User.
	Value *string `json:"value,omitempty"`
}

UserTokenResult get User Token response details.

type UserUpdateParameters 

type UserUpdateParameters struct {
	// UserUpdateParametersProperties - User entity update contract properties.
	*UserUpdateParametersProperties `json:"properties,omitempty"`
}

UserUpdateParameters user update parameters.

func (UserUpdateParameters) MarshalJSON 

func (uup UserUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UserUpdateParameters.

func (*UserUpdateParameters) UnmarshalJSON 

func (uup *UserUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UserUpdateParameters struct.

type UserUpdateParametersProperties 

type UserUpdateParametersProperties struct {
	// Email - Email address. Must not be empty and must be unique within the service instance.
	Email *string `json:"email,omitempty"`
	// Password - User Password.
	Password *string `json:"password,omitempty"`
	// FirstName - First name.
	FirstName *string `json:"firstName,omitempty"`
	// LastName - Last name.
	LastName *string `json:"lastName,omitempty"`
	// State - Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'UserStateActive', 'UserStateBlocked', 'UserStatePending', 'UserStateDeleted'
	State UserState `json:"state,omitempty"`
	// Note - Optional note about a user set by the administrator.
	Note *string `json:"note,omitempty"`
	// Identities - Collection of user identities.
	Identities *[]UserIdentityContract `json:"identities,omitempty"`
}

UserUpdateParametersProperties parameters supplied to the Update User operation.

type VersioningScheme 

type VersioningScheme string

VersioningScheme enumerates the values for versioning scheme. 

const (
	// VersioningSchemeHeader The API Version is passed in a HTTP header.
	VersioningSchemeHeader VersioningScheme = "Header"
	// VersioningSchemeQuery The API Version is passed in a query parameter.
	VersioningSchemeQuery VersioningScheme = "Query"
	// VersioningSchemeSegment The API Version is passed in a path segment.
	VersioningSchemeSegment VersioningScheme = "Segment"
)

func PossibleVersioningSchemeValues 

func PossibleVersioningSchemeValues() []VersioningScheme

PossibleVersioningSchemeValues returns an array of possible values for the VersioningScheme const type.

type VersioningScheme1 

type VersioningScheme1 string

VersioningScheme1 enumerates the values for versioning scheme 1. 

const (
	// VersioningScheme1Header ...
	VersioningScheme1Header VersioningScheme1 = "Header"
	// VersioningScheme1Query ...
	VersioningScheme1Query VersioningScheme1 = "Query"
	// VersioningScheme1Segment ...
	VersioningScheme1Segment VersioningScheme1 = "Segment"
)

func PossibleVersioningScheme1Values 

func PossibleVersioningScheme1Values() []VersioningScheme1

PossibleVersioningScheme1Values returns an array of possible values for the VersioningScheme1 const type.

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"`
}

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 The service is part of Virtual Network and it is accessible from Internet.
	VirtualNetworkTypeExternal VirtualNetworkType = "External"
	// VirtualNetworkTypeInternal The service is part of Virtual Network and it is only accessible from within
	// the virtual network.
	VirtualNetworkTypeInternal VirtualNetworkType = "Internal"
	// VirtualNetworkTypeNone The service is not part of any Virtual Network.
	VirtualNetworkTypeNone VirtualNetworkType = "None"
)

func PossibleVirtualNetworkTypeValues 

func PossibleVirtualNetworkTypeValues() []VirtualNetworkType

PossibleVirtualNetworkTypeValues returns an array of possible values for the VirtualNetworkType const type.

type X509CertificateName 

type X509CertificateName struct {
	// Name - Common Name of the Certificate.
	Name *string `json:"name,omitempty"`
	// IssuerCertificateThumbprint - Thumbprint for the Issuer of the Certificate.
	IssuerCertificateThumbprint *string `json:"issuerCertificateThumbprint,omitempty"`
}

X509CertificateName properties of server X509Names.

Source Files

View all Source files

Directories

Path Synopsis

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.