apimanagement

package
v8.1.1-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Mar 2, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

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

Use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

Index

Constants

View Source 
const (
	// APIVersion is the version of the Apimanagement
	APIVersion = "2016-07-07"

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

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type APICollection 

type APICollection struct {
	autorest.Response `json:"-"`
	Value             *[]APIContract `json:"value,omitempty"`
	Count             *int64         `json:"count,omitempty"`
	NextLink          *string        `json:"nextLink,omitempty"`
}

APICollection is paged Api list representation.

func (APICollection) APICollectionPreparer 

func (client APICollection) APICollectionPreparer() (*http.Request, error)

APICollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type APIContract 

type APIContract struct {
	autorest.Response             `json:"-"`
	ID                            *string                                `json:"id,omitempty"`
	Name                          *string                                `json:"name,omitempty"`
	Description                   *string                                `json:"description,omitempty"`
	ServiceURL                    *string                                `json:"serviceUrl,omitempty"`
	Path                          *string                                `json:"path,omitempty"`
	Protocols                     *[]APIProtocolContract                 `json:"protocols,omitempty"`
	AuthenticationSettings        *AuthenticationSettingsContract        `json:"authenticationSettings,omitempty"`
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	Type                          APITypeContract                        `json:"type,omitempty"`
}

APIContract is aPI details.

type APIExportResult 

type APIExportResult struct {
	autorest.Response `json:"-"`
	Content           *[]byte        `json:"content,omitempty"`
	StatusCode        HTTPStatusCode `json:"statusCode,omitempty"`
	RequestID         *string        `json:"requestId,omitempty"`
}

APIExportResult is the response model for the export API output operation.

type APIOperationsClient 

type APIOperationsClient struct {
	ManagementClient
}

APIOperationsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewAPIOperationsClient 

func NewAPIOperationsClient(subscriptionID string) APIOperationsClient

NewAPIOperationsClient creates an instance of the APIOperationsClient client.

func NewAPIOperationsClientWithBaseURI 

func NewAPIOperationsClientWithBaseURI(baseURI string, subscriptionID string) APIOperationsClient

NewAPIOperationsClientWithBaseURI creates an instance of the APIOperationsClient client.

func (APIOperationsClient) CreateOrUpdate 

func (client APIOperationsClient) CreateOrUpdate(resourceGroupName string, serviceName string, apiID string, operationID string, parameters OperationContract) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiID is aPI identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance. parameters is create parameters.

func (APIOperationsClient) CreateOrUpdatePreparer 

func (client APIOperationsClient) CreateOrUpdatePreparer(resourceGroupName string, serviceName string, apiID string, operationID string, parameters OperationContract) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationsClient) CreateOrUpdateResponder 

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

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

func (APIOperationsClient) CreateOrUpdateSender 

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

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

func (APIOperationsClient) Delete 

func (client APIOperationsClient) Delete(resourceGroupName string, serviceName string, apiID string, operationID string, ifMatch string) (result autorest.Response, err error)

Delete deletes the specified operation.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiID is aPI identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance. ifMatch is eTag of the API Operation Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIOperationsClient) DeletePreparer 

func (client APIOperationsClient) DeletePreparer(resourceGroupName string, serviceName string, apiID string, operationID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (APIOperationsClient) DeleteResponder 

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

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

func (APIOperationsClient) DeleteSender 

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

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

func (APIOperationsClient) Get 

func (client APIOperationsClient) Get(resourceGroupName string, serviceName string, apiID string, operationID string) (result OperationContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiID is aPI identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance.

func (APIOperationsClient) GetPreparer 

func (client APIOperationsClient) GetPreparer(resourceGroupName string, serviceName string, apiID string, operationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (APIOperationsClient) GetResponder 

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

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

func (APIOperationsClient) GetSender 

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

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

func (APIOperationsClient) ListByAPI 

func (client APIOperationsClient) ListByAPI(resourceGroupName string, serviceName string, apiID string, filter string, top *int32, skip *int32) (result OperationCollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiID is aPI identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | method | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (APIOperationsClient) ListByAPINextResults 

func (client APIOperationsClient) ListByAPINextResults(lastResults OperationCollection) (result OperationCollection, err error)

ListByAPINextResults retrieves the next set of results, if any.

func (APIOperationsClient) ListByAPIPreparer 

func (client APIOperationsClient) ListByAPIPreparer(resourceGroupName string, serviceName string, apiID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByAPIPreparer prepares the ListByAPI request.

func (APIOperationsClient) ListByAPIResponder 

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

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

func (client APIOperationsClient) Update(resourceGroupName string, serviceName string, apiID string, operationID string, parameters PatchParameters, ifMatch string) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiID is aPI identifier. Must be unique in the current API Management service instance. operationID is operation identifier within an API. Must be unique in the current API Management service instance. parameters is update parameters. ifMatch is eTag of the API Operation Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APIOperationsClient) UpdatePreparer 

func (client APIOperationsClient) UpdatePreparer(resourceGroupName string, serviceName string, apiID string, operationID string, parameters PatchParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (APIOperationsClient) UpdateResponder 

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

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

func (APIOperationsClient) UpdateSender 

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

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

type APIProductsClient 

type APIProductsClient struct {
	ManagementClient
}

APIProductsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewAPIProductsClient 

func NewAPIProductsClient(subscriptionID string) APIProductsClient

NewAPIProductsClient creates an instance of the APIProductsClient client.

func NewAPIProductsClientWithBaseURI 

func NewAPIProductsClientWithBaseURI(baseURI string, subscriptionID string) APIProductsClient

NewAPIProductsClientWithBaseURI creates an instance of the APIProductsClient client.

func (APIProductsClient) ListByAPI 

func (client APIProductsClient) ListByAPI(resourceGroupName string, serviceName string, apiID string, filter string, top *int32, skip *int32) (result ProductCollection, err error)

ListByAPI lists all API associated products.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiID is aPI identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (APIProductsClient) ListByAPINextResults 

func (client APIProductsClient) ListByAPINextResults(lastResults ProductCollection) (result ProductCollection, err error)

ListByAPINextResults retrieves the next set of results, if any.

func (APIProductsClient) ListByAPIPreparer 

func (client APIProductsClient) ListByAPIPreparer(resourceGroupName string, serviceName string, apiID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByAPIPreparer prepares the ListByAPI request.

func (APIProductsClient) ListByAPIResponder 

func (client APIProductsClient) ListByAPIResponder(resp *http.Response) (result ProductCollection, err error)

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

func (APIProductsClient) ListByAPISender 

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

type APIProtocolContract string

APIProtocolContract enumerates the values for api protocol contract. 

const (
	// HTTP specifies the http state for api protocol contract.
	HTTP APIProtocolContract = "Http"
	// HTTPS specifies the https state for api protocol contract.
	HTTPS APIProtocolContract = "Https"
)

type APITypeContract 

type APITypeContract string

APITypeContract enumerates the values for api type contract. 

const (
	// APITypeContractHTTP specifies the api type contract http state for api
	// type contract.
	APITypeContractHTTP APITypeContract = "Http"
	// APITypeContractSoap specifies the api type contract soap state for api
	// type contract.
	APITypeContractSoap APITypeContract = "Soap"
)

type AccessInformationContract 

type AccessInformationContract struct {
	autorest.Response `json:"-"`
	ID                *string `json:"id,omitempty"`
	PrimaryKey        *string `json:"primaryKey,omitempty"`
	SecondaryKey      *string `json:"secondaryKey,omitempty"`
	Enabled           *bool   `json:"enabled,omitempty"`
}

AccessInformationContract is tenant access information contract of the API Management service.

type AccessInformationUpdateParameters 

type AccessInformationUpdateParameters struct {
	Enabled *bool `json:"enabled,omitempty"`
}

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

type ApisClient 

type ApisClient struct {
	ManagementClient
}

ApisClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewApisClient 

func NewApisClient(subscriptionID string) ApisClient

NewApisClient creates an instance of the ApisClient client.

func NewApisClientWithBaseURI 

func NewApisClientWithBaseURI(baseURI string, subscriptionID string) ApisClient

NewApisClientWithBaseURI creates an instance of the ApisClient client.

func (ApisClient) CreateOrUpdate 

func (client ApisClient) CreateOrUpdate(resourceGroupName string, serviceName string, apiID string, parameters APIContract, ifMatch string) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiID is aPI identifier. Must be unique in the current API Management service instance. parameters is create or update parameters. ifMatch is eTag of the Api Entity. For Create Api Etag should not be specified. For Update Etag should match the existing Entity or it can be * for unconditional update.

func (ApisClient) CreateOrUpdatePreparer 

func (client ApisClient) CreateOrUpdatePreparer(resourceGroupName string, serviceName string, apiID string, parameters APIContract, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ApisClient) CreateOrUpdateResponder 

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

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

func (ApisClient) CreateOrUpdateSender 

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

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

func (ApisClient) Delete 

func (client ApisClient) Delete(resourceGroupName string, serviceName string, apiID string, ifMatch string) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiID is aPI identifier. Must be unique in the current API Management service instance. ifMatch is eTag of the API Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (ApisClient) DeletePreparer 

func (client ApisClient) DeletePreparer(resourceGroupName string, serviceName string, apiID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ApisClient) DeleteResponder 

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

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

func (ApisClient) DeleteSender 

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

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

func (ApisClient) Export 

func (client ApisClient) Export(resourceGroupName string, serviceName string, apiID string) (result APIExportResult, err error)

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

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

func (ApisClient) ExportPreparer 

func (client ApisClient) ExportPreparer(resourceGroupName string, serviceName string, apiID string) (*http.Request, error)

ExportPreparer prepares the Export request.

func (ApisClient) ExportResponder 

func (client ApisClient) ExportResponder(resp *http.Response) (result APIExportResult, err error)

ExportResponder handles the response to the Export request. The method always closes the http.Response Body.

func (ApisClient) ExportSender 

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

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

func (ApisClient) Get 

func (client ApisClient) Get(resourceGroupName string, serviceName string, apiID string) (result APIContract, err error)

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

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

func (ApisClient) GetPreparer 

func (client ApisClient) GetPreparer(resourceGroupName string, serviceName string, apiID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ApisClient) GetResponder 

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

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

func (ApisClient) GetSender 

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

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

func (ApisClient) ListByService 

func (client ApisClient) ListByService(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result APICollection, err error)

ListByService lists all APIs of the API Management service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (ApisClient) ListByServiceNextResults 

func (client ApisClient) ListByServiceNextResults(lastResults APICollection) (result APICollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (ApisClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (ApisClient) ListByServiceResponder 

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

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

func (ApisClient) ListByServiceSender 

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

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

func (ApisClient) Update 

func (client ApisClient) Update(resourceGroupName string, serviceName string, apiID string, parameters PatchParameters, ifMatch string) (result autorest.Response, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. apiID is aPI identifier. Must be unique in the current API Management service instance. parameters is patch parameters. ifMatch is eTag of the API entity. ETag should match the current entity state in the header response of the GET request or it should be * for unconditional update.

func (ApisClient) UpdatePreparer 

func (client ApisClient) UpdatePreparer(resourceGroupName string, serviceName string, apiID string, parameters PatchParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ApisClient) UpdateResponder 

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

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

func (ApisClient) UpdateSender 

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

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

type AsyncOperationState 

type AsyncOperationState string

AsyncOperationState enumerates the values for async operation state. 

const (
	// Failed specifies the failed state for async operation state.
	Failed AsyncOperationState = "Failed"
	// InProgress specifies the in progress state for async operation state.
	InProgress AsyncOperationState = "InProgress"
	// Started specifies the started state for async operation state.
	Started AsyncOperationState = "Started"
	// Succeeded specifies the succeeded state for async operation state.
	Succeeded AsyncOperationState = "Succeeded"
)

type AuthenticationSettingsContract 

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

AuthenticationSettingsContract is aPI Authentication Settings.

type AuthorizationServerCollection 

type AuthorizationServerCollection struct {
	autorest.Response `json:"-"`
	Value             *[]OAuth2AuthorizationServerContract `json:"value,omitempty"`
	Count             *int64                               `json:"count,omitempty"`
	NextLink          *string                              `json:"nextLink,omitempty"`
}

AuthorizationServerCollection is paged OAuth2 Authorization Servers list representation.

func (AuthorizationServerCollection) AuthorizationServerCollectionPreparer 

func (client AuthorizationServerCollection) AuthorizationServerCollectionPreparer() (*http.Request, error)

AuthorizationServerCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type AuthorizationServersClient 

type AuthorizationServersClient struct {
	ManagementClient
}

AuthorizationServersClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewAuthorizationServersClient 

func NewAuthorizationServersClient(subscriptionID string) AuthorizationServersClient

NewAuthorizationServersClient creates an instance of the AuthorizationServersClient client.

func NewAuthorizationServersClientWithBaseURI 

func NewAuthorizationServersClientWithBaseURI(baseURI string, subscriptionID string) AuthorizationServersClient

NewAuthorizationServersClientWithBaseURI creates an instance of the AuthorizationServersClient client.

func (AuthorizationServersClient) CreateOrUpdate 

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

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

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

func (AuthorizationServersClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AuthorizationServersClient) CreateOrUpdateResponder 

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

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

func (AuthorizationServersClient) CreateOrUpdateSender 

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

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

func (AuthorizationServersClient) Delete 

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

Delete deletes specific authorization server instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. authsid is identifier of the authorization server. ifMatch is the entity state (Etag) version of the authentication server to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (AuthorizationServersClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (AuthorizationServersClient) DeleteResponder 

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

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

func (AuthorizationServersClient) DeleteSender 

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

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

func (AuthorizationServersClient) Get 

func (client AuthorizationServersClient) Get(resourceGroupName string, serviceName string, authsid string) (result OAuth2AuthorizationServerContract, err error)

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

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

func (AuthorizationServersClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (AuthorizationServersClient) GetResponder 

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

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

func (AuthorizationServersClient) GetSender 

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

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

func (AuthorizationServersClient) ListByService 

func (client AuthorizationServersClient) ListByService(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result AuthorizationServerCollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (AuthorizationServersClient) ListByServiceNextResults 

func (client AuthorizationServersClient) ListByServiceNextResults(lastResults AuthorizationServerCollection) (result AuthorizationServerCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (AuthorizationServersClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (AuthorizationServersClient) ListByServiceResponder 

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

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

func (AuthorizationServersClient) ListByServiceSender 

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

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

func (AuthorizationServersClient) Update 

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

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. authsid is identifier of the authorization server. parameters is oAuth2 Server settings Update parameters. ifMatch is the entity state (Etag) version of the authorization server to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (AuthorizationServersClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (AuthorizationServersClient) UpdateResponder 

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

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

func (AuthorizationServersClient) UpdateSender 

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

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

type BackendCollection 

type BackendCollection struct {
	autorest.Response `json:"-"`
	Value             *[]BackendResponse `json:"value,omitempty"`
	Count             *int64             `json:"count,omitempty"`
	NextLink          *string            `json:"nextLink,omitempty"`
}

BackendCollection is paged Backend list representation.

func (BackendCollection) BackendCollectionPreparer 

func (client BackendCollection) BackendCollectionPreparer() (*http.Request, error)

BackendCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type BackendContract 

type BackendContract struct {
	Host                           *string `json:"host,omitempty"`
	SkipCertificateChainValidation *bool   `json:"skipCertificateChainValidation,omitempty"`
}

BackendContract is parameters supplied to the Create Backend operation.

type BackendResponse 

type BackendResponse struct {
	autorest.Response              `json:"-"`
	Host                           *string `json:"host,omitempty"`
	SkipCertificateChainValidation *bool   `json:"skipCertificateChainValidation,omitempty"`
	ID                             *string `json:"id,omitempty"`
}

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

type BackendUpdateParameters 

type BackendUpdateParameters struct {
	Host                           *string `json:"host,omitempty"`
	SkipCertificateChainValidation *bool   `json:"skipCertificateChainValidation,omitempty"`
}

BackendUpdateParameters is parameters supplied to the Update Backend operation.

type BackendsClient 

type BackendsClient struct {
	ManagementClient
}

BackendsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewBackendsClient 

func NewBackendsClient(subscriptionID string) BackendsClient

NewBackendsClient creates an instance of the BackendsClient client.

func NewBackendsClientWithBaseURI 

func NewBackendsClientWithBaseURI(baseURI string, subscriptionID string) BackendsClient

NewBackendsClientWithBaseURI creates an instance of the BackendsClient client.

func (BackendsClient) CreateOrUpdate 

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

CreateOrUpdate creates or Updates a backend.

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

func (BackendsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BackendsClient) CreateOrUpdateResponder 

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

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

func (BackendsClient) CreateOrUpdateSender 

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

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

func (BackendsClient) Delete 

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

Delete deletes the specified backend.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. backendid is user identifier. Must be unique in the current API Management service instance. ifMatch is the entity state (Etag) version of the backend to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (BackendsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (BackendsClient) DeleteResponder 

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

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

func (BackendsClient) DeleteSender 

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

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

func (BackendsClient) Get 

func (client BackendsClient) Get(resourceGroupName string, serviceName string, backendid string) (result BackendResponse, err error)

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

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

func (BackendsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (BackendsClient) GetResponder 

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

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

func (BackendsClient) GetSender 

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

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

func (BackendsClient) ListByService 

func (client BackendsClient) ListByService(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result BackendCollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | host | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (BackendsClient) ListByServiceNextResults 

func (client BackendsClient) ListByServiceNextResults(lastResults BackendCollection) (result BackendCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (BackendsClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (BackendsClient) ListByServiceResponder 

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

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

func (BackendsClient) ListByServiceSender 

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

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

func (BackendsClient) Update 

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

Update updates an existing backend.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. backendid is user identifier. Must be unique in the current API Management service instance. parameters is update parameters. ifMatch is the entity state (Etag) version of the backend to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (BackendsClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (BackendsClient) UpdateResponder 

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

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

func (BackendsClient) UpdateSender 

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

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

type BearerTokenSendingMethodsContract 

type BearerTokenSendingMethodsContract string

BearerTokenSendingMethodsContract enumerates the values for bearer token sending methods contract. 

const (
	// AuthorizationHeader specifies the authorization header state for bearer
	// token sending methods contract.
	AuthorizationHeader BearerTokenSendingMethodsContract = "authorizationHeader"
	// Query specifies the query state for bearer token sending methods
	// contract.
	Query BearerTokenSendingMethodsContract = "query"
)

type CertificateCollection 

type CertificateCollection struct {
	autorest.Response `json:"-"`
	Value             *[]CertificateContract `json:"value,omitempty"`
	Count             *int64                 `json:"count,omitempty"`
	NextLink          *string                `json:"nextLink,omitempty"`
}

CertificateCollection is paged Certificates list representation.

func (CertificateCollection) CertificateCollectionPreparer 

func (client CertificateCollection) CertificateCollectionPreparer() (*http.Request, error)

CertificateCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type CertificateContract 

type CertificateContract struct {
	autorest.Response `json:"-"`
	ID                *string    `json:"id,omitempty"`
	Subject           *string    `json:"subject,omitempty"`
	Thumbprint        *string    `json:"thumbprint,omitempty"`
	ExpirationDate    *date.Time `json:"expirationDate,omitempty"`
}

CertificateContract is certificate details.

type CertificateCreateOrUpdateParameters 

type CertificateCreateOrUpdateParameters struct {
	Data     *string `json:"data,omitempty"`
	Password *string `json:"password,omitempty"`
}

CertificateCreateOrUpdateParameters is parameters supplied to the CreateOrUpdate certificate operation.

type CertificatesClient 

type CertificatesClient struct {
	ManagementClient
}

CertificatesClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewCertificatesClient 

func NewCertificatesClient(subscriptionID string) CertificatesClient

NewCertificatesClient creates an instance of the CertificatesClient client.

func NewCertificatesClientWithBaseURI 

func NewCertificatesClientWithBaseURI(baseURI string, subscriptionID string) CertificatesClient

NewCertificatesClientWithBaseURI creates an instance of the CertificatesClient client.

func (CertificatesClient) CreateOrUpdate 

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

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. certificateID is identifier of the certificate entity. Must be unique in the current API Management service instance. parameters is create parameters. ifMatch is the entity state (Etag) version of the certificate to update. A value of "*" can be used for If-Match to unconditionally apply the operation..

func (CertificatesClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CertificatesClient) CreateOrUpdateResponder 

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

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

func (CertificatesClient) CreateOrUpdateSender 

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

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

func (CertificatesClient) Delete 

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

Delete deletes specific certificate.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. certificateID is identifier of the certificate. ifMatch is the entity state (Etag) version of the certificate to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (CertificatesClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (CertificatesClient) DeleteResponder 

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

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

func (CertificatesClient) DeleteSender 

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

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

func (CertificatesClient) Get 

func (client CertificatesClient) Get(resourceGroupName string, serviceName string, certificateID string) (result CertificateContract, err error)

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

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

func (CertificatesClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (CertificatesClient) GetResponder 

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

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

func (CertificatesClient) GetSender 

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

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

func (CertificatesClient) ListByService 

func (client CertificatesClient) ListByService(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result CertificateCollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |----------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | subject | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | thumbprint | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | expirationDate | ge, le, eq, ne, gt, lt | N/A | top is number of records to return. skip is number of records to skip.

func (CertificatesClient) ListByServiceNextResults 

func (client CertificatesClient) ListByServiceNextResults(lastResults CertificateCollection) (result CertificateCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (CertificatesClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (CertificatesClient) ListByServiceResponder 

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

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

func (CertificatesClient) ListByServiceSender 

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

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

type ClientAuthenticationMethodContract 

type ClientAuthenticationMethodContract string

ClientAuthenticationMethodContract enumerates the values for client authentication method contract. 

const (
	// Basic specifies the basic state for client authentication method
	// contract.
	Basic ClientAuthenticationMethodContract = "Basic"
	// Body specifies the body state for client authentication method contract.
	Body ClientAuthenticationMethodContract = "Body"
)

type DeployConfigurationParameters 

type DeployConfigurationParameters struct {
	Branch *string `json:"branch,omitempty"`
	Force  *bool   `json:"force,omitempty"`
}

DeployConfigurationParameters is parameters supplied to the Deploy Configuration operation.

type ErrorBodyContract 

type ErrorBodyContract struct {
	autorest.Response `json:"-"`
	Code              *string               `json:"code,omitempty"`
	Message           *string               `json:"message,omitempty"`
	Details           *[]ErrorFieldContract `json:"details,omitempty"`
}

ErrorBodyContract is error Body contract.

type ErrorFieldContract 

type ErrorFieldContract struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
	Target  *string `json:"target,omitempty"`
}

ErrorFieldContract is error Field contract.

type GenerateSsoURLResult 

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

GenerateSsoURLResult is generate SSO Url operations response details.

type GrantTypesContract 

type GrantTypesContract string

GrantTypesContract enumerates the values for grant types contract. 

const (
	// AuthorizationCode specifies the authorization code state for grant types
	// contract.
	AuthorizationCode GrantTypesContract = "authorizationCode"
	// ClientCredentials specifies the client credentials state for grant types
	// contract.
	ClientCredentials GrantTypesContract = "clientCredentials"
	// Implicit specifies the implicit state for grant types contract.
	Implicit GrantTypesContract = "implicit"
	// ResourceOwnerPassword specifies the resource owner password state for
	// grant types contract.
	ResourceOwnerPassword GrantTypesContract = "resourceOwnerPassword"
)

type GroupCollection 

type GroupCollection struct {
	autorest.Response `json:"-"`
	Value             *[]GroupContract `json:"value,omitempty"`
	Count             *int64           `json:"count,omitempty"`
	NextLink          *string          `json:"nextLink,omitempty"`
}

GroupCollection is paged Group list representation.

func (GroupCollection) GroupCollectionPreparer 

func (client GroupCollection) GroupCollectionPreparer() (*http.Request, error)

GroupCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type GroupContract 

type GroupContract struct {
	autorest.Response `json:"-"`
	ID                *string           `json:"id,omitempty"`
	Name              *string           `json:"name,omitempty"`
	Description       *string           `json:"description,omitempty"`
	BuiltIn           *bool             `json:"builtIn,omitempty"`
	Type              GroupTypeContract `json:"type,omitempty"`
	ExternalID        *string           `json:"externalId,omitempty"`
}

GroupContract is developer group.

type GroupCreateParameters 

type GroupCreateParameters struct {
	Name        *string           `json:"name,omitempty"`
	Description *string           `json:"description,omitempty"`
	Type        GroupTypeContract `json:"type,omitempty"`
	ExternalID  *string           `json:"externalId,omitempty"`
}

GroupCreateParameters is parameters supplied to the Create Group operation.

type GroupTypeContract 

type GroupTypeContract string

GroupTypeContract enumerates the values for group type contract. 

const (
	// Custom specifies the custom state for group type contract.
	Custom GroupTypeContract = "Custom"
	// External specifies the external state for group type contract.
	External GroupTypeContract = "External"
	// System specifies the system state for group type contract.
	System GroupTypeContract = "System"
)

type GroupUpdateParameters 

type GroupUpdateParameters struct {
	Name        *string           `json:"name,omitempty"`
	Description *string           `json:"description,omitempty"`
	Type        GroupTypeContract `json:"type,omitempty"`
	ExternalID  *string           `json:"externalId,omitempty"`
}

GroupUpdateParameters is parameters supplied to the Update Group operation.

type GroupUsersClient 

type GroupUsersClient struct {
	ManagementClient
}

GroupUsersClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewGroupUsersClient 

func NewGroupUsersClient(subscriptionID string) GroupUsersClient

NewGroupUsersClient creates an instance of the GroupUsersClient client.

func NewGroupUsersClientWithBaseURI 

func NewGroupUsersClientWithBaseURI(baseURI string, subscriptionID string) GroupUsersClient

NewGroupUsersClientWithBaseURI creates an instance of the GroupUsersClient client.

func (GroupUsersClient) Add 

func (client GroupUsersClient) Add(resourceGroupName string, serviceName string, groupID string, uid string) (result ErrorBodyContract, err error)

Add adds a user to the specified group.

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

func (GroupUsersClient) AddPreparer 

func (client GroupUsersClient) AddPreparer(resourceGroupName string, serviceName string, groupID string, uid string) (*http.Request, error)

AddPreparer prepares the Add request.

func (GroupUsersClient) AddResponder 

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

AddResponder handles the response to the Add request. The method always closes the http.Response Body.

func (GroupUsersClient) AddSender 

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

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

func (GroupUsersClient) ListByGroup 

func (client GroupUsersClient) ListByGroup(resourceGroupName string, serviceName string, groupID string, filter string, top *int32, skip *int32) (result UserCollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. groupID is group identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |------------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | N/A | | registrationDate | ge, le, eq, ne, gt, lt | N/A | | note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (GroupUsersClient) ListByGroupNextResults 

func (client GroupUsersClient) ListByGroupNextResults(lastResults UserCollection) (result UserCollection, err error)

ListByGroupNextResults retrieves the next set of results, if any.

func (GroupUsersClient) ListByGroupPreparer 

func (client GroupUsersClient) ListByGroupPreparer(resourceGroupName string, serviceName string, groupID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByGroupPreparer prepares the ListByGroup request.

func (GroupUsersClient) ListByGroupResponder 

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

ListByGroupResponder handles the response to the ListByGroup request. The method always closes the http.Response Body.

func (GroupUsersClient) ListByGroupSender 

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

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

func (GroupUsersClient) Remove 

func (client GroupUsersClient) Remove(resourceGroupName string, serviceName string, groupID string, uid string) (result ErrorBodyContract, err error)

Remove remove existing user from existing group.

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

func (GroupUsersClient) RemovePreparer 

func (client GroupUsersClient) RemovePreparer(resourceGroupName string, serviceName string, groupID string, uid string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (GroupUsersClient) RemoveResponder 

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

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (GroupUsersClient) RemoveSender 

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

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

type GroupsClient 

type GroupsClient struct {
	ManagementClient
}

GroupsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewGroupsClient 

func NewGroupsClient(subscriptionID string) GroupsClient

NewGroupsClient creates an instance of the GroupsClient client.

func NewGroupsClientWithBaseURI 

func NewGroupsClientWithBaseURI(baseURI string, subscriptionID string) GroupsClient

NewGroupsClientWithBaseURI creates an instance of the GroupsClient client.

func (GroupsClient) CreateOrUpdate 

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

CreateOrUpdate creates or Updates a group.

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

func (GroupsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupsClient) CreateOrUpdateResponder 

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

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

func (GroupsClient) CreateOrUpdateSender 

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

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

func (GroupsClient) Delete 

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

Delete deletes specific group of the API Management service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. groupID is group identifier. Must be unique in the current API Management service instance. ifMatch is eTag of the Group Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (GroupsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (GroupsClient) DeleteResponder 

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

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

func (GroupsClient) DeleteSender 

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

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

func (GroupsClient) Get 

func (client GroupsClient) Get(resourceGroupName string, serviceName string, groupID string) (result GroupContract, err error)

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

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

func (GroupsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (GroupsClient) GetResponder 

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

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

func (GroupsClient) GetSender 

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

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

func (GroupsClient) ListByService 

func (client GroupsClient) ListByService(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result GroupCollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq, ne | N/A | top is number of records to return. skip is number of records to skip.

func (GroupsClient) ListByServiceNextResults 

func (client GroupsClient) ListByServiceNextResults(lastResults GroupCollection) (result GroupCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (GroupsClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (GroupsClient) ListByServiceResponder 

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

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

func (GroupsClient) ListByServiceSender 

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

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

func (GroupsClient) Update 

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

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. groupID is group identifier. Must be unique in the current API Management service instance. parameters is update parameters. ifMatch is eTag of the Group Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (GroupsClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (GroupsClient) UpdateResponder 

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

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

func (GroupsClient) UpdateSender 

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

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

type HTTPStatusCode 

type HTTPStatusCode string

HTTPStatusCode enumerates the values for http status code. 

const (
	// Accepted specifies the accepted state for http status code.
	Accepted HTTPStatusCode = "Accepted"
	// Conflict specifies the conflict state for http status code.
	Conflict HTTPStatusCode = "Conflict"
	// Continue specifies the continue state for http status code.
	Continue HTTPStatusCode = "Continue"
	// Created specifies the created state for http status code.
	Created HTTPStatusCode = "Created"
	// NotFound specifies the not found state for http status code.
	NotFound HTTPStatusCode = "NotFound"
	// OK specifies the ok state for http status code.
	OK HTTPStatusCode = "OK"
)

type IdentityProviderContract 

type IdentityProviderContract struct {
	autorest.Response `json:"-"`
	ClientID          *string                  `json:"clientId,omitempty"`
	ClientSecret      *string                  `json:"clientSecret,omitempty"`
	Type              IdentityProviderNameType `json:"type,omitempty"`
	AllowedTenants    *[]string                `json:"allowedTenants,omitempty"`
}

IdentityProviderContract is 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             *[]IdentityProviderContract `json:"value,omitempty"`
}

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

type IdentityProviderNameType 

type IdentityProviderNameType string

IdentityProviderNameType enumerates the values for identity provider name type. 

const (
	// Aad specifies the aad state for identity provider name type.
	Aad IdentityProviderNameType = "aad"
	// Facebook specifies the facebook state for identity provider name type.
	Facebook IdentityProviderNameType = "facebook"
	// Google specifies the google state for identity provider name type.
	Google IdentityProviderNameType = "google"
	// Microsoft specifies the microsoft state for identity provider name type.
	Microsoft IdentityProviderNameType = "microsoft"
	// Twitter specifies the twitter state for identity provider name type.
	Twitter IdentityProviderNameType = "twitter"
)

type IdentityProviderUpdateParameters 

type IdentityProviderUpdateParameters struct {
	ClientID       *string   `json:"clientId,omitempty"`
	ClientSecret   *string   `json:"clientSecret,omitempty"`
	AllowedTenants *[]string `json:"allowedTenants,omitempty"`
}

IdentityProviderUpdateParameters is parameters supplied to the Update Identity Provider operation.

type IdentityProvidersClient 

type IdentityProvidersClient struct {
	ManagementClient
}

IdentityProvidersClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewIdentityProvidersClient 

func NewIdentityProvidersClient(subscriptionID string) IdentityProvidersClient

NewIdentityProvidersClient creates an instance of the IdentityProvidersClient client.

func NewIdentityProvidersClientWithBaseURI 

func NewIdentityProvidersClientWithBaseURI(baseURI string, subscriptionID string) IdentityProvidersClient

NewIdentityProvidersClientWithBaseURI creates an instance of the IdentityProvidersClient client.

func (IdentityProvidersClient) CreateOrUpdate 

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

CreateOrUpdate creates or Updates the IdentityProvider configuration.

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

func (IdentityProvidersClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (IdentityProvidersClient) CreateOrUpdateResponder 

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

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

func (IdentityProvidersClient) CreateOrUpdateSender 

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

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

func (IdentityProvidersClient) Delete 

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

Delete deletes the specified identity provider configuration.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. identityProviderName is identity Provider Type identifier. ifMatch is the entity state (Etag) version of the backend to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (IdentityProvidersClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (IdentityProvidersClient) DeleteResponder 

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

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

func (IdentityProvidersClient) DeleteSender 

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

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

func (IdentityProvidersClient) Get 

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

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

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

func (IdentityProvidersClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (IdentityProvidersClient) GetResponder 

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

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

func (IdentityProvidersClient) GetSender 

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

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

func (IdentityProvidersClient) ListByService 

func (client IdentityProvidersClient) ListByService(resourceGroupName string, serviceName string) (result IdentityProviderList, err error)

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

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

func (IdentityProvidersClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (IdentityProvidersClient) ListByServiceResponder 

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

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

func (IdentityProvidersClient) ListByServiceSender 

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

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

func (IdentityProvidersClient) Update 

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

Update updates an existing IdentityProvider configuration.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. identityProviderName is identity Provider Type identifier. parameters is update parameters. ifMatch is the entity state (Etag) version of the identity provider configuration to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (IdentityProvidersClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (IdentityProvidersClient) UpdateResponder 

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

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

func (IdentityProvidersClient) UpdateSender 

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

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

type ListPolicySnippetContract 

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

ListPolicySnippetContract is

type ListUserIdentityContract 

type ListUserIdentityContract struct {
	autorest.Response `json:"-"`
	Value             *[]UserIdentityContract `json:"value,omitempty"`
}

ListUserIdentityContract is

type LoggerCollection 

type LoggerCollection struct {
	autorest.Response `json:"-"`
	Value             *[]LoggerResponse `json:"value,omitempty"`
	Count             *int64            `json:"count,omitempty"`
	NextLink          *string           `json:"nextLink,omitempty"`
}

LoggerCollection is paged Logger list representation.

func (LoggerCollection) LoggerCollectionPreparer 

func (client LoggerCollection) LoggerCollectionPreparer() (*http.Request, error)

LoggerCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type LoggerCreateParameters 

type LoggerCreateParameters struct {
	Type        *string             `json:"type,omitempty"`
	Description *string             `json:"description,omitempty"`
	Credentials *map[string]*string `json:"credentials,omitempty"`
	IsBuffered  *bool               `json:"isBuffered,omitempty"`
}

LoggerCreateParameters is parameters supplied to the Create Logger operation.

type LoggerResponse 

type LoggerResponse struct {
	autorest.Response `json:"-"`
	ID                *string             `json:"id,omitempty"`
	Type              *string             `json:"type,omitempty"`
	Description       *string             `json:"description,omitempty"`
	Credentials       *map[string]*string `json:"credentials,omitempty"`
	IsBuffered        *bool               `json:"isBuffered,omitempty"`
}

LoggerResponse is the Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.

type LoggerUpdateParameters 

type LoggerUpdateParameters struct {
	Type        *string             `json:"type,omitempty"`
	Description *string             `json:"description,omitempty"`
	Credentials *map[string]*string `json:"credentials,omitempty"`
	IsBuffered  *bool               `json:"isBuffered,omitempty"`
}

LoggerUpdateParameters is parameters supplied to the Update Logger operation.

type LoggersClient 

type LoggersClient struct {
	ManagementClient
}

LoggersClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewLoggersClient 

func NewLoggersClient(subscriptionID string) LoggersClient

NewLoggersClient creates an instance of the LoggersClient client.

func NewLoggersClientWithBaseURI 

func NewLoggersClientWithBaseURI(baseURI string, subscriptionID string) LoggersClient

NewLoggersClientWithBaseURI creates an instance of the LoggersClient client.

func (LoggersClient) CreateOrUpdate 

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

CreateOrUpdate creates or Updates a logger.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. loggerid is identifier of the logger. parameters is create parameters.

func (LoggersClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (LoggersClient) CreateOrUpdateResponder 

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

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

func (LoggersClient) CreateOrUpdateSender 

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

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

func (LoggersClient) Delete 

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

Delete deletes the specified logger.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. loggerid is identifier of the logger. ifMatch is the entity state (Etag) version of the logger to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (LoggersClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (LoggersClient) DeleteResponder 

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

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

func (LoggersClient) DeleteSender 

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

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

func (LoggersClient) Get 

func (client LoggersClient) Get(resourceGroupName string, serviceName string, loggerid string) (result LoggerResponse, err error)

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

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

func (LoggersClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (LoggersClient) GetResponder 

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

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

func (LoggersClient) GetSender 

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

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

func (LoggersClient) ListByService 

func (client LoggersClient) ListByService(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result LoggerCollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq | | top is number of records to return. skip is number of records to skip.

func (LoggersClient) ListByServiceNextResults 

func (client LoggersClient) ListByServiceNextResults(lastResults LoggerCollection) (result LoggerCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (LoggersClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (LoggersClient) ListByServiceResponder 

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

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

func (LoggersClient) ListByServiceSender 

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

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

func (LoggersClient) Update 

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

Update updates an existing logger.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. loggerid is identifier of the logger. parameters is update parameters. ifMatch is the entity state (Etag) version of the logger to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (LoggersClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (LoggersClient) UpdateResponder 

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

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

func (LoggersClient) UpdateSender 

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

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

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	APIVersion     string
	SubscriptionID string
}

ManagementClient is the base client for Apimanagement.

func New 

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type MethodContract 

type MethodContract string

MethodContract enumerates the values for method contract. 

const (
	// DELETE specifies the delete state for method contract.
	DELETE MethodContract = "DELETE"
	// GET specifies the get state for method contract.
	GET MethodContract = "GET"
	// HEAD specifies the head state for method contract.
	HEAD MethodContract = "HEAD"
	// OPTIONS specifies the options state for method contract.
	OPTIONS MethodContract = "OPTIONS"
	// PATCH specifies the patch state for method contract.
	PATCH MethodContract = "PATCH"
	// POST specifies the post state for method contract.
	POST MethodContract = "POST"
	// PUT specifies the put state for method contract.
	PUT MethodContract = "PUT"
	// TRACE specifies the trace state for method contract.
	TRACE MethodContract = "TRACE"
)

type OAuth2AuthenticationSettingsContract 

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

OAuth2AuthenticationSettingsContract is aPI OAuth2 Authentication settings details.

type OAuth2AuthorizationServerContract 

type OAuth2AuthorizationServerContract struct {
	autorest.Response          `json:"-"`
	ID                         *string                               `json:"id,omitempty"`
	Name                       *string                               `json:"name,omitempty"`
	Description                *string                               `json:"description,omitempty"`
	ClientRegistrationEndpoint *string                               `json:"clientRegistrationEndpoint,omitempty"`
	AuthorizationEndpoint      *string                               `json:"authorizationEndpoint,omitempty"`
	AuthorizationMethods       *[]MethodContract                     `json:"authorizationMethods,omitempty"`
	ClientAuthenticationMethod *[]ClientAuthenticationMethodContract `json:"clientAuthenticationMethod,omitempty"`
	TokenBodyParameters        *[]TokenBodyParameterContract         `json:"tokenBodyParameters,omitempty"`
	TokenEndpoint              *string                               `json:"tokenEndpoint,omitempty"`
	SupportState               *bool                                 `json:"supportState,omitempty"`
	DefaultScope               *string                               `json:"defaultScope,omitempty"`
	GrantTypes                 *[]GrantTypesContract                 `json:"grantTypes,omitempty"`
	BearerTokenSendingMethods  *[]BearerTokenSendingMethodsContract  `json:"bearerTokenSendingMethods,omitempty"`
	ClientID                   *string                               `json:"clientId,omitempty"`
	ClientSecret               *string                               `json:"clientSecret,omitempty"`
	ResourceOwnerUsername      *string                               `json:"resourceOwnerUsername,omitempty"`
	ResourceOwnerPassword      *string                               `json:"resourceOwnerPassword,omitempty"`
}

OAuth2AuthorizationServerContract is external OAuth authorization server settings.

type OAuth2AuthorizationServerUpdateContract 

type OAuth2AuthorizationServerUpdateContract struct {
	Name                       *string                               `json:"name,omitempty"`
	Description                *string                               `json:"description,omitempty"`
	ClientRegistrationEndpoint *string                               `json:"clientRegistrationEndpoint,omitempty"`
	AuthorizationEndpoint      *string                               `json:"authorizationEndpoint,omitempty"`
	AuthorizationMethods       *[]MethodContract                     `json:"authorizationMethods,omitempty"`
	ClientAuthenticationMethod *[]ClientAuthenticationMethodContract `json:"clientAuthenticationMethod,omitempty"`
	TokenBodyParameters        *[]TokenBodyParameterContract         `json:"tokenBodyParameters,omitempty"`
	TokenEndpoint              *string                               `json:"tokenEndpoint,omitempty"`
	SupportState               *bool                                 `json:"supportState,omitempty"`
	DefaultScope               *string                               `json:"defaultScope,omitempty"`
	GrantTypes                 *[]GrantTypesContract                 `json:"grantTypes,omitempty"`
	BearerTokenSendingMethods  *[]BearerTokenSendingMethodsContract  `json:"bearerTokenSendingMethods,omitempty"`
	ClientID                   *string                               `json:"clientId,omitempty"`
	ClientSecret               *string                               `json:"clientSecret,omitempty"`
	ResourceOwnerUsername      *string                               `json:"resourceOwnerUsername,omitempty"`
	ResourceOwnerPassword      *string                               `json:"resourceOwnerPassword,omitempty"`
}

OAuth2AuthorizationServerUpdateContract is external OAuth authorization server Update settings contract.

type OpenIDConnectProviderCollection 

type OpenIDConnectProviderCollection struct {
	autorest.Response `json:"-"`
	Value             *[]OpenidConnectProviderContract `json:"value,omitempty"`
	Count             *int64                           `json:"count,omitempty"`
	NextLink          *string                          `json:"nextLink,omitempty"`
}

OpenIDConnectProviderCollection is paged OpenIdProviders list representation.

func (OpenIDConnectProviderCollection) OpenIDConnectProviderCollectionPreparer 

func (client OpenIDConnectProviderCollection) OpenIDConnectProviderCollectionPreparer() (*http.Request, error)

OpenIDConnectProviderCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type OpenIDConnectProvidersClient 

type OpenIDConnectProvidersClient struct {
	ManagementClient
}

OpenIDConnectProvidersClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewOpenIDConnectProvidersClient 

func NewOpenIDConnectProvidersClient(subscriptionID string) OpenIDConnectProvidersClient

NewOpenIDConnectProvidersClient creates an instance of the OpenIDConnectProvidersClient client.

func NewOpenIDConnectProvidersClientWithBaseURI 

func NewOpenIDConnectProvidersClientWithBaseURI(baseURI string, subscriptionID string) OpenIDConnectProvidersClient

NewOpenIDConnectProvidersClientWithBaseURI creates an instance of the OpenIDConnectProvidersClient client.

func (OpenIDConnectProvidersClient) CreateOrUpdate 

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

CreateOrUpdate creates or updates the OpenID Connect Provider.

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

func (OpenIDConnectProvidersClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (OpenIDConnectProvidersClient) CreateOrUpdateResponder 

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

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

func (OpenIDConnectProvidersClient) CreateOrUpdateSender 

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

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

func (OpenIDConnectProvidersClient) Delete 

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

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. opid is identifier of the OpenID Connect Provider. ifMatch is the entity state (Etag) version of the OpenID Connect Provider to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (OpenIDConnectProvidersClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (OpenIDConnectProvidersClient) DeleteResponder 

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

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

func (OpenIDConnectProvidersClient) DeleteSender 

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

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

func (OpenIDConnectProvidersClient) Get 

func (client OpenIDConnectProvidersClient) Get(resourceGroupName string, serviceName string, opid string) (result OpenidConnectProviderContract, err error)

Get gets specific OpenID Connect Provider.

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

func (OpenIDConnectProvidersClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (OpenIDConnectProvidersClient) GetResponder 

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

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

func (OpenIDConnectProvidersClient) GetSender 

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

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

func (OpenIDConnectProvidersClient) ListByService 

func (client OpenIDConnectProvidersClient) ListByService(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result OpenIDConnectProviderCollection, err error)

ListByService lists all OpenID Connect Providers.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (OpenIDConnectProvidersClient) ListByServiceNextResults 

func (client OpenIDConnectProvidersClient) ListByServiceNextResults(lastResults OpenIDConnectProviderCollection) (result OpenIDConnectProviderCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (OpenIDConnectProvidersClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (OpenIDConnectProvidersClient) ListByServiceResponder 

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

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

func (OpenIDConnectProvidersClient) ListByServiceSender 

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

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

func (OpenIDConnectProvidersClient) Update 

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

Update updates the specific OpenID Connect Provider.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. opid is identifier of the OpenID Connect Provider. parameters is update parameters. ifMatch is the entity state (Etag) version of the OpenID Connect Provider to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (OpenIDConnectProvidersClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (OpenIDConnectProvidersClient) UpdateResponder 

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

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

func (OpenIDConnectProvidersClient) UpdateSender 

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

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

type OpenidConnectProviderContract 

type OpenidConnectProviderContract struct {
	autorest.Response `json:"-"`
	ID                *string `json:"id,omitempty"`
	Name              *string `json:"name,omitempty"`
	Description       *string `json:"description,omitempty"`
	MetadataEndpoint  *string `json:"metadataEndpoint,omitempty"`
	ClientID          *string `json:"clientId,omitempty"`
	ClientSecret      *string `json:"clientSecret,omitempty"`
}

OpenidConnectProviderContract is openID Connect Providers Contract.

type OpenidConnectProviderCreateContract 

type OpenidConnectProviderCreateContract struct {
	Name             *string `json:"name,omitempty"`
	Description      *string `json:"description,omitempty"`
	MetadataEndpoint *string `json:"metadataEndpoint,omitempty"`
	ClientID         *string `json:"clientId,omitempty"`
	ClientSecret     *string `json:"clientSecret,omitempty"`
}

OpenidConnectProviderCreateContract is parameters supplied to the Create OpenID Connect Provider operation.

type OpenidConnectProviderUpdateContract 

type OpenidConnectProviderUpdateContract struct {
	Name             *string `json:"name,omitempty"`
	Description      *string `json:"description,omitempty"`
	MetadataEndpoint *string `json:"metadataEndpoint,omitempty"`
	ClientID         *string `json:"clientId,omitempty"`
	ClientSecret     *string `json:"clientSecret,omitempty"`
}

OpenidConnectProviderUpdateContract is parameters supplied to the Update OpenID Connect Provider operation.

type OperationCollection 

type OperationCollection struct {
	autorest.Response `json:"-"`
	Value             *[]OperationContract `json:"value,omitempty"`
	Count             *int64               `json:"count,omitempty"`
	NextLink          *string              `json:"nextLink,omitempty"`
}

OperationCollection is paged Operation list representation.

func (OperationCollection) OperationCollectionPreparer 

func (client OperationCollection) OperationCollectionPreparer() (*http.Request, error)

OperationCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type OperationContract 

type OperationContract struct {
	autorest.Response  `json:"-"`
	ID                 *string              `json:"id,omitempty"`
	Name               *string              `json:"name,omitempty"`
	Method             *string              `json:"method,omitempty"`
	URLTemplate        *string              `json:"urlTemplate,omitempty"`
	TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
	Description        *string              `json:"description,omitempty"`
	Request            *RequestContract     `json:"request,omitempty"`
	Responses          *[]ResultContract    `json:"responses,omitempty"`
}

OperationContract is api Operation details.

type OperationResultContract 

type OperationResultContract struct {
	autorest.Response `json:"-"`
	ID                *string             `json:"id,omitempty"`
	Status            AsyncOperationState `json:"status,omitempty"`
	Started           *date.Time          `json:"started,omitempty"`
	Updated           *date.Time          `json:"updated,omitempty"`
	ResultInfo        *string             `json:"resultInfo,omitempty"`
	Error             *ErrorBodyContract  `json:"error,omitempty"`
}

OperationResultContract is operation Result.

type OperationStatus 

type OperationStatus string

OperationStatus enumerates the values for operation status. 

const (
	// OperationStatusFailed specifies the operation status failed state for
	// operation status.
	OperationStatusFailed OperationStatus = "Failed"
	// OperationStatusInProgress specifies the operation status in progress
	// state for operation status.
	OperationStatusInProgress OperationStatus = "InProgress"
	// OperationStatusSucceeded specifies the operation status succeeded state
	// for operation status.
	OperationStatusSucceeded OperationStatus = "Succeeded"
)

type ParameterContract 

type ParameterContract struct {
	Name         *string   `json:"name,omitempty"`
	Description  *string   `json:"description,omitempty"`
	Type         *string   `json:"type,omitempty"`
	DefaultValue *string   `json:"defaultValue,omitempty"`
	Required     *bool     `json:"required,omitempty"`
	Values       *[]string `json:"values,omitempty"`
}

ParameterContract is operation parameters details.

type PatchParameters 

type PatchParameters struct {
	RawJSON *map[string]interface{} `json:"RawJson,omitempty"`
}

PatchParameters is parameters supplied to the Patch operations.

type PolicyScopeContract 

type PolicyScopeContract string

PolicyScopeContract enumerates the values for policy scope contract. 

const (
	// All specifies the all state for policy scope contract.
	All PolicyScopeContract = "All"
	// API specifies the api state for policy scope contract.
	API PolicyScopeContract = "Api"
	// Operation specifies the operation state for policy scope contract.
	Operation PolicyScopeContract = "Operation"
	// Product specifies the product state for policy scope contract.
	Product PolicyScopeContract = "Product"
	// Tenant specifies the tenant state for policy scope contract.
	Tenant PolicyScopeContract = "Tenant"
)

type PolicySnippetContract 

type PolicySnippetContract struct {
	Name    *string             `json:"name,omitempty"`
	Content *string             `json:"content,omitempty"`
	ToolTip *string             `json:"toolTip,omitempty"`
	Scope   PolicyScopeContract `json:"scope,omitempty"`
}

PolicySnippetContract is policy snippet.

type PolicySnippetsClient 

type PolicySnippetsClient struct {
	ManagementClient
}

PolicySnippetsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

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(resourceGroupName string, serviceName string, scope PolicyScopeContract) (result ListPolicySnippetContract, err error)

ListByService lists all policy snippets.

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

func (PolicySnippetsClient) ListByServicePreparer 

func (client PolicySnippetsClient) ListByServicePreparer(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 ListPolicySnippetContract, 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 ProductApisClient 

type ProductApisClient struct {
	ManagementClient
}

ProductApisClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewProductApisClient 

func NewProductApisClient(subscriptionID string) ProductApisClient

NewProductApisClient creates an instance of the ProductApisClient client.

func NewProductApisClientWithBaseURI 

func NewProductApisClientWithBaseURI(baseURI string, subscriptionID string) ProductApisClient

NewProductApisClientWithBaseURI creates an instance of the ProductApisClient client.

func (ProductApisClient) Add 

func (client ProductApisClient) Add(resourceGroupName string, serviceName string, productID string, apiID string) (result autorest.Response, err error)

Add adds an API to the specified product.

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

func (ProductApisClient) AddPreparer 

func (client ProductApisClient) AddPreparer(resourceGroupName string, serviceName string, productID string, apiID string) (*http.Request, error)

AddPreparer prepares the Add request.

func (ProductApisClient) AddResponder 

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

AddResponder handles the response to the Add request. The method always closes the http.Response Body.

func (ProductApisClient) AddSender 

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

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

func (ProductApisClient) ListByProduct 

func (client ProductApisClient) ListByProduct(resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result APICollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. productID is product identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (ProductApisClient) ListByProductNextResults 

func (client ProductApisClient) ListByProductNextResults(lastResults APICollection) (result APICollection, err error)

ListByProductNextResults retrieves the next set of results, if any.

func (ProductApisClient) ListByProductPreparer 

func (client ProductApisClient) ListByProductPreparer(resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ProductApisClient) ListByProductResponder 

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

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

func (client ProductApisClient) Remove(resourceGroupName string, serviceName string, productID string, apiID string) (result autorest.Response, err error)

Remove deletes the specified API from the specified product.

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

func (ProductApisClient) RemovePreparer 

func (client ProductApisClient) RemovePreparer(resourceGroupName string, serviceName string, productID string, apiID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (ProductApisClient) RemoveResponder 

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

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (ProductApisClient) RemoveSender 

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

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

type ProductCollection 

type ProductCollection struct {
	autorest.Response `json:"-"`
	Value             *[]ProductContract `json:"value,omitempty"`
	Count             *int64             `json:"count,omitempty"`
	NextLink          *string            `json:"nextLink,omitempty"`
}

ProductCollection is paged Products list representation.

func (ProductCollection) ProductCollectionPreparer 

func (client ProductCollection) ProductCollectionPreparer() (*http.Request, error)

ProductCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ProductContract 

type ProductContract struct {
	autorest.Response    `json:"-"`
	ID                   *string              `json:"id,omitempty"`
	Name                 *string              `json:"name,omitempty"`
	Description          *string              `json:"description,omitempty"`
	Terms                *string              `json:"terms,omitempty"`
	SubscriptionRequired *bool                `json:"subscriptionRequired,omitempty"`
	ApprovalRequired     *bool                `json:"approvalRequired,omitempty"`
	SubscriptionsLimit   *int32               `json:"subscriptionsLimit,omitempty"`
	State                ProductStateContract `json:"state,omitempty"`
}

ProductContract is product profile.

type ProductGroupsClient 

type ProductGroupsClient struct {
	ManagementClient
}

ProductGroupsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewProductGroupsClient 

func NewProductGroupsClient(subscriptionID string) ProductGroupsClient

NewProductGroupsClient creates an instance of the ProductGroupsClient client.

func NewProductGroupsClientWithBaseURI 

func NewProductGroupsClientWithBaseURI(baseURI string, subscriptionID string) ProductGroupsClient

NewProductGroupsClientWithBaseURI creates an instance of the ProductGroupsClient client.

func (ProductGroupsClient) Add 

func (client ProductGroupsClient) Add(resourceGroupName string, serviceName string, productID string, groupID string) (result autorest.Response, err error)

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

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

func (ProductGroupsClient) AddPreparer 

func (client ProductGroupsClient) AddPreparer(resourceGroupName string, serviceName string, productID string, groupID string) (*http.Request, error)

AddPreparer prepares the Add request.

func (ProductGroupsClient) AddResponder 

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

AddResponder handles the response to the Add request. The method always closes the http.Response Body.

func (ProductGroupsClient) AddSender 

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

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

func (ProductGroupsClient) ListByProduct 

func (client ProductGroupsClient) ListByProduct(resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result GroupCollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. productID is product identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq, ne | N/A | top is number of records to return. skip is number of records to skip.

func (ProductGroupsClient) ListByProductNextResults 

func (client ProductGroupsClient) ListByProductNextResults(lastResults GroupCollection) (result GroupCollection, err error)

ListByProductNextResults retrieves the next set of results, if any.

func (ProductGroupsClient) ListByProductPreparer 

func (client ProductGroupsClient) ListByProductPreparer(resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ProductGroupsClient) ListByProductResponder 

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

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

func (client ProductGroupsClient) Remove(resourceGroupName string, serviceName string, productID string, groupID string) (result ErrorBodyContract, err error)

Remove deletes the association between the specified group and product.

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

func (ProductGroupsClient) RemovePreparer 

func (client ProductGroupsClient) RemovePreparer(resourceGroupName string, serviceName string, productID string, groupID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (ProductGroupsClient) RemoveResponder 

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

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (ProductGroupsClient) RemoveSender 

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

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

type ProductStateContract 

type ProductStateContract string

ProductStateContract enumerates the values for product state contract. 

const (
	// NotPublished specifies the not published state for product state
	// contract.
	NotPublished ProductStateContract = "NotPublished"
	// Published specifies the published state for product state contract.
	Published ProductStateContract = "Published"
)

type ProductSubscriptionsClient 

type ProductSubscriptionsClient struct {
	ManagementClient
}

ProductSubscriptionsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

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) ListByProduct 

func (client ProductSubscriptionsClient) ListByProduct(resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result SubscriptionCollection, err error)

ListByProduct lists the collection of subscriptions to the specified product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. productID is product identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |--------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top is number of records to return. skip is number of records to skip.

func (ProductSubscriptionsClient) ListByProductNextResults 

func (client ProductSubscriptionsClient) ListByProductNextResults(lastResults SubscriptionCollection) (result SubscriptionCollection, err error)

ListByProductNextResults retrieves the next set of results, if any.

func (ProductSubscriptionsClient) ListByProductPreparer 

func (client ProductSubscriptionsClient) ListByProductPreparer(resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByProductPreparer prepares the ListByProduct request.

func (ProductSubscriptionsClient) ListByProductResponder 

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

ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.

func (ProductSubscriptionsClient) ListByProductSender 

func (client ProductSubscriptionsClient) 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 ProductUpdateParameters 

type ProductUpdateParameters struct {
	Name                 *string              `json:"name,omitempty"`
	Description          *string              `json:"description,omitempty"`
	Terms                *string              `json:"terms,omitempty"`
	SubscriptionRequired *bool                `json:"subscriptionRequired,omitempty"`
	ApprovalRequired     *bool                `json:"approvalRequired,omitempty"`
	SubscriptionsLimit   *int32               `json:"subscriptionsLimit,omitempty"`
	State                ProductStateContract `json:"state,omitempty"`
}

ProductUpdateParameters is parameters supplied to the CreateOrUpdate Product operation.

type ProductsClient 

type ProductsClient struct {
	ManagementClient
}

ProductsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewProductsClient 

func NewProductsClient(subscriptionID string) ProductsClient

NewProductsClient creates an instance of the ProductsClient client.

func NewProductsClientWithBaseURI 

func NewProductsClientWithBaseURI(baseURI string, subscriptionID string) ProductsClient

NewProductsClientWithBaseURI creates an instance of the ProductsClient client.

func (ProductsClient) CreateOrUpdate 

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

CreateOrUpdate creates or Updates a product.

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

func (ProductsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductsClient) CreateOrUpdateResponder 

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

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

func (ProductsClient) CreateOrUpdateSender 

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

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

func (ProductsClient) Delete 

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

Delete delete product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. productID is product identifier. Must be unique in the current API Management service instance. ifMatch is eTag of the Product Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. deleteSubscriptions is delete existing subscriptions to the product or not.

func (ProductsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (ProductsClient) DeleteResponder 

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

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

func (ProductsClient) DeleteSender 

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

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

func (ProductsClient) Get 

func (client ProductsClient) Get(resourceGroupName string, serviceName string, productID string) (result ProductContract, err error)

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

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

func (ProductsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (ProductsClient) GetResponder 

func (client ProductsClient) GetResponder(resp *http.Response) (result ProductContract, err error)

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

func (ProductsClient) GetSender 

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

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

func (ProductsClient) ListByService 

func (client ProductsClient) ListByService(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32, expandGroups *bool) (result ProductCollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top is number of records to return. skip is number of records to skip. expandGroups is when set to true, the response contains an array of groups that have visibility to the product. The default is false.

func (ProductsClient) ListByServiceNextResults 

func (client ProductsClient) ListByServiceNextResults(lastResults ProductCollection) (result ProductCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (ProductsClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (ProductsClient) ListByServiceResponder 

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

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

func (ProductsClient) ListByServiceSender 

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

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

func (ProductsClient) Update 

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

Update update product.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. productID is product identifier. Must be unique in the current API Management service instance. parameters is update parameters. ifMatch is eTag of the Product Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (ProductsClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (ProductsClient) UpdateResponder 

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

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

func (ProductsClient) UpdateSender 

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

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

type PropertyClient 

type PropertyClient struct {
	ManagementClient
}

PropertyClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

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(resourceGroupName string, serviceName string, propID string, parameters PropertyCreateParameters) (result autorest.Response, err error)

CreateOrUpdate creates or updates a property.

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

func (PropertyClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PropertyClient) CreateOrUpdateResponder 

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

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

func (PropertyClient) CreateOrUpdateSender 

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

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

func (PropertyClient) Delete 

func (client PropertyClient) Delete(resourceGroupName string, serviceName string, propID string, ifMatch string) (result ErrorBodyContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. propID is identifier of the property. ifMatch is the entity state (Etag) version of the property to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (PropertyClient) DeletePreparer 

func (client PropertyClient) DeletePreparer(resourceGroupName string, serviceName string, propID string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PropertyClient) DeleteResponder 

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

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

func (PropertyClient) DeleteSender 

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

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

func (PropertyClient) Get 

func (client PropertyClient) Get(resourceGroupName string, serviceName string, propID string) (result PropertyContract, err error)

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

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

func (PropertyClient) GetPreparer 

func (client PropertyClient) GetPreparer(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(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result PropertyCollection, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |-------|------------------------|-------------------------------------------------------| | tags | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (PropertyClient) ListByServiceNextResults 

func (client PropertyClient) ListByServiceNextResults(lastResults PropertyCollection) (result PropertyCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (PropertyClient) ListByServicePreparer 

func (client PropertyClient) ListByServicePreparer(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(resourceGroupName string, serviceName string, propID string, parameters PropertyUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates the specific property.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. propID is identifier of the property. parameters is update parameters. ifMatch is the entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (PropertyClient) UpdatePreparer 

func (client PropertyClient) UpdatePreparer(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             *[]PropertyContract `json:"value,omitempty"`
	Count             *int64              `json:"count,omitempty"`
	NextLink          *string             `json:"nextLink,omitempty"`
}

PropertyCollection is paged Property list representation.

func (PropertyCollection) PropertyCollectionPreparer 

func (client PropertyCollection) PropertyCollectionPreparer() (*http.Request, error)

PropertyCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type PropertyContract 

type PropertyContract struct {
	autorest.Response `json:"-"`
	ID                *string   `json:"id,omitempty"`
	Name              *string   `json:"name,omitempty"`
	Value             *string   `json:"value,omitempty"`
	Tags              *[]string `json:"tags,omitempty"`
	Secret            *bool     `json:"secret,omitempty"`
}

PropertyContract is property details.

type PropertyCreateParameters 

type PropertyCreateParameters struct {
	Name   *string   `json:"name,omitempty"`
	Value  *string   `json:"value,omitempty"`
	Tags   *[]string `json:"tags,omitempty"`
	Secret *bool     `json:"secret,omitempty"`
}

PropertyCreateParameters is parameters supplied to the Create Property operation.

type PropertyUpdateParameters 

type PropertyUpdateParameters struct {
	Name   *string   `json:"name,omitempty"`
	Value  *string   `json:"value,omitempty"`
	Tags   *[]string `json:"tags,omitempty"`
	Secret *bool     `json:"secret,omitempty"`
}

PropertyUpdateParameters is parameters supplied to the Update Property operation.

type QuotaByCounterKeysClient 

type QuotaByCounterKeysClient struct {
	ManagementClient
}

QuotaByCounterKeysClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

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(resourceGroupName string, serviceName string, quotaCounterKey string) (result QuotaCounterCollection, err error)

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

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

func (QuotaByCounterKeysClient) ListByServicePreparer 

func (client QuotaByCounterKeysClient) ListByServicePreparer(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(resourceGroupName string, serviceName string, quotaCounterKey string, parameters QuotaCounterValueContract) (result autorest.Response, err error)

Update updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. quotaCounterKey is quota counter key identifier. parameters is the value of the quota counter to be applied to all quota counter periods.

func (QuotaByCounterKeysClient) UpdatePreparer 

func (client QuotaByCounterKeysClient) UpdatePreparer(resourceGroupName string, serviceName string, quotaCounterKey string, parameters QuotaCounterValueContract) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (QuotaByCounterKeysClient) UpdateResponder 

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

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

func (QuotaByCounterKeysClient) UpdateSender 

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

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

type QuotaByPeriodKeysClient 

type QuotaByPeriodKeysClient struct {
	ManagementClient
}

QuotaByPeriodKeysClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

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(resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string) (result QuotaCounterContract, err error)

Get gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.

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

func (QuotaByPeriodKeysClient) GetPreparer 

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

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. quotaCounterKey is quota counter key identifier. quotaPeriodKey is quota period key identifier. parameters is the value of the Quota counter to be applied on the specified period.

func (QuotaByPeriodKeysClient) UpdatePreparer 

func (client QuotaByPeriodKeysClient) UpdatePreparer(resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string, parameters QuotaCounterValueContract) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (QuotaByPeriodKeysClient) UpdateResponder 

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

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

func (QuotaByPeriodKeysClient) UpdateSender 

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

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

type QuotaCounterCollection 

type QuotaCounterCollection struct {
	autorest.Response `json:"-"`
	Value             *[]QuotaCounterContract `json:"value,omitempty"`
	Count             *int64                  `json:"count,omitempty"`
	NextLink          *string                 `json:"nextLink,omitempty"`
}

QuotaCounterCollection is paged Quota Counter list representation.

type QuotaCounterContract 

type QuotaCounterContract struct {
	autorest.Response `json:"-"`
	CallsCount        *int32     `json:"callsCount,omitempty"`
	KbTransferred     *float64   `json:"kbTransferred,omitempty"`
	CounterKey        *string    `json:"counterKey,omitempty"`
	PeriodKey         *string    `json:"periodKey,omitempty"`
	PeriodStartTime   *date.Time `json:"periodStartTime,omitempty"`
	PeriodEndTime     *date.Time `json:"periodEndTime,omitempty"`
}

QuotaCounterContract is quota counter details.

type QuotaCounterValueContract 

type QuotaCounterValueContract struct {
	CallsCount    *int32   `json:"callsCount,omitempty"`
	KbTransferred *float64 `json:"kbTransferred,omitempty"`
}

QuotaCounterValueContract is quota counter value details.

type RegionContract 

type RegionContract struct {
	Name           *string `json:"name,omitempty"`
	IsMasterRegion *bool   `json:"isMasterRegion,omitempty"`
}

RegionContract is region profile.

type RegionListResult 

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

RegionListResult is lists Regions operation response details.

type RegionsClient 

type RegionsClient struct {
	ManagementClient
}

RegionsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

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(resourceGroupName string, serviceName string) (result RegionListResult, err error)

ListByService lists all azure regions in which the service exists.

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

func (RegionsClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (RegionsClient) ListByServiceResponder 

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

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

func (RegionsClient) ListByServiceSender 

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

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

type ReportCollection 

type ReportCollection struct {
	autorest.Response `json:"-"`
	Value             *[]ReportRecordContract `json:"value,omitempty"`
	Count             *int64                  `json:"count,omitempty"`
	NextLink          *string                 `json:"nextLink,omitempty"`
}

ReportCollection is paged Report records list representation.

func (ReportCollection) ReportCollectionPreparer 

func (client ReportCollection) ReportCollectionPreparer() (*http.Request, error)

ReportCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ReportRecordContract 

type ReportRecordContract struct {
	Name             *string    `json:"name,omitempty"`
	Timestamp        *date.Time `json:"timestamp,omitempty"`
	Interval         *int64     `json:"interval,omitempty"`
	Country          *string    `json:"country,omitempty"`
	Region           *string    `json:"region,omitempty"`
	Zip              *string    `json:"zip,omitempty"`
	UserID           *string    `json:"userId,omitempty"`
	ProductID        *string    `json:"productId,omitempty"`
	APIID            *string    `json:"apiId,omitempty"`
	OperationID      *string    `json:"operationId,omitempty"`
	APIRegion        *string    `json:"apiRegion,omitempty"`
	SubscriptionID   *string    `json:"subscriptionId,omitempty"`
	CallCountSuccess *int32     `json:"callCountSuccess,omitempty"`
	CallCountBlocked *int32     `json:"callCountBlocked,omitempty"`
	CallCountFailed  *int32     `json:"callCountFailed,omitempty"`
	CallCountOther   *int32     `json:"callCountOther,omitempty"`
	CallCountTotal   *int32     `json:"callCountTotal,omitempty"`
	Bandwidth        *int64     `json:"bandwidth,omitempty"`
	CacheHitCount    *int32     `json:"cacheHitCount,omitempty"`
	CacheMissCount   *int32     `json:"cacheMissCount,omitempty"`
	APITimeAvg       *float64   `json:"apiTimeAvg,omitempty"`
	APITimeMin       *float64   `json:"apiTimeMin,omitempty"`
	APITimeMax       *float64   `json:"apiTimeMax,omitempty"`
	ServiceTimeAvg   *float64   `json:"serviceTimeAvg,omitempty"`
	ServiceTimeMin   *float64   `json:"serviceTimeMin,omitempty"`
	ServiceTimeMax   *float64   `json:"serviceTimeMax,omitempty"`
}

ReportRecordContract is report data.

type ReportsAggregation 

type ReportsAggregation string

ReportsAggregation enumerates the values for reports aggregation. 

const (
	// ByAPI specifies the by api state for reports aggregation.
	ByAPI ReportsAggregation = "byApi"
	// ByGeo specifies the by geo state for reports aggregation.
	ByGeo ReportsAggregation = "byGeo"
	// ByOperation specifies the by operation state for reports aggregation.
	ByOperation ReportsAggregation = "byOperation"
	// ByProduct specifies the by product state for reports aggregation.
	ByProduct ReportsAggregation = "byProduct"
	// BySubscription specifies the by subscription state for reports
	// aggregation.
	BySubscription ReportsAggregation = "bySubscription"
	// ByTime specifies the by time state for reports aggregation.
	ByTime ReportsAggregation = "byTime"
	// ByUser specifies the by user state for reports aggregation.
	ByUser ReportsAggregation = "byUser"
)

type ReportsClient 

type ReportsClient struct {
	ManagementClient
}

ReportsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewReportsClient 

func NewReportsClient(subscriptionID string) ReportsClient

NewReportsClient creates an instance of the ReportsClient client.

func NewReportsClientWithBaseURI 

func NewReportsClientWithBaseURI(baseURI string, subscriptionID string) ReportsClient

NewReportsClientWithBaseURI creates an instance of the ReportsClient client.

func (ReportsClient) ListByService 

func (client ReportsClient) ListByService(resourceGroupName string, serviceName string, aggregation ReportsAggregation, filter string, top *int32, skip *int32, interval string) (result ReportCollection, err error)

ListByService lists report records.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. aggregation is report aggregation. filter is the filter to apply on the operation. top is number of records to return. skip is number of records to skip. interval is by time interval. This value is only applicable to ByTime aggregation. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))

func (ReportsClient) ListByServiceNextResults 

func (client ReportsClient) ListByServiceNextResults(lastResults ReportCollection) (result ReportCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (ReportsClient) ListByServicePreparer 

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

ListByServicePreparer prepares the ListByService request.

func (ReportsClient) ListByServiceResponder 

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

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

func (ReportsClient) ListByServiceSender 

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

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

type RepresentationContract 

type RepresentationContract struct {
	ContentType *string `json:"contentType,omitempty"`
	Sample      *string `json:"sample,omitempty"`
}

RepresentationContract is operation request/response representation details.

type RequestContract 

type RequestContract struct {
	Description     *string                   `json:"description,omitempty"`
	QueryParameters *[]ParameterContract      `json:"queryParameters,omitempty"`
	Headers         *[]ParameterContract      `json:"headers,omitempty"`
	Representations *[]RepresentationContract `json:"representations,omitempty"`
}

RequestContract is operation request details.

type ResultContract 

type ResultContract struct {
	StatusCode      *int32                    `json:"statusCode,omitempty"`
	Description     *string                   `json:"description,omitempty"`
	Representations *[]RepresentationContract `json:"representations,omitempty"`
}

ResultContract is operation response details.

type SaveConfigurationParameter 

type SaveConfigurationParameter struct {
	Branch *string `json:"branch,omitempty"`
	Force  *bool   `json:"force,omitempty"`
}

SaveConfigurationParameter is parameters supplied to the Save Tenant Configuration operation.

type SubscriptionCollection 

type SubscriptionCollection struct {
	autorest.Response `json:"-"`
	Value             *[]SubscriptionContract `json:"value,omitempty"`
	Count             *int64                  `json:"count,omitempty"`
	NextLink          *string                 `json:"nextLink,omitempty"`
}

SubscriptionCollection is paged Subsctions list representation.

func (SubscriptionCollection) SubscriptionCollectionPreparer 

func (client SubscriptionCollection) SubscriptionCollectionPreparer() (*http.Request, error)

SubscriptionCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type SubscriptionContract 

type SubscriptionContract struct {
	autorest.Response `json:"-"`
	ID                *string                   `json:"id,omitempty"`
	UserID            *string                   `json:"userId,omitempty"`
	ProductID         *string                   `json:"productId,omitempty"`
	Name              *string                   `json:"name,omitempty"`
	State             SubscriptionStateContract `json:"state,omitempty"`
	CreatedDate       *date.Time                `json:"createdDate,omitempty"`
	StartDate         *date.Time                `json:"startDate,omitempty"`
	ExpirationDate    *date.Time                `json:"expirationDate,omitempty"`
	EndDate           *date.Time                `json:"endDate,omitempty"`
	NotificationDate  *date.Time                `json:"notificationDate,omitempty"`
	PrimaryKey        *string                   `json:"primaryKey,omitempty"`
	SecondaryKey      *string                   `json:"secondaryKey,omitempty"`
	StateComment      *string                   `json:"stateComment,omitempty"`
}

SubscriptionContract is subscription details.

type SubscriptionCreateParameters 

type SubscriptionCreateParameters struct {
	UserID       *string                   `json:"userId,omitempty"`
	ProductID    *string                   `json:"productId,omitempty"`
	Name         *string                   `json:"name,omitempty"`
	PrimaryKey   *string                   `json:"primaryKey,omitempty"`
	SecondaryKey *string                   `json:"secondaryKey,omitempty"`
	State        SubscriptionStateContract `json:"state,omitempty"`
}

SubscriptionCreateParameters is parameters supplied to the Create subscription operation.

type SubscriptionKeyParameterNamesContract 

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

SubscriptionKeyParameterNamesContract is subscription key parameter names details.

type SubscriptionStateContract 

type SubscriptionStateContract string

SubscriptionStateContract enumerates the values for subscription state contract. 

const (
	// Active specifies the active state for subscription state contract.
	Active SubscriptionStateContract = "Active"
	// Cancelled specifies the cancelled state for subscription state contract.
	Cancelled SubscriptionStateContract = "Cancelled"
	// Expired specifies the expired state for subscription state contract.
	Expired SubscriptionStateContract = "Expired"
	// Rejected specifies the rejected state for subscription state contract.
	Rejected SubscriptionStateContract = "Rejected"
	// Submitted specifies the submitted state for subscription state contract.
	Submitted SubscriptionStateContract = "Submitted"
	// Suspended specifies the suspended state for subscription state contract.
	Suspended SubscriptionStateContract = "Suspended"
)

type SubscriptionUpdateParameters 

type SubscriptionUpdateParameters struct {
	UserID         *string                   `json:"userId,omitempty"`
	ProductID      *string                   `json:"productId,omitempty"`
	ExpirationDate *date.Time                `json:"expirationDate,omitempty"`
	Name           *string                   `json:"name,omitempty"`
	PrimaryKey     *string                   `json:"primaryKey,omitempty"`
	SecondaryKey   *string                   `json:"secondaryKey,omitempty"`
	State          SubscriptionStateContract `json:"state,omitempty"`
	StateComment   *string                   `json:"stateComment,omitempty"`
}

SubscriptionUpdateParameters is parameters supplied to the Update subscription operation.

type SubscriptionsClient 

type SubscriptionsClient struct {
	ManagementClient
}

SubscriptionsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewSubscriptionsClient 

func NewSubscriptionsClient(subscriptionID string) SubscriptionsClient

NewSubscriptionsClient creates an instance of the SubscriptionsClient client.

func NewSubscriptionsClientWithBaseURI 

func NewSubscriptionsClientWithBaseURI(baseURI string, subscriptionID string) SubscriptionsClient

NewSubscriptionsClientWithBaseURI creates an instance of the SubscriptionsClient client.

func (SubscriptionsClient) CreateOrUpdate 

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

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. sid is identifier of the subscription. parameters is create parameters.

func (SubscriptionsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SubscriptionsClient) CreateOrUpdateResponder 

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

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

func (SubscriptionsClient) CreateOrUpdateSender 

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

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

func (SubscriptionsClient) Delete 

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

Delete deletes the specified subscription.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. sid is identifier of the subscription. ifMatch is eTag of the Subscription Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (SubscriptionsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (SubscriptionsClient) DeleteResponder 

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

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

func (SubscriptionsClient) DeleteSender 

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

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

func (SubscriptionsClient) Get 

func (client SubscriptionsClient) Get(resourceGroupName string, serviceName string, sid string) (result SubscriptionContract, err error)

Get gets the specified Subscription entity.

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

func (SubscriptionsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (SubscriptionsClient) GetResponder 

func (client SubscriptionsClient) GetResponder(resp *http.Response) (result SubscriptionContract, err error)

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

func (SubscriptionsClient) GetSender 

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

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

func (SubscriptionsClient) ListByService 

func (client SubscriptionsClient) ListByService(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result SubscriptionCollection, err error)

ListByService lists all subscriptions of the API Management service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |--------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top is number of records to return. skip is number of records to skip.

func (SubscriptionsClient) ListByServiceNextResults 

func (client SubscriptionsClient) ListByServiceNextResults(lastResults SubscriptionCollection) (result SubscriptionCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (SubscriptionsClient) ListByServicePreparer 

func (client SubscriptionsClient) ListByServicePreparer(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (SubscriptionsClient) ListByServiceResponder 

func (client SubscriptionsClient) ListByServiceResponder(resp *http.Response) (result SubscriptionCollection, err error)

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

func (SubscriptionsClient) ListByServiceSender 

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

func (client SubscriptionsClient) RegeneratePrimaryKey(resourceGroupName string, serviceName string, sid string) (result autorest.Response, err error)

RegeneratePrimaryKey regenerates primary key of existing subscription of the API Management service instance.

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

func (SubscriptionsClient) RegeneratePrimaryKeyPreparer 

func (client SubscriptionsClient) RegeneratePrimaryKeyPreparer(resourceGroupName string, serviceName string, sid string) (*http.Request, error)

RegeneratePrimaryKeyPreparer prepares the RegeneratePrimaryKey request.

func (SubscriptionsClient) RegeneratePrimaryKeyResponder 

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

RegeneratePrimaryKeyResponder handles the response to the RegeneratePrimaryKey request. The method always closes the http.Response Body.

func (SubscriptionsClient) RegeneratePrimaryKeySender 

func (client SubscriptionsClient) RegeneratePrimaryKeySender(req *http.Request) (*http.Response, error)

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

func (SubscriptionsClient) RegenerateSecondaryKey 

func (client SubscriptionsClient) RegenerateSecondaryKey(resourceGroupName string, serviceName string, sid string) (result autorest.Response, err error)

RegenerateSecondaryKey regenerates secondary key of existing subscription of the API Management service instance.

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

func (SubscriptionsClient) RegenerateSecondaryKeyPreparer 

func (client SubscriptionsClient) RegenerateSecondaryKeyPreparer(resourceGroupName string, serviceName string, sid string) (*http.Request, error)

RegenerateSecondaryKeyPreparer prepares the RegenerateSecondaryKey request.

func (SubscriptionsClient) RegenerateSecondaryKeyResponder 

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

RegenerateSecondaryKeyResponder handles the response to the RegenerateSecondaryKey request. The method always closes the http.Response Body.

func (SubscriptionsClient) RegenerateSecondaryKeySender 

func (client SubscriptionsClient) RegenerateSecondaryKeySender(req *http.Request) (*http.Response, error)

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

func (SubscriptionsClient) Update 

func (client SubscriptionsClient) Update(resourceGroupName string, serviceName string, sid string, parameters SubscriptionUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update updates the details of a subscription specificied by its identifier.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. sid is identifier of the subscription. parameters is update parameters. ifMatch is eTag of the Subscription Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (SubscriptionsClient) UpdatePreparer 

func (client SubscriptionsClient) UpdatePreparer(resourceGroupName string, serviceName string, sid string, parameters SubscriptionUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (SubscriptionsClient) UpdateResponder 

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

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

func (SubscriptionsClient) UpdateSender 

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

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

type TenantAccessClient 

type TenantAccessClient struct {
	ManagementClient
}

TenantAccessClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

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(resourceGroupName string, serviceName string) (result AccessInformationContract, err error)

Get get tenant access information details.

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

func (TenantAccessClient) GetPreparer 

func (client TenantAccessClient) GetPreparer(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(resourceGroupName string, serviceName string) (result autorest.Response, err error)

RegeneratePrimaryKey regenerate primary access key.

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

func (TenantAccessClient) RegeneratePrimaryKeyPreparer 

func (client TenantAccessClient) RegeneratePrimaryKeyPreparer(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(resourceGroupName string, serviceName string) (result autorest.Response, err error)

RegenerateSecondaryKey regenerate secondary access key.

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

func (TenantAccessClient) RegenerateSecondaryKeyPreparer 

func (client TenantAccessClient) RegenerateSecondaryKeyPreparer(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(resourceGroupName string, serviceName string, parameters AccessInformationUpdateParameters, ifMatch string) (result autorest.Response, err error)

Update update tenant access information details.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters. ifMatch is the entity state (Etag) version of the tenant access settings to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (TenantAccessClient) UpdatePreparer 

func (client TenantAccessClient) UpdatePreparer(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 {
	ManagementClient
}

TenantAccessGitClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

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(resourceGroupName string, serviceName string) (result AccessInformationContract, err error)

Get gets the Git access configuration for the tenant.

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

func (TenantAccessGitClient) GetPreparer 

func (client TenantAccessGitClient) GetPreparer(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(resourceGroupName string, serviceName string) (result autorest.Response, err error)

RegeneratePrimaryKey regenerate primary access key for GIT.

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

func (TenantAccessGitClient) RegeneratePrimaryKeyPreparer 

func (client TenantAccessGitClient) RegeneratePrimaryKeyPreparer(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(resourceGroupName string, serviceName string) (result autorest.Response, err error)

RegenerateSecondaryKey regenerate secondary access key for GIT.

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

func (TenantAccessGitClient) RegenerateSecondaryKeyPreparer 

func (client TenantAccessGitClient) RegenerateSecondaryKeyPreparer(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 {
	ManagementClient
}

TenantConfigurationClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

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(resourceGroupName string, serviceName string, parameters DeployConfigurationParameters, cancel <-chan struct{}) (result autorest.Response, 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. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

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

func (TenantConfigurationClient) DeployPreparer 

func (client TenantConfigurationClient) DeployPreparer(resourceGroupName string, serviceName string, parameters DeployConfigurationParameters, cancel <-chan struct{}) (*http.Request, error)

DeployPreparer prepares the Deploy request.

func (TenantConfigurationClient) DeployResponder 

func (client TenantConfigurationClient) DeployResponder(resp *http.Response) (result autorest.Response, 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) (*http.Response, error)

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

func (TenantConfigurationClient) Save 

func (client TenantConfigurationClient) Save(resourceGroupName string, serviceName string, parameters SaveConfigurationParameter, cancel <-chan struct{}) (result autorest.Response, 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. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

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

func (TenantConfigurationClient) SavePreparer 

func (client TenantConfigurationClient) SavePreparer(resourceGroupName string, serviceName string, parameters SaveConfigurationParameter, cancel <-chan struct{}) (*http.Request, error)

SavePreparer prepares the Save request.

func (TenantConfigurationClient) SaveResponder 

func (client TenantConfigurationClient) SaveResponder(resp *http.Response) (result autorest.Response, 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) (*http.Response, 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(resourceGroupName string, serviceName string, parameters DeployConfigurationParameters, cancel <-chan struct{}) (result autorest.Response, 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. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

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

func (TenantConfigurationClient) ValidatePreparer 

func (client TenantConfigurationClient) ValidatePreparer(resourceGroupName string, serviceName string, parameters DeployConfigurationParameters, cancel <-chan struct{}) (*http.Request, error)

ValidatePreparer prepares the Validate request.

func (TenantConfigurationClient) ValidateResponder 

func (client TenantConfigurationClient) ValidateResponder(resp *http.Response) (result autorest.Response, 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) (*http.Response, error)

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

type TenantConfigurationSyncStateClient 

type TenantConfigurationSyncStateClient struct {
	ManagementClient
}

TenantConfigurationSyncStateClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewTenantConfigurationSyncStateClient 

func NewTenantConfigurationSyncStateClient(subscriptionID string) TenantConfigurationSyncStateClient

NewTenantConfigurationSyncStateClient creates an instance of the TenantConfigurationSyncStateClient client.

func NewTenantConfigurationSyncStateClientWithBaseURI 

func NewTenantConfigurationSyncStateClientWithBaseURI(baseURI string, subscriptionID string) TenantConfigurationSyncStateClient

NewTenantConfigurationSyncStateClientWithBaseURI creates an instance of the TenantConfigurationSyncStateClient client.

func (TenantConfigurationSyncStateClient) Get 

func (client TenantConfigurationSyncStateClient) Get(resourceGroupName string, serviceName string) (result TenantConfigurationSyncStateContract, err error)

Get gets the status of the most recent synchronization between the configuration database and the Git repository.

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

func (TenantConfigurationSyncStateClient) GetPreparer 

func (client TenantConfigurationSyncStateClient) GetPreparer(resourceGroupName string, serviceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (TenantConfigurationSyncStateClient) GetResponder 

func (client TenantConfigurationSyncStateClient) GetResponder(resp *http.Response) (result TenantConfigurationSyncStateContract, err error)

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

func (TenantConfigurationSyncStateClient) GetSender 

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

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

type TenantConfigurationSyncStateContract 

type TenantConfigurationSyncStateContract struct {
	autorest.Response       `json:"-"`
	Branch                  *string    `json:"branch,omitempty"`
	CommitID                *string    `json:"commitId,omitempty"`
	IsExport                *bool      `json:"isExport,omitempty"`
	IsSynced                *bool      `json:"isSynced,omitempty"`
	IsGitEnabled            *bool      `json:"isGitEnabled,omitempty"`
	SyncDate                *date.Time `json:"syncDate,omitempty"`
	ConfigurationChangeDate *date.Time `json:"configurationChangeDate,omitempty"`
}

TenantConfigurationSyncStateContract is tenant Configuration Synchronization State.

type TenantLongRunningOperationResult 

type TenantLongRunningOperationResult struct {
	OperationStatusLink *string         `json:"operationStatusLink,omitempty"`
	RetryAfter          *int32          `json:"retryAfter,omitempty"`
	Status              OperationStatus `json:"status,omitempty"`
	StatusCode          HTTPStatusCode  `json:"statusCode,omitempty"`
	RequestID           *string         `json:"requestId,omitempty"`
}

TenantLongRunningOperationResult is a standard service response for long running tenant operations.

type TokenBodyParameterContract 

type TokenBodyParameterContract struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

TokenBodyParameterContract is oAuth acquire token request body parameter (www-url-form-encoded).

type UserCollection 

type UserCollection struct {
	autorest.Response `json:"-"`
	Value             *[]UserContract `json:"value,omitempty"`
	Count             *int64          `json:"count,omitempty"`
	NextLink          *string         `json:"nextLink,omitempty"`
}

UserCollection is paged Users list representation.

func (UserCollection) UserCollectionPreparer 

func (client UserCollection) UserCollectionPreparer() (*http.Request, error)

UserCollectionPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type UserContract 

type UserContract struct {
	autorest.Response `json:"-"`
	ID                *string                 `json:"id,omitempty"`
	FirstName         *string                 `json:"firstName,omitempty"`
	LastName          *string                 `json:"lastName,omitempty"`
	Email             *string                 `json:"email,omitempty"`
	State             UserStateContract       `json:"state,omitempty"`
	RegistrationDate  *date.Time              `json:"registrationDate,omitempty"`
	Note              *string                 `json:"note,omitempty"`
	Identities        *[]UserIdentityContract `json:"identities,omitempty"`
}

UserContract is user profile.

type UserCreateParameters 

type UserCreateParameters struct {
	Email     *string           `json:"email,omitempty"`
	Password  *string           `json:"password,omitempty"`
	FirstName *string           `json:"firstName,omitempty"`
	LastName  *string           `json:"lastName,omitempty"`
	State     UserStateContract `json:"state,omitempty"`
	Note      *string           `json:"note,omitempty"`
}

UserCreateParameters is parameters supplied to the Create User operation.

type UserGroupsClient 

type UserGroupsClient struct {
	ManagementClient
}

UserGroupsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewUserGroupsClient 

func NewUserGroupsClient(subscriptionID string) UserGroupsClient

NewUserGroupsClient creates an instance of the UserGroupsClient client.

func NewUserGroupsClientWithBaseURI 

func NewUserGroupsClientWithBaseURI(baseURI string, subscriptionID string) UserGroupsClient

NewUserGroupsClientWithBaseURI creates an instance of the UserGroupsClient client.

func (UserGroupsClient) ListByUser 

func (client UserGroupsClient) ListByUser(resourceGroupName string, serviceName string, uid string, filter string, top *int32, skip *int32) (result GroupCollection, err error)

ListByUser lists all user groups.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. uid is user identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (UserGroupsClient) ListByUserNextResults 

func (client UserGroupsClient) ListByUserNextResults(lastResults GroupCollection) (result GroupCollection, err error)

ListByUserNextResults retrieves the next set of results, if any.

func (UserGroupsClient) ListByUserPreparer 

func (client UserGroupsClient) ListByUserPreparer(resourceGroupName string, serviceName string, uid string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByUserPreparer prepares the ListByUser request.

func (UserGroupsClient) ListByUserResponder 

func (client UserGroupsClient) ListByUserResponder(resp *http.Response) (result GroupCollection, err error)

ListByUserResponder handles the response to the ListByUser request. The method always closes the http.Response Body.

func (UserGroupsClient) ListByUserSender 

func (client UserGroupsClient) 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 UserIdentitiesClient 

type UserIdentitiesClient struct {
	ManagementClient
}

UserIdentitiesClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

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) ListByUser 

func (client UserIdentitiesClient) ListByUser(resourceGroupName string, serviceName string, uid string) (result ListUserIdentityContract, err error)

ListByUser lists all user identities.

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

func (UserIdentitiesClient) ListByUserPreparer 

func (client UserIdentitiesClient) ListByUserPreparer(resourceGroupName string, serviceName string, uid string) (*http.Request, error)

ListByUserPreparer prepares the ListByUser request.

func (UserIdentitiesClient) ListByUserResponder 

func (client UserIdentitiesClient) ListByUserResponder(resp *http.Response) (result ListUserIdentityContract, err error)

ListByUserResponder handles the response to the ListByUser request. The method always closes the http.Response Body.

func (UserIdentitiesClient) ListByUserSender 

func (client UserIdentitiesClient) 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 UserIdentityContract 

type UserIdentityContract struct {
	Provider *string `json:"provider,omitempty"`
	ID       *string `json:"id,omitempty"`
}

UserIdentityContract is user identity details.

type UserStateContract 

type UserStateContract string

UserStateContract enumerates the values for user state contract. 

const (
	// UserStateContractActive specifies the user state contract active state
	// for user state contract.
	UserStateContractActive UserStateContract = "Active"
	// UserStateContractBlocked specifies the user state contract blocked state
	// for user state contract.
	UserStateContractBlocked UserStateContract = "Blocked"
)

type UserSubscriptionsClient 

type UserSubscriptionsClient struct {
	ManagementClient
}

UserSubscriptionsClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewUserSubscriptionsClient 

func NewUserSubscriptionsClient(subscriptionID string) UserSubscriptionsClient

NewUserSubscriptionsClient creates an instance of the UserSubscriptionsClient client.

func NewUserSubscriptionsClientWithBaseURI 

func NewUserSubscriptionsClientWithBaseURI(baseURI string, subscriptionID string) UserSubscriptionsClient

NewUserSubscriptionsClientWithBaseURI creates an instance of the UserSubscriptionsClient client.

func (UserSubscriptionsClient) ListByUser 

func (client UserSubscriptionsClient) ListByUser(resourceGroupName string, serviceName string, uid string, filter string, top *int32, skip *int32) (result SubscriptionCollection, err error)

ListByUser lists the collection of subscriptions of the specified user.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. uid is user identifier. Must be unique in the current API Management service instance. filter is | Field | Supported operators | Supported functions | |--------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top is number of records to return. skip is number of records to skip.

func (UserSubscriptionsClient) ListByUserNextResults 

func (client UserSubscriptionsClient) ListByUserNextResults(lastResults SubscriptionCollection) (result SubscriptionCollection, err error)

ListByUserNextResults retrieves the next set of results, if any.

func (UserSubscriptionsClient) ListByUserPreparer 

func (client UserSubscriptionsClient) ListByUserPreparer(resourceGroupName string, serviceName string, uid string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByUserPreparer prepares the ListByUser request.

func (UserSubscriptionsClient) ListByUserResponder 

func (client UserSubscriptionsClient) ListByUserResponder(resp *http.Response) (result SubscriptionCollection, err error)

ListByUserResponder handles the response to the ListByUser request. The method always closes the http.Response Body.

func (UserSubscriptionsClient) ListByUserSender 

func (client UserSubscriptionsClient) 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 UserUpdateParameters 

type UserUpdateParameters struct {
	Email     *string           `json:"email,omitempty"`
	Password  *string           `json:"password,omitempty"`
	FirstName *string           `json:"firstName,omitempty"`
	LastName  *string           `json:"lastName,omitempty"`
	State     UserStateContract `json:"state,omitempty"`
	Note      *string           `json:"note,omitempty"`
}

UserUpdateParameters is parameters supplied to the Update User operation.

type UsersClient 

type UsersClient struct {
	ManagementClient
}

UsersClient is the use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.

func NewUsersClient 

func NewUsersClient(subscriptionID string) UsersClient

NewUsersClient creates an instance of the UsersClient client.

func NewUsersClientWithBaseURI 

func NewUsersClientWithBaseURI(baseURI string, subscriptionID string) UsersClient

NewUsersClientWithBaseURI creates an instance of the UsersClient client.

func (UsersClient) CreateOrUpdate 

func (client UsersClient) CreateOrUpdate(resourceGroupName string, serviceName string, uid string, parameters UserCreateParameters) (result autorest.Response, err error)

CreateOrUpdate creates or Updates a user.

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

func (UsersClient) CreateOrUpdatePreparer 

func (client UsersClient) CreateOrUpdatePreparer(resourceGroupName string, serviceName string, uid string, parameters UserCreateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (UsersClient) CreateOrUpdateResponder 

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

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

func (UsersClient) CreateOrUpdateSender 

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

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

func (UsersClient) Delete 

func (client UsersClient) Delete(resourceGroupName string, serviceName string, uid string, ifMatch string, deleteSubscriptions *bool) (result ErrorBodyContract, err error)

Delete deletes specific user.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. uid is user identifier. Must be unique in the current API Management service instance. ifMatch is the entity state (Etag) version of the user to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. deleteSubscriptions is whether to delete user's subscription or not.

func (UsersClient) DeletePreparer 

func (client UsersClient) DeletePreparer(resourceGroupName string, serviceName string, uid string, ifMatch string, deleteSubscriptions *bool) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (UsersClient) DeleteResponder 

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

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

func (UsersClient) DeleteSender 

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

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

func (UsersClient) GenerateSsoURL 

func (client UsersClient) GenerateSsoURL(resourceGroupName string, serviceName string, uid string) (result GenerateSsoURLResult, err error)

GenerateSsoURL retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.

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

func (UsersClient) GenerateSsoURLPreparer 

func (client UsersClient) GenerateSsoURLPreparer(resourceGroupName string, serviceName string, uid string) (*http.Request, error)

GenerateSsoURLPreparer prepares the GenerateSsoURL request.

func (UsersClient) GenerateSsoURLResponder 

func (client UsersClient) GenerateSsoURLResponder(resp *http.Response) (result GenerateSsoURLResult, err error)

GenerateSsoURLResponder handles the response to the GenerateSsoURL request. The method always closes the http.Response Body.

func (UsersClient) GenerateSsoURLSender 

func (client UsersClient) GenerateSsoURLSender(req *http.Request) (*http.Response, error)

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

func (UsersClient) Get 

func (client UsersClient) Get(resourceGroupName string, serviceName string, uid string) (result UserContract, err error)

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

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

func (UsersClient) GetPreparer 

func (client UsersClient) GetPreparer(resourceGroupName string, serviceName string, uid string) (*http.Request, error)

GetPreparer prepares the Get request.

func (UsersClient) GetResponder 

func (client UsersClient) GetResponder(resp *http.Response) (result UserContract, err error)

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

func (UsersClient) GetSender 

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

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

func (UsersClient) ListByService 

func (client UsersClient) ListByService(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result UserCollection, err error)

ListByService lists a collection of registered users in the specified service instance.

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. filter is | Field | Supported operators | Supported functions | |------------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | N/A | | registrationDate | ge, le, eq, ne, gt, lt | N/A | | note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top is number of records to return. skip is number of records to skip.

func (UsersClient) ListByServiceNextResults 

func (client UsersClient) ListByServiceNextResults(lastResults UserCollection) (result UserCollection, err error)

ListByServiceNextResults retrieves the next set of results, if any.

func (UsersClient) ListByServicePreparer 

func (client UsersClient) ListByServicePreparer(resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)

ListByServicePreparer prepares the ListByService request.

func (UsersClient) ListByServiceResponder 

func (client UsersClient) ListByServiceResponder(resp *http.Response) (result UserCollection, err error)

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

func (UsersClient) ListByServiceSender 

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

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

func (UsersClient) Update 

func (client UsersClient) Update(resourceGroupName string, serviceName string, uid string, parameters UserUpdateParameters, ifMatch string) (result ErrorBodyContract, err error)

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

resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. uid is user identifier. Must be unique in the current API Management service instance. parameters is update parameters. ifMatch is the entity state (Etag) version of the user to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (UsersClient) UpdatePreparer 

func (client UsersClient) UpdatePreparer(resourceGroupName string, serviceName string, uid string, parameters UserUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (UsersClient) UpdateResponder 

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

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

func (UsersClient) UpdateSender 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.