azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/apimanagement/ctrl/2017-03-01/apimanagement Index | Files | Directories

package apimanagement

import "github.com/Azure/azure-sdk-for-go/services/preview/apimanagement/ctrl/2017-03-01/apimanagement"

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

Index

Package Files

api.go apiexport.go apioperation.go apioperationpolicy.go apipolicy.go apiproduct.go apischema.go authorizationserver.go backend.go certificate.go client.go delegationsettings.go emailtemplate.go group.go groupuser.go identityprovider.go logger.go models.go openidconnectprovider.go policy.go policysnippets.go product.go productapi.go productgroup.go productpolicy.go productsubscriptions.go property.go quotabycounterkeys.go quotabyperiodkeys.go regions.go reports.go signinsettings.go signupsettings.go subscription.go tenantaccess.go tenantaccessgit.go tenantconfiguration.go user.go usergroup.go useridentities.go usersubscription.go version.go

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 APIClient Uses

type APIClient struct {
    BaseClient
}

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

func NewAPIClient Uses

func NewAPIClient() APIClient

NewAPIClient creates an instance of the APIClient client.

func (APIClient) CreateOrUpdate Uses

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

CreateOrUpdate creates new or updates existing specified API of the API Management service instance. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (APIClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIClient) CreateOrUpdateResponder Uses

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

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

func (APIClient) CreateOrUpdateSender Uses

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

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

func (APIClient) Delete Uses

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

Delete deletes the specified API of the API Management service instance. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (APIClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIClient) DeleteResponder Uses

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

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

func (APIClient) DeleteSender Uses

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

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

func (APIClient) Get Uses

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

Get gets the details of the API specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid - API identifier. Must be unique in the current API Management service instance.

func (APIClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIClient) GetResponder Uses

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

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

func (APIClient) GetSender Uses

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

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

func (APIClient) List Uses

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

List lists all APIs of the API Management service instance. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (APIClient) ListComplete Uses

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

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

func (APIClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (APIClient) ListResponder Uses

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

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

func (APIClient) ListSender Uses

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

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

func (APIClient) Update Uses

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

Update updates the specified API of the API Management service instance. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid - API identifier. Must be unique in the current API Management service instance. parameters - API Update Contract 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 (APIClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (APIClient) UpdateResponder Uses

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

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

func (APIClient) UpdateSender Uses

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

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

type APICollection Uses

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

APICollection paged Api list representation.

func (APICollection) IsEmpty 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 - Identifier of the Entity
    ID  *string `json:"id,omitempty"`
    // Name - API name.
    Name *string `json:"name,omitempty"`
    // ServiceURL - Absolute URL of the backend service implementing this API.
    ServiceURL *string `json:"serviceUrl,omitempty"`
    // Path - Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
    Path *string `json:"path,omitempty"`
    // Protocols - Describes on which protocols the operations in this API can be invoked.
    Protocols *[]Protocol `json:"protocols,omitempty"`
    // Description - Description of the API. May include HTML formatting tags.
    Description *string `json:"description,omitempty"`
    // AuthenticationSettings - Collection of authentication settings included into this API.
    AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
    // SubscriptionKeyParameterNames - Protocols over which API is made available.
    SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
    // APIType - Type of API. Possible values include: 'HTTP', 'Soap'
    APIType APIType `json:"type,omitempty"`
    // APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
    APIRevision *string `json:"apiRevision,omitempty"`
    // IsCurrent - Indicates if API revision is current api revision.
    IsCurrent *bool `json:"isCurrent,omitempty"`
    // IsOnline - Indicates if API revision is accessible via the gateway.
    IsOnline *bool `json:"isOnline,omitempty"`
}

APIContract api Contract Details

type APIContractProperties Uses

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

APIContractProperties api Entity Properties

type APICreateOrUpdateParameter Uses

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

APICreateOrUpdateParameter api Create or Update Properties.

type APICreateOrUpdateParameterWsdlSelector Uses

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

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

type APIEntityBaseContract Uses

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

APIEntityBaseContract API base contract details.

type APIExportClient Uses

type APIExportClient struct {
    BaseClient
}

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

func NewAPIExportClient Uses

func NewAPIExportClient() APIExportClient

NewAPIExportClient creates an instance of the APIExportClient client.

func (APIExportClient) Get Uses

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

Get gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid - API identifier. Must be unique in the current API Management service instance.

func (APIExportClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIExportClient) GetResponder Uses

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

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

func (APIExportClient) GetSender Uses

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

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

type APIExportResult Uses

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

APIExportResult API Export result Blob Uri.

type APIOperationClient Uses

type APIOperationClient struct {
    BaseClient
}

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

func NewAPIOperationClient Uses

func NewAPIOperationClient() APIOperationClient

NewAPIOperationClient creates an instance of the APIOperationClient client.

func (APIOperationClient) CreateOrUpdate Uses

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

CreateOrUpdate creates a new operation in the API or updates an existing one. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (APIOperationClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationClient) CreateOrUpdateResponder Uses

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

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

func (APIOperationClient) CreateOrUpdateSender Uses

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

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

func (APIOperationClient) Delete Uses

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

Delete deletes the specified operation in the API. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (APIOperationClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIOperationClient) DeleteResponder Uses

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

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

func (APIOperationClient) DeleteSender Uses

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

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

func (APIOperationClient) Get Uses

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

Get gets the details of the API Operation specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (APIOperationClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIOperationClient) GetResponder Uses

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

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

func (APIOperationClient) GetSender Uses

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

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

func (APIOperationClient) ListByAPI Uses

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

ListByAPI lists a collection of the operations for the specified API. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (APIOperationClient) ListByAPIComplete Uses

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

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

func (APIOperationClient) ListByAPIPreparer Uses

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

ListByAPIPreparer prepares the ListByAPI request.

func (APIOperationClient) ListByAPIResponder Uses

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

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

func (APIOperationClient) ListByAPISender Uses

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

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

func (APIOperationClient) Update Uses

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

Update updates the details of the operation in the API specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 - API Operation 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 (APIOperationClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (APIOperationClient) UpdateResponder Uses

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

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

func (APIOperationClient) UpdateSender Uses

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

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

type APIOperationPolicyClient Uses

type APIOperationPolicyClient struct {
    BaseClient
}

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

func NewAPIOperationPolicyClient Uses

func NewAPIOperationPolicyClient() APIOperationPolicyClient

NewAPIOperationPolicyClient creates an instance of the APIOperationPolicyClient client.

func (APIOperationPolicyClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or updates policy configuration for the API Operation level. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 - the policy contents to apply. ifMatch - the entity state (Etag) version of the Api Operation policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (APIOperationPolicyClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationPolicyClient) CreateOrUpdateResponder Uses

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

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

func (APIOperationPolicyClient) CreateOrUpdateSender Uses

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

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

func (APIOperationPolicyClient) Delete Uses

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

Delete deletes the policy configuration at the Api Operation. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 - the entity state (Etag) version of the Api Operation Policy to delete. A value of "*" can be used for If-Match to unconditionally apply the operation.

func (APIOperationPolicyClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIOperationPolicyClient) DeleteResponder Uses

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

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

func (APIOperationPolicyClient) DeleteSender Uses

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

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

func (APIOperationPolicyClient) Get Uses

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

Get get the policy configuration at the API Operation level. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (APIOperationPolicyClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIOperationPolicyClient) GetResponder Uses

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

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

func (APIOperationPolicyClient) GetSender Uses

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

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

func (APIOperationPolicyClient) ListByOperation Uses

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

ListByOperation get the list of policy configuration at the API Operation level. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (APIOperationPolicyClient) ListByOperationPreparer Uses

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

ListByOperationPreparer prepares the ListByOperation request.

func (APIOperationPolicyClient) ListByOperationResponder Uses

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

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

func (APIOperationPolicyClient) ListByOperationSender Uses

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

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

type APIPolicyClient Uses

type APIPolicyClient struct {
    BaseClient
}

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

func NewAPIPolicyClient Uses

func NewAPIPolicyClient() APIPolicyClient

NewAPIPolicyClient creates an instance of the APIPolicyClient client.

func (APIPolicyClient) CreateOrUpdate Uses

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

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

func (APIPolicyClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIPolicyClient) CreateOrUpdateResponder Uses

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

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

func (APIPolicyClient) CreateOrUpdateSender Uses

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

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

func (APIPolicyClient) Delete Uses

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

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

func (APIPolicyClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIPolicyClient) DeleteResponder Uses

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

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

func (APIPolicyClient) DeleteSender Uses

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

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

func (APIPolicyClient) Get Uses

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

Get get the policy configuration at the API level. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid - API identifier. Must be unique in the current API Management service instance.

func (APIPolicyClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIPolicyClient) GetResponder Uses

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

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

func (APIPolicyClient) GetSender Uses

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

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

func (APIPolicyClient) ListByAPI Uses

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

ListByAPI get the policy configuration at the API level. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid - API identifier. Must be unique in the current API Management service instance.

func (APIPolicyClient) ListByAPIPreparer Uses

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

ListByAPIPreparer prepares the ListByAPI request.

func (APIPolicyClient) ListByAPIResponder Uses

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

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

func (APIPolicyClient) ListByAPISender Uses

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

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

type APIProductClient Uses

type APIProductClient struct {
    BaseClient
}

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

func NewAPIProductClient Uses

func NewAPIProductClient() APIProductClient

NewAPIProductClient creates an instance of the APIProductClient client.

func (APIProductClient) ListByApis Uses

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

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

func (APIProductClient) ListByApisComplete Uses

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

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

func (APIProductClient) ListByApisPreparer Uses

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

ListByApisPreparer prepares the ListByApis request.

func (APIProductClient) ListByApisResponder Uses

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

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

func (APIProductClient) ListByApisSender Uses

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

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

type APISchemaClient Uses

type APISchemaClient struct {
    BaseClient
}

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

func NewAPISchemaClient Uses

func NewAPISchemaClient() APISchemaClient

NewAPISchemaClient creates an instance of the APISchemaClient client.

func (APISchemaClient) CreateOrUpdate Uses

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

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

func (APISchemaClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APISchemaClient) CreateOrUpdateResponder Uses

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

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

func (APISchemaClient) CreateOrUpdateSender Uses

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

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

func (APISchemaClient) Delete Uses

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

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

func (APISchemaClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APISchemaClient) DeleteResponder Uses

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

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

func (APISchemaClient) DeleteSender Uses

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

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

func (APISchemaClient) Get Uses

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

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

func (APISchemaClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APISchemaClient) GetResponder Uses

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

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

func (APISchemaClient) GetSender Uses

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

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

func (APISchemaClient) ListByAPI Uses

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

ListByAPI get the schema configuration at the API level. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. apiid - API identifier. Must be unique in the current API Management service instance.

func (APISchemaClient) ListByAPIComplete Uses

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

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

func (APISchemaClient) ListByAPIPreparer Uses

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

ListByAPIPreparer prepares the ListByAPI request.

func (APISchemaClient) ListByAPIResponder Uses

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

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

func (APISchemaClient) ListByAPISender Uses

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

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

type APIType Uses

type APIType string

APIType enumerates the values for api type.

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

func PossibleAPITypeValues Uses

func PossibleAPITypeValues() []APIType

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

type APIUpdateContract Uses

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

APIUpdateContract API update contract properties.

type AccessInformationContract 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 AsyncOperationStatus Uses

type AsyncOperationStatus string

AsyncOperationStatus enumerates the values for async operation status.

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

func PossibleAsyncOperationStatusValues Uses

func PossibleAsyncOperationStatusValues() []AsyncOperationStatus

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

type AuthenticationSettingsContract Uses

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

AuthenticationSettingsContract API Authentication Settings.

type AuthorizationMethod Uses

type AuthorizationMethod string

AuthorizationMethod enumerates the values for authorization method.

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

func PossibleAuthorizationMethodValues Uses

func PossibleAuthorizationMethodValues() []AuthorizationMethod

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

type AuthorizationServerClient Uses

type AuthorizationServerClient struct {
    BaseClient
}

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

func NewAuthorizationServerClient Uses

func NewAuthorizationServerClient() AuthorizationServerClient

NewAuthorizationServerClient creates an instance of the AuthorizationServerClient client.

func (AuthorizationServerClient) CreateOrUpdate Uses

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

CreateOrUpdate creates new authorization server or updates an existing authorization server. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. authsid - identifier of the authorization server. parameters - create or update parameters.

func (AuthorizationServerClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AuthorizationServerClient) CreateOrUpdateResponder Uses

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

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

func (AuthorizationServerClient) CreateOrUpdateSender Uses

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

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

func (AuthorizationServerClient) Delete Uses

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

Delete deletes specific authorization server instance. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (AuthorizationServerClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (AuthorizationServerClient) DeleteResponder Uses

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

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

func (AuthorizationServerClient) DeleteSender Uses

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

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

func (AuthorizationServerClient) Get Uses

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

Get gets the details of the authorization server specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. authsid - identifier of the authorization server.

func (AuthorizationServerClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (AuthorizationServerClient) GetResponder Uses

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

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

func (AuthorizationServerClient) GetSender Uses

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

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

func (AuthorizationServerClient) List Uses

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

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

func (AuthorizationServerClient) ListComplete Uses

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

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

func (AuthorizationServerClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (AuthorizationServerClient) ListResponder Uses

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

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

func (AuthorizationServerClient) ListSender Uses

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

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

func (AuthorizationServerClient) Update Uses

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

Update updates the details of the authorization server specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (AuthorizationServerClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (AuthorizationServerClient) UpdateResponder Uses

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

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

func (AuthorizationServerClient) UpdateSender Uses

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

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

type AuthorizationServerCollection Uses

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

AuthorizationServerCollection paged OAuth2 Authorization Servers list representation.

func (AuthorizationServerCollection) IsEmpty 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 AuthorizationServerContract 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() AuthorizationServerContract

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

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

type AuthorizationServerContract Uses

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

AuthorizationServerContract external OAuth authorization server settings.

type AuthorizationServerContractBaseProperties Uses

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

AuthorizationServerContractBaseProperties external OAuth authorization server Update settings contract.

type AuthorizationServerContractProperties Uses

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

AuthorizationServerContractProperties external OAuth authorization server settings Properties.

type AuthorizationServerUpdateContract Uses

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

AuthorizationServerUpdateContract external OAuth authorization server Update settings contract.

type BackendAuthorizationHeaderCredentials Uses

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

BackendAuthorizationHeaderCredentials authorization header information.

type BackendBaseParameters Uses

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

BackendBaseParameters backend entity base Parameter set.

type BackendClient Uses

type BackendClient struct {
    BaseClient
}

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

func NewBackendClient Uses

func NewBackendClient() BackendClient

NewBackendClient creates an instance of the BackendClient client.

func (BackendClient) CreateOrUpdate Uses

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

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

func (BackendClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (BackendClient) CreateOrUpdateResponder Uses

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

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

func (BackendClient) CreateOrUpdateSender Uses

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

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

func (BackendClient) Delete Uses

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

Delete deletes the specified backend. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. backendid - identifier of the Backend entity. 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 (BackendClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (BackendClient) DeleteResponder Uses

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

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

func (BackendClient) DeleteSender Uses

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

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

func (BackendClient) Get Uses

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

Get gets the details of the backend specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance.

func (BackendClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (BackendClient) GetResponder Uses

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

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

func (BackendClient) GetSender Uses

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

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

func (BackendClient) List Uses

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

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

func (BackendClient) ListComplete Uses

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

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

func (BackendClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (BackendClient) ListResponder Uses

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

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

func (BackendClient) ListSender Uses

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

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

func (BackendClient) Update Uses

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

Update updates an existing backend. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. backendid - identifier of the Backend entity. 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 (BackendClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (BackendClient) UpdateResponder Uses

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

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

func (BackendClient) UpdateSender Uses

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

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

type BackendCollection Uses

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

BackendCollection paged Backend list representation.

func (BackendCollection) IsEmpty 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 BackendContract 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() BackendContract

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

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

type BackendContract Uses

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

BackendContract backend details.

type BackendContractProperties Uses

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

BackendContractProperties parameters supplied to the Create Backend operation.

type BackendCredentialsContract Uses

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

BackendCredentialsContract details of the Credentials used to connect to Backend.

func (BackendCredentialsContract) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for BackendCredentialsContract.

type BackendProperties Uses

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

BackendProperties properties specific to the Backend Type.

type BackendProtocol Uses

type BackendProtocol string

BackendProtocol enumerates the values for backend protocol.

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

func PossibleBackendProtocolValues Uses

func PossibleBackendProtocolValues() []BackendProtocol

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

type BackendProxyContract Uses

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

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

type BackendServiceFabricClusterProperties Uses

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

BackendServiceFabricClusterProperties properties of the Service Fabric Type Backend.

type BackendTLSProperties Uses

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

BackendTLSProperties properties controlling TLS Certificate Validation.

type BackendUpdateParameters Uses

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

BackendUpdateParameters parameters supplied to the Update Backend operation.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
}

BaseClient is the base client for Apimanagement.

func New Uses

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults Uses

func NewWithoutDefaults() BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

type BearerTokenSendingMethod Uses

type BearerTokenSendingMethod string

BearerTokenSendingMethod enumerates the values for bearer token sending method.

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

func PossibleBearerTokenSendingMethodValues Uses

func PossibleBearerTokenSendingMethodValues() []BearerTokenSendingMethod

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

type CertificateClient Uses

type CertificateClient struct {
    BaseClient
}

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

func NewCertificateClient Uses

func NewCertificateClient() CertificateClient

NewCertificateClient creates an instance of the CertificateClient client.

func (CertificateClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or updates the certificate being used for authentication with the backend. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance. parameters - create or Update 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 (CertificateClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CertificateClient) CreateOrUpdateResponder Uses

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

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

func (CertificateClient) CreateOrUpdateSender Uses

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

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

func (CertificateClient) Delete Uses

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

Delete deletes specific certificate. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance. 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 (CertificateClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (CertificateClient) DeleteResponder Uses

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

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

func (CertificateClient) DeleteSender Uses

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

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

func (CertificateClient) Get Uses

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

Get gets the details of the certificate specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance.

func (CertificateClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (CertificateClient) GetResponder Uses

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

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

func (CertificateClient) GetSender Uses

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

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

func (CertificateClient) List Uses

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

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

func (CertificateClient) ListComplete Uses

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

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

func (CertificateClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (CertificateClient) ListResponder Uses

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

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

func (CertificateClient) ListSender Uses

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

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

type CertificateCollection Uses

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

CertificateCollection paged Certificates list representation.

func (CertificateCollection) IsEmpty 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 - Identifier of the Certificate entity.
    ID  *string `json:"id,omitempty"`
    // Subject - Subject attribute of the certificate.
    Subject *string `json:"subject,omitempty"`
    // Thumbprint - Thumbprint of the certificate.
    Thumbprint *string `json:"thumbprint,omitempty"`
    // ExpirationDate - Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
    ExpirationDate *date.Time `json:"expirationDate,omitempty"`
}

CertificateContract certificate details.

type CertificateContractProperties Uses

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

CertificateContractProperties properties of the Certificate contract.

type CertificateCreateOrUpdateParameters 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 ClientAuthenticationMethod Uses

type ClientAuthenticationMethod string

ClientAuthenticationMethod enumerates the values for client authentication method.

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

func PossibleClientAuthenticationMethodValues Uses

func PossibleClientAuthenticationMethodValues() []ClientAuthenticationMethod

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

type ContentFormat Uses

type ContentFormat string

ContentFormat enumerates the values for content format.

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

func PossibleContentFormatValues Uses

func PossibleContentFormatValues() []ContentFormat

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

type DelegationSettingsClient Uses

type DelegationSettingsClient struct {
    BaseClient
}

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

func NewDelegationSettingsClient Uses

func NewDelegationSettingsClient() DelegationSettingsClient

NewDelegationSettingsClient creates an instance of the DelegationSettingsClient client.

func (DelegationSettingsClient) CreateOrUpdate Uses

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

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

func (DelegationSettingsClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DelegationSettingsClient) CreateOrUpdateResponder Uses

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

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

func (DelegationSettingsClient) CreateOrUpdateSender Uses

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

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

func (DelegationSettingsClient) Get Uses

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

Get get Delegation settings. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (DelegationSettingsClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (DelegationSettingsClient) GetResponder Uses

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

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

func (DelegationSettingsClient) GetSender Uses

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

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

func (DelegationSettingsClient) Update Uses

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

Update update Delegation settings. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters - update Delegation settings. 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 (DelegationSettingsClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (DelegationSettingsClient) UpdateResponder Uses

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

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

func (DelegationSettingsClient) UpdateSender Uses

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

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

type DeployConfigurationParameters 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 EmailTemplateClient Uses

type EmailTemplateClient struct {
    BaseClient
}

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

func NewEmailTemplateClient Uses

func NewEmailTemplateClient() EmailTemplateClient

NewEmailTemplateClient creates an instance of the EmailTemplateClient client.

func (EmailTemplateClient) CreateOrUpdate Uses

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

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

func (EmailTemplateClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (EmailTemplateClient) CreateOrUpdateResponder Uses

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

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

func (EmailTemplateClient) CreateOrUpdateSender Uses

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

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

func (EmailTemplateClient) Delete Uses

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

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

func (EmailTemplateClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (EmailTemplateClient) DeleteResponder Uses

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

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

func (EmailTemplateClient) DeleteSender Uses

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

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

func (EmailTemplateClient) Get Uses

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

Get gets the details of the email template specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. templateName - email Template Name Identifier.

func (EmailTemplateClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (EmailTemplateClient) GetResponder Uses

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

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

func (EmailTemplateClient) GetSender Uses

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

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

func (EmailTemplateClient) List Uses

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

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

func (EmailTemplateClient) ListComplete Uses

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

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

func (EmailTemplateClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (EmailTemplateClient) ListResponder Uses

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

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

func (EmailTemplateClient) ListSender Uses

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

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

func (EmailTemplateClient) Update Uses

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

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

func (EmailTemplateClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (EmailTemplateClient) UpdateResponder Uses

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

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

func (EmailTemplateClient) UpdateSender Uses

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

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

type EmailTemplateCollection Uses

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

EmailTemplateCollection paged email template list representation.

func (EmailTemplateCollection) IsEmpty Uses

func (etc EmailTemplateCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EmailTemplateCollectionIterator Uses

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

EmailTemplateCollectionIterator provides access to a complete listing of EmailTemplateContract values.

func NewEmailTemplateCollectionIterator Uses

func NewEmailTemplateCollectionIterator(page EmailTemplateCollectionPage) EmailTemplateCollectionIterator

Creates a new instance of the EmailTemplateCollectionIterator type.

func (*EmailTemplateCollectionIterator) Next Uses

func (iter *EmailTemplateCollectionIterator) Next() error

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

func (*EmailTemplateCollectionIterator) NextWithContext Uses

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

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

func (EmailTemplateCollectionIterator) NotDone Uses

func (iter EmailTemplateCollectionIterator) NotDone() bool

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

func (EmailTemplateCollectionIterator) Response Uses

func (iter EmailTemplateCollectionIterator) Response() EmailTemplateCollection

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

func (EmailTemplateCollectionIterator) Value Uses

func (iter EmailTemplateCollectionIterator) Value() EmailTemplateContract

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

type EmailTemplateCollectionPage Uses

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

EmailTemplateCollectionPage contains a page of EmailTemplateContract values.

func NewEmailTemplateCollectionPage Uses

func NewEmailTemplateCollectionPage(getNextPage func(context.Context, EmailTemplateCollection) (EmailTemplateCollection, error)) EmailTemplateCollectionPage

Creates a new instance of the EmailTemplateCollectionPage type.

func (*EmailTemplateCollectionPage) Next Uses

func (page *EmailTemplateCollectionPage) Next() error

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

func (*EmailTemplateCollectionPage) NextWithContext Uses

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

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

func (EmailTemplateCollectionPage) NotDone Uses

func (page EmailTemplateCollectionPage) NotDone() bool

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

func (EmailTemplateCollectionPage) Response Uses

func (page EmailTemplateCollectionPage) Response() EmailTemplateCollection

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

func (EmailTemplateCollectionPage) Values Uses

func (page EmailTemplateCollectionPage) Values() []EmailTemplateContract

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

type EmailTemplateContract Uses

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

EmailTemplateContract email Template details.

type EmailTemplateContractProperties Uses

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

EmailTemplateContractProperties email Template Contract properties.

type EmailTemplateParametersContractProperties Uses

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

EmailTemplateParametersContractProperties email Template Parameter contract.

type EmailTemplateUpdateParameters Uses

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

EmailTemplateUpdateParameters email Template Update Contract properties.

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

ErrorResponse error Body contract.

type GenerateSsoURLResult 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 GrantType Uses

type GrantType string

GrantType enumerates the values for grant type.

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

func PossibleGrantTypeValues Uses

func PossibleGrantTypeValues() []GrantType

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

type GroupClient Uses

type GroupClient struct {
    BaseClient
}

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

func NewGroupClient Uses

func NewGroupClient() GroupClient

NewGroupClient creates an instance of the GroupClient client.

func (GroupClient) CreateOrUpdate Uses

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

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

func (GroupClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (GroupClient) CreateOrUpdateResponder Uses

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

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

func (GroupClient) CreateOrUpdateSender Uses

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

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

func (GroupClient) Delete Uses

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

Delete deletes specific group of the API Management service instance. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (GroupClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (GroupClient) DeleteResponder Uses

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

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

func (GroupClient) DeleteSender Uses

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

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

func (GroupClient) Get Uses

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

Get gets the details of the group specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. groupID - group identifier. Must be unique in the current API Management service instance.

func (GroupClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (GroupClient) GetResponder Uses

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

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

func (GroupClient) GetSender Uses

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

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

func (GroupClient) List Uses

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

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

func (GroupClient) ListComplete Uses

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

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

func (GroupClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (GroupClient) ListResponder Uses

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

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

func (GroupClient) ListSender Uses

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

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

func (GroupClient) Update Uses

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

Update updates the details of the group specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (GroupClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (GroupClient) UpdateResponder Uses

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

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

func (GroupClient) UpdateSender Uses

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

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

type GroupCollection Uses

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

GroupCollection paged Group list representation.

func (GroupCollection) IsEmpty 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 - Identifier of the Group entity.
    ID  *string `json:"id,omitempty"`
    // Name - Group name.
    Name *string `json:"name,omitempty"`
    // Description - Group description. Can contain HTML formatting tags.
    Description *string `json:"description,omitempty"`
    // BuiltIn - 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 - Group type. Possible values include: 'Custom', 'System', 'External'
    Type GroupType `json:"type,omitempty"`
    // ExternalID - For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
    ExternalID *string `json:"externalId,omitempty"`
}

GroupContract contract details.

type GroupContractProperties Uses

type GroupContractProperties struct {
    // Name - Group name.
    Name *string `json:"name,omitempty"`
    // Description - Group description. Can contain HTML formatting tags.
    Description *string `json:"description,omitempty"`
    // BuiltIn - 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 - Group type. Possible values include: 'Custom', 'System', 'External'
    Type GroupType `json:"type,omitempty"`
    // ExternalID - For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
    ExternalID *string `json:"externalId,omitempty"`
}

GroupContractProperties developer group.

type GroupCreateParameters 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 GroupType `json:"type,omitempty"`
    // ExternalID - Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
    ExternalID *string `json:"externalId,omitempty"`
}

GroupCreateParameters parameters supplied to the Create Group operation.

type GroupType Uses

type GroupType string

GroupType enumerates the values for group type.

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

func PossibleGroupTypeValues Uses

func PossibleGroupTypeValues() []GroupType

PossibleGroupTypeValues returns an array of possible values for the GroupType 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 GroupType `json:"type,omitempty"`
    // ExternalID - Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
    ExternalID *string `json:"externalId,omitempty"`
}

GroupUpdateParameters parameters supplied to the Update Group operation.

type GroupUserClient Uses

type GroupUserClient struct {
    BaseClient
}

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

func NewGroupUserClient Uses

func NewGroupUserClient() GroupUserClient

NewGroupUserClient creates an instance of the GroupUserClient client.

func (GroupUserClient) Create Uses

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

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

func (GroupUserClient) CreatePreparer Uses

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

CreatePreparer prepares the Create request.

func (GroupUserClient) CreateResponder Uses

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

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

func (GroupUserClient) CreateSender Uses

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

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

func (GroupUserClient) Delete Uses

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

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

func (GroupUserClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (GroupUserClient) DeleteResponder Uses

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

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

func (GroupUserClient) DeleteSender Uses

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

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

func (GroupUserClient) List Uses

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

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

func (GroupUserClient) ListComplete Uses

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

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

func (GroupUserClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (GroupUserClient) ListResponder Uses

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

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

func (GroupUserClient) ListSender Uses

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

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

type IdentityProviderBaseParameters Uses

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

IdentityProviderBaseParameters identity Provider Base Parameter Properties.

type IdentityProviderClient Uses

type IdentityProviderClient struct {
    BaseClient
}

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

func NewIdentityProviderClient Uses

func NewIdentityProviderClient() IdentityProviderClient

NewIdentityProviderClient creates an instance of the IdentityProviderClient client.

func (IdentityProviderClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or Updates the IdentityProvider configuration. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. identityProviderName - identity Provider Type identifier. parameters - create parameters.

func (IdentityProviderClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (IdentityProviderClient) CreateOrUpdateResponder Uses

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

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

func (IdentityProviderClient) CreateOrUpdateSender Uses

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

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

func (IdentityProviderClient) Delete Uses

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

Delete deletes the specified identity provider configuration. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (IdentityProviderClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (IdentityProviderClient) DeleteResponder Uses

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

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

func (IdentityProviderClient) DeleteSender Uses

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

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

func (IdentityProviderClient) Get Uses

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

Get gets the configuration details of the identity Provider configured in specified service instance. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. identityProviderName - identity Provider Type identifier.

func (IdentityProviderClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (IdentityProviderClient) GetResponder Uses

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

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

func (IdentityProviderClient) GetSender Uses

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

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

func (IdentityProviderClient) List Uses

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

List lists a collection of Identity Provider configured in the specified service instance. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (IdentityProviderClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (IdentityProviderClient) ListResponder Uses

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

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

func (IdentityProviderClient) ListSender Uses

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

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

func (IdentityProviderClient) Update Uses

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

Update updates an existing IdentityProvider configuration. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (IdentityProviderClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (IdentityProviderClient) UpdateResponder Uses

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

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

func (IdentityProviderClient) UpdateSender Uses

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

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

type IdentityProviderContract Uses

type IdentityProviderContract struct {
    autorest.Response `json:"-"`
    // ID - Identifier of the identity provider.
    ID  *string `json:"id,omitempty"`
    // ClientID - Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
    ClientID *string `json:"clientId,omitempty"`
    // ClientSecret - Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.
    ClientSecret *string `json:"clientSecret,omitempty"`
    // Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
    Type IdentityProviderType `json:"type,omitempty"`
    // AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
    AllowedTenants *[]string `json:"allowedTenants,omitempty"`
    // SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
    SignupPolicyName *string `json:"signupPolicyName,omitempty"`
    // SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
    SigninPolicyName *string `json:"signinPolicyName,omitempty"`
    // ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
    ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
    // PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
    PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`
}

IdentityProviderContract identity Provider details.

type IdentityProviderContractProperties Uses

type IdentityProviderContractProperties struct {
    // ClientID - Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
    ClientID *string `json:"clientId,omitempty"`
    // ClientSecret - Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.
    ClientSecret *string `json:"clientSecret,omitempty"`
    // Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
    Type IdentityProviderType `json:"type,omitempty"`
    // AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
    AllowedTenants *[]string `json:"allowedTenants,omitempty"`
    // SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
    SignupPolicyName *string `json:"signupPolicyName,omitempty"`
    // SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
    SigninPolicyName *string `json:"signinPolicyName,omitempty"`
    // ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
    ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
    // PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
    PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`
}

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

type IdentityProviderList Uses

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

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

type IdentityProviderType Uses

type IdentityProviderType string

IdentityProviderType enumerates the values for identity provider type.

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

func PossibleIdentityProviderTypeValues Uses

func PossibleIdentityProviderTypeValues() []IdentityProviderType

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

IdentityProviderUpdateParameters parameters supplied to the Update Identity Provider operation.

type KeyType Uses

type KeyType string

KeyType enumerates the values for key type.

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

func PossibleKeyTypeValues Uses

func PossibleKeyTypeValues() []KeyType

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

type LoggerClient Uses

type LoggerClient struct {
    BaseClient
}

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

func NewLoggerClient Uses

func NewLoggerClient() LoggerClient

NewLoggerClient creates an instance of the LoggerClient client.

func (LoggerClient) CreateOrUpdate Uses

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

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

func (LoggerClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (LoggerClient) CreateOrUpdateResponder Uses

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

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

func (LoggerClient) CreateOrUpdateSender Uses

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

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

func (LoggerClient) Delete Uses

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

Delete deletes the specified logger. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. loggerid - logger identifier. Must be unique in the API Management service instance. 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 (LoggerClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (LoggerClient) DeleteResponder Uses

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

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

func (LoggerClient) DeleteSender Uses

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

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

func (LoggerClient) Get Uses

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

Get gets the details of the logger specified by its identifier. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. loggerid - logger identifier. Must be unique in the API Management service instance.

func (LoggerClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (LoggerClient) GetResponder Uses

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

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

func (LoggerClient) GetSender Uses

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

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

func (LoggerClient) List Uses

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

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

func (LoggerClient) ListComplete Uses

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

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

func (LoggerClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (LoggerClient) ListResponder Uses

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

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

func (LoggerClient) ListSender Uses

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

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

func (LoggerClient) Update Uses

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

Update updates an existing logger. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. loggerid - logger identifier. Must be unique in the API Management service instance. 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 (LoggerClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (LoggerClient) UpdateResponder Uses

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

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

func (LoggerClient) UpdateSender Uses

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

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

type LoggerCollection Uses

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

LoggerCollection paged Logger list representation.

func (LoggerCollection) IsEmpty 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 LoggerContract 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() LoggerContract

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

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

type LoggerContract Uses

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

LoggerContract logger details.

func (LoggerContract) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for LoggerContract.

type LoggerContractProperties Uses

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

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

func (LoggerContractProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for LoggerContractProperties.

type LoggerType Uses

type LoggerType string

LoggerType enumerates the values for logger type.

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

func PossibleLoggerTypeValues Uses

func PossibleLoggerTypeValues() []LoggerType

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

type LoggerUpdateContract Uses

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

LoggerUpdateContract parameters supplied to the Update Logger operation.

func (LoggerUpdateContract) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for LoggerUpdateContract.

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 OpenIDConnectProviderClient Uses

type OpenIDConnectProviderClient struct {
    BaseClient
}

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

func NewOpenIDConnectProviderClient Uses

func NewOpenIDConnectProviderClient() OpenIDConnectProviderClient

NewOpenIDConnectProviderClient creates an instance of the OpenIDConnectProviderClient client.

func (OpenIDConnectProviderClient) CreateOrUpdate Uses

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

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

func (OpenIDConnectProviderClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (OpenIDConnectProviderClient) CreateOrUpdateResponder Uses

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

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

func (OpenIDConnectProviderClient) CreateOrUpdateSender Uses

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

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

func (OpenIDConnectProviderClient) Delete Uses

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

Delete deletes specific OpenID Connect Provider of the API Management service instance. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (OpenIDConnectProviderClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (OpenIDConnectProviderClient) DeleteResponder Uses

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

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

func (OpenIDConnectProviderClient) DeleteSender Uses

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

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

func (OpenIDConnectProviderClient) Get Uses

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

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

func (OpenIDConnectProviderClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (OpenIDConnectProviderClient) GetResponder Uses

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

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

func (OpenIDConnectProviderClient) GetSender Uses

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

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

func (OpenIDConnectProviderClient) List Uses

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

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

func (OpenIDConnectProviderClient) ListComplete Uses

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

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

func (OpenIDConnectProviderClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OpenIDConnectProviderClient) ListResponder Uses

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

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

func (OpenIDConnectProviderClient) ListSender Uses

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

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

func (OpenIDConnectProviderClient) Update Uses

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

Update updates the specific OpenID Connect Provider. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. 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 (OpenIDConnectProviderClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (OpenIDConnectProviderClient) UpdateResponder Uses

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

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

func (OpenIDConnectProviderClient) UpdateSender Uses

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

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

type OpenIDConnectProviderCollection Uses

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

OpenIDConnectProviderCollection paged OpenIdProviders list representation.

func (OpenIDConnectProviderCollection) IsEmpty 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 OpenidConnectProviderContract Uses

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

OpenidConnectProviderContract openId Connect Provider details.

type OpenidConnectProviderContractProperties Uses

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

OpenidConnectProviderContractProperties openID Connect Providers Contract.

type OpenidConnectProviderUpdateContract 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 number of entities
    Count *int32 `json:"count,omitempty"`
    // NextLink - Next page link if any.
    NextLink *string `json:"nextLink,omitempty"`
}

OperationCollection paged Operation list representation.

func (OperationCollection) IsEmpty 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 - Identifier of the Operation.
    ID  *string `json:"id,omitempty"`
    // Name - Operation Name.
    Name *string `json:"name,omitempty"`
    // Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
    Method *string `json:"method,omitempty"`
    // URLTemplate - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
    URLTemplate *string `json:"urlTemplate,omitempty"`
    // TemplateParameters - Collection of URL template parameters.
    TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
    // Description - Description of the operation. May include HTML formatting tags.
    Description *string `json:"description,omitempty"`
    // Request - An entity containing request details.
    Request *RequestContract `json:"request,omitempty"`
    // Responses - Array of Operation responses.
    Responses *[]ResponseContract `json:"responses,omitempty"`
    // Policies - Operation Policies
    Policies *string `json:"policies,omitempty"`
}

OperationContract api Operation details.

type OperationContractProperties Uses

type OperationContractProperties struct {
    // Name - Operation Name.
    Name *string `json:"name,omitempty"`
    // Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
    Method *string `json:"method,omitempty"`
    // URLTemplate - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
    URLTemplate *string `json:"urlTemplate,omitempty"`
    // TemplateParameters - Collection of URL template parameters.
    TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
    // Description - Description of the operation. May include HTML formatting tags.
    Description *string `json:"description,omitempty"`
    // Request - An entity containing request details.
    Request *RequestContract `json:"request,omitempty"`
    // Responses - Array of Operation responses.
    Responses *[]ResponseContract `json:"responses,omitempty"`
    // Policies - Operation Policies
    Policies *string `json:"policies,omitempty"`
}

OperationContractProperties operation Contract Properties

type OperationEntityBaseContract Uses

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

OperationEntityBaseContract api Operation Entity Base Contract details.

type OperationResultContract 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 AsyncOperationStatus `json:"status,omitempty"`
    // Started - Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
    Started *date.Time `json:"started,omitempty"`
    // Updated - Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
    Updated *date.Time `json:"updated,omitempty"`
    // ResultInfo - Optional result info.
    ResultInfo *string `json:"resultInfo,omitempty"`
    // Error - Error Body Contract
    Error *ErrorResponse `json:"error,omitempty"`
    // ActionLog - READ-ONLY; This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation.
    ActionLog *[]OperationResultLogItemContract `json:"actionLog,omitempty"`
}

OperationResultContract operation Result.

type OperationResultLogItemContract Uses

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

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

type OperationUpdateContract Uses

type OperationUpdateContract struct {
    // Name - Operation Name.
    Name *string `json:"name,omitempty"`
    // Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
    Method *string `json:"method,omitempty"`
    // URLTemplate - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
    URLTemplate *string `json:"urlTemplate,omitempty"`
    // TemplateParameters - Collection of URL template parameters.
    TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
    // Description - Description of the operation. May include HTML formatting tags.
    Description *string `json:"description,omitempty"`
    // Request - An entity containing request details.
    Request *RequestContract `json:"request,omitempty"`
    // Responses - Array of Operation responses.
    Responses *[]ResponseContract `json:"responses,omitempty"`
    // Policies - Operation Policies
    Policies *string `json:"policies,omitempty"`
}

OperationUpdateContract operation Update Contract Properties.

type ParameterContract 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 PolicyClient Uses

type PolicyClient struct {
    BaseClient
}

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

func NewPolicyClient Uses

func NewPolicyClient() PolicyClient

NewPolicyClient creates an instance of the PolicyClient client.

func (PolicyClient) CreateOrUpdate Uses

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

CreateOrUpdate creates or updates the global policy configuration of the Api Management service. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. parameters - the policy contents to apply.

func (PolicyClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PolicyClient) CreateOrUpdateResponder Uses

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

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

func (PolicyClient) CreateOrUpdateSender Uses

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

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

func (PolicyClient) Delete Uses

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

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

func (PolicyClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (PolicyClient) DeleteResponder Uses

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

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

func (PolicyClient) DeleteSender Uses

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

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

func (PolicyClient) Get Uses

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

Get get the Global policy definition of the Api Management service. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net.

func (PolicyClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (PolicyClient) GetResponder Uses

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

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

func (PolicyClient) GetSender Uses

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

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

func (PolicyClient) List Uses

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

List lists all the Global Policy definitions of the Api Management service. Parameters: apimBaseURL - the management endpoint of the API Management service, for example https://myapimservice.management.azure-api.net. scope - policy scope.

func (PolicyClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (PolicyClient) ListResponder Uses

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