azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/apimanagement/mgmt/2016-07-07/apimanagement Index | Files | Directories

package apimanagement

import "github.com/Azure/azure-sdk-for-go/services/apimanagement/mgmt/2016-07-07/apimanagement"

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

ApiManagement Client

Index

Package Files

apioperations.go apiproducts.go apis.go authorizationservers.go backends.go certificates.go client.go groups.go groupusers.go identityproviders.go loggers.go models.go openidconnectproviders.go policysnippets.go productapis.go productgroups.go products.go productsubscriptions.go property.go quotabycounterkeys.go quotabyperiodkeys.go regions.go reports.go services.go subscriptions.go tenantaccess.go tenantaccessgit.go tenantconfiguration.go tenantconfigurationsyncstate.go usergroups.go useridentities.go users.go usersubscriptions.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type APICollection Uses

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

APICollection paged Api list representation.

func (APICollection) IsEmpty Uses

func (ac APICollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type APICollectionIterator Uses

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

APICollectionIterator provides access to a complete listing of APIContract values.

func NewAPICollectionIterator Uses

func NewAPICollectionIterator(page APICollectionPage) APICollectionIterator

Creates a new instance of the APICollectionIterator type.

func (*APICollectionIterator) Next Uses

func (iter *APICollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*APICollectionIterator) NextWithContext Uses

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

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

func (APICollectionIterator) NotDone Uses

func (iter APICollectionIterator) NotDone() bool

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

func (APICollectionIterator) Response Uses

func (iter APICollectionIterator) Response() APICollection

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

func (APICollectionIterator) Value Uses

func (iter APICollectionIterator) Value() APIContract

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

type APICollectionPage Uses

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

APICollectionPage contains a page of APIContract values.

func NewAPICollectionPage Uses

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

Creates a new instance of the APICollectionPage type.

func (*APICollectionPage) Next Uses

func (page *APICollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*APICollectionPage) NextWithContext Uses

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

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

func (APICollectionPage) NotDone Uses

func (page APICollectionPage) NotDone() bool

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

func (APICollectionPage) Response Uses

func (page APICollectionPage) Response() APICollection

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

func (APICollectionPage) Values Uses

func (page APICollectionPage) Values() []APIContract

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

type APIContract Uses

type APIContract struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; API identifier path: /apis/{apiId}
    ID  *string `json:"id,omitempty"`
    // Name - API name.
    Name *string `json:"name,omitempty"`
    // Description - Description of the API. May include HTML formatting tags.
    Description *string `json:"description,omitempty"`
    // ServiceURL - Absolute URL of the backend service implementing this API.
    ServiceURL *string `json:"serviceUrl,omitempty"`
    // Path - Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
    Path *string `json:"path,omitempty"`
    // Protocols - Describes on which protocols the operations in this API can be invoked.
    Protocols *[]APIProtocolContract `json:"protocols,omitempty"`
    // AuthenticationSettings - Collection of authentication settings included into this API.
    AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
    // SubscriptionKeyParameterNames - Protocols over which API is made available.
    SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
    // Type - Type of API. Possible values include: 'APITypeContractHTTP', 'APITypeContractSoap'
    Type APITypeContract `json:"type,omitempty"`
}

APIContract API details.

type APIExportResult Uses

type APIExportResult struct {
    autorest.Response `json:"-"`
    // Content - Response content bytes.
    Content *[]byte `json:"content,omitempty"`
    // StatusCode - Possible values include: 'Continue', 'OK', 'Created', 'Accepted', 'NotFound', 'Conflict'
    StatusCode HTTPStatusCode `json:"statusCode,omitempty"`
    RequestID  *string        `json:"requestId,omitempty"`
}

APIExportResult the response model for the export API output operation.

type APIOperationsClient Uses

type APIOperationsClient struct {
    BaseClient
}

APIOperationsClient is the apiManagement Client

func NewAPIOperationsClient Uses

func NewAPIOperationsClient(subscriptionID string) APIOperationsClient

NewAPIOperationsClient creates an instance of the APIOperationsClient client.

func NewAPIOperationsClientWithBaseURI Uses

func NewAPIOperationsClientWithBaseURI(baseURI string, subscriptionID string) APIOperationsClient

NewAPIOperationsClientWithBaseURI creates an instance of the APIOperationsClient client.

func (APIOperationsClient) CreateOrUpdate Uses

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

CreateOrUpdate creates a new API operation or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. operationID - operation identifier within an API. Must be unique in the current API Management service instance. parameters - create parameters.

func (APIOperationsClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationsClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete deletes the specified operation. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. operationID - operation identifier within an API. Must be unique in the current API Management service instance. ifMatch - 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 Uses

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

DeletePreparer prepares the Delete request.

func (APIOperationsClient) DeleteResponder Uses

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 Uses

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 Uses

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

Get gets the details of the API Operation specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. operationID - operation identifier within an API. Must be unique in the current API Management service instance.

func (APIOperationsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIOperationsClient) GetResponder Uses

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 Uses

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 Uses

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

ListByAPI lists a collection of the operations for the specified API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | method | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (APIOperationsClient) ListByAPIComplete Uses

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

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

func (APIOperationsClient) ListByAPIPreparer Uses

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

ListByAPIPreparer prepares the ListByAPI request.

func (APIOperationsClient) ListByAPIResponder Uses

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 Uses

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 Uses

func (client APIOperationsClient) Update(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. operationID - operation identifier within an API. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - 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 Uses

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

UpdatePreparer prepares the Update request.

func (APIOperationsClient) UpdateResponder Uses

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 Uses

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 Uses

type APIProductsClient struct {
    BaseClient
}

APIProductsClient is the apiManagement Client

func NewAPIProductsClient Uses

func NewAPIProductsClient(subscriptionID string) APIProductsClient

NewAPIProductsClient creates an instance of the APIProductsClient client.

func NewAPIProductsClientWithBaseURI Uses

func NewAPIProductsClientWithBaseURI(baseURI string, subscriptionID string) APIProductsClient

NewAPIProductsClientWithBaseURI creates an instance of the APIProductsClient client.

func (APIProductsClient) ListByAPI Uses

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

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

func (APIProductsClient) ListByAPIComplete Uses

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

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

func (APIProductsClient) ListByAPIPreparer Uses

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

ListByAPIPreparer prepares the ListByAPI request.

func (APIProductsClient) ListByAPIResponder Uses

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 Uses

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 Uses

type APIProtocolContract string

APIProtocolContract enumerates the values for api protocol contract.

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

func PossibleAPIProtocolContractValues Uses

func PossibleAPIProtocolContractValues() []APIProtocolContract

PossibleAPIProtocolContractValues returns an array of possible values for the APIProtocolContract const type.

type APITypeContract Uses

type APITypeContract string

APITypeContract enumerates the values for api type contract.

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

func PossibleAPITypeContractValues Uses

func PossibleAPITypeContractValues() []APITypeContract

PossibleAPITypeContractValues returns an array of possible values for the APITypeContract const type.

type AccessInformationContract Uses

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

AccessInformationContract tenant access information contract of the API Management service.

type AccessInformationUpdateParameters Uses

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

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

type AdditionalRegion Uses

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

AdditionalRegion description of an additional API Management resource location.

type ApisClient Uses

type ApisClient struct {
    BaseClient
}

ApisClient is the apiManagement Client

func NewApisClient Uses

func NewApisClient(subscriptionID string) ApisClient

NewApisClient creates an instance of the ApisClient client.

func NewApisClientWithBaseURI Uses

func NewApisClientWithBaseURI(baseURI string, subscriptionID string) ApisClient

NewApisClientWithBaseURI creates an instance of the ApisClient client.

func (ApisClient) CreateOrUpdate Uses

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

CreateOrUpdate creates new or updates existing specified API of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. parameters - create or update parameters. ifMatch - 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 Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ApisClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete deletes the specified API of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. ifMatch - 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 Uses

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

DeletePreparer prepares the Delete request.

func (ApisClient) DeleteResponder Uses

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 Uses

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 Uses

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

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

func (ApisClient) ExportPreparer Uses

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

ExportPreparer prepares the Export request.

func (ApisClient) ExportResponder Uses

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 Uses

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 Uses

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

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

func (ApisClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (ApisClient) GetResponder Uses

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 Uses

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 Uses

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

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

func (ApisClient) ListByServiceComplete Uses

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

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

func (ApisClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (ApisClient) ListByServiceResponder Uses

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 Uses

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 Uses

func (client ApisClient) Update(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. parameters - patch parameters. ifMatch - 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 Uses

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

UpdatePreparer prepares the Update request.

func (ApisClient) UpdateResponder Uses

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 Uses

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 Uses

type AsyncOperationState string

AsyncOperationState enumerates the values for async operation state.

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

func PossibleAsyncOperationStateValues Uses

func PossibleAsyncOperationStateValues() []AsyncOperationState

PossibleAsyncOperationStateValues returns an array of possible values for the AsyncOperationState const type.

type AuthenticationSettingsContract Uses

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

AuthenticationSettingsContract API Authentication Settings.

type AuthorizationServerCollection Uses

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

AuthorizationServerCollection paged OAuth2 Authorization Servers list representation.

func (AuthorizationServerCollection) IsEmpty Uses

func (asc AuthorizationServerCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AuthorizationServerCollectionIterator Uses

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

AuthorizationServerCollectionIterator provides access to a complete listing of OAuth2AuthorizationServerContract values.

func NewAuthorizationServerCollectionIterator Uses

func NewAuthorizationServerCollectionIterator(page AuthorizationServerCollectionPage) AuthorizationServerCollectionIterator

Creates a new instance of the AuthorizationServerCollectionIterator type.

func (*AuthorizationServerCollectionIterator) Next Uses

func (iter *AuthorizationServerCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AuthorizationServerCollectionIterator) NextWithContext Uses

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

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

func (AuthorizationServerCollectionIterator) NotDone Uses

func (iter AuthorizationServerCollectionIterator) NotDone() bool

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

func (AuthorizationServerCollectionIterator) Response Uses

func (iter AuthorizationServerCollectionIterator) Response() AuthorizationServerCollection

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

func (AuthorizationServerCollectionIterator) Value Uses

func (iter AuthorizationServerCollectionIterator) Value() OAuth2AuthorizationServerContract

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

type AuthorizationServerCollectionPage Uses

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

AuthorizationServerCollectionPage contains a page of OAuth2AuthorizationServerContract values.

func NewAuthorizationServerCollectionPage Uses

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

Creates a new instance of the AuthorizationServerCollectionPage type.

func (*AuthorizationServerCollectionPage) Next Uses

func (page *AuthorizationServerCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AuthorizationServerCollectionPage) NextWithContext Uses

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

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

func (AuthorizationServerCollectionPage) NotDone Uses

func (page AuthorizationServerCollectionPage) NotDone() bool

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

func (AuthorizationServerCollectionPage) Response Uses

func (page AuthorizationServerCollectionPage) Response() AuthorizationServerCollection

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

func (AuthorizationServerCollectionPage) Values Uses

func (page AuthorizationServerCollectionPage) Values() []OAuth2AuthorizationServerContract

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

type AuthorizationServersClient Uses

type AuthorizationServersClient struct {
    BaseClient
}

AuthorizationServersClient is the apiManagement Client

func NewAuthorizationServersClient Uses

func NewAuthorizationServersClient(subscriptionID string) AuthorizationServersClient

NewAuthorizationServersClient creates an instance of the AuthorizationServersClient client.

func NewAuthorizationServersClientWithBaseURI Uses

func NewAuthorizationServersClientWithBaseURI(baseURI string, subscriptionID string) AuthorizationServersClient

NewAuthorizationServersClientWithBaseURI creates an instance of the AuthorizationServersClient client.

func (AuthorizationServersClient) CreateOrUpdate Uses

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

CreateOrUpdate creates new authorization server or updates an existing authorization server. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server. parameters - create or update parameters.

func (AuthorizationServersClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AuthorizationServersClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete deletes specific authorization server instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server. ifMatch - 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 Uses

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

DeletePreparer prepares the Delete request.

func (AuthorizationServersClient) DeleteResponder Uses

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 Uses

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 Uses

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

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

func (AuthorizationServersClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (AuthorizationServersClient) GetResponder Uses

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 Uses

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 Uses

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

ListByService lists a collection of authorization servers defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (AuthorizationServersClient) ListByServiceComplete Uses

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

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

func (AuthorizationServersClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (AuthorizationServersClient) ListByServiceResponder Uses

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 Uses

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 Uses

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

Update updates the details of the authorization server specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server. parameters - oAuth2 Server settings Update parameters. ifMatch - 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 Uses

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

UpdatePreparer prepares the Update request.

func (AuthorizationServersClient) UpdateResponder Uses

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 Uses

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 Uses

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

BackendCollection paged Backend list representation.

func (BackendCollection) IsEmpty Uses

func (bc BackendCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type BackendCollectionIterator Uses

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

BackendCollectionIterator provides access to a complete listing of BackendResponse values.

func NewBackendCollectionIterator Uses

func NewBackendCollectionIterator(page BackendCollectionPage) BackendCollectionIterator

Creates a new instance of the BackendCollectionIterator type.

func (*BackendCollectionIterator) Next Uses

func (iter *BackendCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*BackendCollectionIterator) NextWithContext Uses

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

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

func (BackendCollectionIterator) NotDone Uses

func (iter BackendCollectionIterator) NotDone() bool

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

func (BackendCollectionIterator) Response Uses

func (iter BackendCollectionIterator) Response() BackendCollection

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

func (BackendCollectionIterator) Value Uses

func (iter BackendCollectionIterator) Value() BackendResponse

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

type BackendCollectionPage Uses

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

BackendCollectionPage contains a page of BackendResponse values.

func NewBackendCollectionPage Uses

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

Creates a new instance of the BackendCollectionPage type.

func (*BackendCollectionPage) Next Uses

func (page *BackendCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*BackendCollectionPage) NextWithContext Uses

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

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

func (BackendCollectionPage) NotDone Uses

func (page BackendCollectionPage) NotDone() bool

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

func (BackendCollectionPage) Response Uses

func (page BackendCollectionPage) Response() BackendCollection

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

func (BackendCollectionPage) Values Uses

func (page BackendCollectionPage) Values() []BackendResponse

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

type BackendContract Uses

type BackendContract struct {
    // Host - Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty.
    Host *string `json:"host,omitempty"`
    // SkipCertificateChainValidation - Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.
    SkipCertificateChainValidation *bool `json:"skipCertificateChainValidation,omitempty"`
}

BackendContract parameters supplied to the Create Backend operation.

type BackendResponse Uses

type BackendResponse struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Uniquely identifies the backend within the current API Management service instance. The value is a valid relative URL in the format of /backends/{backendId} where {backendId} is a backend identifier.
    ID  *string `json:"id,omitempty"`
    // Host - Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty.
    Host *string `json:"host,omitempty"`
    // SkipCertificateChainValidation - Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.
    SkipCertificateChainValidation *bool `json:"skipCertificateChainValidation,omitempty"`
}

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

type BackendUpdateParameters Uses

type BackendUpdateParameters struct {
    // Host - Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty.
    Host *string `json:"host,omitempty"`
    // SkipCertificateChainValidation - Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.
    SkipCertificateChainValidation *bool `json:"skipCertificateChainValidation,omitempty"`
}

BackendUpdateParameters parameters supplied to the Update Backend operation.

type BackendsClient Uses

type BackendsClient struct {
    BaseClient
}

BackendsClient is the apiManagement Client

func NewBackendsClient Uses

func NewBackendsClient(subscriptionID string) BackendsClient

NewBackendsClient creates an instance of the BackendsClient client.

func NewBackendsClientWithBaseURI Uses

func NewBackendsClientWithBaseURI(baseURI string, subscriptionID string) BackendsClient

NewBackendsClientWithBaseURI creates an instance of the BackendsClient client.

func (BackendsClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or Updates a backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - user identifier. Must be unique in the current API Management service instance. parameters - create parameters.

func (BackendsClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BackendsClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete deletes the specified backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - user identifier. Must be unique in the current API Management service instance. ifMatch - 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 Uses

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

DeletePreparer prepares the Delete request.

func (BackendsClient) DeleteResponder Uses

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 Uses

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 Uses

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

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

func (BackendsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (BackendsClient) GetResponder Uses

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 Uses

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 Uses

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

ListByService lists a collection of backends in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | host | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (BackendsClient) ListByServiceComplete Uses

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

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

func (BackendsClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (BackendsClient) ListByServiceResponder Uses

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 Uses

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 Uses

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

Update updates an existing backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - user identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - 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 Uses

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

UpdatePreparer prepares the Update request.

func (BackendsClient) UpdateResponder Uses

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 Uses

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

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

type BaseClient Uses

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

BaseClient is the base client for Apimanagement.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type BearerTokenSendingMethodsContract Uses

type BearerTokenSendingMethodsContract string

BearerTokenSendingMethodsContract enumerates the values for bearer token sending methods contract.

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

func PossibleBearerTokenSendingMethodsContractValues Uses

func PossibleBearerTokenSendingMethodsContractValues() []BearerTokenSendingMethodsContract

PossibleBearerTokenSendingMethodsContractValues returns an array of possible values for the BearerTokenSendingMethodsContract const type.

type CertificateCollection Uses

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

CertificateCollection paged Certificates list representation.

func (CertificateCollection) IsEmpty Uses

func (cc CertificateCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CertificateCollectionIterator Uses

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

CertificateCollectionIterator provides access to a complete listing of CertificateContract values.

func NewCertificateCollectionIterator Uses

func NewCertificateCollectionIterator(page CertificateCollectionPage) CertificateCollectionIterator

Creates a new instance of the CertificateCollectionIterator type.

func (*CertificateCollectionIterator) Next Uses

func (iter *CertificateCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*CertificateCollectionIterator) NextWithContext Uses

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

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

func (CertificateCollectionIterator) NotDone Uses

func (iter CertificateCollectionIterator) NotDone() bool

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

func (CertificateCollectionIterator) Response Uses

func (iter CertificateCollectionIterator) Response() CertificateCollection

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

func (CertificateCollectionIterator) Value Uses

func (iter CertificateCollectionIterator) Value() CertificateContract

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

type CertificateCollectionPage Uses

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

CertificateCollectionPage contains a page of CertificateContract values.

func NewCertificateCollectionPage Uses

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

Creates a new instance of the CertificateCollectionPage type.

func (*CertificateCollectionPage) Next Uses

func (page *CertificateCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*CertificateCollectionPage) NextWithContext Uses

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

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

func (CertificateCollectionPage) NotDone Uses

func (page CertificateCollectionPage) NotDone() bool

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

func (CertificateCollectionPage) Response Uses

func (page CertificateCollectionPage) Response() CertificateCollection

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

func (CertificateCollectionPage) Values Uses

func (page CertificateCollectionPage) Values() []CertificateContract

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

type CertificateContract Uses

type CertificateContract struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Certificate identifier path: /certificates/{certificateId}
    ID  *string `json:"id,omitempty"`
    // Subject - Subject attribute of the certificate.
    Subject *string `json:"subject,omitempty"`
    // Thumbprint - Thumbprint of the certificate.
    Thumbprint *string `json:"thumbprint,omitempty"`
    // ExpirationDate - Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
    ExpirationDate *date.Time `json:"expirationDate,omitempty"`
}

CertificateContract certificate details.

type CertificateCreateOrUpdateParameters Uses

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

CertificateCreateOrUpdateParameters parameters supplied to the CreateOrUpdate certificate operation.

type CertificateInformation Uses

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

CertificateInformation SSL certificate information.

type CertificatesClient Uses

type CertificatesClient struct {
    BaseClient
}

CertificatesClient is the apiManagement Client

func NewCertificatesClient Uses

func NewCertificatesClient(subscriptionID string) CertificatesClient

NewCertificatesClient creates an instance of the CertificatesClient client.

func NewCertificatesClientWithBaseURI Uses

func NewCertificatesClientWithBaseURI(baseURI string, subscriptionID string) CertificatesClient

NewCertificatesClientWithBaseURI creates an instance of the CertificatesClient client.

func (CertificatesClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or updates the certificate being used for authentication with the backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - 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 Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CertificatesClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete deletes specific certificate. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. certificateID - identifier of the certificate. ifMatch - 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 Uses

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

DeletePreparer prepares the Delete request.

func (CertificatesClient) DeleteResponder Uses

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 Uses

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 Uses

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

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

func (CertificatesClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (CertificatesClient) GetResponder Uses

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 Uses

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 Uses

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

ListByService lists a collection of all certificates in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |----------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | subject | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | thumbprint | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | expirationDate | ge, le, eq, ne, gt, lt | N/A | top - number of records to return. skip - number of records to skip.

func (CertificatesClient) ListByServiceComplete Uses

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

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

func (CertificatesClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (CertificatesClient) ListByServiceResponder Uses

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 Uses

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 Uses

type ClientAuthenticationMethodContract string

ClientAuthenticationMethodContract enumerates the values for client authentication method contract.

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

func PossibleClientAuthenticationMethodContractValues Uses

func PossibleClientAuthenticationMethodContractValues() []ClientAuthenticationMethodContract

PossibleClientAuthenticationMethodContractValues returns an array of possible values for the ClientAuthenticationMethodContract const type.

type DeployConfigurationParameters Uses

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

DeployConfigurationParameters parameters supplied to the Deploy Configuration operation.

type ErrorBodyContract Uses

type ErrorBodyContract struct {
    autorest.Response `json:"-"`
    // Code - Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
    Code *string `json:"code,omitempty"`
    // Message - Human-readable representation of the error.
    Message *string `json:"message,omitempty"`
    // Details - The list of invalid fields send in request, in case of validation error.
    Details *[]ErrorFieldContract `json:"details,omitempty"`
}

ErrorBodyContract error Body contract.

type ErrorFieldContract Uses

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

ErrorFieldContract error Field contract.

type ErrorResponse Uses

type ErrorResponse struct {
    autorest.Response `json:"-"`
    // Code - Error code.
    Code *string `json:"code,omitempty"`
    // Message - Error message indicating why the operation failed.
    Message *string `json:"message,omitempty"`
}

ErrorResponse error Response.

type GenerateSsoURLResult Uses

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

GenerateSsoURLResult generate SSO Url operations response details.

type GrantTypesContract Uses

type GrantTypesContract string

GrantTypesContract enumerates the values for grant types contract.

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

func PossibleGrantTypesContractValues Uses

func PossibleGrantTypesContractValues() []GrantTypesContract

PossibleGrantTypesContractValues returns an array of possible values for the GrantTypesContract const type.

type GroupCollection Uses

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

GroupCollection paged Group list representation.

func (GroupCollection) IsEmpty Uses

func (gc GroupCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type GroupCollectionIterator Uses

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

GroupCollectionIterator provides access to a complete listing of GroupContract values.

func NewGroupCollectionIterator Uses

func NewGroupCollectionIterator(page GroupCollectionPage) GroupCollectionIterator

Creates a new instance of the GroupCollectionIterator type.

func (*GroupCollectionIterator) Next Uses

func (iter *GroupCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*GroupCollectionIterator) NextWithContext Uses

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

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

func (GroupCollectionIterator) NotDone Uses

func (iter GroupCollectionIterator) NotDone() bool

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

func (GroupCollectionIterator) Response Uses

func (iter GroupCollectionIterator) Response() GroupCollection

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

func (GroupCollectionIterator) Value Uses

func (iter GroupCollectionIterator) Value() GroupContract

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

type GroupCollectionPage Uses

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

GroupCollectionPage contains a page of GroupContract values.

func NewGroupCollectionPage Uses

func NewGroupCollectionPage(getNextPage func(context.Context, GroupCollection) (GroupCollection, error)) GroupCollectionPage

Creates a new instance of the GroupCollectionPage type.

func (*GroupCollectionPage) Next Uses

func (page *GroupCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*GroupCollectionPage) NextWithContext Uses

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

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

func (GroupCollectionPage) NotDone Uses

func (page GroupCollectionPage) NotDone() bool

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

func (GroupCollectionPage) Response Uses

func (page GroupCollectionPage) Response() GroupCollection

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

func (GroupCollectionPage) Values Uses

func (page GroupCollectionPage) Values() []GroupContract

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

type GroupContract Uses

type GroupContract struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier.
    ID  *string `json:"id,omitempty"`
    // Name - Group name.
    Name *string `json:"name,omitempty"`
    // Description - Group description. Can contain HTML formatting tags.
    Description *string `json:"description,omitempty"`
    // BuiltIn - READ-ONLY; true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
    BuiltIn *bool `json:"builtIn,omitempty"`
    // Type - READ-ONLY; Group type. Possible values include: 'Custom', 'System', 'External'
    Type GroupTypeContract `json:"type,omitempty"`
    // ExternalID - READ-ONLY; For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory; otherwise the value is null.
    ExternalID *string `json:"externalId,omitempty"`
}

GroupContract developer group.

type GroupCreateParameters Uses

type GroupCreateParameters struct {
    // Name - Group name.
    Name *string `json:"name,omitempty"`
    // Description - Group description.
    Description *string `json:"description,omitempty"`
    // Type - Group type. Possible values include: 'Custom', 'System', 'External'
    Type GroupTypeContract `json:"type,omitempty"`
    // ExternalID - Identifier for an external group.
    ExternalID *string `json:"externalId,omitempty"`
}

GroupCreateParameters parameters supplied to the Create Group operation.

type GroupTypeContract Uses

type GroupTypeContract string

GroupTypeContract enumerates the values for group type contract.

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

func PossibleGroupTypeContractValues Uses

func PossibleGroupTypeContractValues() []GroupTypeContract

PossibleGroupTypeContractValues returns an array of possible values for the GroupTypeContract const type.

type GroupUpdateParameters Uses

type GroupUpdateParameters struct {
    // Name - Group name.
    Name *string `json:"name,omitempty"`
    // Description - Group description.
    Description *string `json:"description,omitempty"`
    // Type - Group type. Possible values include: 'Custom', 'System', 'External'
    Type GroupTypeContract `json:"type,omitempty"`
    // ExternalID - Identifier for an external group.
    ExternalID *string `json:"externalId,omitempty"`
}

GroupUpdateParameters parameters supplied to the Update Group operation.

type GroupUsersClient Uses

type GroupUsersClient struct {
    BaseClient
}

GroupUsersClient is the apiManagement Client

func NewGroupUsersClient Uses

func NewGroupUsersClient(subscriptionID string) GroupUsersClient

NewGroupUsersClient creates an instance of the GroupUsersClient client.

func NewGroupUsersClientWithBaseURI Uses

func NewGroupUsersClientWithBaseURI(baseURI string, subscriptionID string) GroupUsersClient

NewGroupUsersClientWithBaseURI creates an instance of the GroupUsersClient client.

func (GroupUsersClient) Add Uses

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

Add adds a user to the specified group. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. UID - user identifier. Must be unique in the current API Management service instance.

func (GroupUsersClient) AddPreparer Uses

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

AddPreparer prepares the Add request.

func (GroupUsersClient) AddResponder Uses

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 Uses

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 Uses

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

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

func (GroupUsersClient) ListByGroupComplete Uses

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

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

func (GroupUsersClient) ListByGroupPreparer Uses

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

ListByGroupPreparer prepares the ListByGroup request.

func (GroupUsersClient) ListByGroupResponder Uses

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 Uses

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 Uses

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

Remove remove existing user from existing group. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. UID - user identifier. Must be unique in the current API Management service instance.

func (GroupUsersClient) RemovePreparer Uses

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

RemovePreparer prepares the Remove request.

func (GroupUsersClient) RemoveResponder Uses

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 Uses

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 Uses

type GroupsClient struct {
    BaseClient
}

GroupsClient is the apiManagement Client

func NewGroupsClient Uses

func NewGroupsClient(subscriptionID string) GroupsClient

NewGroupsClient creates an instance of the GroupsClient client.

func NewGroupsClientWithBaseURI Uses

func NewGroupsClientWithBaseURI(baseURI string, subscriptionID string) GroupsClient

NewGroupsClientWithBaseURI creates an instance of the GroupsClient client.

func (GroupsClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or Updates a group. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. parameters - create parameters.

func (GroupsClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupsClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete deletes specific group of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the 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 Uses

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

DeletePreparer prepares the Delete request.

func (GroupsClient) DeleteResponder Uses

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 Uses

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 Uses

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

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

func (GroupsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (GroupsClient) GetResponder Uses

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 Uses

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 Uses

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

ListByService lists a collection of groups defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq, ne | N/A | top - number of records to return. skip - number of records to skip.

func (GroupsClient) ListByServiceComplete Uses

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

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

func (GroupsClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (GroupsClient) ListByServiceResponder Uses

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 Uses

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 Uses

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

Update updates the details of the group specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the 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 Uses

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

UpdatePreparer prepares the Update request.

func (GroupsClient) UpdateResponder Uses

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 Uses

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 Uses

type HTTPStatusCode string

HTTPStatusCode enumerates the values for http status code.

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

func PossibleHTTPStatusCodeValues Uses

func PossibleHTTPStatusCodeValues() []HTTPStatusCode

PossibleHTTPStatusCodeValues returns an array of possible values for the HTTPStatusCode const type.

type HostnameConfiguration Uses

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

HostnameConfiguration custom hostname configuration.

type HostnameType Uses

type HostnameType string

HostnameType enumerates the values for hostname type.

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

func PossibleHostnameTypeValues Uses

func PossibleHostnameTypeValues() []HostnameType

PossibleHostnameTypeValues returns an array of possible values for the HostnameType const type.

type IdentityProviderContract Uses

type IdentityProviderContract struct {
    autorest.Response `json:"-"`
    // ClientID - Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
    ClientID *string `json:"clientId,omitempty"`
    // ClientSecret - Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.
    ClientSecret *string `json:"clientSecret,omitempty"`
    // Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad'
    Type IdentityProviderNameType `json:"type,omitempty"`
    // AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
    AllowedTenants *[]string `json:"allowedTenants,omitempty"`
}

IdentityProviderContract the external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.

type IdentityProviderList Uses

type IdentityProviderList struct {
    autorest.Response `json:"-"`
    // Value - Identity Provider configuration values.
    Value *[]IdentityProviderContract `json:"value,omitempty"`
}

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

type IdentityProviderNameType Uses

type IdentityProviderNameType string

IdentityProviderNameType enumerates the values for identity provider name type.

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

func PossibleIdentityProviderNameTypeValues Uses

func PossibleIdentityProviderNameTypeValues() []IdentityProviderNameType

PossibleIdentityProviderNameTypeValues returns an array of possible values for the IdentityProviderNameType const type.

type IdentityProviderUpdateParameters Uses

type IdentityProviderUpdateParameters struct {
    // ClientID - Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
    ClientID *string `json:"clientId,omitempty"`
    // ClientSecret - Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.
    ClientSecret *string `json:"clientSecret,omitempty"`
    // AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
    AllowedTenants *[]string `json:"allowedTenants,omitempty"`
}

IdentityProviderUpdateParameters parameters supplied to the Update Identity Provider operation.

type IdentityProvidersClient Uses

type IdentityProvidersClient struct {
    BaseClient
}

IdentityProvidersClient is the apiManagement Client

func NewIdentityProvidersClient Uses

func NewIdentityProvidersClient(subscriptionID string) IdentityProvidersClient

NewIdentityProvidersClient creates an instance of the IdentityProvidersClient client.

func NewIdentityProvidersClientWithBaseURI Uses

func NewIdentityProvidersClientWithBaseURI(baseURI string, subscriptionID string) IdentityProvidersClient

NewIdentityProvidersClientWithBaseURI creates an instance of the IdentityProvidersClient client.

func (IdentityProvidersClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or Updates the IdentityProvider configuration. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier. parameters - create parameters.

func (IdentityProvidersClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (IdentityProvidersClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete deletes the specified identity provider configuration. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier. ifMatch - 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 Uses

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

DeletePreparer prepares the Delete request.

func (IdentityProvidersClient) DeleteResponder Uses

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 Uses

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 Uses

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

Get gets the configuration details of the identity Provider configured in specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier.

func (IdentityProvidersClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (IdentityProvidersClient) GetResponder Uses

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 Uses

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 Uses

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

ListByService lists a collection of Identity Provider configured in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (IdentityProvidersClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (IdentityProvidersClient) ListByServiceResponder Uses

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 Uses

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 Uses

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

Update updates an existing IdentityProvider configuration. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier. parameters - update parameters. ifMatch - 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 Uses

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

UpdatePreparer prepares the Update request.

func (IdentityProvidersClient) UpdateResponder Uses

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 Uses

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 Uses

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

ListPolicySnippetContract ...

type ListUserIdentityContract Uses

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

ListUserIdentityContract ...

type LoggerCollection Uses

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

LoggerCollection paged Logger list representation.

func (LoggerCollection) IsEmpty Uses

func (lc LoggerCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type LoggerCollectionIterator Uses

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

LoggerCollectionIterator provides access to a complete listing of LoggerResponse values.

func NewLoggerCollectionIterator Uses

func NewLoggerCollectionIterator(page LoggerCollectionPage) LoggerCollectionIterator

Creates a new instance of the LoggerCollectionIterator type.

func (*LoggerCollectionIterator) Next Uses

func (iter *LoggerCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*LoggerCollectionIterator) NextWithContext Uses

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

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

func (LoggerCollectionIterator) NotDone Uses

func (iter LoggerCollectionIterator) NotDone() bool

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

func (LoggerCollectionIterator) Response Uses

func (iter LoggerCollectionIterator) Response() LoggerCollection

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

func (LoggerCollectionIterator) Value Uses

func (iter LoggerCollectionIterator) Value() LoggerResponse

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

type LoggerCollectionPage Uses

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

LoggerCollectionPage contains a page of LoggerResponse values.

func NewLoggerCollectionPage Uses

func NewLoggerCollectionPage(getNextPage func(context.Context, LoggerCollection) (LoggerCollection, error)) LoggerCollectionPage

Creates a new instance of the LoggerCollectionPage type.

func (*LoggerCollectionPage) Next Uses

func (page *LoggerCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*LoggerCollectionPage) NextWithContext Uses

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

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

func (LoggerCollectionPage) NotDone Uses

func (page LoggerCollectionPage) NotDone() bool

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

func (LoggerCollectionPage) Response Uses

func (page LoggerCollectionPage) Response() LoggerCollection

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

func (LoggerCollectionPage) Values Uses

func (page LoggerCollectionPage) Values() []LoggerResponse

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

type LoggerCreateParameters Uses

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

LoggerCreateParameters parameters supplied to the Create Logger operation.

func (LoggerCreateParameters) MarshalJSON Uses

func (lcp LoggerCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LoggerCreateParameters.

type LoggerResponse Uses

type LoggerResponse struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Uniquely identifies the logger within the current API Management service instance. The value is a valid relative URL in the format of /loggers/{loggerId} where {loggerId} is a logger identifier.
    ID  *string `json:"id,omitempty"`
    // Type - Logger type.
    Type *string `json:"type,omitempty"`
    // Description - Logger description.
    Description *string `json:"description,omitempty"`
    // Credentials - The name and SendRule connection string of the event hub.
    Credentials map[string]*string `json:"credentials"`
    // IsBuffered - Whether records are buffered in the logger before publishing. Default is assumed to be true.
    IsBuffered *bool `json:"isBuffered,omitempty"`
}

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

func (LoggerResponse) MarshalJSON Uses

func (lr LoggerResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LoggerResponse.

type LoggerUpdateParameters Uses

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

LoggerUpdateParameters parameters supplied to the Update Logger operation.

func (LoggerUpdateParameters) MarshalJSON Uses

func (lup LoggerUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LoggerUpdateParameters.

type LoggersClient Uses

type LoggersClient struct {
    BaseClient
}

LoggersClient is the apiManagement Client

func NewLoggersClient Uses

func NewLoggersClient(subscriptionID string) LoggersClient

NewLoggersClient creates an instance of the LoggersClient client.

func NewLoggersClientWithBaseURI Uses

func NewLoggersClientWithBaseURI(baseURI string, subscriptionID string) LoggersClient

NewLoggersClientWithBaseURI creates an instance of the LoggersClient client.

func (LoggersClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or Updates a logger. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - identifier of the logger. parameters - create parameters.

func (LoggersClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (LoggersClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete deletes the specified logger. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - identifier of the logger. ifMatch - 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 Uses

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

DeletePreparer prepares the Delete request.

func (LoggersClient) DeleteResponder Uses

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 Uses

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 Uses

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

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

func (LoggersClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (LoggersClient) GetResponder Uses

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 Uses

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 Uses

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

ListByService lists a collection of loggers in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq | | top - number of records to return. skip - number of records to skip.

func (LoggersClient) ListByServiceComplete Uses

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

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

func (LoggersClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (LoggersClient) ListByServiceResponder Uses

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 Uses

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 Uses

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

Update updates an existing logger. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - identifier of the logger. parameters - update parameters. ifMatch - 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 Uses

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

UpdatePreparer prepares the Update request.

func (LoggersClient) UpdateResponder Uses

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 Uses

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

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

type MethodContract Uses

type MethodContract string

MethodContract enumerates the values for method contract.

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

func PossibleMethodContractValues Uses

func PossibleMethodContractValues() []MethodContract

PossibleMethodContractValues returns an array of possible values for the MethodContract const type.

type NameAvailabilityReason Uses

type NameAvailabilityReason string

NameAvailabilityReason enumerates the values for name availability reason.

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

func PossibleNameAvailabilityReasonValues Uses

func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason

PossibleNameAvailabilityReasonValues returns an array of possible values for the NameAvailabilityReason const type.

type OAuth2AuthenticationSettingsContract Uses

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

OAuth2AuthenticationSettingsContract API OAuth2 Authentication settings details.

type OAuth2AuthorizationServerContract Uses

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

OAuth2AuthorizationServerContract external OAuth authorization server settings.

type OAuth2AuthorizationServerUpdateContract Uses

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

OAuth2AuthorizationServerUpdateContract external OAuth authorization server Update settings contract.

type OpenIDConnectProviderCollection Uses

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

OpenIDConnectProviderCollection paged OpenIdProviders list representation.

func (OpenIDConnectProviderCollection) IsEmpty Uses

func (oicpc OpenIDConnectProviderCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OpenIDConnectProviderCollectionIterator Uses

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

OpenIDConnectProviderCollectionIterator provides access to a complete listing of OpenidConnectProviderContract values.

func NewOpenIDConnectProviderCollectionIterator Uses

func NewOpenIDConnectProviderCollectionIterator(page OpenIDConnectProviderCollectionPage) OpenIDConnectProviderCollectionIterator

Creates a new instance of the OpenIDConnectProviderCollectionIterator type.

func (*OpenIDConnectProviderCollectionIterator) Next Uses

func (iter *OpenIDConnectProviderCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OpenIDConnectProviderCollectionIterator) NextWithContext Uses

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

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

func (OpenIDConnectProviderCollectionIterator) NotDone Uses

func (iter OpenIDConnectProviderCollectionIterator) NotDone() bool

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

func (OpenIDConnectProviderCollectionIterator) Response Uses

func (iter OpenIDConnectProviderCollectionIterator) Response() OpenIDConnectProviderCollection

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

func (OpenIDConnectProviderCollectionIterator) Value Uses

func (iter OpenIDConnectProviderCollectionIterator) Value() OpenidConnectProviderContract

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

type OpenIDConnectProviderCollectionPage Uses

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

OpenIDConnectProviderCollectionPage contains a page of OpenidConnectProviderContract values.

func NewOpenIDConnectProviderCollectionPage Uses

func NewOpenIDConnectProviderCollectionPage(getNextPage func(context.Context, OpenIDConnectProviderCollection) (OpenIDConnectProviderCollection, error)) OpenIDConnectProviderCollectionPage

Creates a new instance of the OpenIDConnectProviderCollectionPage type.

func (*OpenIDConnectProviderCollectionPage) Next Uses

func (page *OpenIDConnectProviderCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OpenIDConnectProviderCollectionPage) NextWithContext Uses

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

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

func (OpenIDConnectProviderCollectionPage) NotDone Uses

func (page OpenIDConnectProviderCollectionPage) NotDone() bool

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

func (OpenIDConnectProviderCollectionPage) Response Uses

func (page OpenIDConnectProviderCollectionPage) Response() OpenIDConnectProviderCollection

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

func (OpenIDConnectProviderCollectionPage) Values Uses

func (page OpenIDConnectProviderCollectionPage) Values() []OpenidConnectProviderContract

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

type OpenIDConnectProvidersClient Uses

type OpenIDConnectProvidersClient struct {
    BaseClient
}

OpenIDConnectProvidersClient is the apiManagement Client

func NewOpenIDConnectProvidersClient Uses

func NewOpenIDConnectProvidersClient(subscriptionID string) OpenIDConnectProvidersClient

NewOpenIDConnectProvidersClient creates an instance of the OpenIDConnectProvidersClient client.

func NewOpenIDConnectProvidersClientWithBaseURI Uses

func NewOpenIDConnectProvidersClientWithBaseURI(baseURI string, subscriptionID string) OpenIDConnectProvidersClient

NewOpenIDConnectProvidersClientWithBaseURI creates an instance of the OpenIDConnectProvidersClient client.

func (OpenIDConnectProvidersClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or updates the OpenID Connect Provider. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider. parameters - create parameters.

func (OpenIDConnectProvidersClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (OpenIDConnectProvidersClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete deletes specific OpenID Connect Provider of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider. ifMatch - 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 Uses

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

DeletePreparer prepares the Delete request.

func (OpenIDConnectProvidersClient) DeleteResponder Uses

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 Uses

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 Uses

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

Get gets specific OpenID Connect Provider. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider.

func (OpenIDConnectProvidersClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (OpenIDConnectProvidersClient) GetResponder Uses

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 Uses

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 Uses

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

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

func (OpenIDConnectProvidersClient) ListByServiceComplete Uses

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

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

func (OpenIDConnectProvidersClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (OpenIDConnectProvidersClient) ListByServiceResponder Uses

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 Uses

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 Uses

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

Update updates the specific OpenID Connect Provider. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider. parameters - update parameters. ifMatch - 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 Uses

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

UpdatePreparer prepares the Update request.

func (OpenIDConnectProvidersClient) UpdateResponder Uses

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 Uses

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 Uses

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

OpenidConnectProviderContract openID Connect Providers Contract.

type OpenidConnectProviderCreateContract Uses

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

OpenidConnectProviderCreateContract parameters supplied to the Create OpenID Connect Provider operation.

type OpenidConnectProviderUpdateContract Uses

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

OpenidConnectProviderUpdateContract parameters supplied to the Update OpenID Connect Provider operation.

type OperationCollection Uses

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

OperationCollection paged Operation list representation.

func (OperationCollection) IsEmpty Uses

func (oc OperationCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationCollectionIterator Uses

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

OperationCollectionIterator provides access to a complete listing of OperationContract values.

func NewOperationCollectionIterator Uses

func NewOperationCollectionIterator(page OperationCollectionPage) OperationCollectionIterator

Creates a new instance of the OperationCollectionIterator type.

func (*OperationCollectionIterator) Next Uses

func (iter *OperationCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationCollectionIterator) NextWithContext Uses

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

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

func (OperationCollectionIterator) NotDone Uses

func (iter OperationCollectionIterator) NotDone() bool

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

func (OperationCollectionIterator) Response Uses

func (iter OperationCollectionIterator) Response() OperationCollection

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

func (OperationCollectionIterator) Value Uses

func (iter OperationCollectionIterator) Value() OperationContract

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

type OperationCollectionPage Uses

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

OperationCollectionPage contains a page of OperationContract values.

func NewOperationCollectionPage Uses

func NewOperationCollectionPage(getNextPage func(context.Context, OperationCollection) (OperationCollection, error)) OperationCollectionPage

Creates a new instance of the OperationCollectionPage type.

func (*OperationCollectionPage) Next Uses

func (page *OperationCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationCollectionPage) NextWithContext Uses

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

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

func (OperationCollectionPage) NotDone Uses

func (page OperationCollectionPage) NotDone() bool

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

func (OperationCollectionPage) Response Uses

func (page OperationCollectionPage) Response() OperationCollection

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

func (OperationCollectionPage) Values Uses

func (page OperationCollectionPage) Values() []OperationContract

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

type OperationContract Uses

type OperationContract struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Uniquely identifies the operation within the current API Management service instance. The value is a valid relative URL in the format of /apis/{aid}/operations/{id} where {aid} is an API identifier and {id} is an operation identifier.
    ID  *string `json:"id,omitempty"`
    // Name - Operation Name.
    Name *string `json:"name,omitempty"`
    // Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
    Method *string `json:"method,omitempty"`
    // URLTemplate - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
    URLTemplate *string `json:"urlTemplate,omitempty"`
    // TemplateParameters - Collection of URL template parameters.
    TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
    // Description - Description of the operation. May include HTML formatting tags.
    Description *string `json:"description,omitempty"`
    // Request - An entity containing request details.
    Request *RequestContract `json:"request,omitempty"`
    // Responses - Array of Operation responses.
    Responses *[]ResultContract `json:"responses,omitempty"`
}

OperationContract api Operation details.

type OperationResultContract Uses

type OperationResultContract struct {
    autorest.Response `json:"-"`
    // ID - Operation result identifier.
    ID  *string `json:"id,omitempty"`
    // Status - Status of an async operation. Possible values include: 'Started', 'InProgress', 'Succeeded', 'Failed'
    Status AsyncOperationState `json:"status,omitempty"`
    // Started - Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
    Started *date.Time `json:"started,omitempty"`
    // Updated - Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
    Updated *date.Time `json:"updated,omitempty"`
    // ResultInfo - Optional result info.
    ResultInfo *string            `json:"resultInfo,omitempty"`
    Error      *ErrorBodyContract `json:"error,omitempty"`
}

OperationResultContract operation Result.

type OperationStatus Uses

type OperationStatus string

OperationStatus enumerates the values for operation status.

const (
    // OperationStatusFailed ...
    OperationStatusFailed OperationStatus = "Failed"
    // OperationStatusInProgress ...
    OperationStatusInProgress OperationStatus = "InProgress"
    // OperationStatusSucceeded ...
    OperationStatusSucceeded OperationStatus = "Succeeded"
)

func PossibleOperationStatusValues Uses

func PossibleOperationStatusValues() []OperationStatus

PossibleOperationStatusValues returns an array of possible values for the OperationStatus const type.

type ParameterContract Uses

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

ParameterContract operation parameters details.

type PatchParameters Uses

type PatchParameters struct {
    // RawJSON - json value.
    RawJSON interface{} `json:"RawJson,omitempty"`
}

PatchParameters parameters supplied to the Patch operations.

type PolicyScopeContract Uses

type PolicyScopeContract string

PolicyScopeContract enumerates the values for policy scope contract.

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

func PossiblePolicyScopeContractValues Uses

func PossiblePolicyScopeContractValues() []PolicyScopeContract

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

type PolicySnippetContract Uses

type PolicySnippetContract struct {
    // Name - READ-ONLY; Snippet name.
    Name *string `json:"name,omitempty"`
    // Content - READ-ONLY; Snippet content.
    Content *string `json:"content,omitempty"`
    // ToolTip - READ-ONLY; Snippet toolTip.
    ToolTip *string `json:"toolTip,omitempty"`
    // Scope - READ-ONLY; Snippet scope. Possible values include: 'Tenant', 'Product', 'API', 'Operation', 'All'
    Scope PolicyScopeContract `json:"scope,omitempty"`
}

PolicySnippetContract policy snippet.

type PolicySnippetsClient Uses

type PolicySnippetsClient struct {
    BaseClient
}

PolicySnippetsClient is the apiManagement Client

func NewPolicySnippetsClient Uses

func NewPolicySnippetsClient(subscriptionID string) PolicySnippetsClient

NewPolicySnippetsClient creates an instance of the PolicySnippetsClient client.

func NewPolicySnippetsClientWithBaseURI Uses

func NewPolicySnippetsClientWithBaseURI(baseURI string, subscriptionID string) PolicySnippetsClient

NewPolicySnippetsClientWithBaseURI creates an instance of the PolicySnippetsClient client.

func (PolicySnippetsClient) ListByService Uses

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

ListByService lists all policy snippets. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. scope - policy scope.

func (PolicySnippetsClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (PolicySnippetsClient) ListByServiceResponder Uses

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 Uses

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 Uses

type ProductApisClient struct {
    BaseClient
}

ProductApisClient is the apiManagement Client

func NewProductApisClient Uses

func NewProductApisClient(subscriptionID string) ProductApisClient

NewProductApisClient creates an instance of the ProductApisClient client.

func NewProductApisClientWithBaseURI Uses

func NewProductApisClientWithBaseURI(baseURI string, subscriptionID string) ProductApisClient

NewProductApisClientWithBaseURI creates an instance of the ProductApisClient client.

func (ProductApisClient) Add Uses

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

Add adds an API to the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. apiid - API identifier. Must be unique in the current API Management service instance.

func (ProductApisClient) AddPreparer Uses

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

AddPreparer prepares the Add request.

func (ProductApisClient) AddResponder Uses

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 Uses

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 Uses

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

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

func (ProductApisClient) ListByProductComplete Uses

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

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

func (ProductApisClient) ListByProductPreparer Uses

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

ListByProductPreparer prepares the ListByProduct request.

func (ProductApisClient) ListByProductResponder Uses

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 Uses

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 Uses

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

Remove deletes the specified API from the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. apiid - API identifier. Must be unique in the current API Management service instance.

func (ProductApisClient) RemovePreparer Uses

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

RemovePreparer prepares the Remove request.

func (ProductApisClient) RemoveResponder Uses

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 Uses

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 Uses

type ProductCollection struct {
    autorest.Response `json:"-"`
    // Value - Page values.
    Value *[]ProductContract `json:"value,omitempty"`
    // Count - Total records count number.
    Count *int64 `json:"count,omitempty"`
    // NextLink - Next page link if any.
    NextLink *string `json:"nextLink,omitempty"`
}

ProductCollection paged Products list representation.

func (ProductCollection) IsEmpty Uses

func (pc ProductCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ProductCollectionIterator Uses

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

ProductCollectionIterator provides access to a complete listing of ProductContract values.

func NewProductCollectionIterator Uses

func NewProductCollectionIterator(page ProductCollectionPage) ProductCollectionIterator

Creates a new instance of the ProductCollectionIterator type.

func (*ProductCollectionIterator) Next Uses

func (iter *ProductCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ProductCollectionIterator) NextWithContext Uses

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

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

func (ProductCollectionIterator) NotDone Uses

func (iter ProductCollectionIterator) NotDone() bool

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

func (ProductCollectionIterator) Response Uses

func (iter ProductCollectionIterator) Response() ProductCollection

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

func (ProductCollectionIterator) Value Uses

func (iter ProductCollectionIterator) Value() ProductContract

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

type ProductCollectionPage Uses

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

ProductCollectionPage contains a page of ProductContract values.

func NewProductCollectionPage Uses

func NewProductCollectionPage(getNextPage func(context.Context, ProductCollection) (ProductCollection, error)) ProductCollectionPage

Creates a new instance of the ProductCollectionPage type.

func (*ProductCollectionPage) Next Uses

func (page *ProductCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ProductCollectionPage) NextWithContext Uses

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

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

func (ProductCollectionPage) NotDone Uses

func (page ProductCollectionPage) NotDone() bool

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

func (ProductCollectionPage) Response Uses

func (page ProductCollectionPage) Response() ProductCollection

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

func (ProductCollectionPage) Values Uses

func (page ProductCollectionPage) Values() []ProductContract

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

type ProductContract Uses

type ProductContract struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Uniquely identifies the product within the current API Management service instance. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier.
    ID  *string `json:"id,omitempty"`
    // Name - Product name.
    Name *string `json:"name,omitempty"`
    // Description - Product description. May include HTML formatting tags.
    Description *string `json:"description,omitempty"`
    // Terms - Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
    Terms *string `json:"terms,omitempty"`
    // SubscriptionRequired - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
    SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
    // ApprovalRequired - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
    ApprovalRequired *bool `json:"approvalRequired,omitempty"`
    // SubscriptionsLimit - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
    SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`
    // State - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. Possible values include: 'NotPublished', 'Published'
    State ProductStateContract `json:"state,omitempty"`
}

ProductContract product profile.

type ProductGroupsClient Uses

type ProductGroupsClient struct {
    BaseClient
}

ProductGroupsClient is the apiManagement Client

func NewProductGroupsClient Uses

func NewProductGroupsClient(subscriptionID string) ProductGroupsClient

NewProductGroupsClient creates an instance of the ProductGroupsClient client.

func NewProductGroupsClientWithBaseURI Uses

func NewProductGroupsClientWithBaseURI(baseURI string, subscriptionID string) ProductGroupsClient

NewProductGroupsClientWithBaseURI creates an instance of the ProductGroupsClient client.

func (ProductGroupsClient) Add Uses

func (client ProductGroupsClient) Add(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. groupID - group identifier. Must be unique in the current API Management service instance.

func (ProductGroupsClient) AddPreparer Uses

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

AddPreparer prepares the Add request.

func (ProductGroupsClient) AddResponder Uses

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 Uses

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 Uses

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

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

func (ProductGroupsClient) ListByProductComplete Uses

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

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

func (ProductGroupsClient) ListByProductPreparer Uses

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

ListByProductPreparer prepares the ListByProduct request.

func (ProductGroupsClient) ListByProductResponder Uses

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 Uses

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 Uses

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

Remove deletes the association between the specified group and product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. groupID - group identifier. Must be unique in the current API Management service instance.

func (ProductGroupsClient) RemovePreparer Uses

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

RemovePreparer prepares the Remove request.

func (ProductGroupsClient) RemoveResponder Uses

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 Uses

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 Uses

type ProductStateContract string

ProductStateContract enumerates the values for product state contract.

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

func PossibleProductStateContractValues Uses

func PossibleProductStateContractValues() []ProductStateContract

PossibleProductStateContractValues returns an array of possible values for the ProductStateContract const type.

type ProductSubscriptionsClient Uses

type ProductSubscriptionsClient struct {
    BaseClient
}

ProductSubscriptionsClient is the apiManagement Client

func NewProductSubscriptionsClient Uses

func NewProductSubscriptionsClient(subscriptionID string) ProductSubscriptionsClient

NewProductSubscriptionsClient creates an instance of the ProductSubscriptionsClient client.

func NewProductSubscriptionsClientWithBaseURI Uses

func NewProductSubscriptionsClientWithBaseURI(baseURI string, subscriptionID string) ProductSubscriptionsClient

NewProductSubscriptionsClientWithBaseURI creates an instance of the ProductSubscriptionsClient client.

func (ProductSubscriptionsClient) ListByProduct Uses

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

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

func (ProductSubscriptionsClient) ListByProductComplete Uses

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

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

func (ProductSubscriptionsClient) ListByProductPreparer Uses

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

ListByProductPreparer prepares the ListByProduct request.

func (ProductSubscriptionsClient) ListByProductResponder Uses

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 Uses

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 Uses

type ProductUpdateParameters struct {
    // Name - Product name.
    Name *string `json:"name,omitempty"`
    // Description - Product description.
    Description *string `json:"description,omitempty"`
    // Terms - Product terms and conditions. Developer will have to accept these terms before he's allowed to call product API.
    Terms *string `json:"terms,omitempty"`
    // SubscriptionRequired - whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
    SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
    // ApprovalRequired - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
    ApprovalRequired *bool `json:"approvalRequired,omitempty"`
    // SubscriptionsLimit - whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
    SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`
    // State - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Possible values include: 'NotPublished', 'Published'
    State ProductStateContract `json:"state,omitempty"`
}

ProductUpdateParameters parameters supplied to the CreateOrUpdate Product operation.

type ProductsClient Uses

type ProductsClient struct {
    BaseClient
}

ProductsClient is the apiManagement Client

func NewProductsClient Uses

func NewProductsClient(subscriptionID string) ProductsClient

NewProductsClient creates an instance of the ProductsClient client.

func NewProductsClientWithBaseURI Uses

func NewProductsClientWithBaseURI(baseURI string, subscriptionID string) ProductsClient

NewProductsClientWithBaseURI creates an instance of the ProductsClient client.

func (ProductsClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or Updates a product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. parameters - create or update parameters.

func (ProductsClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProductsClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete delete product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the 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 - delete existing subscriptions to the product or not.

func (ProductsClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (ProductsClient) DeleteResponder Uses

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 Uses

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 Uses

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

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

func (ProductsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (ProductsClient) GetResponder Uses

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 Uses

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 Uses

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

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

func (ProductsClient) ListByServiceComplete Uses

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

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

func (ProductsClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (ProductsClient) ListByServiceResponder Uses

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 Uses

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 Uses

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

Update update product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the 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 Uses

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

UpdatePreparer prepares the Update request.

func (ProductsClient) UpdateResponder Uses

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 Uses

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 Uses

type PropertyClient struct {
    BaseClient
}

PropertyClient is the apiManagement Client

func NewPropertyClient Uses

func NewPropertyClient(subscriptionID string) PropertyClient

NewPropertyClient creates an instance of the PropertyClient client.

func NewPropertyClientWithBaseURI Uses

func NewPropertyClientWithBaseURI(baseURI string, subscriptionID string) PropertyClient

NewPropertyClientWithBaseURI creates an instance of the PropertyClient client.

func (PropertyClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or updates a property. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property. parameters - create parameters.

func (PropertyClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PropertyClient) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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

Delete deletes specific property from the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property. ifMatch - 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 Uses

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

DeletePreparer prepares the Delete request.

func (PropertyClient) DeleteResponder Uses

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 Uses

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 Uses

func (client PropertyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, propID string) (result PropertyContract, err error)

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

func (PropertyClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (PropertyClient) GetResponder Uses

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 Uses

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 Uses

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

ListByService lists a collection of properties defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------|------------------------|-------------------------------------------------------| | tags | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.

func (PropertyClient) ListByServiceComplete Uses

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

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

func (PropertyClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (PropertyClient) ListByServiceResponder Uses

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 Uses

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 Uses

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

Update updates the specific property. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property. parameters - update parameters. ifMatch - 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 Uses

func (client PropertyClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, propID string, parameters PropertyUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (PropertyClient) UpdateResponder Uses

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 Uses

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 Uses

type PropertyCollection struct {
    autorest.Response `json:"-"`
    // Value - Page values.
    Value *[]PropertyContract `json:"value,omitempty"`
    // Count - Total records count number.
    Count *int64 `json:"count,omitempty"`
    // NextLink - Next page link if any.
    NextLink *string `json:"nextLink,omitempty"`
}

PropertyCollection paged Property list representation.

func (PropertyCollection) IsEmpty Uses

func (pc PropertyCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PropertyCollectionIterator Uses

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

PropertyCollectionIterator provides access to a complete listing of PropertyContract values.

func NewPropertyCollectionIterator Uses

func NewPropertyCollectionIterator(page PropertyCollectionPage) PropertyCollectionIterator

Creates a new instance of the PropertyCollectionIterator type.

func (*PropertyCollectionIterator) Next Uses

func (iter *PropertyCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PropertyCollectionIterator) NextWithContext Uses

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

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

func (PropertyCollectionIterator) NotDone Uses

func (iter PropertyCollectionIterator) NotDone() bool

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

func (PropertyCollectionIterator) Response Uses

func (iter PropertyCollectionIterator) Response() PropertyCollection

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

func (PropertyCollectionIterator) Value Uses

func (iter PropertyCollectionIterator) Value() PropertyContract

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

type PropertyCollectionPage Uses

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

PropertyCollectionPage contains a page of PropertyContract values.

func NewPropertyCollectionPage Uses

func NewPropertyCollectionPage(getNextPage func(context.Context, PropertyCollection) (PropertyCollection, error)) PropertyCollectionPage

Creates a new instance of the PropertyCollectionPage type.

func (*PropertyCollectionPage) Next Uses

func (page *PropertyCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PropertyCollectionPage) NextWithContext Uses

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

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

func (PropertyCollectionPage) NotDone Uses

func (page PropertyCollectionPage) NotDone() bool

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

func (PropertyCollectionPage) Response Uses

func (page PropertyCollectionPage) Response() PropertyCollection

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

func (PropertyCollectionPage) Values Uses

func (page PropertyCollectionPage) Values() []PropertyContract

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

type PropertyContract Uses

type PropertyContract struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Uniquely identifies the property within the current API Management service instance. The value is a valid relative URL in the format of /properties/{propId} where {propId} is a property identifier.
    ID  *string `json:"id,omitempty"`
    // Name - Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
    Name *string `json:"name,omitempty"`
    // Value - Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
    Value *string `json:"value,omitempty"`
    // Tags - Optional tags that when provided can be used to filter the property list.
    Tags *[]string `json:"tags,omitempty"`
    // Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
    Secret *bool `json:"secret,omitempty"`
}

PropertyContract property details.

type PropertyCreateParameters Uses

type PropertyCreateParameters struct {
    // Name - Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
    Name *string `json:"name,omitempty"`
    // Value - Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
    Value *string `json:"value,omitempty"`
    // Tags - Optional tags that when provided can be used to filter the property list.
    Tags *[]string `json:"tags,omitempty"`
    // Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
    Secret *bool `json:"secret,omitempty"`
}

PropertyCreateParameters parameters supplied to the Create Property operation.

type PropertyUpdateParameters Uses

type PropertyUpdateParameters struct {
    // Name - Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
    Name *string `json:"name,omitempty"`
    // Value - Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
    Value *string `json:"value,omitempty"`
    // Tags - Optional tags that when provided can be used to filter the property list.
    Tags *[]string `json:"tags,omitempty"`
    // Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
    Secret *bool `json:"secret,omitempty"`
}

PropertyUpdateParameters parameters supplied to the Update Property operation.

type QuotaByCounterKeysClient Uses

type QuotaByCounterKeysClient struct {
    BaseClient
}

QuotaByCounterKeysClient is the apiManagement Client

func NewQuotaByCounterKeysClient Uses

func NewQuotaByCounterKeysClient(subscriptionID string) QuotaByCounterKeysClient

NewQuotaByCounterKeysClient creates an instance of the QuotaByCounterKeysClient client.

func NewQuotaByCounterKeysClientWithBaseURI Uses

func NewQuotaByCounterKeysClientWithBaseURI(baseURI string, subscriptionID string) QuotaByCounterKeysClient

NewQuotaByCounterKeysClientWithBaseURI creates an instance of the QuotaByCounterKeysClient client.

func (QuotaByCounterKeysClient) ListByService Uses

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

ListByService lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier.

func (QuotaByCounterKeysClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (QuotaByCounterKeysClient) ListByServiceResponder Uses

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 Uses

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 Uses

func (client QuotaByCounterKeysClient) Update(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, parameters QuotaCounterValueContract) (result autorest.Response, err error)

Update updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier. parameters - the value of the quota counter to be applied to all quota counter periods.

func (QuotaByCounterKeysClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (QuotaByCounterKeysClient) UpdateResponder Uses

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 Uses

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 Uses

type QuotaByPeriodKeysClient struct {
    BaseClient
}

QuotaByPeriodKeysClient is the apiManagement Client

func NewQuotaByPeriodKeysClient Uses

func NewQuotaByPeriodKeysClient(subscriptionID string) QuotaByPeriodKeysClient

NewQuotaByPeriodKeysClient creates an instance of the QuotaByPeriodKeysClient client.

func NewQuotaByPeriodKeysClientWithBaseURI Uses

func NewQuotaByPeriodKeysClientWithBaseURI(baseURI string, subscriptionID string) QuotaByPeriodKeysClient

NewQuotaByPeriodKeysClientWithBaseURI creates an instance of the QuotaByPeriodKeysClient client.

func (QuotaByPeriodKeysClient) Get Uses

func (client QuotaByPeriodKeysClient) Get(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string) (result QuotaCounterContract, err error)

Get gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier. quotaPeriodKey - quota period key identifier.

func (QuotaByPeriodKeysClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (QuotaByPeriodKeysClient) GetResponder Uses

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 Uses

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 Uses

func (client QuotaByPeriodKeysClient) Update(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string, parameters QuotaCounterValueContract) (result autorest.Response, err error)

Update updates an existing quota counter value in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier. quotaPeriodKey - quota period key identifier. parameters - the value of the Quota counter to be applied on the specified period.

func (QuotaByPeriodKeysClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (QuotaByPeriodKeysClient) UpdateResponder Uses

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 Uses

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 Uses

type QuotaCounterCollection struct {
    autorest.Response `json:"-"`
    // Value - Quota counter values.
    Value *[]QuotaCounterContract `json:"value,omitempty"`
    // Count - Total records count number.
    Count *int64 `json:"count,omitempty"`
    // NextLink - Next page link if any.
    NextLink *string `json:"nextLink,omitempty"`
}

QuotaCounterCollection paged Quota Counter list representation.

type QuotaCounterContract Uses

type QuotaCounterContract struct {
    autorest.Response `json:"-"`
    // CounterKey - The Key value of the Counter. Must not be empty.
    CounterKey *string `json:"counterKey,omitempty"`
    // PeriodKey - Identifier of the Period for which the counter was collected. Must not be empty.
    PeriodKey *string `json:"periodKey,omitempty"`
    // PeriodStartTime - The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
    PeriodStartTime *date.Time `json:"periodStartTime,omitempty"`
    // PeriodEndTime - The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
    PeriodEndTime *date.Time `json:"periodEndTime,omitempty"`
    // CallsCount - Number of times Counter was called.
    CallsCount *int32 `json:"callsCount,omitempty"`
    // KbTransferred - Data Transferred in KiloBytes.
    KbTransferred *float64 `json:"kbTransferred,omitempty"`
}

QuotaCounterContract quota counter details.

type QuotaCounterValueContract Uses

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

QuotaCounterValueContract quota counter value details.

type RegionContract Uses

type RegionContract struct {
    // Name - Region name.
    Name *string `json:"name,omitempty"`
    // IsMasterRegion - whether Region is the master region.
    IsMasterRegion *bool `json:"isMasterRegion,omitempty"`
}

RegionContract region profile.

type RegionListResult Uses

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

RegionListResult lists Regions operation response details.

type RegionsClient Uses

type RegionsClient struct {
    BaseClient
}

RegionsClient is the apiManagement Client

func NewRegionsClient Uses

func NewRegionsClient(subscriptionID string) RegionsClient

NewRegionsClient creates an instance of the RegionsClient client.

func NewRegionsClientWithBaseURI Uses

func NewRegionsClientWithBaseURI(baseURI string, subscriptionID string) RegionsClient

NewRegionsClientWithBaseURI creates an instance of the RegionsClient client.

func (RegionsClient) ListByService Uses

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

ListByService lists all azure regions in which the service exists. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.

func (RegionsClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (RegionsClient) ListByServiceResponder Uses

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 Uses

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 Uses

type ReportCollection struct {
    autorest.Response `json:"-"`
    // Value - Page values.
    Value *[]ReportRecordContract `json:"value,omitempty"`
    // Count - Total records count number.
    Count *int64 `json:"count,omitempty"`
    // NextLink - Next page link if any.
    NextLink *string `json:"nextLink,omitempty"`
}

ReportCollection paged Report records list representation.

func (ReportCollection) IsEmpty Uses

func (rc ReportCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ReportCollectionIterator Uses

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

ReportCollectionIterator provides access to a complete listing of ReportRecordContract values.

func NewReportCollectionIterator Uses

func NewReportCollectionIterator(page ReportCollectionPage) ReportCollectionIterator

Creates a new instance of the ReportCollectionIterator type.

func (*ReportCollectionIterator) Next Uses

func (iter *ReportCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ReportCollectionIterator) NextWithContext Uses

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

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

func (ReportCollectionIterator) NotDone Uses

func (iter ReportCollectionIterator) NotDone() bool

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

func (ReportCollectionIterator) Response Uses

func (iter ReportCollectionIterator) Response() ReportCollection

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

func (ReportCollectionIterator) Value