azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/apimanagement/mgmt/2019-12-01/apimanagement Index | Files | Directories

package apimanagement

import "github.com/Azure/azure-sdk-for-go/services/apimanagement/mgmt/2019-12-01/apimanagement"

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

ApiManagement Client

Index

Package Files

api.go apidiagnostic.go apiexport.go apiissue.go apiissueattachment.go apiissuecomment.go apioperation.go apioperationpolicy.go apipolicy.go apiproduct.go apirelease.go apirevision.go apischema.go apitagdescription.go apiversionset.go authorizationserver.go backend.go cache.go certificate.go client.go delegationsettings.go diagnostic.go emailtemplate.go gateway.go gatewayapi.go gatewayhostnameconfiguration.go group.go groupuser.go identityprovider.go issue.go logger.go models.go namedvalue.go networkstatus.go notification.go notificationrecipientemail.go notificationrecipientuser.go openidconnectprovider.go operation.go operations.go policy.go policydescription.go product.go productapi.go productgroup.go productpolicy.go productsubscriptions.go quotabycounterkeys.go quotabyperiodkeys.go region.go reports.go service.go serviceskus.go signinsettings.go signupsettings.go subscription.go tag.go tagresource.go tenantaccess.go tenantaccessgit.go tenantconfiguration.go user.go userconfirmationpassword.go usergroup.go useridentities.go usersubscription.go version.go

Constants

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

func UserAgent Uses

❖
func UserAgent() string

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

func Version Uses

❖
func Version() string

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

type APIClient Uses

❖
type APIClient struct {
    BaseClient
}

APIClient is the apiManagement Client

func NewAPIClient Uses

❖
func NewAPIClient(subscriptionID string) APIClient

NewAPIClient creates an instance of the APIClient client.

func NewAPIClientWithBaseURI Uses

❖
func NewAPIClientWithBaseURI(baseURI string, subscriptionID string) APIClient

NewAPIClientWithBaseURI creates an instance of the APIClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIClient) CreateOrUpdate Uses

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

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

func (APIClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIClient) CreateOrUpdateResponder 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) (future APICreateOrUpdateFuture, err 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, resourceGroupName string, serviceName string, apiid string, ifMatch string, deleteRevisions *bool) (result autorest.Response, err error)

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

func (APIClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIClient) DeleteResponder 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, resourceGroupName string, serviceName string, apiid string) (result APIContract, err error)

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

func (APIClient) GetEntityTag Uses

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

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

func (APIClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIClient) GetEntityTagResponder Uses

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

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

func (APIClient) GetEntityTagSender Uses

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

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

func (APIClient) GetPreparer Uses

❖
func (client APIClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName 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) ListByService Uses

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

ListByService lists all APIs of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br> top - number of records to return. skip - number of records to skip. tags - include tags in the response. expandAPIVersionSet - include full ApiVersionSet resource in response

func (APIClient) ListByServiceComplete Uses

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

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

func (APIClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (APIClient) ListByServiceResponder Uses

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

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

func (APIClient) ListByServiceSender Uses

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

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

func (APIClient) ListByTags Uses

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

ListByTags lists a collection of apis associated with tags. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |isCurrent | eq | | top - number of records to return. skip - number of records to skip. includeNotTaggedApis - include not tagged APIs.

func (APIClient) ListByTagsComplete Uses

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

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

func (APIClient) ListByTagsPreparer Uses

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

ListByTagsPreparer prepares the ListByTags request.

func (APIClient) ListByTagsResponder Uses

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

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

func (APIClient) ListByTagsSender Uses

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

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

func (APIClient) Update Uses

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

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

func (APIClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (APIClient) UpdateResponder 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 - READ-ONLY; Page values.
    Value *[]APIContract `json:"value,omitempty"`
    // NextLink - READ-ONLY; 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:"-"`
    // APIContractProperties - Api entity contract properties.
    *APIContractProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; Resource ID.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; Resource name.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; Resource type for API Management resource.
    Type *string `json:"type,omitempty"`
}

APIContract api details.

func (APIContract) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for APIContract.

func (*APIContract) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for APIContract struct.

type APIContractProperties Uses

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

APIContractProperties api Entity Properties

type APIContractUpdateProperties Uses

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

APIContractUpdateProperties API update contract properties.

type APICreateOrUpdateFuture Uses

❖
type APICreateOrUpdateFuture struct {
    azure.Future
}

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

func (*APICreateOrUpdateFuture) Result Uses

❖
func (future *APICreateOrUpdateFuture) Result(client APIClient) (ac APIContract, err error)

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

type APICreateOrUpdateParameter Uses

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

APICreateOrUpdateParameter API Create or Update Parameters.

func (APICreateOrUpdateParameter) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for APICreateOrUpdateParameter.

func (*APICreateOrUpdateParameter) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for APICreateOrUpdateParameter struct.

type APICreateOrUpdateProperties Uses

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

APICreateOrUpdateProperties api Create or Update Properties.

type APICreateOrUpdatePropertiesWsdlSelector Uses

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

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

type APIDiagnosticClient Uses

❖
type APIDiagnosticClient struct {
    BaseClient
}

APIDiagnosticClient is the apiManagement Client

func NewAPIDiagnosticClient Uses

❖
func NewAPIDiagnosticClient(subscriptionID string) APIDiagnosticClient

NewAPIDiagnosticClient creates an instance of the APIDiagnosticClient client.

func NewAPIDiagnosticClientWithBaseURI Uses

❖
func NewAPIDiagnosticClientWithBaseURI(baseURI string, subscriptionID string) APIDiagnosticClient

NewAPIDiagnosticClientWithBaseURI creates an instance of the APIDiagnosticClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIDiagnosticClient) CreateOrUpdate Uses

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

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

func (APIDiagnosticClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIDiagnosticClient) CreateOrUpdateResponder Uses

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

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

func (APIDiagnosticClient) CreateOrUpdateSender Uses

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

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

func (APIDiagnosticClient) Delete Uses

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

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

func (APIDiagnosticClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIDiagnosticClient) DeleteResponder Uses

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

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

func (APIDiagnosticClient) DeleteSender Uses

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

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

func (APIDiagnosticClient) Get Uses

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

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

func (APIDiagnosticClient) GetEntityTag Uses

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

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

func (APIDiagnosticClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIDiagnosticClient) GetEntityTagResponder Uses

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

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

func (APIDiagnosticClient) GetEntityTagSender Uses

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

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

func (APIDiagnosticClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIDiagnosticClient) GetResponder Uses

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

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

func (APIDiagnosticClient) GetSender Uses

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

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

func (APIDiagnosticClient) ListByService Uses

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

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

func (APIDiagnosticClient) ListByServiceComplete Uses

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

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

func (APIDiagnosticClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (APIDiagnosticClient) ListByServiceResponder Uses

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

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

func (APIDiagnosticClient) ListByServiceSender Uses

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

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

func (APIDiagnosticClient) Update Uses

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

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

func (APIDiagnosticClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (APIDiagnosticClient) UpdateResponder Uses

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

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

func (APIDiagnosticClient) UpdateSender Uses

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

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

type 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"`
    // APIVersion - Indicates the Version identifier of the API if the API is versioned
    APIVersion *string `json:"apiVersion,omitempty"`
    // IsCurrent - Indicates if API revision is current api revision.
    IsCurrent *bool `json:"isCurrent,omitempty"`
    // IsOnline - READ-ONLY; Indicates if API revision is accessible via the gateway.
    IsOnline *bool `json:"isOnline,omitempty"`
    // APIRevisionDescription - Description of the Api Revision.
    APIRevisionDescription *string `json:"apiRevisionDescription,omitempty"`
    // APIVersionDescription - Description of the Api Version.
    APIVersionDescription *string `json:"apiVersionDescription,omitempty"`
    // APIVersionSetID - A resource identifier for the related ApiVersionSet.
    APIVersionSetID *string `json:"apiVersionSetId,omitempty"`
    // SubscriptionRequired - Specifies whether an API or Product subscription is required for accessing the API.
    SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
}

APIEntityBaseContract API base contract details.

type APIExportClient Uses

❖
type APIExportClient struct {
    BaseClient
}

APIExportClient is the apiManagement Client

func NewAPIExportClient Uses

❖
func NewAPIExportClient(subscriptionID string) APIExportClient

NewAPIExportClient creates an instance of the APIExportClient client.

func NewAPIExportClientWithBaseURI Uses

❖
func NewAPIExportClientWithBaseURI(baseURI string, subscriptionID string) APIExportClient

NewAPIExportClientWithBaseURI creates an instance of the APIExportClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIExportClient) Get Uses

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

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

func (APIExportClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIExportClient) GetResponder 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:"-"`
    // ID - ResourceId of the API which was exported.
    ID  *string `json:"id,omitempty"`
    // ExportResultFormat - Format in which the Api Details are exported to the Storage Blob with Sas Key valid for 5 minutes. Possible values include: 'ExportResultFormatSwagger', 'ExportResultFormatWsdl', 'ExportResultFormatWadl', 'ExportResultFormatOpenAPI'
    ExportResultFormat ExportResultFormat `json:"format,omitempty"`
    // Value - The object defining the schema of the exported Api Detail
    Value *APIExportResultValue `json:"value,omitempty"`
}

APIExportResult API Export result.

type APIExportResultValue Uses

❖
type APIExportResultValue struct {
    // 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"`
}

APIExportResultValue the object defining the schema of the exported Api Detail

type APIIssueAttachmentClient Uses

❖
type APIIssueAttachmentClient struct {
    BaseClient
}

APIIssueAttachmentClient is the apiManagement Client

func NewAPIIssueAttachmentClient Uses

❖
func NewAPIIssueAttachmentClient(subscriptionID string) APIIssueAttachmentClient

NewAPIIssueAttachmentClient creates an instance of the APIIssueAttachmentClient client.

func NewAPIIssueAttachmentClientWithBaseURI Uses

❖
func NewAPIIssueAttachmentClientWithBaseURI(baseURI string, subscriptionID string) APIIssueAttachmentClient

NewAPIIssueAttachmentClientWithBaseURI creates an instance of the APIIssueAttachmentClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIIssueAttachmentClient) CreateOrUpdate Uses

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

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

func (APIIssueAttachmentClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIIssueAttachmentClient) CreateOrUpdateResponder Uses

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

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

func (APIIssueAttachmentClient) CreateOrUpdateSender Uses

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

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

func (APIIssueAttachmentClient) Delete Uses

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

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

func (APIIssueAttachmentClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIIssueAttachmentClient) DeleteResponder Uses

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

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

func (APIIssueAttachmentClient) DeleteSender Uses

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

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

func (APIIssueAttachmentClient) Get Uses

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

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

func (APIIssueAttachmentClient) GetEntityTag Uses

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

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

func (APIIssueAttachmentClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIIssueAttachmentClient) GetEntityTagResponder Uses

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

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

func (APIIssueAttachmentClient) GetEntityTagSender Uses

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

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

func (APIIssueAttachmentClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIIssueAttachmentClient) GetResponder Uses

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

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

func (APIIssueAttachmentClient) GetSender Uses

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

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

func (APIIssueAttachmentClient) ListByService Uses

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

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

func (APIIssueAttachmentClient) ListByServiceComplete Uses

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

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

func (APIIssueAttachmentClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (APIIssueAttachmentClient) ListByServiceResponder Uses

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

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

func (APIIssueAttachmentClient) ListByServiceSender Uses

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

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

type APIIssueClient Uses

❖
type APIIssueClient struct {
    BaseClient
}

APIIssueClient is the apiManagement Client

func NewAPIIssueClient Uses

❖
func NewAPIIssueClient(subscriptionID string) APIIssueClient

NewAPIIssueClient creates an instance of the APIIssueClient client.

func NewAPIIssueClientWithBaseURI Uses

❖
func NewAPIIssueClientWithBaseURI(baseURI string, subscriptionID string) APIIssueClient

NewAPIIssueClientWithBaseURI creates an instance of the APIIssueClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIIssueClient) CreateOrUpdate Uses

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

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

func (APIIssueClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIIssueClient) CreateOrUpdateResponder Uses

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

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

func (APIIssueClient) CreateOrUpdateSender Uses

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

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

func (APIIssueClient) Delete Uses

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

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

func (APIIssueClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIIssueClient) DeleteResponder Uses

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

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

func (APIIssueClient) DeleteSender Uses

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

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

func (APIIssueClient) Get Uses

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

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

func (APIIssueClient) GetEntityTag Uses

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

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

func (APIIssueClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIIssueClient) GetEntityTagResponder Uses

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

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

func (APIIssueClient) GetEntityTagSender Uses

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

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

func (APIIssueClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIIssueClient) GetResponder Uses

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

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

func (APIIssueClient) GetSender Uses

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

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

func (APIIssueClient) ListByService Uses

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

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

func (APIIssueClient) ListByServiceComplete Uses

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

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

func (APIIssueClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (APIIssueClient) ListByServiceResponder Uses

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

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

func (APIIssueClient) ListByServiceSender Uses

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

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

func (APIIssueClient) Update Uses

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

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

func (APIIssueClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (APIIssueClient) UpdateResponder Uses

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

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

func (APIIssueClient) UpdateSender Uses

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

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

type APIIssueCommentClient Uses

❖
type APIIssueCommentClient struct {
    BaseClient
}

APIIssueCommentClient is the apiManagement Client

func NewAPIIssueCommentClient Uses

❖
func NewAPIIssueCommentClient(subscriptionID string) APIIssueCommentClient

NewAPIIssueCommentClient creates an instance of the APIIssueCommentClient client.

func NewAPIIssueCommentClientWithBaseURI Uses

❖
func NewAPIIssueCommentClientWithBaseURI(baseURI string, subscriptionID string) APIIssueCommentClient

NewAPIIssueCommentClientWithBaseURI creates an instance of the APIIssueCommentClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIIssueCommentClient) CreateOrUpdate Uses

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

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

func (APIIssueCommentClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIIssueCommentClient) CreateOrUpdateResponder Uses

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

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

func (APIIssueCommentClient) CreateOrUpdateSender Uses

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

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

func (APIIssueCommentClient) Delete Uses

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

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

func (APIIssueCommentClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIIssueCommentClient) DeleteResponder Uses

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

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

func (APIIssueCommentClient) DeleteSender Uses

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

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

func (APIIssueCommentClient) Get Uses

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

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

func (APIIssueCommentClient) GetEntityTag Uses

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

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

func (APIIssueCommentClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIIssueCommentClient) GetEntityTagResponder Uses

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

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

func (APIIssueCommentClient) GetEntityTagSender Uses

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

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

func (APIIssueCommentClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIIssueCommentClient) GetResponder Uses

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

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

func (APIIssueCommentClient) GetSender Uses

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

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

func (APIIssueCommentClient) ListByService Uses

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

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

func (APIIssueCommentClient) ListByServiceComplete Uses

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

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

func (APIIssueCommentClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (APIIssueCommentClient) ListByServiceResponder Uses

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

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

func (APIIssueCommentClient) ListByServiceSender Uses

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

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

type APIOperationClient Uses

❖
type APIOperationClient struct {
    BaseClient
}

APIOperationClient is the apiManagement Client

func NewAPIOperationClient Uses

❖
func NewAPIOperationClient(subscriptionID string) APIOperationClient

NewAPIOperationClient creates an instance of the APIOperationClient client.

func NewAPIOperationClientWithBaseURI Uses

❖
func NewAPIOperationClientWithBaseURI(baseURI string, subscriptionID string) APIOperationClient

NewAPIOperationClientWithBaseURI creates an instance of the APIOperationClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIOperationClient) CreateOrUpdate Uses

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

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

func (APIOperationClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationClient) CreateOrUpdateResponder 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, resourceGroupName string, serviceName string, apiid string, operationID string, ifMatch string) (result autorest.Response, err error)

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

func (APIOperationClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIOperationClient) DeleteResponder 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, resourceGroupName string, serviceName string, apiid string, operationID string) (result OperationContract, err error)

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

func (APIOperationClient) GetEntityTag Uses

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

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

func (APIOperationClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIOperationClient) GetEntityTagResponder Uses

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

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

func (APIOperationClient) GetEntityTagSender Uses

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

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

func (APIOperationClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIOperationClient) GetResponder 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, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32, tags string) (result OperationCollectionPage, err error)

ListByAPI lists a collection of the operations for the specified API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br> top - number of records to return. skip - number of records to skip. tags - include tags in the response.

func (APIOperationClient) ListByAPIComplete Uses

❖
func (client APIOperationClient) ListByAPIComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32, tags string) (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, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32, tags string) (*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, resourceGroupName string, serviceName string, apiid string, operationID string, parameters OperationUpdateContract, ifMatch string) (result autorest.Response, err error)

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

func (APIOperationClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (APIOperationClient) UpdateResponder 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 apiManagement Client

func NewAPIOperationPolicyClient Uses

❖
func NewAPIOperationPolicyClient(subscriptionID string) APIOperationPolicyClient

NewAPIOperationPolicyClient creates an instance of the APIOperationPolicyClient client.

func NewAPIOperationPolicyClientWithBaseURI Uses

❖
func NewAPIOperationPolicyClientWithBaseURI(baseURI string, subscriptionID string) APIOperationPolicyClient

NewAPIOperationPolicyClientWithBaseURI creates an instance of the APIOperationPolicyClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIOperationPolicyClient) CreateOrUpdate Uses

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

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

func (APIOperationPolicyClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIOperationPolicyClient) CreateOrUpdateResponder 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, resourceGroupName string, serviceName string, apiid string, operationID string, ifMatch string) (result autorest.Response, err error)

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

func (APIOperationPolicyClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIOperationPolicyClient) DeleteResponder 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, resourceGroupName string, serviceName string, apiid string, operationID string, formatParameter PolicyExportFormat) (result PolicyContract, err error)

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

func (APIOperationPolicyClient) GetEntityTag Uses

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

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

func (APIOperationPolicyClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIOperationPolicyClient) GetEntityTagResponder Uses

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

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

func (APIOperationPolicyClient) GetEntityTagSender Uses

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

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

func (APIOperationPolicyClient) GetPreparer Uses

❖
func (client APIOperationPolicyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, formatParameter PolicyExportFormat) (*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, resourceGroupName string, serviceName string, apiid string, operationID string) (result PolicyCollection, err error)

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

func (APIOperationPolicyClient) ListByOperationPreparer Uses

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

ListByOperationPreparer prepares the ListByOperation request.

func (APIOperationPolicyClient) ListByOperationResponder 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 apiManagement Client

func NewAPIPolicyClient Uses

❖
func NewAPIPolicyClient(subscriptionID string) APIPolicyClient

NewAPIPolicyClient creates an instance of the APIPolicyClient client.

func NewAPIPolicyClientWithBaseURI Uses

❖
func NewAPIPolicyClientWithBaseURI(baseURI string, subscriptionID string) APIPolicyClient

NewAPIPolicyClientWithBaseURI creates an instance of the APIPolicyClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIPolicyClient) CreateOrUpdate Uses

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

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

func (APIPolicyClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

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

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

func (APIPolicyClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIPolicyClient) DeleteResponder 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, resourceGroupName string, serviceName string, apiid string, formatParameter PolicyExportFormat) (result PolicyContract, err error)

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

func (APIPolicyClient) GetEntityTag Uses

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

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

func (APIPolicyClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIPolicyClient) GetEntityTagResponder Uses

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

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

func (APIPolicyClient) GetEntityTagSender Uses

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

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

func (APIPolicyClient) GetPreparer Uses

❖
func (client APIPolicyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, formatParameter PolicyExportFormat) (*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, resourceGroupName string, serviceName string, apiid string) (result PolicyCollection, err error)

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

func (APIPolicyClient) ListByAPIPreparer Uses

❖
func (client APIPolicyClient) ListByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName 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 apiManagement Client

func NewAPIProductClient Uses

❖
func NewAPIProductClient(subscriptionID string) APIProductClient

NewAPIProductClient creates an instance of the APIProductClient client.

func NewAPIProductClientWithBaseURI Uses

❖
func NewAPIProductClientWithBaseURI(baseURI string, subscriptionID string) APIProductClient

NewAPIProductClientWithBaseURI creates an instance of the APIProductClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIProductClient) ListByApis Uses

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

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

func (APIProductClient) ListByApisComplete Uses

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

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

func (APIProductClient) ListByApisPreparer Uses

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

ListByApisPreparer prepares the ListByApis request.

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

❖
type APIReleaseClient struct {
    BaseClient
}

APIReleaseClient is the apiManagement Client

func NewAPIReleaseClient Uses

❖
func NewAPIReleaseClient(subscriptionID string) APIReleaseClient

NewAPIReleaseClient creates an instance of the APIReleaseClient client.

func NewAPIReleaseClientWithBaseURI Uses

❖
func NewAPIReleaseClientWithBaseURI(baseURI string, subscriptionID string) APIReleaseClient

NewAPIReleaseClientWithBaseURI creates an instance of the APIReleaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIReleaseClient) CreateOrUpdate Uses

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

CreateOrUpdate creates a new Release for the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. releaseID - release identifier within an API. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (APIReleaseClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIReleaseClient) CreateOrUpdateResponder Uses

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

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

func (APIReleaseClient) CreateOrUpdateSender Uses

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

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

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

func (APIReleaseClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIReleaseClient) DeleteResponder Uses

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

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

func (APIReleaseClient) DeleteSender Uses

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

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

func (APIReleaseClient) Get Uses

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

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

func (APIReleaseClient) GetEntityTag Uses

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

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

func (APIReleaseClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APIReleaseClient) GetEntityTagResponder Uses

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

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

func (APIReleaseClient) GetEntityTagSender Uses

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

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

func (APIReleaseClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APIReleaseClient) GetResponder Uses

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

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

func (APIReleaseClient) GetSender Uses

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

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

func (APIReleaseClient) ListByService Uses

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

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

func (APIReleaseClient) ListByServiceComplete Uses

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

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

func (APIReleaseClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (APIReleaseClient) ListByServiceResponder Uses

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

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

func (APIReleaseClient) ListByServiceSender Uses

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

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

func (APIReleaseClient) Update Uses

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

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

func (APIReleaseClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (APIReleaseClient) UpdateResponder Uses

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

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

func (APIReleaseClient) UpdateSender Uses

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

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

type APIReleaseCollection Uses

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

APIReleaseCollection paged ApiRelease list representation.

func (APIReleaseCollection) IsEmpty Uses

❖
func (arc APIReleaseCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type APIReleaseCollectionIterator Uses

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

APIReleaseCollectionIterator provides access to a complete listing of APIReleaseContract values.

func NewAPIReleaseCollectionIterator Uses

❖
func NewAPIReleaseCollectionIterator(page APIReleaseCollectionPage) APIReleaseCollectionIterator

Creates a new instance of the APIReleaseCollectionIterator type.

func (*APIReleaseCollectionIterator) Next Uses

❖
func (iter *APIReleaseCollectionIterator) Next() error

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

func (*APIReleaseCollectionIterator) NextWithContext Uses

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

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

func (APIReleaseCollectionIterator) NotDone Uses

❖
func (iter APIReleaseCollectionIterator) NotDone() bool

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

func (APIReleaseCollectionIterator) Response Uses

❖
func (iter APIReleaseCollectionIterator) Response() APIReleaseCollection

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

func (APIReleaseCollectionIterator) Value Uses

❖
func (iter APIReleaseCollectionIterator) Value() APIReleaseContract

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

type APIReleaseCollectionPage Uses

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

APIReleaseCollectionPage contains a page of APIReleaseContract values.

func NewAPIReleaseCollectionPage Uses

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

Creates a new instance of the APIReleaseCollectionPage type.

func (*APIReleaseCollectionPage) Next Uses

❖
func (page *APIReleaseCollectionPage) Next() error

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

func (*APIReleaseCollectionPage) NextWithContext Uses

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

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

func (APIReleaseCollectionPage) NotDone Uses

❖
func (page APIReleaseCollectionPage) NotDone() bool

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

func (APIReleaseCollectionPage) Response Uses

❖
func (page APIReleaseCollectionPage) Response() APIReleaseCollection

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

func (APIReleaseCollectionPage) Values Uses

❖
func (page APIReleaseCollectionPage) Values() []APIReleaseContract

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

type APIReleaseContract Uses

❖
type APIReleaseContract struct {
    autorest.Response `json:"-"`
    // APIReleaseContractProperties - ApiRelease entity contract properties.
    *APIReleaseContractProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; Resource ID.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; Resource name.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; Resource type for API Management resource.
    Type *string `json:"type,omitempty"`
}

APIReleaseContract apiRelease details.

func (APIReleaseContract) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for APIReleaseContract.

func (*APIReleaseContract) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for APIReleaseContract struct.

type APIReleaseContractProperties Uses

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

APIReleaseContractProperties API Release details

type APIRevisionClient Uses

❖
type APIRevisionClient struct {
    BaseClient
}

APIRevisionClient is the apiManagement Client

func NewAPIRevisionClient Uses

❖
func NewAPIRevisionClient(subscriptionID string) APIRevisionClient

NewAPIRevisionClient creates an instance of the APIRevisionClient client.

func NewAPIRevisionClientWithBaseURI Uses

❖
func NewAPIRevisionClientWithBaseURI(baseURI string, subscriptionID string) APIRevisionClient

NewAPIRevisionClientWithBaseURI creates an instance of the APIRevisionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIRevisionClient) ListByService Uses

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

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

func (APIRevisionClient) ListByServiceComplete Uses

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

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

func (APIRevisionClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (APIRevisionClient) ListByServiceResponder Uses

❖
func (client APIRevisionClient) ListByServiceResponder(resp *http.Response) (result APIRevisionCollection, err error)

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

func (APIRevisionClient) ListByServiceSender Uses

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

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

type APIRevisionCollection Uses

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

APIRevisionCollection paged Api Revision list representation.

func (APIRevisionCollection) IsEmpty Uses

❖
func (arc APIRevisionCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type APIRevisionCollectionIterator Uses

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

APIRevisionCollectionIterator provides access to a complete listing of APIRevisionContract values.

func NewAPIRevisionCollectionIterator Uses

❖
func NewAPIRevisionCollectionIterator(page APIRevisionCollectionPage) APIRevisionCollectionIterator

Creates a new instance of the APIRevisionCollectionIterator type.

func (*APIRevisionCollectionIterator) Next Uses

❖
func (iter *APIRevisionCollectionIterator) Next() error

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

func (*APIRevisionCollectionIterator) NextWithContext Uses

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

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

func (APIRevisionCollectionIterator) NotDone Uses

❖
func (iter APIRevisionCollectionIterator) NotDone() bool

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

func (APIRevisionCollectionIterator) Response Uses

❖
func (iter APIRevisionCollectionIterator) Response() APIRevisionCollection

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

func (APIRevisionCollectionIterator) Value Uses

❖
func (iter APIRevisionCollectionIterator) Value() APIRevisionContract

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

type APIRevisionCollectionPage Uses

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

APIRevisionCollectionPage contains a page of APIRevisionContract values.

func NewAPIRevisionCollectionPage Uses

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

Creates a new instance of the APIRevisionCollectionPage type.

func (*APIRevisionCollectionPage) Next Uses

❖
func (page *APIRevisionCollectionPage) Next() error

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

func (*APIRevisionCollectionPage) NextWithContext Uses

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

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

func (APIRevisionCollectionPage) NotDone Uses

❖
func (page APIRevisionCollectionPage) NotDone() bool

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

func (APIRevisionCollectionPage) Response Uses

❖
func (page APIRevisionCollectionPage) Response() APIRevisionCollection

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

func (APIRevisionCollectionPage) Values Uses

❖
func (page APIRevisionCollectionPage) Values() []APIRevisionContract

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

type APIRevisionContract Uses

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

APIRevisionContract summary of revision metadata.

type APIRevisionInfoContract Uses

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

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

type APISchemaClient Uses

❖
type APISchemaClient struct {
    BaseClient
}

APISchemaClient is the apiManagement Client

func NewAPISchemaClient Uses

❖
func NewAPISchemaClient(subscriptionID string) APISchemaClient

NewAPISchemaClient creates an instance of the APISchemaClient client.

func NewAPISchemaClientWithBaseURI Uses

❖
func NewAPISchemaClientWithBaseURI(baseURI string, subscriptionID string) APISchemaClient

NewAPISchemaClientWithBaseURI creates an instance of the APISchemaClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APISchemaClient) CreateOrUpdate Uses

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

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

func (APISchemaClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APISchemaClient) CreateOrUpdateResponder 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) (future APISchemaCreateOrUpdateFuture, err 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, resourceGroupName string, serviceName string, apiid string, schemaID string, ifMatch string, force *bool) (result autorest.Response, err error)

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

func (APISchemaClient) DeletePreparer Uses

❖
func (client APISchemaClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, schemaID string, ifMatch string, force *bool) (*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, resourceGroupName string, serviceName string, apiid string, schemaID string) (result SchemaContract, err error)

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

func (APISchemaClient) GetEntityTag Uses

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

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

func (APISchemaClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APISchemaClient) GetEntityTagResponder Uses

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

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

func (APISchemaClient) GetEntityTagSender Uses

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

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

func (APISchemaClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APISchemaClient) GetResponder 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, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result SchemaCollectionPage, err error)

ListByAPI get the schema configuration at the API level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br> top - number of records to return. skip - number of records to skip.

func (APISchemaClient) ListByAPIComplete Uses

❖
func (client APISchemaClient) ListByAPIComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (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, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (*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 APISchemaCreateOrUpdateFuture Uses

❖
type APISchemaCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*APISchemaCreateOrUpdateFuture) Result Uses

❖
func (future *APISchemaCreateOrUpdateFuture) Result(client APISchemaClient) (sc SchemaContract, err error)

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

type APITagDescriptionClient Uses

❖
type APITagDescriptionClient struct {
    BaseClient
}

APITagDescriptionClient is the apiManagement Client

func NewAPITagDescriptionClient Uses

❖
func NewAPITagDescriptionClient(subscriptionID string) APITagDescriptionClient

NewAPITagDescriptionClient creates an instance of the APITagDescriptionClient client.

func NewAPITagDescriptionClientWithBaseURI Uses

❖
func NewAPITagDescriptionClientWithBaseURI(baseURI string, subscriptionID string) APITagDescriptionClient

NewAPITagDescriptionClientWithBaseURI creates an instance of the APITagDescriptionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APITagDescriptionClient) CreateOrUpdate Uses

❖
func (client APITagDescriptionClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagDescriptionID string, parameters TagDescriptionCreateParameters, ifMatch string) (result TagDescriptionContract, err error)

CreateOrUpdate create/Update tag description in scope of the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagDescriptionID - tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.

func (APITagDescriptionClient) CreateOrUpdatePreparer Uses

❖
func (client APITagDescriptionClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagDescriptionID string, parameters TagDescriptionCreateParameters, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APITagDescriptionClient) CreateOrUpdateResponder Uses

❖
func (client APITagDescriptionClient) CreateOrUpdateResponder(resp *http.Response) (result TagDescriptionContract, err error)

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

func (APITagDescriptionClient) CreateOrUpdateSender Uses

❖
func (client APITagDescriptionClient) 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 (APITagDescriptionClient) Delete Uses

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

Delete delete tag description for the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagDescriptionID - tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

func (APITagDescriptionClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APITagDescriptionClient) DeleteResponder Uses

❖
func (client APITagDescriptionClient) 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 (APITagDescriptionClient) DeleteSender Uses

❖
func (client APITagDescriptionClient) 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 (APITagDescriptionClient) Get Uses

❖
func (client APITagDescriptionClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagDescriptionID string) (result TagDescriptionContract, err error)

Get get Tag description in scope of API Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagDescriptionID - tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

func (APITagDescriptionClient) GetEntityTag Uses

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

GetEntityTag gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagDescriptionID - tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

func (APITagDescriptionClient) GetEntityTagPreparer Uses

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

GetEntityTagPreparer prepares the GetEntityTag request.

func (APITagDescriptionClient) GetEntityTagResponder Uses

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

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

func (APITagDescriptionClient) GetEntityTagSender Uses

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

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

func (APITagDescriptionClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (APITagDescriptionClient) GetResponder Uses

❖
func (client APITagDescriptionClient) GetResponder(resp *http.Response) (result TagDescriptionContract, err error)

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

func (APITagDescriptionClient) GetSender Uses

❖
func (client APITagDescriptionClient) 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 (APITagDescriptionClient) ListByService Uses

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

ListByService lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br> top - number of records to return. skip - number of records to skip.

func (APITagDescriptionClient) ListByServiceComplete Uses

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

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

func (APITagDescriptionClient) ListByServicePreparer Uses

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

ListByServicePreparer prepares the ListByService request.

func (APITagDescriptionClient) ListByServiceResponder Uses

❖
func (client APITagDescriptionClient) ListByServiceResponder(resp *http.Response) (result TagDescriptionCollection, err error)

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

func (APITagDescriptionClient) ListByServiceSender Uses

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

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

type APITagResourceContractProperties Uses

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

APITagResourceContractProperties API contract properties for the Tag Resources.

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 {
    // APIContractUpdateProperties - Properties of the API entity that can be updated.
    *APIContractUpdateProperties `json:"properties,omitempty"`
}

APIUpdateContract API update contract details.

func (APIUpdateContract) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for APIUpdateContract.

func (*APIUpdateContract) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for APIUpdateContract struct.

type APIVersionConstraint Uses

❖
type APIVersionConstraint struct {
    // MinAPIVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
    MinAPIVersion *string `json:"minApiVersion,omitempty"`
}

APIVersionConstraint control Plane Apis version constraint for the API Management service.

type APIVersionSetClient Uses

❖
type APIVersionSetClient struct {
    BaseClient
}

APIVersionSetClient is the apiManagement Client

func NewAPIVersionSetClient Uses

❖
func NewAPIVersionSetClient(subscriptionID string) APIVersionSetClient

NewAPIVersionSetClient creates an instance of the APIVersionSetClient client.

func NewAPIVersionSetClientWithBaseURI Uses

❖
func NewAPIVersionSetClientWithBaseURI(baseURI string, subscriptionID string) APIVersionSetClient

NewAPIVersionSetClientWithBaseURI creates an instance of the APIVersionSetClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (APIVersionSetClient) CreateOrUpdate Uses

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

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

func (APIVersionSetClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (APIVersionSetClient) CreateOrUpdateResponder Uses

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

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

func (APIVersionSetClient) CreateOrUpdateSender Uses

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

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

func (APIVersionSetClient) Delete Uses

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

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

func (APIVersionSetClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (APIVersionSetClient) DeleteResponder Uses

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

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

func (APIVersionSetClient) DeleteSender Uses

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

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

func (APIVersionSetClient) Get Uses

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

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

func (APIVersionSetClient) GetEntityTag Uses

❖
func (client APIVe